Template:Citation Style documentation/doc

Usage

This template is used to build consistent documentation pages for Citation Style 1 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

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)

Where aliases are listed, only one of the parameters may be defined; if aliased parameters are defined, then only one will show.

coins

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

• Be careful using templates within the citation template, as many will add a lot of extraneous HTML or CSS that will be rendered in the meta-data.
  • Known templates that should not be used: {{smallcaps}}.

sep_period

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

By default, sets of fields are terminated with a comma (,).

required

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

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

• 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. Aliases: last, author, authors, last1, author1
  • 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. Aliases: first, first1.
  • OR: for multiple authors, use last1, first1 through last9, first9 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. Aliases: last1, author1 through last9, author9.

• authorlink: Title of existing Wikipedia article about the author—not the author's website; do not wikilink. Aliases: authorlink, authorlink1, author-link, author1-link.
• OR: for multiple authors, use authorlink1 through authorlink9. Aliases: authorlink1, author1-link through authorlink9, author9-link.

When using Shortened footnotes or parenthetical referencing

styles with templates, do not use multiple names in one field else the anchor will not match the inline link.

Options for this field:

• |coauthors=yes adds "coauthors: (deprecated) Names of of coauthors. Use the same format as the authors."
• |others=yes adds "others: To record other contributors to the work, such as "Illustrated by Smith" or "Trans. Smith"."
• |aliases= add aliases for last.

editor

• 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. Aliases: editor1-last, editor, editors.
  • 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. Aliases: editor1-first.
  • OR: for multiple editors, use editor1-last, editor1-first through editor4-last, editor4-first for up to four editors.

• editor-link: Title of existing Wikipedia article about the editor—not the editor's website; do not wikilink. Aliases: editor1-link.
• OR: for multiple editors, use editor1-link through editor4-link.

Display:

If authors: Authors are first, followed by the editors and the included work, 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

• title: Title of source. Can be wikilinked to an existing Wikipedia article or url may be used to add an external link, but not both. Displays in italics.
  • trans_title: English translation of the title if the source cited is in a foreign language. Displays in square brackets after title; if url is defined, then trans_title is included in the link. Use of the language parameter is recommended.

Titles containing certain characters will display and link incorrectly unless those characters are encoded.

newline	[	]	|
space	[	]	|

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

• title: Title of source page on website; can be wikilinked to an existing Wikipedia article or url may be used to add an external link, but not both. Displays in quotes.

Titles containing certain characters will display and link incorrectly unless those characters are encoded.

newline	[	]	|
space	[	]	|

• 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.

• website: Title of website; may be wikilinked. Displays in italics. Aliases: work

chapter

• chapter: The title of the source. May be wikilinked or may use chapter-url, but not both. Displays in quotes.
  • trans_chapter: English translation of the title if the source cited is in a foreign language. Displays in square brackets after the chapter field; if chapter-url is defined, then trans_title is included in the link. Use of the language parameter is recommended.

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

• type: Provides additional information about the media type of the source; format in sentence case. Displays in parentheses following the title. Examples: Thesis, Booklet, CD liner, Press release.

Options for this field:

• type_default: Adds "Defaults to type_default"

journal

• work (required by {{cite journal}} and {{cite magazine}}): Name of the work containing the source; may be wikilinked if relevant. Displays in italics. Aliases: journal, newspaper, magazine, periodical, website. Use Latin script. For languages written in non-Latin based scripts (Arabic, Chinese, Cyrillic, Greek, Hebrew, Indic, Japanese, Korean, etc.) use a standard Romanization in this field.
  • script-work: Work title in its original, non-Latin script; not italicized, follows italicized Romanization defined in work. Must be prefixed with an ISO 639-1 two-character code to help browsers properly display the script. Leave empty for Latin-based scripts (Czech, French, Turkish, Vietnamese, etc.). Aliases: script-journal, script-newspaper, script-magazine, script-periodical, script-website.
  • trans-work: English translation of the work title if the source cited is in a foreign language. Displays in square brackets after work or script-work. Aliases: trans-journal, trans-newspaper, trans-magazine, trans-periodical, trans-website.

    ... |work=Zhōngguó piàofáng |script-work=zh:中国票房 |trans-work=China Box Office ...

  • issue: When the publication is one of a series that is published periodically. Alias: number. When the issue has a special title of its own, this may be given, in italics, along with the issue number, e.g. |issue=2, ''Modern Canadian Literature''. Displayed in parentheses following volume.

When set, work changes the formatting of other parameters in the same citation:

title is not italicized and is enclosed in quotes.

chapter does not display (and will produce an error message).

Options for this field:

• department adds:

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

edition

• 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." Does not display if a periodical field is defined.

