FANDOM


[edit] [purge] Template-info.svg Template documentation

Usage

This template is used to build consistent documentation pages for Template:Cs1 templates.

For example: {{Citation Style documentation|author}} will show the author documentation.

Where a particular section of documentation is not appropriate for a certain template, simply add the text manually or create a new subtemplate.

Each module of text is a subtemplate that can be edited using the link.

Parameters

syntax

[edit subtemplate]

Nested parameters rely on their parent parameters:

  • parent
  • OR: parent2—may be used instead of parent
    • child—may be used with parent (and is ignored if parent is not used)
    • OR: child2—may be used instead of child (and is ignored if parent2 is not used)

coins

[edit subtemplate]

This template embeds COinS metadata in the HTML output, allowing reference management software to retrieve bibliographic metadata; see Wikipedia:COinS.

  • Do not use parser or extension tags such as <nowiki> in fields—this exposes strip markers in the metadata; see Help:Strip markers for details.
  • Do not use templates such as {{smallcaps}} or other markup in fields—the HTML output will be rendered in the meta-data.

sep_period

[edit subtemplate]

By default, sets of fields are terminated with a period (.); this can be an issue when the last field in an abbreviation or initial with a period, as two periods then display. The only solution is to not include the last period in the value for the set of fields.

sep_comma

[edit subtemplate]

Template:Citation Style documentation/sep comma

required

[edit subtemplate]

This parameter is required and will generate an error if not defined. On errors, main, help and template pages are placed into Category:Articles with incorrect citation syntax. Set |template doc demo=true to disable categorization; mainly used for documentation where the error is demonstrated.

deprecated

[edit subtemplate]

These parameters are deprecated and will no longer work. Use will place the page in Category:Pages containing cite templates with deprecated parameters.

Use accessdate:

  • access-date
  • accessed
  • accessdaymonth
  • accessday
  • accessmonthday
  • accessmonth
  • accessyear

Use date:

  • day

No longer supported:

  • dateformat
  • doilabel

Options for this field:

  • |date2=yes adds:
    • date2
    • month2
    • year2

author

[edit subtemplate]

  • last: Surname of author. Do not wikilink—use authorlink instead. Where the surname is usually written first—as in Chinese—or for corporate authors, simply use last to include the same format as the source.
    • first: Given or first names of author, including title(s); for example: Firstname Middlename or Firstname M. or Dr. Firstname M., Sr. Do not wikilink—use authorlink instead.
    • OR: for multiple authors, use first1, last1 through first9, last9 for up to nine authors. By default, if nine authors are defined, then only eight will show and "et al." will show in place of the last author.
  • authorlink: Title of existing Wikipedia article about the author—not the author's website; do not wikilink.
  • OR: for multiple authors, use authorlink1 through authorlink9.
Aliases: last, last1, author, authors; last1, author1 through last9, author9

Options for this field:

  • |coauthors=yes adds the coauthors parameter.
  • |others=yes adds the others parameter.
  • |aliases= includes aliases for last.

editor

[edit subtemplate]

  • editor-last: Surname of editor. Do not wikilink—use editor-link instead. Where the surname is usually written first—as in Chinese—or for corporate authors, simply use editor-last to include the same format as the source.
    • editor-first: Given or first names of editor, including title(s); example: Firstname Middlename or Firstname M. or Dr. Firstname M., Sr. Do not wikilink—use editor-link instead.
    • OR: for multiple editors, use editor1-first, editor1-last through editor1-first, editor4-last for up to four editors.
  • editor-link: Title of existing Wikipedia article about the editor—not the editor's website; do not wikilink.
  • OR: for multiple editors, use editor1-link through editor4-link.
Format:
If authors: Authors are first, followed by the included work, then "In" and the editors, then the main work.
If no authors: Editors appear before the included work; a single editor is followed by "ed."; multiple editors are followed by "eds."; more than three editors will be followed by "et al., eds.".

title

