Template:Cite document

File:Test Template Info-Icon - Version (2).svg Template documentation[view] [edit] [history] [purge]

Citation Style 1 templates

{{Cite arXiv}}	arXiv preprints
{{Cite AV media}}	audio and visual media
{{Cite AV media notes}}	AV media liner notes
{{Cite bioRxiv}}	bioRxiv preprints
{{Cite book}}	books and chapters
{{Cite CiteSeerX}}	CiteSeerX papers
{{Cite conference}}	conference papers
{{Cite document}}	short, stand-alone, offline documents
{{Cite encyclopedia}}	edited collections
{{Cite episode}}	radio or TV episodes
{{Cite interview}}	interviews
{{Cite journal}}	academic journals
{{Cite magazine}}	magazines, periodicals
{{Cite mailing list}}	public mailing lists
{{Cite map}}	maps
{{Cite medRxiv}}	medRxiv preprints
{{Cite news}}	news articles
{{Cite newsgroup}}	online newsgroups
{{Cite podcast}}	podcasts
{{Cite press release}}	press releases
{{Cite report}}	reports
{{Cite serial}}	audio or video serials
{{Cite sign}}	signs, plaques
{{Cite speech}}	speeches
{{Cite SSRN}}	SSRN papers
{{Cite tech report}}	technical reports
{{Cite thesis}}	theses
{{Cite web}}	web sources not covered by the above
See also	Specific-source templates Citation Style 1 wrapper templates

This Citation Style 1 template is used to create citations for short, stand-alone, off-line documents. When citing an article in a periodical, use {{cite journal}}, {{cite magazine}}, or {{cite periodical}}. For conference papers, use {{cite conference}}. For edited collections, use {{cite encyclopedia}}. For theses, use {{cite thesis}}. To cite online sources when none of the other cs1 templates are suitable, use {{cite web}}.

Usage

Copy a blank version to use. Almost all parameter names are supported only in lower case (some initialisms, such as |isbn= have upper-case aliases like |ISBN=, which are acceptable for use). Use the "|" (pipe) character between each parameter. Unused parameters may be deleted to avoid clutter in the edit window. Some samples on this documentation page may include the current date. If the date is not current, then the page.

Most commonly used parameters in horizontal format

<syntaxhighlight lang="wikitext" inline> (Document). {{cite document}}: Cite document requires |publisher= (help); Missing or empty |title= (help)</syntaxhighlight>

Most commonly used parameters in vertical format

<syntaxhighlight lang="wikitext"> (Document). {{cite document}}: Cite document requires |publisher= (help); Cite has empty unknown parameter: |isbn= (help); Missing or empty |title= (help) </syntaxhighlight>

Full parameter set in horizontal format

<syntaxhighlight lang="wikitext" inline> (Document). {{cite document}}: Cite document requires |publisher= (help); Cite has empty unknown parameter: |display-translators= (help); Missing or empty |title= (help)</syntaxhighlight>

Full parameter set in vertical format