series

• 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

• series: The name of the series the episode belongs to; may be wikilinked.
  • series-link: name of an existing Wikipedia article; used to wikilink series; with proper interwiki prefix, may hold the name of an article at an other-language wikipedia; do not wikilink, do not use a URL.

volume

• volume: For one publication published in several volumes. Displays in bold after the title and series fields; if bolding is not desired, then include the volume information in the title field.

date

• date: Full date of source being referenced in the same format as other publication dates in the citations. Do not wikilink. Displays after the authors and enclosed in parentheses. If there is no author, then displays after publisher.
• 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; displays 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

• 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

• newsgroup: Name of newsgroup; a link is automatically created; do not wikilink.

language

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

pages

• page: Page in the source that supports the content. Displays preceded with <syntaxhighlight lang="text" enclose="none">p.</syntaxhighlight> unless |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. Displays preceded with <syntaxhighlight lang="text" enclose="none">pp.</syntaxhighlight> unless |nopp=y.
  • nopp: Set to y to suppress the <syntaxhighlight lang="text" enclose="none">p.</syntaxhighlight> or <syntaxhighlight lang="text" enclose="none">pp.</syntaxhighlight> 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

• minutes: Time the event occurs in the source; followed by "minutes in".
• OR: time: Time the event occurs in the source; preceded by default text "Event occurs at time".
  • time-caption: Changes the default text displayed before time. Alias: timecaption.

id1

• id: A unique identifier, used where none of the specialized identifiers are applicable; wikilink or use a template as applicable.

id2

These identifiers create links and are designed to accept a single value. Using multiple values or other text will break the link and/or invalidate the identifier.

• arxiv: arXiv identifier; for example: arxiv=hep-th/9205027
• asin: Amazon Standard Identification Number
  • asin-tld: ASIN top-level domain for Amazon sites other than the US; valid values: ca, cn, co.jp, co.uk, de, es, fr, it
• bibcode: Bibcode; used by a number of astronomical data systems; for example: 1974AJ.....79..819H
• doi: Digital object identifier; for example: 10.1038/news070508-7. Checked to ensure it begins with (<syntaxhighlight lang="text" enclose="none">10.</syntaxhighlight>).
  • doi_brokendate: Date the DOI is broken; use the same format as other dates in the article.
• isbn: International Standard Book Number; for example: 978-0-8126-9593-9. (See: Wikipedia:ISBN and ISBN). Dashes in the ISBN are optional, but preferred. Use the 13-digit ISBN wherever possible; this can normally be found beneath the barcode as a number beginning with 978 or 979 (barcodes beginning with any other numbers are not ISBNs). For sources with the older 9 digit SBN system, prefix the number with a zero; thus, SBN 902888-45-5 should be entered as |isbn=0-902888-45-5. Checked for length, invalid characters and the proper check digit.
• issn: International Standard Serial Number; eight characters may be split into two groups of four using a hyphen, but not an en dash or a space.
• jfm: Jahrbuch über die Fortschritte der Mathematik
• jstor: JSTOR abstract; for example: "jstor=3793107" will generate JSTOR 3793107.
• lccn: Library of Congress Control Number
• mr: Mathematical Reviews
• oclc: OCLC
• ol: Open Library
• osti: Office of Scientific and Technical Information
• pmc: PubMed Central; use article number for full-text free repository of a journal article.
• pmid: PubMed; use unique identifier.
• rfc: Request for Comments
• ssrn: Social Science Research Network
• zbl: Zentralblatt MATH

url

• 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:PAGELINKS.
  • accessdate: Full date when original URL was accessed; use the same format as other access and archive dates in the citations. Do not wikilink. Not required for web pages or linked documents that do not change; mainly for use of web pages that change frequently or have no publication date. Can be hidden or styled by registered editors.
  • 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 (see: Wikipedia:Using WebCite) and Internet Archive (see: Wikipedia:Using the Wayback Machine); requires archivedate.
    • archivedate: Date when the original URL was archived; preceded by default text "archived from the original on". Use the same format as other access and archive dates in the citations. Do not wikilink.
    • deadurl: When the URL is still live, but preemptively archived, then set |deadurl=no. This changes the display order with the title retaining the original link and the archive linked at the end.
  • template doc demo: The archive parameters will be error checked to ensure that all the required parameters are included, or else {{citation error}} is invoked. With 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.
• format: Format of the work referred to by url; for example: PDF, DOC, or XLS; displayed in parentheses after title. HTML is implied and should not be specified. Does not change the external link icon. Note: External link icons do not include alt text; thus, they do not add format information for the visually impaired.