[edit subtemplate]

Template:Citation Style documentation/title

Options for this field:


title_format sets the display format:

  • quotes = Displays in quotes.
  • work = If work is defined, then title is displayed in quotes, else displays in italics.
  • default = Displays in italics.

title_title sets the display title:

  • encyclopedia = encyclopedia
  • default = title

web

[edit subtemplate]

  • title: Title of web page. Displays in quotes.
Titles containing certain characters will display and link incorrectly unless those characters are encoded.
newline [ ] |
space &#91; &#93; &#124;
  • trans_title: If the source cited is in a foreign language, an English translation of the title can be given here. The template will display this in square brackets after the work field and it will link to the url field, if used. Use of the language parameter is recommended.
This parameter is required and will generate an error if not defined. On errors, main, help and template pages are placed into Category:Articles with incorrect citation syntax. Set |template doc demo=true to disable categorization; mainly used for documentation where the error is demonstrated.
  • work: Title of website; can be wikilinked to an existing Wikipedia article or url may be used to add an external link, but not both. Displays in italics.

chapter

[edit subtemplate]

Template:Citation Style documentation/chapter

Options for this field:


title_format sets the display format:

  • italics = Displays in italics.
  • work = If work is defined, then title is displayed in quotes, else displays in italics.
  • default = Displays in quotes.

title_title sets the display title:

  • booktitle = booktitle
  • default = chapter

type

[edit subtemplate]

  • type: Provides additional information about the work type; appears in parentheses following the title.

Options for this field:


  • type_default: Adds "Defaults to type_default"

journal

[edit subtemplate]

  • work: Name of the source.
Aliases: work, journal, periodical, magazine

Options for this field:

  • department adds:
  • department: Regular department within the periodical. Displays after work and is in plain text.

edition

[edit subtemplate]

  • edition: When the publication has more than one edition; for example: "2nd", "Revised" etc. Displays " ed." after this field, so |edition=2nd produces "2nd ed."

series

[edit subtemplate]

  • series or version: When the source is part of a series, such as a book series or a journal where the issue numbering has restarted.

series_episode

[edit subtemplate]

Template:Citation Style documentation/series episode

event

[edit subtemplate]

Template:Citation Style documentation/event

agency

[edit subtemplate]

Template:Citation Style documentation/agency

volume

[edit subtemplate]

  • volume: For one publication published in several volumes. Displayed in bold after the title and series fields. An alternative is to include the volume information using title after the main title.

date

[edit subtemplate]

  • date: Full date of source being referenced; in same format as other dates in the article; do not wikilink. Use only the full date including month, day and year, else the anchor may be malformed.
  • OR: year: Year of source being referenced.
    • month: Name of the month of publication. If you also have the day, use date instead; do not wikilink.
    • origyear: Original publication year; displayed after the date or year. For clarity, please supply specifics; example: |origyear=First published 1859 or |origyear=Composed 1904.

Options for this field:

  • aliases includes aliases for date
  • began adds:
  • OR: began: Full date the first part of the program or episode aired.
    • AND: ended: Full date the last part of the program or episode aired.

publisher

[edit subtemplate]

  • publisher: Name of publisher; may be wikilinked if relevant. Not normally included for periodicals. Corporate designations such as "Ltd", "Inc" or "GmbH" are not usually included. Displays after title; if work is defined, then publisher and location are enclosed in parentheses.
  • location: Geographical place of publication; generally not wikilinked; omit when the name of the work includes the location; examples: The Boston Globe, The Times of India. Displays preceding publisher.
  • publication-date: Date of publication when different from the date the work was written. Displays only if year or date are defined and only if different, else publication-date is used and displayed as date. Use the same format as other dates in the article; do not wikilink. Follows publisher; if work is not defined, then publication-date is preceded by "published" and enclosed in parenthesis.