Parameters	Prerequisites	Brief instructions / notes	Vertical list
last1		Author's last name or single name author. Don't link.	{{cite document  |last1                = |first1 = |author-link1 = |last2 = |first2 = |author-link2 = |last3 = |first3 = |author-link3 = |last4 = |first4 = |author-link4 = |last5 = |first5 = |author-link5 = |display-authors = |author-mask1 = |author-mask2 = |author-mask3 = |author-mask4 = |author-mask5 = |translator-last1 = |translator-first1 = |translator-link1 = |translator-last2 = |translator-first2 = |translator-link2 = |translator-last3 = |translator-first3 = |translator-link3 = |translator-last4 = |translator-first4 = |translator-link4 = |translator-last5 = |translator-first5 = |translator-link5 = |display-translators = |translator-mask1 = |translator-mask2 = |translator-mask3 = |translator-mask4 = |translator-mask5 = |name-list-style = |date = |year = |orig-date = |title = |script-title = |trans-title = |title-link = |type = |language = |location = |publisher = |page = |pages = |at = |no-pp = |bibcode = |bibcode-access = |doi = |doi-access = |doi-broken-date = |hdl = |hdl-access = |jfm = |mr = |osti = |osti-access = |zbl = |id = |quote = |script-quote = |trans-quote = |quote-page = |quote-pages = |mode = |postscript = |ref = }}
first1	last1	Author's first name. Don't link.
author-link1	last1	Title of Wikipedia article about the first author. Don't link.
last2	last1	Like last1, but for 2nd author.
first2	last2	Like first1, but for 2nd author.
author-link2	last2	Like author-link1, but for 2nd author.
last3	last2	Like last1, but for 3rd author.
first3	last3	Like first1, but for 3rd author.
author-link3	last3	Like author-link1, but for 3rd author.
last4	last3	Like last1, but for 4th author.
first4	last4	Like first1, but for 4th author.
author-link4	last4	Like author-link1, but for 4th author.
last5	last4	Like last1, but for 5th author. Similar: last6, etc.
first5	last5	Like first1, but for 5th author. Similar: first6, etc.
author-link5	last5	Like author-link1, but for 5th author. Similar: author-link6, etc.
display-authors	last1	Number (number of authors displayed) or etal (more authors)
author-mask1	last1	See Display options below; not for lists of cited works
author-mask2	last2
author-mask3	last3
author-mask4	last4
author-mask5	last5
translator-last1		Like last1, but for translator
translator-first1	translator-last1	Like first1, but for translator
translator-link1	translator-last1	Like author-link1, but for translator
translator-last2	translator-last1	Like last1, but for 2nd translator. Similar: translator-last3, etc.
translator-first2	translator-last2	Like first1, but for 2nd translator. Similar: translator-first3, etc.
translator-link2	translator-last2	Like author-link1, but for 2nd transl. Similar: translator-link3, ...
display-translators	translator-last1	Like display-authors, but for translators
translator-mask1	translator-last1	See Display options below; not for lists of cited works
translator-mask2	translator-last2
name-list-style	last2	Set to amp or ampersand to separate the last author with " & "; set to and to separate with " and "
date
year
orig-date	date or year
title
script-title
trans-title	title or script-title
title-link	title or script-title	Name of a Wikipedia article about the work.
type
language
location	publisher
publisher
page		choose one: "page", "pages", or "at"
pages		choose one: "page", "pages", or "at". Use when content on multiple pages supports the article text.
at		choose one: "page", "pages", or "at"
no-pp	page or pages	set no-pp to "yes" to suppress the "p." or "pp." before page numbers
bibcode
doi
doi-broken-date	doi
hdl
jfm
mr
osti
zbl
id
quote
script-quote
trans-quote
quote-page		choose one: "quote-page", "quote-pages"
quote-pages		choose one: "quote-page", "quote-pages". Use when quote contains contents from multiple pages.
mode		cs1 or cs2
postscript
ref
If a field name is listed in the Prerequisites column, it is a prerequisite for the field to the left.

Examples

Basic usage (single author)

• <syntaxhighlight lang="wikitext" inline>Bloggs, Joe (1974). "Secondary reprocessing of barn floor sweepings" (Pamphlet). Acme University Agriculture Extension.</syntaxhighlight>

  Bloggs, Joe (1974). "Secondary reprocessing of barn floor sweepings" (Pamphlet). Acme University Agriculture Extension.

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 multiple 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. As a general rule, only one data item per parameter. Do not include explanatory or alternate text:

• use |date=27 September 2007 not |date=27 September 2007 (print version 25 September)

Use of templates within the citation template is discouraged because many of these templates will add extraneous HTML or CSS that will be included raw in the metadata. Also, HTML entities, for example  , –, or  , should not be used in parameters that contribute to the metadata.

COinS metadata is created for these parameters

Note: This table of metadata is displayed in the documentation of all Citation Style 1 templates. Not all of these parameters are supported by every CS1 template. Some of these parameters are mutually exclusive, some are aliases of another parameter, and some require other parameters to be present. A full list of this template's supported parameters, their aliases, and their dependencies is shown in the Usage section near the top of this documentation page.

• |periodical=, |journal=, |newspaper=, |magazine=, |work=, |website=, |encyclopedia=, |encyclopaedia=, |dictionary=
• |chapter=, |script-chapter=, |contribution=, |script-contribution=, |entry=, |script-entry=, |article=, |script-article=, |section=, |script-section=
• |title=, |script-title=, |book-title=
• |publication-place=, |place=, |location=
• |date=, |year=, |publication-date=
• |series=, |version=
• |volume=, |issue=, |number=
• |page=, |pages=, |at=, |quote-page=, |quote-pages=
• |edition=
• |publisher=, |institution=
• |url=, |chapter-url=, |contribution-url=, |section-url=
• |author-last=, |author-last#=, |author#-last=, |author-surname=, |author-surname#=, |author#-surname=, |last=, |last#=, |surname=, |surname#=, |author=, |author#=, |subject=, |subject#=, |host=, |host#=
• |author-first=, |author-first#=, |author#-first=, |author-given=, |author-given#=, |author#-given=, |first=, |first#=, |given=, |given#=
• |degree=
• |arxiv=, |bibcode=, |biorxiv=, |citeseerx=, |doi=, |eissn=, |eprint=, |hdl=, |isbn=, |issn=, |jfm=, |jstor=, |lccn=, |message-id=, |mr=, |oclc=, |osti=, |pmc=, |pmid=, |rfc=, |ssrn=, |s2cid=, |zbl=

What's new

What's new or changed recently

Parameter	Description	Date
N/A

Deprecated