URLs must begin with a supported URI scheme. http:// and https:// will be supported by all browsers; however, ftp://, gopher://, irc://, ircs://, mailto: and news: will require a plug-in or an external application and should normally be avoided. IPv6 host-names are currently not supported.

If URLs in citation template parameters contain certain characters, then they will not display and link correctly. Those characters need to be percent-encoded. For example, a space must be replaced by %20. To encode the URL, replace the following characters with:

sp	"	'	<	>	[	]	|	}
%20	%22	%27	%3c	%3e	%5b	%5d	%7c	%7d

Single apostrophes do not need to be encoded; however, unencoded multiples will be parsed as italic or bold markup. Single curly closing braces also do not need to be encoded; however, an unencoded pair will be parsed as the double closing braces for the template transclusion.

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."

lay

• 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. Displays in italics and preceded by an endash.
  • laydate: Date of the summary. Displays in parentheses.

quote

• quote: Relevant text quoted from the source. Displays 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

• ref: ID for anchor. By default, no anchor is generated. The ordinary nonempty value |ref=ID generates an anchor with the given ID; such a linkable reference can be made the target of wikilinks to full references, especially useful in short citations like shortened notes and parenthetical referencing. The special value |ref=harv generates an anchor suitable for the {{harv}} template. See: Anchors for Harvard referencing templates.

display

• author-mask: Replaces the name of the first author with em dashes or text. Set author-mask to a numeric value n to set the dash n em spaces wide; set author-mask to a text value to display the text without a trailing author separator; for example, "with". You must still include the values for all authors for metadata purposes. Primarily intended for use with bibliography styles where multiple works by a single author are listed sequentially. Do not use in a list generated by {{reflist}}, <references></references> or similar as there is no control of the order in which references are displayed.
• 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 encoded as   do not use an asterisk (*), 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 encoded as   do not use an asterisk (*), 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."; for example, use |display-authors=2 for only two authors. The "et al." may be suppressed altogether by setting |display-authors=9. Aliases: displayauthors.

• lastauthoramp: When set to any value, changes the separator between the last two names of the author list to space ampersand space ( & ).
• 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 defined.
• 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; a space must be encoded as   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 (,)"

interview_author

• last: Surname of subject, not interviewer. Do not wikilink—use subject-link 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); example: Firstname Middlename or Firstname M. or Firstname M., Sr. Do not wikilink—use subject-link instead.
  • OR: for multiple subjects, use firstn, lastn.

• subject-link: Title of existing Wikipedia article about the subject—not the subject's website; do not wikilink. Aliases: subject-link, author-link, author-linkn; subject-linkn, authorn-link
• OR: for multiple subjects, use subject-linkn.

Aliases: subject, last, lastn, authorn, author, subjectn.

interview_interviewer

• interviewer-last: Surname of a single interviewer. Do not wikilink—use interviewer-link instead. For interviewers for whom only one name is listed by the source, use interviewer or one of its aliases (e.g. |interviewer=Bono). Aliases: interviewer-last1, interviewer1-last, interviewer-surname, interviewer-surname1, interviewer1-surname, interviewer, interviewer1.
  • interviewer-first: Given or first names of interviewer; for example: Firstname Middlename or Firstname M. or Firstname M., Sr. Do not wikilink—use interviewer-link instead. Aliases: interviewer-first1, interviewer1-first, interviewer-given, interviewer-given1, interviewer1-given. Requires interviewer-last; interviewer first name will not display if interviewer-last is empty.
  • interviewer: this parameter is used to hold the complete name of a single interviewer (first and last). This parameter should never hold the names of more than one interviewer.
  • For multiple interviewers, use interviewer-last1, interviewer-first1 through interviewer-lastn, interviewer-firstn, where n is any consecutive number for an unlimited number of interviewer- (each interviewer-firstn requires a corresponding interviewer-lastn, but not the other way around). See the display parameters to change how many interviewers are displayed. Aliases of interviewer-last1 through interviewer-lastn: interviewer1 through interviewern. For an individual interviewer plus an interviewer with a single name, you can use |interviewer-first1=... |interviewer-last1=... |interviewer2=....

season

• season: Season number, usually for US shows.
• OR: series-number: Series number, usually for British shows. Aliases: series-no.
• number: Many episodic shows are identified by separate season and episode numbers. Alternately, some shows prefer the format of a single episode number that includes the season within it; this format can be used by omitting the season field.

network

• network: The network the episode was aired on. (e.g. ABC, NBC, CBS, Fox, Disney, USA Network, BBC)
  • station: Call letters of the local station (if any).

transcript

• transcript: Transcript of the original source.
  • transcript-url: URL of the transcript.

conference

• conference: Name of the conference, may include location if different from location and date if different from date or year.
  • conference-url: URL of conference proceedings, if different from url.