Options for this field:

  • |work=no suppresses "; if work is defined, then publisher and location are enclosed in parentheses"
  • |map=yes changes:
    • publisher: Name of publisher. Displays before title. Do not wikilink—use publisher-link instead.
    • publisher-link: Title of existing Wikipedia article about the publisher—not the publisher's website; do not wikilink.

newsgroup

[edit subtemplate]

Template:Citation Style documentation/newsgroup

language

[edit subtemplate]

  • language: The language the source is written in, if not English. Formatted in parentheses with "in" before the language name. Use the full language name; do not use icons or templates.

pages

[edit subtemplate]

  • page: Page in the source that supports the content; preceded with ​p.​ unless |journal= is set or |nopp=y.
  • OR: pages: Pages in the source that supports the content; separate page ranges with an en dash (–); separate non-sequential pages with a comma (,); do not use to indicate the total number of pages in the source; ; preceded with ​pp.​ unless |journal= is set or |nopp=y.
    • nopp: Set to y to suppress the ​p.​ or ​pp.​ notations where this is inappropriate; for example, where |page=Front cover.
  • OR: at: For sources where a page number is inappropriate or insufficient; overridden by |page= or |pages=.
Examples: page (p.) or pages (pp.); section (sec.), column (col.), paragraph (para.); track; hours, minutes and seconds; act, scene, canto, book, part, folio, stanza, back cover, liner notes, indicia, colophon, dust jacket, verse.

Options for this field:

  • work adds "or work is defined"

time

[edit subtemplate]

Template:Citation Style documentation/time

id1

[edit subtemplate]

  • id: A unique identifier, used where none of the specialized identifiers are applicable. Wikilink as applicable.

id2

[edit subtemplate]

url

[edit subtemplate]

  • url: URL of an online location where the text of the publication can be found. Cannot be used if title is wikilinked. If applicable, the link may point to the specific page(s) referenced. Do not link to any commercial booksellers such as Amazon.com; see WP:BOOKLINKS.
    • format: Format of the work referred to by url; examples: PDF, DOC, XLS; HTML is implied and should not be specified; displayed in parentheses after title.
    • accessdate: Full date when URL was accessed; use the same format as other dates in citations in the same article; do not wikilink; requires url.
    • archiveurl: The URL of an archived copy of a web page, if or in case the url becomes unavailable. Typically used to refer to services like WebCite and the Internet Archive; requires archivedate.
    • archivedate: Date when the item was archived; do not wikilink; requires archiveurl.
    • deadurl: To change the order with the title retaining the original link and the archive linked at the end, set |deadurl=no.
    • template doc demo: The archive parameters have error checking to ensure that all the required parameters are included, else {{citation error}} is invoked. On errors, main, help and template pages are placed into Category:Articles with incorrect citation syntax. Set |template doc demo=true to disable categorization; mainly used for documentation where the error is demonstrated.
URLs must begin with a supported URI scheme: http:// and https://will be supported by all browsers; irc://, ircs://, ftp://, news://, mailto: and gopher:// will require a plugin or an external application. IPv6 host-names are currently not supported.
URLs containing certain characters will display and link incorrectly unless those characters are encoded. For example, a space must be replaced by %20. To encode the URL, replace these characters:
sp " , '  ; < >  ? [ ]
 %20  %22  %2c  %3a  %3b  %3c  %3e  %3f  %5b  %5d

Options for this field:


  • pmc adds:
" If url is not defined but pmc is, then url is set to the pmc link.
  • Embargo: Date that pmc goes live; if this is in the future, then then url is not set to the pmc link until that date."

chapterurl

[edit subtemplate]

Template:Citation Style documentation/chapterurl

lay

[edit subtemplate]

  • laysummary: URL link to a non-technical summary or review of the source; the URL title is set to "Lay summary".
    • laysource: Name of the source of the laysummary; formatted in italics and preceded by an endash.
    • laydate: Date of the summary; enclosed in parentheses.

quote

