![]() | When updating this template keep in mind that it is used on a number of template documentation pages. If the parameters in question are unique to a template, then either add it manually to the template documentation or create a new section here for transclusion. |
This template is used to build consistent documentation pages for Citation Style 1 templates.
{{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.
When creating template documentation, use the following order of sections and content:
Use {{csdoc|lead|content type}}
to create consistent content for the lead:
This Citation Style 1 template is used to create citations for .
Options for this field: One unnamed parameter is used to create the trailing text.
Markup | Renders as |
---|---|
{{csdoc|lead|books}} |
This Citation Style 1 template is used to create citations for books. |
![]() | This template uses Lua: |
Start the usage section with {{csdoc|usage}}
:
|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.Parameters to copy are enclosed in tables created by sub-templates.
{{csdoc|usage full}}
:
to create an indent<code><nowiki>...</nowiki>
</code>
{{end}}
{{csdoc|usage full}} :<code><nowiki>{{cite xxxxx |last1= |first1= |author-link1= |last2= |first2= |author-link2= |last3= |first3= |author-link3= |last4= |first4= |author-link4= |last5= |first5= |author-link5= |name-list-style= |vauthors= |translator-last1= |translator-first1= |translator-link1= |translator-last2= |translator-first2= |translator-link2= |collaboration= |contributor-last1= |contributor-first1= |contributor-link1= |contributor-last2= |contributor-first2= |contributor-link2= |others= |editor-last1= |editor-first1= |editor-link1= |editor-last2= |editor-first2= |editor-link2= |editor-last3= |editor-first3= |editor-link3= |veditors= |title= |script-title= |trans-title= |work= |script-work= |trans-work= |issue= |department= |chapter= |script-chapter= |trans-chapter= |contribution= |type= |edition= |series= |series-link= |episode= |event= |agency= |volume= |date= |year= |orig-date= |df= |publisher= |location= |publication-place= |via= |language= |page= |pages= |no-pp= |at= |minutes= |time= |time-caption= |id= |arxiv= |asin= |asin-tld= |bibcode= |biorxiv= |citeseerx= |doi= |doi-broken-date= |eissn= |hdl= |sbn= |isbn= |ismn= |issn= |jfm= |jstor= |lccn= |mr= |oclc= |ol= |osti= |pmc= |embargo= |pmid= |rfc= |ssrn= |zbl= |url= |format= |archive-url= |archive-format= |url-status= |archive-date= |chapter-url= |chapter-format= |access-date= |no-tracking= |quote= |ref= |mode= |author-mask1= |author-mask2= |author-mask3= |author-mask4= |author-mask5= |display-authors= |translator-mask1= |translator-mask2= |display-translators= |contributor-mask1= |contributor-mask2= |display-contributors= |editor-mask1= |editor-mask2= |editor-mask3= |display-editors= |postscript= |url-access= |chapter-url-access= |bibcode-access= |doi-access= |hdl-access= |jstor-access= |ol-access= |osti-access= |map= |script-map= |trans-map= |map-url= |map-format= |map-url-access= |scale= |cartography= |inset= |sections= |interviewer-last1= |interviewer-first1= |interviewer-link1= |interviewer-last2= |interviewer-first2= |interviewer-link2= |interviewer-mask1= |interviewer-mask2= |display-interviewers= |season= |series-number= |series-separator= |network= |station= |transcript= |transcript-url= |transcript-format= |conference= |conference-url= |conference-format=}}</nowiki></code> {{end}}
|
The above set is organised contextually rather than alphabetically. The following parameters, which are usually available for at least a few cite templates, are not included in the full parameter set above: |authors=
; |book-title=
; |class=
; |degree=
; |docket=
; |encyclopedia=
; |mailing-list=
; |message-id=
; |number=
; |publication-date=
; |section=
; |sheet=
; |sheets=
; |title-link=
; |s2cid=
.
{{csdoc|usage common}}
:
to create an indent<code><nowiki>...</nowiki>
</code>
{{end}}
{{csdoc|usage common}} :<code><nowiki>{{cite book |last= |first= |author-link= |title= |url= |access-date= |date= |publisher= |location= |isbn= |page= |pages=}}</nowiki></code> {{end}}
|
The full vertical style can be implemented in a three-columns format (only practical when the number of parameters is not too extended) or in a four-columns format.
The full vertical style in three columns consists of a "Vertical list", "Prerequisites" and "Brief instructions / notes".
<!--
* Start with:
-->
{{csdoc|usage vertical}}
<pre style="margin:0px;">
<!--
* Create the vertical list column
* Separate the next column with:
-->
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
<!--
* Create the prerequisites column; blank lines must include a
* Separate the next column with:
-->
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
<!--
* Create the instructions column; blank lines must include a
* End with:
-->
</pre>
{{csdoc|usage vertical end}}
Example:
{{csdoc|usage vertical}}
<pre style="margin:0px;">
{{cite book
| last =
| first =
| author-link =
}}
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
last
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
same as last1
same as first1
</pre>
{{csdoc|usage vertical end}}
{| class="wikitable"
|+ Full parameter set in vertical format
! Parameters !! Prerequisites !! Brief instructions / notes !! Vertical list
|-
| {{tooltip|2=or any of its aliases, including: last; author1; author; author-last1; author-last; (etc.)|last1}}
|
| Author's last name or single name author. Don't link.
| rowspan="3" style="vertical-align:top;" | <pre style="margin:0px; border:none;">
{{cite xxxxx
|last1 =
|first1 =
|author-link1 =
}}
</pre>
|-
| {{tooltip|2=or any of its aliases, including: first; given1; given; author-first1; author-first; (etc.)|first1}}
| {{tooltip|2=or any of its aliases, including: last; author1; author; author-last1; author-last; (etc.)|last1}}
| Author's first name. Don't link.
|-
| {{tooltip|2=or any of its aliases, including: author-link; subject-link1; subject-link; (etc.)|author-link1}}
| {{tooltip|2=or any of its aliases, including: last; author1; author; author-last1; author-last; (etc.)|last1}}
| Title of Wikipedia article about the first author. Don't link.
|}
Parameters | Prerequisites | Brief instructions / notes | Vertical list |
---|---|---|---|
last1 | Author's last name or single name author. Don't link. | {{cite xxxxx |last1 = |first1 = |author-link1 = |last2 = |first2 = |author-link2 = |last3 = |first3 = |author-link3 = |last4 = |first4 = |author-link4 = |last5 = |first5 = |author-link5 = |name-list-style = |vauthors = |translator-last1 = |translator-first1 = |translator-link1 = |translator-last2 = |translator-first2 = |translator-link2 = |collaboration = |contributor-last1 = |contributor-first1 = |contributor-link1 = |contributor-last2 = |contributor-first2 = |contributor-link2 = |others = |editor-last1 = |editor-first1 = |editor-link1 = |editor-last2 = |editor-first2 = |editor-link2 = |editor-last3 = |editor-first3 = |editor-link3 = |veditors = |title = |script-title = |trans-title = |work = |script-work = |trans-work = |issue = |department = |chapter = |script-chapter = |trans-chapter = |contribution = |type = |edition = |series = |series-link = |episode = |event = |agency = |volume = |date = |year = |orig-date = |df = |publisher = |location = |publication-place = |via = |language = |page = |pages = |no-pp = |at = |minutes = |time = |time-caption = |id = |arxiv = |asin = |asin-tld = |bibcode = |biorxiv = |citeseerx = |doi = |doi-broken-date = |eissn = |hdl = |sbn = |isbn = |ismn = |issn = |jfm = |jstor = |lccn = |mr = |oclc = |ol = |osti = |pmc = |embargo = |pmid = |rfc = |ssrn = |zbl = |url = |format = |archive-url = |archive-format = |url-status = |archive-date = |chapter-url = |chapter-format = |access-date = |no-tracking = |quote = |ref = |mode = |author-mask1 = |author-mask2 = |author-mask3 = |author-mask4 = |author-mask5 = |display-authors = |translator-mask1 = |translator-mask2 = |display-translators = |contributor-mask1 = |contributor-mask2 = |display-contributors = |editor-mask1 = |editor-mask2 = |editor-mask3 = |display-editors = |postscript = |url-access = |chapter-url-access = |bibcode-access = |doi-access = |hdl-access = |jstor-access = |ol-access = |osti-access = |map = |script-map = |trans-map = |map-url = |map-format = |map-url-access = |scale = |cartography = |inset = |sections = |interviewer-last1 = |interviewer-first1 = |interviewer-link1 = |interviewer-last2 = |interviewer-first2 = |interviewer-link2 = |interviewer-mask1 = |interviewer-mask2 = |display-interviewers = |season = |series-number = |series-separator = |network = |station = |transcript = |transcript-url = |transcript-format = |conference = |conference-url = |conference-format = }} | |
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.
| |
name-list-style | vanc to emulate Vancouver style
| ||
vauthors | |||
translator-last1 | |||
translator-first1 | translator-last1 | ||
translator-link1 | translator-last1 | ||
translator-last2 | translator-last1 | Additional translators: translator-last3, etc. | |
translator-first2 | translator-last2 | ||
translator-link2 | translator-last2 | ||
collaboration | |||
contributor-last1 | |||
contributor-first1 | |||
contributor-link1 | |||
contributor-last2 | |||
contributor-first2 | |||
contributor-link2 | |||
others | |||
editor-last1 | |||
editor-first1 | editor-last1 | ||
editor-link1 | editor-last1 | ||
editor-last2 | editor-last1 | ||
editor-first2 | editor-last2 | ||
editor-link2 | editor-last2 | ||
editor-last3 | editor-last2 | ||
editor-first3 | editor-last3 | ||
editor-link3 | editor-last3 | ||
veditors | |||
title | |||
script-title | |||
trans-title | title or script-title | ||
work | |||
script-work | |||
trans-work | work or script-work | ||
issue | |||
department | |||
chapter | Chapter title can be wikilinked unless when a chapter-url is given
| ||
script-chapter | |||
trans-chapter | chapter or script-chapter | ||
contribution | |||
type | |||
edition | Ordinal number | ||
series | |||
series-link | |||
episode | |||
event | |||
agency | |||
volume | |||
date | |||
year | |||
orig-date | date or year | ||
df | |||
publisher | |||
location | publisher | ||
publication-place | |||
via | |||
language | |||
page | choose one: "page", "pages", or "at" | ||
pages | choose one: "page", "pages", or "at". Use when content on multiple pages supports the article text. | ||
no-pp | page or pages | set no-pp to "yes" to suppress the "p." or "pp." before page numbers | |
at | choose one: "page", "pages", or "at" | ||
minutes | |||
time | |||
time-caption | |||
id | |||
arxiv | |||
asin | |||
asin-tld | |||
bibcode | |||
biorxiv | |||
citeseerx | |||
doi | |||
doi-broken-date | doi | ||
eissn | |||
hdl | |||
sbn | |||
isbn | always include ISBN, if one has been assigned | ||
ismn | |||
issn | |||
jfm | |||
jstor | |||
lccn | |||
mr | |||
oclc | |||
ol | |||
osti | |||
pmc | |||
embargo | |||
pmid | |||
rfc | |||
ssrn | |||
zbl | |||
url | title or script-title | ||
format | url | ||
archive-url | archive-date, url | ||
archive-format | |||
url-status | archive-url | ||
archive-date | archive-url | ||
chapter-url | chapter or script-chapter | ||
chapter-format | chapter-url | ||
access-date | url | ||
no-tracking | |||
quote | |||
ref | |||
mode | cs1 or cs2
| ||
author-mask1 | last1 | ||
author-mask2 | last2 | ||
author-mask3 | last3 | ||
author-mask4 | last4 | ||
author-mask5 | last5 | ||
display-authors | last1 | number (number of authors displayed) or etal (more authors)
| |
translator-mask1 | translator-last1 | ||
translator-mask2 | translator-last2 | ||
display-translators | |||
contributor-mask1 | |||
contributor-mask2 | |||
display-contributors | |||
editor-mask1 | editor-last1 | ||
editor-mask2 | editor-last2 | ||
editor-mask3 | editor-last3 | ||
display-editors | |||
postscript | |||
url-access | |||
chapter-url-access | |||
bibcode-access | |||
doi-access | |||
hdl-access | |||
jstor-access | |||
ol-access | |||
osti-access | |||
map | |||
script-map | |||
trans-map | |||
map-url | |||
map-format | |||
map-url-access | |||
scale | |||
cartography | |||
inset | |||
sections | |||
interviewer-last1 | |||
interviewer-first1 | |||
interviewer-link1 | |||
interviewer-last2 | |||
interviewer-first2 | |||
interviewer-link2 | |||
interviewer-mask1 | |||
interviewer-mask2 | |||
display-interviewers | |||
season | |||
series-number | |||
series-separator | |||
network | |||
station | |||
transcript | |||
transcript-url | |||
transcript-format | |||
conference | |||
conference-url | |||
conference-format | |||
If a field name is listed in the Prerequisites column it is a prerequisite for the field to the left. | |||
Additional parameters (available for at least some cite templates) | |||
|authors=
| |||
|book-title=
| |||
|class=
| |||
|degree=
| |||
|docket=
| |||
|encyclopedia=
| |||
|mailing-list=
| |||
|message-id=
| |||
|number=
| |||
|publication-date=
| |||
|section=
| |||
|sheet=
| |||
|sheets=
| |||
|title-link=
| |||
(available from late April 2020) | |s2cid=
|
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.
|}
Vertical list | Prerequisites | Brief instructions / notes |
---|---|---|
| style="vertical-align:top;" |
|}
|}
Use {{markup2}} to format the examples .
{{markup2 |t=Basic usage with url and edition |m={{cite book |title=Mysterious book |url=https://www.example.com |edition=2nd}} |r={{cite book |title=Mysterious book |url=https://www.example.com |edition=2nd}} }}
Basic usage with url and edition
{{cite book |title=Mysterious book |url=https://www.example.com |edition=2nd}}
Nested parameters rely on their parent parameters:
This template embeds COinS metadata in the HTML output, allowing reference management software to retrieve bibliographic metadata. As a general rule, only one data item per parameter. Do not include explanatory or alternate text:
|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.
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=
By default, sets of fields are terminated with a period (.).
By default, sets of fields are terminated with a comma (,).
|no-tracking=true
to disable categorization; mainly used for documentation where the error is demonstrated.
Parameter | Description | Date |
---|---|---|
N/A |
Deprecated parameter | Replace with | Date |
---|---|---|
none deprecated at present |
Removed parameter | Replace with | Date | Note |
---|---|---|---|
|authors=
|
|lastn= / |firstn= , |authorn= , |vauthors=
|
August 2024 |
|author=Bono
). Aliases: surname, author, last1, surname1, author1.
|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.|first1=...
|last1=...
|author2=...
.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 vanc
displays name lists in Vancouver style when the lists use the last
/first
forms of name parameters.|vauthors=Smythe JB, ((Megabux Corp.)), etal
|vauthors=
as described aboveOptions for this field:
|contributor=yes
adds contributors (use with cite book and citation only)|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-first1=...
|editor-last1=...
|editor2=...
.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 vanc
displays name lists in Vancouver style when the lists use the last
/first
forms of name parameters.|veditors=Smythe JB, ((Megabux Corp.)), etal
|veditors=
, as described above
... |title=Tōkyō tawā |script-title=ja:東京タワー |trans-title=Tokyo Tower ...
newline | [ | ] | | |
---|---|---|---|
space | [ | ] | {{!}} (preferred)
|
{{bracket|text}} | | or {{pipe}} – |
Options for this field:
title_title sets the display title:
- encyclopedia = encyclopedia
- default = title
... |title=Tōkyō tawā |script-title=ja:東京タワー |trans-title=Tokyo Tower ...
newline | [ | ] | | |
---|---|---|---|
space | [ | ] | | |
{{bracket|text}} | {{pipe}} – |
|no-tracking=true
to disable categorization; mainly used for documentation where the error is demonstrated.
... |chapter=Tōkyō tawā |script-chapter=ja:東京タワー |trans-chapter=Tokyo Tower ...
Afterword
, Foreword
, Introduction
, or Preface
will display unquoted; any other value will display in quotation marks. The author of the contribution is given in contributor.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
none
can be used to disable the display of a type. Examples: Thesis, Booklet, Accepted manuscript, CD liner, Press release. Alias: medium.Options for this field:
- type_default: Adds "Defaults to type_default"
{{cite journal}}
and {{cite magazine}}
): Name of the work containing the source; may be wikilinked if relevant. Displays in italics. If the name of the periodical changed over time use the name at the time of the source's publication. If script-work is defined, use work to hold a Romanization (if available) of the title in script-work. 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.
... |work=Zhōngguó piàofáng |script-work=zh:中国票房 |trans-work=China Box Office ...
|issue=2, ''Modern Canadian Literature''
. Please choose either |issue=
or |number=
depending on what is used in the actual publication. If a publication carries both issue and number designations (typically one being a year-relative and the other an absolute value), provide them both, for example |issue=2 #143
. Displayed in parentheses following volume.Options for this field:
- department adds:
- department: Regular department or section within the periodical or journal. Examples include "Communication", "Editorial", "Letter to the Editor", and "Review". Displays after title and is in plain text.
|edition=2nd
produces "2nd ed." Does not display if a periodical field is defined.
{{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.c.
", like this: |date=c. 1900
.
|date=n.d.
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.|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.|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:
CITEREF
disambiguator, usually a lowercase letter suffixed to the year.)|date=
format is YYYY-MM-DD. (This format prevents the addition of a disambiguating letter to the year.)|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-yeardmy
– set publication dates to day month year format; access- and archive-dates are not modified;mdy
– as above for month day, year formatymd
– as above for year initial numeric format YYYY-MM-DDdmy-all
– set publication, access-, and archive-dates to day month year format;mdy-all
– as above for month day, year formatymd-all
– as above for year initial numeric format YYYY-MM-DDOptions for this field:
- limited_param_list hides orig-date because not allowed in limited-parameter templates
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. The publisher is the company that publishes the work being cited. Do not use the publisher parameter for the name of a work (e.g., a book, encyclopedia, newspaper, magazine, journal, website). 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.
|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: espagnol at a French-language wiki instead of the English word "Spanish". Aliases: lang
|page=
or |pages=
, but not both. Displays preceded by p.
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.|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 pp.
unless |no-pp=yes
. |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.
p.
or pp.
notations where this is inappropriate; for example, where |page=Front cover
or |pages=passim
.|page=
or |pages=
. Use only one of |page=
, |pages=
, or |at=
.|quote-page=
and |quote-pages=
used in conjunction with |quote=
, see here.Options for this field:
- work adds "or work (or an alias) is defined"
|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 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. In general, the parameters should include only the variable part of the identifier, e.g. |rfc=822
or |pmc=345678
.
|arxiv=hep-th/9205027
(before April 2007) or |arxiv=0706.0001
(April 2007 – December 2014) or |arxiv=1501.00001
(since January 2015). Do not include extraneous file extensions like ".pdf" or ".html". Aliases: eprint.|asin=B00005N5PF
. Aliases: ASIN.
ae
, au
, br
, ca
, cn
, de
, es
, fr
, in
, it
, jp
, mx
, nl
, pl
, sa
, se
, sg
, tr
, uk
. Aliases: none.1974AJ.....79..819H
. Aliases: none.10.1101/078733
for http://biorxiv.org/content/early/2016/10/01/078733 or https://doi.org/10.1101/078733; 10.1101/2020.07.24.220400
for https://doi.org/10.1101/2020.07.24.220400). Aliases: none.10.1.1.176.341
for https://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.176.341). Aliases: none.10.1038/news070508-7
. It is checked to ensure it begins with (10.
). Aliases: DOI.
|eissn=1557-2986
. Aliases: EISSN.
|hdl=20.1000/100
. Aliases: HDL.978-0-8126-9593-9
. Hyphens in the ISBN are optional, but preferred. Use the ISBN actually printed on or in the book. Use the 13-digit ISBN – beginning with 978 or 979 – when it is available. If only a 10-digit ISBN is printed on or in the book, use it. ISBNs can be found on the page with the publisher's information – usually the back of the title page – or 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, use sbn. Do not convert a 10-digit ISBN to 13-digit by just adding the 978 prefix; the last digit is a calculated check digit and just making changes to the numbers will make the ISBN invalid. This parameter should hold only the ISBN without any additional characters. It is checked for length, invalid characters – anything other than numbers, spaces, and hyphens, with "X" permitted as the last character in a 10-digit ISBN – and the proper check digit. Aliases: ISBN.
|isbn={{Format ISBN|9780812695939}}
– if you are unsure of how any particular ISBN should be hyphenated, as the pattern varies by country and publisher.979-0-9016791-7-7
. Hyphens or spaces in the ISMN are optional. Use the ISMN actually printed on or in the work. This parameter should hold only the ISMN without any additional characters. It is checked for length, invalid characters – anything other than numbers, spaces, and hyphens – and the proper check digit. Aliases: ISMN.|issn=2049-3630
. Aliases: ISSN.
|jfm=53.0144.01
. Aliases: JFM.|jstor=3793107
. Aliases: JSTOR.|lccn=79-57364
or |lccn=2004042477
or |lccn=e09001178
. Aliases: LCCN.|mr=630583
. Aliases: MR.|oclc=9355469
. Aliases: OCLC.|ol=7030731M
. Aliases: OL.|osti=4367507
. Aliases: OSTI.|pmc=345678
. Do not include "PMC" in the value. . Aliases: PMC.
|pmid=17322060
Aliases: PMID.|rfc=3143
. Aliases: RFC.|sbn=356-02201-3
. Aliases: SBN.
|ssrn=1900856
. Aliases: SSRN.|s2cid=37220927
. Aliases: S2CID.|zbl=0472.53010
For zbMATH search results like JFM 35.0387.02
use |jfm=35.0387.02
. Aliases: ZBL.In very rare cases, identifiers are published which do not follow their defined standard format or use non-conforming checksums. These 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, some identifiers (|doi=
, |eissn=
, |isbn=
, |issn=
, and |sbn=
) support a special accept-this-as-written markup which can be applied to disable the error-checking (as |<param>=((<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.
For {{cite journal}}, some identifiers (specifying free resources) will automatically be linked to the title when |url=
and |title-link=
are not used to specify a different link target. This behaviour can be overridden by one out of a number of special keywords for |title-link=
to manually select a specific source (|title-link=pmc
or |title-link=doi
) for auto-linking or to disable the feature (|title-link=none
).
It is not necessary to specify a URL to a link identical to a link also produced by an identifier. The |url=
parameter (or |title-link=
) can then be used for providing a direct deep link to the corresponding document or a convenience link to a resource that would not otherwise be obviously accessible.
#ixzz2rBr3aO94
or ?utm_source=google&utm_medium=...&utm_term=...&utm_campaign=...
. Do not link to any commercial booksellers, such as Amazon; use |isbn=
or |oclc=
to provide neutral search links for books. Invalid URLs, including those containing spaces, will result in an error message.
{{use dmy dates}}
and {{use mdy dates}}
. Can be hidden or styled by registered editors. Alias: accessdate.|url-status=live
) the archived link is displayed first, with the original link at the end. Alias: archiveurl.
{{use dmy dates}}
and {{use mdy dates}}
. Alias: archivedate.|url=
or |archive-url=
to link |title=
; requires url and archive-url. Use {{dead link}}
to mark dead |url=
when there is no |archive-url=
.
dead
– (default condition when |url-status=
omitted or empty) selects |archive-url=
live
– selects |url=
; used when |url=
is preemptively archived with |archive-url=
deviated
– selects |archive-url=
; used when |url=
is still 'live' but no-longer supports the text in a Wikipedia articleunfit
– selects |archive-url=
; used when |url=
links to vice (gambling, pornography), advertising, or other unsuitable page; links to |url=
are suppressed in the rendering. If an entire domain is unsuitable, consider instead usurpation or blacklist. Bot help is available at WP:URLREQusurped
– selects |archive-url=
; used when the domain in |url=
no longer serves its original intent, particularly when the domain has been (mis)appropriated by other entities, such as vice, reseller and advertising sites; links to |url=
are suppressed in the rendering. Bot help is available at WP:URLREQbot: unknown
– Editors may encounter this value which is left behind by a bot that has visited the reference and wasn't able to determine the status of the url. The page will be automatically placed in Category:CS1 maint: bot: original URL status unknown when this value is present, and per the instructions in that category, editors manually evaluate the state of the URL and change the parameter value appropriately.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:
may 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:
Character | space | " | ' | < | > | [ | ] | { | | | } |
---|---|---|---|---|---|---|---|---|---|---|
Encoding | %20 | %22 | %27 | %3C | %3E | %5B | %5D | %7B | %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:
- media uses 'media' in place of 'text of the publication'
... |quote=Tōkyō tawā |script-quote=ja:東京タワー |trans-quote=Tokyo Tower ...
|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 p.
unless |no-pp=yes
. If hyphenated, use {{hyphen}} to indicate this is intentional (e.g. |quote-page=3{{hyphen}}12
). Alias: none.|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 pp.
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.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=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.
|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...'). These styles correspond to Citation Style 1 and Citation Style 2 respectively. To override default terminal punctuation use postscript.{{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. |authorn-mask=
) to apply the mask to a specific name.|display-authors=2
will display only the first two authors in a citation (and not affect the display of the other kinds of contributors). |display-authors=0
is a special case suppressing the display of all authors including the et al. |display-authors=etal
displays all authors in the list followed by et al. Aliases: none..
); 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.Options for this field:
- cs2: When set, changes:
- postscript to "defaults to none"
- separator to "Defaults to a comma (,)"
Citations of online sources that require registration or a subscription are acceptable in Wikipedia as documented in Verifiability § Access to sources. As a courtesy to readers and other editors, editors should signal restrictions on access to material provided via the external links included in a citation. These levels describe requirements or constraints related to accessing and viewing the cited material; they are not intended to indicate the ability to reuse, or the copyright status, of the material, since that status is not relevant to verifying claims in articles.
Four access levels can be used:
free
: the source is free to read for anyoneregistration
: a free registration with the provider is required to access the source, even if a limited preview, abstract or review may still be available without registrationlimited
: free access is subject to limited trial and a subscription is normally requiredsubscription
: the source is only accessible via a paid subscription with the provider of the source ("paywall")As there are often multiple external links with different access levels in the same citation, each value is attributed to a specific external link.
Online sources linked by |url=
, |article-url=
, |chapter-url=
, |contribution-url=
, |entry-url=
, |map-url=
, and |section-url=
are presumed to be free-to-read. When they are not free-to-read, editors should mark those sources with the matching access-indicator parameter so that an appropriate icon is included in the rendered citation. Because the sources linked by these URL-holding parameters are presumed to be free-to-read, they are not marked as free
. If the registration/limited/subscription access to the source goes dead and is no longer available, then remove the access-indicator parameter and add |archive-url=
and |archive-date=
values if possible.
URL | Access | Allowed keywords |
---|---|---|
|url=
|
|url-access= |
registration ![]() limited ![]() subscription ![]() |
|article-url=
|
|article-url-access=
| |
|chapter-url=
|
|chapter-url-access=
| |
|contribution-url=
|
|contribution-url-access=
| |
|entry-url=
|
|entry-url-access=
| |
|map-url=
|
|map-url-access=
| |
|section-url=
|
|section-url-access=
|
For example, this cites a web page that requires registration but not subscription:
{{cite web |url=https://example.com/nifty_data.php |url-access=registration |date=2021-04-15 |title=Nifty example data}}
which renders as:
Links inserted by named identifiers are presumed to lie behind a paywall or registration barrier – exceptions listed below. When they are free-to-read, editors should mark those sources with the matching access-indicator parameter so that an appropriate icon is included in the rendered citation. When the sources linked by these named-identifier parameters are not presumed to carry a free-to-read full text (for instance because they're just abstracting services), they may not be marked as limited
, registration
, or subscription
.
Identifier | Access | Allowed keywords |
---|---|---|
|bibcode=
|
|bibcode-access= |
free ![]() |
|doi=
|
|doi-access=
| |
|hdl=
|
|hdl-access=
| |
|jstor=
|
|jstor-access=
| |
|ol=
|
|ol-access=
| |
|osti=
|
|osti-access=
| |
|ssrn=
|
|ssrn-access=
| |
|s2cid=
|
|s2cid-access=
|
Some named-identifiers are always free-to-read. For those named identifiers there are no access-indicator parameters; the access level is automatically indicated by the template. These named identifiers are:
|arxiv=
|biorxiv=
|citeseerx=
|medrxiv=
|pmc=
|rfc=
For embargoed pmc that will become available in the future, see pmc-embargo-date.
|inset=Downtown Fooburg
becomes "Downtown Fooburg inset."; overridden by at.
|interviewer=Bono
). Aliases: interviewer-last1, interviewer1-last, interviewer-surname, interviewer-surname1, interviewer1-surname, interviewer, interviewer1. Supports accept-this-as-written markup.
|interviewer-first1=...
|interviewer-last1=...
|interviewer2=...
.