{{#lst:Help:CS1 errors|deprecated_params_table}} {{#lst:Help:CS1 errors|deleted_params_table}}

Description

Authors

• last: Surname of a single author. Do not wikilink—use author-link instead. For corporate authors or authors for whom only one name is listed by the source, use last or one of its aliases (e.g. |author=Bono). Aliases: surname, author, last1, surname1, author1.
  • author: this parameter is used to hold the name of an organizational author (e.g. a committee) or the complete name (first and last) of a single person; for the latter, prefer the use of |first= and |last=. This parameter should never hold the names of more than one author. Supports accept-this-as-written markup. Do not use italics in this field, as doing so produces corrupt metadata.
  • first: Given or first names of author; for example: Firstname Middlename or Firstname M. or Firstname M. Sr. Do not wikilink—use author-link instead. Aliases: given, first1, given1. Requires last; first name will not display if last is empty. Use generational and regnal suffixes only in accordance with MOS:JRSR and use honorifics only in accordance with MOS:HON.
  • OR: for multiple authors, use last1, first1 through lastn, firstn, where n is any consecutive number for an unlimited number of authors (each firstn requires a corresponding lastn, but not the other way around). See the display parameters to change how many authors are displayed. Aliases: surname1, given1 through surnamen, givenn, or author1 through authorn. For an individual author plus an institutional author, you can use |first1=...|last1=...|author2=....
  • author-link: Title of existing Wikipedia article about the author—not the author's website; do not wikilink. Aliases: author-link1, author1-link, authorlink.
  • OR: for multiple authors, use author-link1 through author-linkn. Aliases: author1-link through authorn-link.
  • name-list-style: accepts a limited list of keywords as value; when set to amp, ampersand, or &, inserts an ampersand between the last two names in a name list; when set to and, inserts the conjunction 'and' between the last two names of a name list; when set to vancdisplays name lists in Vancouver style when the lists use the last/first forms of name parameters.
• vauthors: comma-separated list of author names in Vancouver style; enclose corporate or institutional author names in doubled parentheses. End with etal if appropriate:

  |vauthors=Smythe JB, ((Megabux Corp.)), etal

  • author-link and author-mask may be used for the individual names in |vauthors= as described above
• authors: deprecated Free-form list of author names; use of this parameter is discouraged because it does not contribute to a citation's metadata; not an alias of last.
• translator-last: Surname of translator. Do not wikilink—use translator-link instead. Aliases: translator-surname, translator1, translator1-last, translator-last1. Supports accept-this-as-written markup.
  • translator-first: Given or first names of translator. Do not wikilink—use translator-link instead. Aliases: translator-given, translator1-first, translator-first1.
  • OR: for multiple translators, use translator-last1, translator-first1 through translator-lastn, translator-firstn, where n is any consecutive number for an unlimited number of translators (each translator-firstn requires a corresponding translator-lastn, but not the other way around). Aliases: translator1-last, translator1-first through translatorn-last, translatorn-first, or translator1 through translatorn.
  • translator-link: Title of existing Wikipedia article about the translator—not the translator's website; do not wikilink. Aliases: translator-link1, translator1-link.
  • OR: for multiple translators, use translator-link1 through translator-linkn. Aliases: translator1-link through translatorn-link.
• collaboration: Name of a group of authors or collaborators; requires author, last, or vauthors listing one or more primary authors; follows author name-list; appends "et al." to author name-list.

• Note: When using shortened footnotes or parenthetical referencing styles with templates, do not use multiple names in one field, or else the anchor will not match the inline link.

Date

"Wikipedia:Undated" redirects here. For undated signatures, see Template:Undated.

• date: Date of referenced source. Can be full date (day, month, and year) or partial date (month and year, season and year, or year). Use same format as other publication dates in the citations. Do not wikilink. Displays after the authors and is enclosed in parentheses. If there is no author, then displays after the website and publisher. For acceptable date formats, see Help:Citation Style 1 § Dates.

Shortened footnotes target full citations using the year specified in this parameter. A lowercase letter may be suffixed to the year to disambiguate {{sfn}} links to multiple works by the same author in the same year,^[more] unless the date is formatted as YYYY-MM-DD. In the latter case, year or ref is required to disambiguate the link targets.

For approximate year, precede with "c. ", like this: |date=c. 1900.

For no date, or "undated", use |date=n.d.

The date of a Web page, PDF, etc. with no visible date can sometimes be established by searching the page source or document code for a created or updated date; a comment for editors such as date=2021-12-25<!--date from page source-->|orig-date=Original date 2011-01-01 can be added.

Automatic date formatting: Citation Style 1 and 2 templates, including this template, automatically render dates in all date parameters (such as |date=, |publication-date=, |access-date=, |archive-date=, etc.) except for |orig-date= in the style specified by the article's {{use dmy dates}} or {{use mdy dates}} template. See those templates' documentation for details.

• year: Year of publication. The more flexible |date= parameter also handles a year by itself. Do not use in combination with the |date= parameter, unless both of the following conditions are met:
  1. Shortened footnotes target multiple citations with same last name and year of publication. (This situation necessitates a CITEREF disambiguator, usually a lowercase letter suffixed to the year.)
  2. The |date= format is YYYY-MM-DD. (This format prevents the addition of a disambiguating letter to the year.)
• orig-date: Original publication date or year; displays in square brackets after the date (or year). For clarity, please supply specifics. For example: |orig-date=First published 1859 or |orig-date=Composed 1904. As |orig-date= does not support automatic date formatting, use the same date format as defined by |df= (or, if it exists in the article, by |cs1-dates= of a {{use dmy dates}} or {{use mdy dates}} template), or as used in the |date= parameter. Alias: orig-year
• df: date format; sets rendered dates to the specified format; does not support date ranges or seasonal dates; overrides the automatic date formatting described above. Accepts one value which may be one of these:

  dmy – set publication dates to day month year format; access- and archive-dates are not modified;

  mdy – as above for month day, year format

  ymd – as above for year initial numeric format YYYY-MM-DD

  dmy-all – set publication, access-, and archive-dates to day month year format;

  mdy-all – as above for month day, year format

  ymd-all – as above for year initial numeric format YYYY-MM-DD

Title

(See also Help:Citation Style 1 § Titles and chapters.)

• title: Title of source. Can be wikilinked to an existing Wikipedia article. Displays in italics. If script-title is defined, use title to hold a Romanization (if available) of the title in script-title.
  • script-title: Original title for languages that do not use a Latin-based script (Arabic, Chinese, Cyrillic, Greek, Hebrew, Japanese, Korean, etc.); not italicized, follows italicized Romanization defined in title (if present). Must be prefixed with one of the supported language codes to help browsers properly display the script:

    ... |title=Tōkyō tawā |script-title=ja:東京タワー |trans-title=Tokyo Tower ...

  • trans-title: English translation of the title if the source cited is in a foreign language. Displays in square brackets after title. Use of the language parameter is recommended.

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

newline	[	]	|
space	[	]	{{!}} (preferred)
	{{bracket|text}}		| or {{pipe}} – see also Help:Table § Rendering the pipe

• title-link: Title of existing Wikipedia article about the source named in title – do not use a web address; do not wikilink.

• type: Provides additional information about the media type of the source. May alternatively be used to identify the type of manuscript linked to in the title, if this is not the final version of a manuscript (e.g. if a preprint of a manuscript is freely available, but the version of record is behind a paywall). Format in sentence case. Displays in parentheses following the title. The reserved keyword none can be used to disable the display of a type. Examples: Thesis, Booklet, Accepted manuscript, CD liner, Press release. Alias: medium.

• language: The language (or a comma-separated list of the languages) in which the source is written, as either the ISO 639 language code (preferred) or the full language name. Examples: |language=ru; |lang=fr, pt-br; |lang=Russian; |language=French, Portuguese. See the list of supported codes and names. Do not use templates or wikilinks. Displays in parentheses with "in" before the language name or names. When the only source language is English, no language is displayed in the citation. The use of languages recognized by the citation module adds the page to the appropriate subcategory of Category:CS1 foreign language sources. Because cs1|2 templates are often copied from en.wiki to other wikis, the use of language codes is preferred so that language names render in the correct language and form, e.g. español at a French-language wiki instead of the English word "Spanish". Aliases: lang

Publisher

• publisher: Name of publisher; may be wikilinked if relevant. The publisher is the company, organization or other legal entity that publishes the work being cited. If the name of the publisher changed over time, use the name as stated in the publication or used at the time of the source's publication. Corporate designations such as "Ltd", "Inc.", or "GmbH" are not usually included. Displays after title.
• location: Geographical location of publication; generally not wikilinked. Displays after the title. If the name of the location changed over time, use the name as stated in the publication or used at the time of the source's publication. Alias: place.

In-source locations

• page: The number of a single page in the source that supports the content. Use either |page= or |pages=, but not both. Displays preceded by <syntaxhighlight lang="text" class="" style="" inline="1">p.</syntaxhighlight> unless |no-pp=yes. If hyphenated, use {{hyphen}} to indicate this is intentional (e.g. |page=3{{hyphen}}12), otherwise several editors and semi-automated tools will assume this was a misuse of the parameter to indicate a page range and will convert |page=3-12 to |pages=3{{ndash}}12. Alias: p.
• OR: pages: A range of pages in the source that supports the content. Use either |page= or |pages=, but not both. Separate using 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 by <syntaxhighlight lang="text" class="" style="" inline="1">pp.</syntaxhighlight> unless |no-pp=yes.
  Hyphens are automatically converted to en dashes; if hyphens are appropriate because individual page numbers contain hyphens, for example: pp. 3-1–3-15, use double parentheses to tell the template to display the value of |pages= without processing it, and use {{hyphen}} to indicate to editors that a hyphen is really intended: |pages=((3{{hyphen}}1{{ndash}}3{{hyphen}}15)). Alternatively, use |at=, like this: |at=pp. 3-1–3-15. Alias: pp.
  • no-pp: Set to yes, y, or true to suppress the <syntaxhighlight lang="text" class="" style="" inline="1">p.</syntaxhighlight> or <syntaxhighlight lang="text" class="" style="" inline="1">pp.</syntaxhighlight> notations where this is inappropriate; for example, where |page=Front cover or |pages=passim.
• OR: at: For sources where a page number is inappropriate or insufficient. Overridden by |page= or |pages=. Use only one of |page=, |pages=, or |at=.
  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.
• For |quote-page= and |quote-pages= used in conjunction with |quote=, see here.

Anchor

Not to be confused with § Identifiers.

• ref: the citation's HTML anchor identifier, when different from its default. When set, |ref=ID generates an anchor with the given ID (the id= attribute in the citation's <cite id="ID"> HTML tag). Setting |ref=ID identifies the template as a target and allows wikilinking to full references, especially useful with short-form citations like shortened notes and parenthetical referencing. The default anchor ID is suitable for use with {{sfn}} and {{harv}} templates. Since April 2020, the parameter / keyword pair |ref=harv has no special meaning; this deprecated setting should not be used and may be removed from existing cs1|2 templates. To inhibit anchor ID creation, set |ref=none. Aliases: none. See Template:Citation/doc § Anchors for Harvard referencing templates.

Identifiers

Not to be confused with § Anchor.

• id: A unique identifier, used where none of the specialized identifiers are applicable; wikilink or use an external link template as applicable. For example, |id=NCJ 122967 will append "NCJ 122967" at the end of the citation. You can use templates such as |id={{NCJ|122967}} to append NCJ 122967 ^[archive] instead.

The following 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.

• bibcode: bibcode; used by a number of astronomical data systems; for example: 1974AJ.....79..819H. Aliases: none.
• doi: Digital object identifier; for example: 10.1038/news070508-7. It is checked to ensure it begins with (<syntaxhighlight lang="text" class="" style="" inline="1">10.</syntaxhighlight>). Aliases: DOI.
  • Supports accept-this-as-written markup to indicate valid DOIs using a non-standard format
  • Supports |
  • doi-broken-date: Date a valid DOI was found to be non-working/inactive at https://doi.org ^[archive]. Use the same format as other dates in the article. Aliases: none.
• hdl: Handle System identifier for digital objects and other resources on the Internet; example |hdl=20.1000/100. Aliases: HDL.
  • Supports |
• jfm: Jahrbuch über die Fortschritte der Mathematik; do not include "JFM" in the value; example |jfm=53.0144.01. Aliases: JFM.
• mr: Mathematical Reviews; example |mr=630583. Aliases: MR.
• osti: Office of Scientific and Technical Information; example |osti=4367507. Aliases: OSTI.
• zbl: Zentralblatt MATH; example |zbl=0472.53010 For zbMATH search results like JFM 35.0387.02 use |jfm=35.0387.02. Aliases: ZBL.

In very rare cases, valid identifiers (f.e., as actually printed on publications) do not follow their defined standard format or use non-conforming checksums, which would typically cause an error message to be shown. Do not alter them to match a different checksum. In order to suppress the error message, |doi= supports a special accept-this-as-written markup which can be applied to disable the error-checking (as |doi=((<value>))). If the problem is down to a mere typographical error in a third-party source, correct the identifier value instead of overriding the error message.

For some identifiers, it is possible to specify the access status using the corresponding |<param>-access= parameter.

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 must include terminating punctuation. If script-quote is defined, use quote to hold a Romanization (if available) of the text in script-quote.
  • script-quote: Original quotation for languages that do not use a Latin-based script (Arabic, Chinese, Cyrillic, Greek, Hebrew, Japanese, Korean, etc.); not italicized, follows italicized Romanization defined in quote (if available). Alias: none. Must be prefixed with one of the supported language codes to help browsers properly display the script:

    ... |quote=Tōkyō tawā |script-quote=ja:東京タワー |trans-quote=Tokyo Tower ...

  • trans-quote: English translation of the quotation if the source quoted is in a foreign language. Displays in square brackets. Alias: none.
• quote-page: The number of a single page quoted in |quote=. Use either |quote-page= or |quote-pages=, but not both. Should be a subset of the page(s) specified in |page=, |pages= or |at=. Displays preceded by <syntaxhighlight lang="text" class="" style="" inline="1">p.</syntaxhighlight> unless |no-pp=yes. If hyphenated, use {{hyphen}} to indicate this is intentional (e.g. |quote-page=3{{hyphen}}12). Alias: none.
• OR: quote-pages: A list or range of pages quoted in |quote=. Use either |quote-page= or |quote-pages=, but not both. Should be a subset of the pages specified in |pages= or |at=. Separate using an en dash (–); separate non-sequential pages with a comma (,). Displays preceded by <syntaxhighlight lang="text" class="" style="" inline="1">pp.</syntaxhighlight> unless |no-pp=yes is defined. Hyphens are automatically converted to en dashes; if hyphens are appropriate because individual page numbers contain hyphens, for example: pp. 3-1–3-15, use double parentheses to tell the template to display the value of |quote-pages= without processing it, and use {{hyphen}} to indicate to editors that a hyphen is really intended: |quote-pages=((3{{hyphen}}1{{ndash}}3{{hyphen}}15)). Alias: none.

Display options

• mode: Sets element separator, default terminal punctuation, and certain capitalization according to the value provided. For |mode=cs1, element separator and terminal punctuation is a period (.); where appropriate, initial letters of certain words are capitalized ('Retrieved...'). For |mode=cs2, element separator is a comma (,); terminal punctuation is omitted; where appropriate, initial letters of certain words are not capitalized ('retrieved...'). To override default terminal punctuation use postscript.
• author-mask:
• translator-mask:

  Replaces the name of the (first) author with em dashes or text. Set <name>-mask to a numeric value n to set the dash n em spaces wide; set <name>-mask to a text value to display the text without a trailing author separator; for example, "with". The numeric value 0 is a special case to be used in conjunction with <name>-link—in this case, the value of <name>-link will be used as (linked) text. In either case, you must still include the values for all names for metadata purposes. Primarily intended for use with bibliographies or bibliography styles where multiple works by a single author are listed sequentially such as shortened footnotes. Do not use in a list generated by {{reflist}}, <references /> or similar as there is no control of the order in which references are displayed. Mask parameters can take an enumerator in the name of the parameter (e.g. |author-maskn=) to apply the mask to a specific name.

• display-authors:
• display-translators:

  Controls the number of names that are displayed when a citation is published. To change the displayed number of names, set display-authors and/or display-translators to the desired number. For example, |display-authors=2 will display only the first two authors in a citation (and not affect the display of translators). Likewise, |display-translators=2 will display only the first two translators (and all authors). |display-authors=0 and |display-translators=0 are special cases suppressing the display of all authors or translators including the et al. By default, all authors and translators are displayed. |display-authors=etal displays all authors in the list followed by et al. Aliases: none.

• postscript: Controls the closing punctuation for a citation; defaults to a period (.); for no terminating punctuation, specify |postscript=none – leaving |postscript= empty is the same as omitting it, but is ambiguous. Additional text, or templates that render more than a single terminating punctuation character, will generate a maintenance message. |postscript= is ignored if quote is defined.

This template produces COinS metadata; see COinS in Wikipedia for background information.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report ^[archive] for Template:Cite document in articles based on its TemplateData.

TemplateData for Cite document

Formats a citation to a stand-alone, off-line document.

Template parameters

This template has custom formatting.

Parameter		Description	Type	Status
Last name	last author author1 last1	The surname of the author; don't wikilink, use 'author-link' instead; can suffix with a numeral to add additional authors	Line	suggested
First name	first first1	Given or first name, middle names, or initials of the author; don't wikilink, use 'author-link' instead; can suffix with a numeral to add additional authors	Line	suggested
Author link	author-link author1-link author-link1	Title of existing Wikipedia article about the author; can suffix with a numeral to add additional authors	Page name	optional
Date of source	date	Full date of source being referenced in the same format as other publication dates in the citations.[1] Do not wikilink. Displays after the authors and enclosed in parentheses. If there is no author, then displays after publisher.	Date	suggested
Title of source	title	Title of source; surrounded in quotation marks.	String	required
Type	type	Additional information about the media type of the source; format in sentence case; displays in parentheses following the title	Content	suggested
Location of publication	place location	Geographical place of publication; usually not wikilinked	String	optional
Publisher	publisher	Name of the publisher; displays after title	Content	required
Page	page	Page in the source that supports the content; displays after 'p.'	Line	optional
Pages	pages	Pages in the source that support the content (not an indication of the number of pages in the source; displays after 'pp.'	Line	suggested
Date format	df	Sets rendered dates to the specified format	String	optional
Year of publication	year	Year of the source being referenced; recommended only when date parameter format is YYYY-MM-DD and a CITEREF disambiguator is needed	Number	optional
Postscript	postscript	Controls the closing punctuation for a citation; defaults to a period (.); for no terminating punctuation, specify |postscript=none – leaving |postscript= empty is the same as omitting it, but is ambiguous. Ignored if quote is defined.	String	optional
Author mask	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 bibliographies or bibliography styles where multiple works by a single author are listed sequentially such as shortened footnotes. Do not use in a list generated by {{reflist}}, <references /> or similar as there is no control of the order in which references are displayed. You can also use editor-mask and translator-mask in the same way.	String	optional
Original date	orig-date	Original date of publication; provide specifics	String	optional
Translated title	trans-title	An English language title, if the source cited is in a foreign language; 'language' is recommended	Content	optional
Script Title	script-title	Original title for languages that do not use a Latin-based script (Arabic, Chinese, Cyrillic, Greek, Hebrew, Japanese, Korean, etc.); not italicized, follows italicized Romanization defined in title (if present). Must be prefixed with one of the supported language codes to help browsers properly display the script Example ja:東京タワー	String	optional
At	at	May be used instead of 'page' or 'pages' where a page number is inappropriate or insufficient	Line	optional
No pp	no-pp	Set to 'y' to suppress the 'p.' or 'pp.' display with 'page' or 'pages' when inappropriate (such as 'Front cover')	Line	optional
Language	language	The language in which the source is written, if not English; use the ISO 639 language code (preferred) or the full language name; do not use icons or templates	Content	optional
Bibcode	bibcode	Bibliographic Reference Code (REFCODE); 19 characters	Line	optional
DOI	doi DOI	Digital Object Identifier; begins with '10.'	String	optional
DOI broken date	doi-broken-date	The date that the DOI was determined to be broken	Date	optional
jfm code	jfm	Jahrbuch über die Fortschritte der Mathematik classification code	Line	optional
MR	mr	Mathematical Reviews identifier	Line	optional
OSTI	osti	Office of Scientific and Technical Information identifier	Line	optional
Zbl	zbl	Zentralblatt MATH journal identifier	Line	optional
id	id	A unique identifier used where none of the specialized ones are applicable	Line	optional
Quote	quote	Relevant text quoted from the source; displays last, enclosed in quotes; needs to include terminating punctuation	Content	optional
Ref	ref	An anchor identifier; can be made the target of wikilinks to full references; special value 'harv' generates an anchor suitable for the harv and sfn templates	Line	optional
Name list style	name-list-style	Sets the style for the list. Accepts 'amp', 'and', and 'vanc'. amp displays an ampersand after the penultimate name; and the same with 'and', and vanc displays in Vancouver format	String	optional
Display authors	display-authors	number of authors to display before 'et al.' is used; must be less than the number listed	Number	optional
Last name 2	last2 author2 surname2	The surname of the second author; don't wikilink, use 'author-link2' instead.	Line	optional
First name 2	first2 given2	Given or first name, middle names, or initials of the second author; don't wikilink.	Line	optional
Last name 3	last3 author3 surname3	The surname of the third author; don't wikilink, use 'author-link3' instead.	Line	optional
First name 3	first3 given3	Given or first name, middle names, or initials of the third author; don't wikilink.	Line	optional
Last name 4	last4 author4 surname4	The surname of the fourth author; don't wikilink, use 'author-link4' instead.	Line	optional
First name 4	first4 given4	Given or first name, middle names, or initials of the fourth author; don't wikilink.	Line	optional
Last name 5	last5 author5 surname5	The surname of the fifth author; don't wikilink, use 'author-link5' instead.	Line	optional
First name 5	first5 given5	Given or first name, middle names, or initials of the fifth author; don't wikilink.	Line	optional
Last name 6	last6 author6 surname6	The surname of the sixth author; don't wikilink, use 'author-link6' instead.	Line	optional
First name 6	first6	Given or first name, middle names, or initials of the sixth author; don't wikilink.	Line	optional
Last name 7	last7 author7 surname7	The surname of the seventh author; don't wikilink, use 'author-link7' instead.	Line	optional
First name 7	first7 given7	Given or first name, middle names, or initials of the seventh author; don't wikilink.	Line	optional
Last name 8	last8 author8 surname8	The surname of the eighth author; don't wikilink, use 'author-link8' instead.	Line	optional
First name 8	first8 given8	Given or first name, middle names, or initials of the eighth author; don't wikilink.	Line	optional
Last name 9	last9 author9 surname9	The surname of the ninth author; don't wikilink, use 'author-link9' instead.	Line	optional
First name 9	first9 given9	Given or first name, middle names, or initials of the ninth author; don't wikilink.	Line	optional
Author link 2	author-link2 author2-link	Title of existing Wikipedia article about the second author.	Page name	optional
Author link 3	author-link3 author3-link	Title of existing Wikipedia article about the third author.	Page name	optional
Author link 4	author-link4 author4-link	Title of existing Wikipedia article about the fourth author.	Page name	optional
Author link 5	author-link5 author5-link	Title of existing Wikipedia article about the sixth author.	Page name	optional
Author link 6	author-link6 author6-link	Title of existing Wikipedia article about the sixth author.	Page name	optional
Author link 7	author-link7 author7-link	Title of existing Wikipedia article about the seventh author.	Page name	optional
Author link 8	author-link8 author8-link	Title of existing Wikipedia article about the eighth author.	Page name	optional
Author link 9	author-link9 author9-link	Title of existing Wikipedia article about the ninth author.	Page name	optional
Translator last name	translator-last translator translator-last1 translator1 translator1-last	The surname of the translator; don't wikilink, use 'translator-link'; can suffix with a numeral to add additional translators.	String	optional
Translator first name	translator-first translator1-first translator-first1	Given or first name, middle names, or initials of the translator; don't wikilink, use 'translator-link'; can suffix with a numeral to add additional translators.	String	optional
Translator link	translator-link translator-link1 translator1-link	Title of existing Wikipedia article about the translator; can suffix with a numeral to add additional translators.	Page name	optional
Translator last name 2	translator-last2 translator2 translator2-last	The surname of the second translator; don't wikilink, use 'translator-link'.	String	optional
Translator first name 2	translator-first2 translator2-first	Given or first name, middle names, or initials of the second translator; don't wikilink, use 'translator-link'.	String	optional
Translator last name 3	translator-last3 translator3 translator3-last	The surname of the third translator; don't wikilink, use 'translator-link'.	String	optional
Translator first name 3	translator-first3 translator3-first	Given or first name, middle names, or initials of the third translator; don't wikilink, use 'translator-link'.	String	optional
Translator last name 4	translator-last4 translator4 translator4-last	The surname of the fourth translator; don't wikilink, use 'translator-link'.	String	optional
Translator first name 4	translator-first4 translator4-first	Given or first name, middle names, or initials of the fourth translator; don't wikilink, use 'translator-link'.	String	optional
Translator last name 5	translator-last5 translator5 translator5-last	The surname of the fifth translator; don't wikilink, use 'translator-link'.	String	optional
Translator first name 5	translator-first5 translator5-first	Given or first name, middle names, or initials of the fifth translator; don't wikilink, use 'translator-link'.	String	optional
Translator last name 6	translator-last6 translator6 translator6-last	The surname of the sixth translator; don't wikilink, use 'translator-link'.	String	optional
Translator first name 6	translator-first6 translator6-first	Given or first name, middle names, or initials of the sixth translator; don't wikilink, use 'translator-link'.	String	optional
Translator last name 7	translator-last7 translator7 translator7-last	The surname of the seventh translator; don't wikilink, use 'translator-link'.	String	optional
Translator first name 7	translator-first7 translator7-first	Given or first name, middle names, or initials of the seventh translator; don't wikilink, use 'translator-link'.	String	optional
Translator last name 8	translator-last8 translator8 translator8-last	The surname of the eighth translator; don't wikilink, use 'translator-link'.	String	optional
Translator first name 8	translator-first8 translator8-first	Given or first name, middle names, or initials of the eighth translator; don't wikilink, use 'translator-link'.	String	optional
Translator last name 9	translator-last9 translator9 translator9-last	The surname of the ninth translator; don't wikilink, use 'translator-link'.	String	optional
Translator first name 9	translator-first9 translator9-first	Given or first name, middle names, or initials of the ninth translator; don't wikilink, use 'translator-link'.	String	optional
Translator link 2	translator-link2 translator2-link	Title of existing Wikipedia article about the second translator.	Page name	optional
Translator link 3	translator-link3 translator3-link	Title of existing Wikipedia article about the third translator.	Page name	optional
Translator link 4	translator-link4 translator4-link	Title of existing Wikipedia article about the fourth translator.	Page name	optional
Translator link 5	translator-link5 translator5-link	Title of existing Wikipedia article about the fifth translator.	Page name	optional
Translator link 6	translator-link6 translator6-link	Title of existing Wikipedia article about the sixth translator.	Page name	optional
Translator link 7	translator-link7 translator7-link	Title of existing Wikipedia article about the seventh translator.	Page name	optional
Translator link 8	translator-link8 translator8-link	Title of existing Wikipedia article about the eighth translator.	Page name	optional
Translator link 9	translator-link9 translator9-link	Title of existing Wikipedia article about the ninth translator.	Page name	optional
DOI access level	doi-access	Requires DOI value.	Unknown	optional
bibcode-access	bibcode-access	no description Suggested values free	Unknown	optional
Citation Style	mode	Sets element separator, default terminal punctuation, and certain capitalization according to the value provided. For cs1, element separator and terminal punctuation is a period (.); where appropriate, initial letters of certain words are capitalized ('Retrieved...'). For cs2, element separator is a comma (,); terminal punctuation is omitted; where appropriate, initial letters of certain words are not capitalized ('retrieved...'). These styles correspond to Citation Style 1 and Citation Style 2 respectively. To override default terminal punctuation use the postscript parameter. Suggested values cs1 cs2 Default cs1	String	optional

The above documentation is transcluded from Template:Cite document/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.