[edit subtemplate]

  • quote: Relevant text quoted from the source; enclosed in quotes. When supplied, the citation terminator (a period by default) is suppressed, so the quote needs to include terminating punctuation.

Options for this field:

  • |cs2=yes suppresses "When supplied, the citation terminator (a period by default) is suppressed, so the quote needs to include terminating punctuation."

ref

[edit subtemplate]

ref2

[edit subtemplate]

Template:Citation Style documentation/ref2

display

[edit subtemplate]

  • author-mask: Replaces the name of the first author with a strike-through dash (—) author-mask em in length. If |author-mask=1 then the dash will be one em in length and so on. Set author-mask to a text value to display a word instead:– for example, 'with'. You must still include the values for all authors for metadata purposes. Primarily intended for use in bibliographies for some styles where multiple works by a single author are listed. Do not use in a list generated by {{reflist}}, <references /> or similar as there is no control as to the order that references will display.
  • author-name-separator: Changes the separator between last and first names; defaults to a comma and space (, ); if the parameter is present, but blank, no separator punctuation will be used; a space must be percent encoded as &amp#32;; do not use a semicolon (;), colon (:) or hash (#) as they will be interpreted as wikimarkup.
  • author-separator: Changes the separator between authors; defaults to a semicolon and space (; ); if the parameter is present, but blank, no separator punctuation will be used; a space must be percent encoded as &amp#32;; do not use a semicolon (;), colon (:) or hash (#) as they will be interpreted as wikimarkup.
  • display-authors: By default, the number of authors displayed is limited to 8; if 9 are provided, the ninth is displayed as "et al." This parameter allows display of fewer authors before the "et al."; example: |display-authors=2; if there are 8 or fewer authors, then "et al." may be suppressed by setting |display-authors=9.
  • lastauthoramp: When set to any value, changes the separator to use between the last two names in lists of authors to an ampersand (&); defaults to a semicolon and space (; ), else |author-separator= if set.
  • postscript: The closing punctuation for the citation; defaults to a period (.); if the parameter is present, but blank, no terminating punctuation will be used. Ignored if |quote= is specified.
  • separator: The punctuation used to separate lists of authors, editors, etc. Defaults to a period (.); if the parameter is present, but blank, no separator punctuation will be used; do not use an asterisk (*), colon (:) or hash (#) as they will be interpreted as wikimarkup.

Options for this field:


  • cs2: When set, changes:
    • postscript to "defaults to none"
    • separator to "Defaults to a comma (,)"

map_series

[edit subtemplate]

Template:Citation Style documentation/map series

map_id

[edit subtemplate]

Template:Citation Style documentation/map id

map_pages

[edit subtemplate]

Template:Citation Style documentation/map pages

interview_id

[edit subtemplate]

Template:Citation Style documentation/interview id

interview_author

[edit subtemplate]

Template:Citation Style documentation/interview author

interview_interviewer

[edit subtemplate]

Template:Citation Style documentation/interview interviewer

DVD-notes_date

[edit subtemplate]

Template:Citation Style documentation/DVD-notes date

album_name

[edit subtemplate]

Template:Citation Style documentation/album name

album_artist

[edit subtemplate]

Template:Citation Style documentation/album artist

season

[edit subtemplate]

Template:Citation Style documentation/season

network

[edit subtemplate]

Template:Citation Style documentation/network

transcript

[edit subtemplate]

Template:Citation Style documentation/transcript

notestitle

[edit subtemplate]

Template:Citation Style documentation/notestitle

conference

[edit subtemplate]

Template:Citation Style documentation/conference

See also

Template:Citation Style 1

*Disclosure: Some of the links above are affiliate links, meaning, at no additional cost to you, Fandom will earn a commission if you click through and make a purchase. Community content is available under CC-BY-SA unless otherwise noted.

Fandom may earn an affiliate commission on sales made from links on this page.

Stream the best stories.

Fandom may earn an affiliate commission on sales made from links on this page.

Get Disney+