Movatterモバイル変換

[0]ホーム
URL:

Jump to content
WikipediaThe Free Encyclopedia
Search

Template:Citation Style documentation

Permanently protected template
From Wikipedia, the free encyclopedia
Template documentation[view] [edit] [history] [purge]
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.

Usage

This template is used to build consistent documentation pages forCitation 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.

Section usage

When creating template documentation, use the following order of sections and content:

  • Lead: a brief overview of the template intent
  • Usage: samples of blank parameters that can be copied and pasted
  • Examples: examples of various usage
  • Parameters: detailed descriptions of each parameter
    • Syntax: overview of the template syntax
    • Deprecated: list of deprecated parameters
    • Description: parameter descriptions separated by function in this general order:
      • Authors
      • Title
      • Date
      • Publisher
      • Edition, series, volume
      • In-source locations
      • URL
      • Anchor
      • Identifiers
      • Quote
      • Editors
      • Display options

Lead section

Use{{csdoc|lead|content type}} to create consistent content for the lead:

[edit subtemplate]

ThisCitation Style 1 template is used to createcitations for .

Options for this field:One unnamed parameter is used to create the trailing text.

MarkupRenders as 
{{csdoc|lead|books}}

ThisCitation Style 1 template is used to createcitations for books.

Lua notice

[edit subtemplate]

This template usesLua:

Usage section

Start the usage section with{{csdoc|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, thenpurge the page.

Parameters to copy are enclosed in tables created by sub-templates.

Full horizontal style

  • Start with{{csdoc|usage full}}
  • Enclose the sample in<code><nowiki>...</nowiki></code>
  • Close the table with{{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}}
Full parameter set in horizontal format
{{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=}}

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

Most commonly used horizontal style

  • Start with{{csdoc|usage common}}
  • Precede the sample markup with: to create an indent
  • Enclose the sample in<code><nowiki>...</nowiki></code>
  • Close the table with{{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}}}}
Most-commonly-used parameters in horizontal format
{{cite book |last= |first= |author-link= |title= |url= |access-date= |date= |publisher= |location= |isbn= |page= |pages=}}

Full vertical style

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.

Three-columns format

The full vertical style in three columns consists of a "Vertical list", "Prerequisites" and "Brief instructions / notes".

<!--* Start with:-->{{csdoc|usage vertical}}<prestyle="margin:0px;"><!--* Create the vertical list column* Separate the next column with:--></pre>{{csdoc|usage vertical mid}}<prestyle="margin:0px;"><!--* Create the prerequisites column; blank lines must include a&nbsp;* Separate the next column with:--></pre>{{csdoc|usage vertical mid}}<prestyle="margin:0px;"><!--* Create the instructions column; blank lines must include a&nbsp;* End with:--></pre>{{csdoc|usage vertical end}}

Example:

{{csdoc|usage vertical}}<prestyle="margin:0px;">{{cite book| last                  =| first                 =| author-link           =}}</pre>{{csdoc|usage vertical mid}}<prestyle="margin:0px;">&nbsp;&nbsp;last&nbsp;&nbsp;</pre>{{csdoc|usage vertical mid}}<prestyle="margin:0px;">&nbsp;same as last1same as first1&nbsp;&nbsp;</pre>{{csdoc|usage vertical end}}
Full parameter set in vertical format
Vertical listPrerequisitesBrief instructions / notes
{{cite book| last                  =| first                 =| author-link           =}}
  last  
 same as last1same as first1  
  • If a field name is listed in thePrerequisites column, it is a prerequisite for the field to the left.

Four-columns format

{|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;"|<prestyle="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.|}
Full parameter set in vertical format
ParametersPrerequisitesBrief instructions / notesVertical list
last1Author'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    =}}
first1last1Author's first name. Don't link.
author-link1last1Title of Wikipedia article about the first author. Don't link.
last2last1Likelast1, but for 2nd author.
first2last2Likefirst1, but for 2nd author.
author-link2last2Likeauthor-link1, but for 2nd author.
last3last2Likelast1, but for 3rd author.
first3last3Likefirst1, but for 3rd author.
author-link3last3Likeauthor-link1, but for 3rd author.
last4last3Likelast1, but for 4th author.
first4last4Likefirst1, but for 4th author.
author-link4last4Likeauthor-link1, but for 4th author.
last5last4Likelast1, but for 5th author. Similar: last6, etc.
first5last5Likefirst1, but for 5th author. Similar: first6, etc.
author-link5last5Likeauthor-link1, but for 5th author. Similar: author-link6, etc.
name-list-stylevanc to emulateVancouver style
vauthors
translator-last1
translator-first1translator-last1
translator-link1translator-last1
translator-last2translator-last1Additional translators: translator-last3, etc.
translator-first2translator-last2
translator-link2translator-last2
collaboration
contributor-last1
contributor-first1
contributor-link1
contributor-last2
contributor-first2
contributor-link2
others
editor-last1
editor-first1editor-last1
editor-link1editor-last1
editor-last2editor-last1
editor-first2editor-last2
editor-link2editor-last2
editor-last3editor-last2
editor-first3editor-last3
editor-link3editor-last3
veditors
title
script-title
trans-titletitle or script-title
work
script-work
trans-workwork or script-work
issue
department
chapterChapter title can be wikilinked unless when achapter-url is given
script-chapter
trans-chapterchapter or script-chapter
contribution
type
editionOrdinal number
series
series-link
episode
event
agency
volume
date
year
orig-datedate or year
df
publisher
locationpublisher
publication-place
via
language
pagechoose one: "page", "pages", or "at"
pageschoose one: "page", "pages", or "at". Use when content on multiple pages supports the article text.
no-pppage or pagesset no-pp to "yes" to suppress the "p." or "pp." before page numbers
atchoose one: "page", "pages", or "at"
minutes
time
time-caption
id
arxiv
asin
asin-tld
bibcode
biorxiv
citeseerx
doi
doi-broken-datedoi
eissn
hdl
sbn
isbnalways include ISBN, if one has been assigned
ismn
issn
jfm
jstor
lccn
mr
oclc
ol
osti
pmc
embargo
pmid
rfc
ssrn
zbl
urltitle or script-title
formaturl
archive-urlarchive-date, url
archive-format
url-statusarchive-url
archive-datearchive-url
chapter-urlchapter or script-chapter
chapter-formatchapter-url
access-dateurl
no-tracking
quote
ref
modecs1 orcs2
author-mask1last1
author-mask2last2
author-mask3last3
author-mask4last4
author-mask5last5
display-authorslast1number (number of authors displayed) oretal (more authors)
translator-mask1translator-last1
translator-mask2translator-last2
display-translators
contributor-mask1
contributor-mask2
display-contributors
editor-mask1editor-last1
editor-mask2editor-last2
editor-mask3editor-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 thePrerequisites 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=

Sub-templates

Usage

[edit subtemplate]

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, thenpurge the page.

|}

Usage full

[edit subtemplate]

Full parameter set in horizontal format

Usage common

[edit subtemplate]

Most-commonly-used parameters in horizontal format

Usage vertical

[edit subtemplate]

Full parameter set in vertical format
Vertical listPrerequisitesBrief instructions / notes

Usage vertical mid

[edit subtemplate]

| |

|}

Usage vertical end

[edit subtemplate]

|}

  • If a field name is listed in thePrerequisites column, it is a prerequisite for the field to the left.

Examples section

Use{{markup2}} to format the examples(see that template's documentation for use).

{{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}}
    Mysterious book (2nd ed.).

Parameters section

syntax

[edit subtemplate]

Nested parameters rely on their parent parameters:

  • parent
  • OR:parent2—may be used instead ofparent
    • child—may be used withparent (and is ignored ifparent is not used)
    • OR:child2—may be used instead ofchild (and is ignored ifparent2 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

[edit subtemplate]

This template embedsCOinS metadata in the HTML output, allowingreference management software to retrieve bibliographic metadata.SeeWikipedia: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&nbsp;,&ndash;, or&#160;, 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 theUsage 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=

sep_period

[edit subtemplate]

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

sep_comma

[edit subtemplate]

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

required

[edit subtemplate]

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

whats new

[edit subtemplate]

What's new or changed recently
ParameterDescriptionDate
N/A

deprecated

[edit subtemplate]


Deprecated CS1/CS2 parameters
Deprecated parameterReplace withDate
none deprecated at present
Recently removed CS1/CS2 parameters
Removed parameterReplace withDateNote
|authors=|lastn= /|firstn=,|authorn=,|vauthors=August 2024

author

[edit subtemplate]

  • last: Surname of a single author. Do not wikilink—useauthor-link instead. For corporate authors or authors for whom only one name is listed by the source, uselast 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. Supportsaccept-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 orFirstname M. orFirstname M. Sr. Do not wikilink—useauthor-link instead. Aliases:given,first1,given1. Requireslast; first name will not display iflast is empty. Use generational and regnal suffixes only in accordance withMOS:JRSR and use honorifics (includingDr.,Sir, and similar) only in accordance withMOS:HON.
    • OR: for multiple authors, uselast1,first1 throughlastn,firstn, wheren is any consecutive number for an unlimited number of authors (eachfirstn requires a correspondinglastn, but not the other way around).See thedisplay parameters to change how many authors are displayed. Aliases:surname1,given1 throughsurnamen,givenn, orauthor1 throughauthorn. 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, useauthor-link1 throughauthor-linkn. Aliases:author1-link throughauthorn-link.
    • name-list-style: accepts a limited list of keywords as value; when set toamp,ampersand, or&, inserts an ampersand between the last two names in a name list; when set toand, inserts the conjunction 'and' between the last two names of a name list; when set tovancdisplays name lists inVancouver style when the lists use thelast/first forms of name parameters.
  • vauthors: comma-separated list of author names inVancouver style; enclose corporate or institutional author names indoubled parentheses. End with etal if appropriate:
    |vauthors=Smythe JB, ((Megabux Corp.)), etal
    • author-link andauthor-mask may be used for the individual names in|vauthors= as described above
  • authors: deprecatedFree-form list of author names; use of this parameter is discouraged because it does not contribute to a citation's metadata; not an alias oflast.
  • translator-last: Surname of translator. Do not wikilink—usetranslator-link instead. Aliases:translator-surname,translator1,translator1-last,translator-last1. Supportsaccept-this-as-written markup.
    • translator-first: Given or first names of translator. Do not wikilink—usetranslator-link instead. Aliases:translator-given,translator1-first,translator-first1.
    • OR: for multiple translators, usetranslator-last1,translator-first1 throughtranslator-lastn,translator-firstn, wheren is any consecutive number for an unlimited number of translators (eachtranslator-firstn requires a correspondingtranslator-lastn, but not the other way around). Aliases:translator1-last,translator1-first throughtranslatorn-last,translatorn-first, ortranslator1 throughtranslatorn.
    • 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, usetranslator-link1 throughtranslator-linkn. Aliases:translator1-link throughtranslatorn-link.
  • collaboration: Name of a group of authors or collaborators; requiresauthor,last, orvauthors listing one or more primary authors; follows author name-list; appends "et al." to author name-list.
  • Note: When usingshortened footnotes orparenthetical referencing styles with templates, do not use multiple names in one field, or else the anchor will not match the inline link.

Options 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 forlast.

editor

[edit subtemplate]

  • editor-last: surname of editor. Do not wikilink—useeditor-link instead. Where the surname is usually written first—as in Chinese—or for corporate authors, simply useeditor-last to include the same format as the source. Aliases:editor-last1,editor1-last,editor-surname,editor-surname1,editor1-surname,editor,editor1.
    • editor: This parameter is used to hold the complete name of a single editor (first and last), or the name of an editorial committee. This parameter should never hold the names of more than one editor. Supportsaccept-this-as-written markup.
    • editor-first: given or first names of editor, including title(s); example:Firstname Middlename orFirstname M. orDr. Firstname M., Sr. Do not wikilink—useeditor-link instead. Aliases:editor-first1,editor1-first,editor-given,editor-given1,editor1-given.
    • OR: for multiple editors, useeditor-last1,editor-first1 througheditor-lastn,editor-firstn (Aliases:editorn-last,editor-surnamen oreditorn-surname;editorn-first,editor-givenn oreditorn-given;editorn). For an individual editor plus an institutional editor, you can use|editor-first1=...|editor-last1=...|editor2=....
    • editor-link: title of existing Wikipedia article about the editor—not the editor's website; do not wikilink. Aliases:editor-link1.
    • OR: for multiple editors, useeditor-link1 througheditor-linkn (aliaseditorn-link).
    • name-list-style: accepts a limited list of keywords as value; when set toamp,ampersand, or&, inserts an ampersand between the last two names in a name list; when set toand, inserts the conjunction 'and' between the last two names of a name list; when set tovancdisplays name lists inVancouver style when the lists use thelast/first forms of name parameters.
  • veditors: comma separated list of editor names inVancouver style; enclose corporate or institutional names indoubled parentheses. End with etal if appropriate:
    |veditors=Smythe JB, ((Megabux Corp.)), etal
    • editor-linkn andeditor-maskn may be used for the individual names in|veditors=, as described above
  • Display:
    Usedisplay-editors to control the length of the displayed editor name list and to specify when "et al." is included.
    If authors: Authors are first, followed by the included work, then "In" and the editors, then the main work.
    If no authors: Editors appear before the included work; a single editor is followed by "ed."; multiple editors are followed by "eds."

title

[edit subtemplate]

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

  • title: Title of source. Can be wikilinked to an existing Wikipedia article orurl may be used to add an external link, but not both. Displays initalics. Ifscript-title is defined, usetitle to hold aRomanization (if available) of the title inscript-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 intitle (if present). Must be prefixed with one of thesupported 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 aftertitle. Use of thelanguage parameter is recommended.
Titles containing certain characters will not display and link correctly unless those characters are encoded.
newline[]|
space&#91;&#93;{{!}} (preferred)
{{bracket|text}}&#124; or{{pipe}} –see alsoHelp:Table § Rendering the pipe
  • title-link: Title of existing Wikipedia article about the source named intitle – do not use a web address; do not wikilink.

Options for this field:

title_title sets the display title:

  • encyclopedia = encyclopedia
  • default = title

web

[edit subtemplate]

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

  • title: Title of source page on website. Displays in quotation marks. For titles containing quotation marks, convert regular quotation marks (") to single quotation marks ('). SeeMOS:QINQ for guidance in more complex situations. Ifscript-title is defined, usetitle to hold aRomanization (if available) of the title inscript-title.
    • script-title: Original title for languages that do not use a Latin-based script (Arabic, Chinese, Cyrillic, Greek, Hebrew, Japanese, Korean, etc); follows Romanization defined intitle (if present). Must be prefixed with one of thesupported 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 aftertitle. Use of thelanguage parameter is recommended.
Titles containing certain characters will display and link incorrectly unless those characters are encoded.
newline[]|
space&#91;&#93;&#124;
{{bracket|text}}{{pipe}} –see alsoHelp:Table § Rendering pipe itself
This parameter is required and will generate an error if not defined. On errors, main, help and template pages are placed intoCategory:Articles with incorrect citation syntax. Set|no-tracking=true to disable categorization; mainly used for documentation where the error is demonstrated.
  • website: Title of website (when the website has a clear name, use that rather than the domain name); may be wikilinked. Displays in italics. Aliases:work

chapter

[edit subtemplate]

  • chapter: The chapter heading of the source. May be wikilinked or may usechapter-url, but not both. Displays in quotes. Ifscript-chapter is defined, usechapter to hold aRomanization (if available) of the title inscript-chapter
    • script-chapter: Chapter heading for languages that do not use a Latin-based script (Arabic, Chinese, Cyrillic, Greek, Hebrew, Japanese, Korean, etc); followsRomanization defined inchapter (if present). Must be prefixed with one of thesupported language codes to help browsers properly display the script:
      ... |chapter=Tōkyō tawā |script-chapter=ja:東京タワー |trans-chapter=Tokyo Tower ...
    • trans-chapter: English translation of the chapter heading, if the source cited is in a foreign language. Displays in square brackets after thechapter field; ifchapter-url is defined, thentrans-chapter is included in the link. Use of thelanguage parameter is recommended.
  • contribution: A separately-authored part ofauthor's book. May be wikilinked or may usecontribution-url, but not both. Values ofAfterword,Foreword,Introduction, orPreface will display unquoted; any other value will display in quotation marks. The author of the contribution is given incontributor.

Options for this field:

title_format sets the display format:

  • italics = Displays in italics.
  • work = Ifwork is defined, thentitle is displayed in quotes, else displays in italics.
  • default = Displays in quotes.

title_title sets the display title:

  • booktitle = booktitle
  • default = chapter

type

[edit subtemplate]

  • type: Provides additional information about the 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 keywordnone 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 totype_default"

journal

[edit subtemplate]

  • work (required by{{cite journal}} and{{cite magazine}}): Name of the work containing the source; may be wikilinked if relevant. Displays initalics. If the name of the periodical changed over time use the name at the time of the source's publication. Ifscript-work is defined, usework to hold aRomanization (if available) of the title inscript-work. Aliases:journal,newspaper,magazine,periodical,website. UseLatin script. For languages written in non-Latin based scripts (Arabic, Chinese, Cyrillic, Greek, Hebrew, Indic, Japanese, Korean, etc.) use a standardRomanization in this field.
    • script-work: Work title in its original, non-Latin script; not italicized, follows italicized Romanization defined inwork (if present). Must be prefixed with one of thesupported language codes 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 afterwork orscript-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''. Please choose either|issue= or|number= depending on what is used in the actual publication. If a publication carries both issueand 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 followingvolume.
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 or section within the periodical or journal. Examples include "Communication", "Editorial", "Letter to the Editor", and "Review". Displays aftertitle and is in plain text.

edition

[edit subtemplate]

  • edition: When the publication has more than one edition; for example: "2nd", "Revised", and so forth. Appends the string " ed." after the field, so|edition=2nd produces "2nd ed." Does not display if a periodical field is defined.

series

[edit subtemplate]

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

series_episode

[edit subtemplate]

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

event

[edit subtemplate]

  • event: Event where the speech was given.

agency

[edit subtemplate]

  • agency: Thenews agency (wire service) that provided the content; examples:Associated Press,Reuters,Agence France-Presse. Do not use for sources published on the agency's own website; e.g. apnews.com or reuters.com; instead, usework orpublisher. May be wikilinked if relevant.

volume

[edit subtemplate]

  • volume: For one publication published in several volumes. Displays after thetitle andseries fields; volume numbers should be entered just as a numeral (e.g. 37). Volume values that are wholly digits, wholly uppercase Roman numerals, or fewer than five characters will appear in bold. Any alphanumeric value of five or more characters will not appear in bold. In rare cases, publications carry both an ongoing volume and a year-related value; if so, provide them both, for example |volume=IV / #10.

date

[edit subtemplate]

"Wikipedia:Undated" redirects here. For undated signatures, seeTemplate: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.[date 1] 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, seeHelp: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 orref 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 acreated orupdated date; a comment for editors such asdate=2021-12-25<!--date from page source-->|orig-date=Original date 2011-01-01 can be added.
Automatic date formatting:Citation Style 1 and2 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, unlessboth of the following conditions are met:
    1. Shortened footnotes target multiple citations with same last name and year of publication. (This situation necessitates aCITEREFdisambiguator, 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 thedate (oryear). 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
  1. ^Publication dates in references within an article should all have the same format. This may be a different format from that used for archive and access dates.SeeMOS:DATEUNIFY.

Options for this field:

  • limited_param_list hidesorig-date because not allowed in limited-parameter templates

publisher

[edit subtemplate]

  • publisher: Name of publisher; may be wikilinked[1] if relevant. Thepublisher is thecompany,organization or other legal entity that publishes the work being cited. For self-published works (i.e., where the publisher is the same as the author or creator) state|publisher=self-published.[2] Donot use thepublisher parameter for the name of awork (e.g. a website, book, encyclopedia, newspaper, magazine, journal, etc.). 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. This parameter is most commonly used for books, and rarely for websites or periodicals (although it may be used instead ofwork in some cases). Omit where the publisher's name is substantially the same as the name of the work (for example, The New York Times Co. publishesThe New York Times newspaper, so there is no reason to name the publisher). Displays aftertitle.
  • place: For news stories with adateline, the location where the story was written. 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. In earlier versions of the template this was the publication place, and for compatibility, will be treated as the publication place if the publication-place parameter is absent; see that parameter for further information. Alias:location
  • publication-place: Geographical place of publication; generally not wikilinked; omit when the name of the work includes the publication place, for example,The Boston Globe,The Times of India. Displays after the title. If the name of the publication place changed over time, use the name as stated in the publication or used at the time of the source's publication. If only one ofpublication-place,place, orlocation is defined, it will be treated as the publication place and will show after the title; ifpublication-place andplace orlocation are defined, thenplace orlocation is shown before the title prefixed with "written at" andpublication-place is shown after the title.
  • publication-date: Date of publication when different from the date the work was written. Ifdate (oryear) is also defined and is different, thenpublication-date displays preceded by "published" and enclosed in parentheses, followingpublisher. Ifdate (oryear) is not defined,publication-date is displayed asdate. Use the same format as other dates in the article; do not wikilink.
  • via: Name of the content deliverer (ifdifferent frompublisher).via is not a replacement forpublisher, but provides additional detail. It may be used when the article is attributed to a different publication (e.g. inYahoo News) but cannot be traced, when the content deliverer (e.g.NewsBank) presents the source in a format different from the original, when the URL provided does not make clear the identity of the deliverer, where no URL or DOI is available (e.g.EBSCOhost), or if the deliverer requests attribution.See theaccess level parameters to display access restrictions, and theagency parameters if the original source is a news agency or wire service.

Options for this field:

  • |work=no suppresses "; ifwork is defined, thenpublisher andlocation are enclosed in parentheses"
  • |map=yes changes:
    • publisher: Name of publisher. Thepublisher is the company that publishes the work being cited. Do not use thepublisher 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.

newsgroup

[edit subtemplate]

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

language

[edit subtemplate]

  • language: The language (or a comma-separated list of the languages) in which the source is written, as either theISO 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 ofCategory: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.espagnol at a French-language wiki instead of the English word "Spanish". Aliases:lang

pages

[edit subtemplate]

  • page: The number of a single page in the source that supports the content. Use either|page= or|pages=, but not both. Displays preceded byp. 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 bypp. 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, usedouble 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&ndash;3-15. Alias:pp.
    • no-pp: Set toyes,y, ortrue to suppress thep. orpp. 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=, seehere.

Options for this field:

  • work adds "orwork (or an alias) is defined"

time

[edit subtemplate]

  • 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-caption: Changes the default text displayed beforetime.

id1

[edit subtemplate]

  • id: Aunique identifier, used where none of the specialized identifiers are applicable; wikilink or use anexternal 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 appendNCJ 122967 instead.

id2

[edit subtemplate]

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:arXividentifier; for example:|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:Amazon Standard Identification Number; if first character ofasin value is a digit, useisbn. Because this link favours one specific distributor, include it only if standard identifiers are not available. Example|asin=B00005N5PF. Aliases:ASIN.
    • asin-tld: ASIN top-level domain for Amazon sites other than the US; valid values:ae,au,br,ca,cn,de,es,fr,in,it,jp,mx,nl,pl,sa,se,sg,tr,uk. Aliases: none.
  • bibcode:bibcode; used by a number of astronomical data systems; for example:1974AJ.....79..819H. Aliases: none.
  • biorxiv:bioRxiv id, as in the entire DOI (e.g.10.1101/078733 forhttp://biorxiv.org/content/early/2016/10/01/078733 orhttps://doi.org/10.1101/078733;10.1101/2020.07.24.220400 forhttps://doi.org/10.1101/2020.07.24.220400). Aliases: none.
  • citeseerx:CiteSeerX id, a string of digits and dots found in a CiteSeerX URL (e.g.10.1.1.176.341 forhttps://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.176.341). Aliases: none.
  • doi:Digital object identifier; for example:10.1038/news070508-7. It is checked to ensure it begins with (10.). Aliases:DOI.
    • Supports accept-this-as-written markup to indicatevalid DOIs using a non-standard format, seebelow.
    • doi-broken-date: Date a valid DOI was found to be non-working/inactive athttps://doi.org. Use the same format as other dates in the article. Aliases: none.
  • eissn:International Standard Serial Number for the electronic media of a serial publication; eight characters may be split into two groups of four using ahyphen, but not anen dash or a space; example|eissn=1557-2986. Aliases:EISSN.
    • Supports accept-this-as-written markup to indicatevalid eISSNs using a non-standard format, seebelow.
  • hdl:Handle System identifier for digital objects and other resources on the Internet; example|hdl=20.1000/100. Aliases:HDL.
  • isbn:International Standard Book Number; for example:978-0-8126-9593-9.(SeeWikipedia:ISBN andISBN § Overview.) 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, usesbn. 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 withoutany 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.
    • Use the{{Format ISBN}} template within the parameter – in the form|isbn={{Format ISBN|9780812695939}} – if you are unsure of how any particular ISBN should be hyphenated, as the pattern varies by country and publisher.
    • Supports accept-this-as-written markup to indicatevalid ISBNs using a non-standard format, seebelow.
  • ismn:International Standard Music Number; for example: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 withoutany additional characters. It is checked for length, invalid characters – anything other than numbers, spaces, and hyphens – and the proper check digit. Aliases:ISMN.
  • issn:International Standard Serial Number; eight characters may be split into two groups of four using ahyphen, but not anen dash or a space; example|issn=2049-3630. Aliases:ISSN.
    • Supports accept-this-as-written markup to indicatevalid ISSNs using a non-standard format, seebelow.
  • jfm:Jahrbuch über die Fortschritte der Mathematik; do not include "JFM" in the value; example|jfm=53.0144.01. Aliases:JFM.
  • jstor:JSTOR reference number; for example:|jstor=3793107. Aliases:JSTOR.
  • lccn:Library of Congress Control Number. When present, alphabetic prefix characters are to be lower case and without a space; example|lccn=79-57364 or|lccn=2004042477 or|lccn=e09001178. Aliases:LCCN.
  • mr:Mathematical Reviews; example|mr=630583. Aliases:MR.
  • oclc:OCLC Number for looking up publications in theWorldCatunion catalog; example|oclc=9355469. Aliases:OCLC.
  • ol:Open Library identifier; do not include "OL" in the value; example|ol=7030731M. Aliases:OL.
  • osti:Office of Scientific and Technical Information; example|osti=4367507. Aliases:OSTI.
  • pmc:PubMed Central; use article number foropen repository full-text of a journal article, e.g.|pmc=345678. Do not include "PMC" in the value.See also thepmid parameter, below; these are two different identifiers. Aliases:PMC.
    • pmc-embargo-date: Date thatpmc goes live; if this date is in the future, thenpmc is not linked until that date. Aliases: none.
  • pmid:PubMed; use unique identifier; example|pmid=17322060See also thepmc parameter, above; these are two different identifiers. Aliases:PMID.
  • rfc:Request for Comments; example|rfc=3143. Aliases:RFC.
  • sbn:Standard Book Number; example|sbn=356-02201-3. Aliases:SBN.
    • Supports accept-this-as-written markup to indicatevalid SBNs using a non-standard format, seebelow.
  • ssrn:Social Science Research Network; example|ssrn=1900856. Aliases:SSRN.
  • s2cid:Semantic Scholar corpus ID; example|s2cid=37220927. Aliases:S2CID.
  • zbl:Zentralblatt MATH; example|zbl=0472.53010 For zbMATH search results likeJFM 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 specialaccept-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 theaccess 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 linkidentical 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 aconvenience link to a resource that would not otherwise be obviously accessible.

url

[edit subtemplate]

  • url: URL of an online location where the text of the publication named bytitle can be found. Cannot be used iftitle is wikilinked. If applicable, the link may point to the specific page(s) referenced. Remove tracking parameters from URLs, e.g.#ixzz2rBr3aO94 or?utm_source=google&utm_medium=...&utm_term=...&utm_campaign=....For linking to pages in PDF files or in Google Books, seeWP:PAGELINKS. Do not link to any commercial booksellers, such asAmazon; use|isbn= or|oclc= to provide neutral search links for books. Invalid URLs, including those containing spaces, will result in an error message.
    • access-date: Full date when the content pointed to byurl was last verified to support the text in the article; do not wikilink; requiresurl; use the same format as other access and archive dates in the citations.[date 1]Not required for linked documents that do not change. For example,access-date is required for online sources, such as personal websites, that do not have a publication date; seeWP:CITEWEB. Access dates are not required for links to published research papers or published books. Note thataccess-date is the date that the URL was found to be working and to support the text being cited. See"Automatic date formatting" above for details about interaction with{{use dmy dates}} and{{use mdy dates}}. Can behidden or styled by registered editors. Alias:accessdate.
    • archive-url: The URL of anarchived snapshot of a web page. Typically used to refer to services such asInternet Archive(seeHelp:Using the Wayback Machine) andarchive.today(seeHelp:Using archive.today); requiresarchive-date andurl. By default (overridden by|url-status=live) the archived link is displayed first, with the original link at the end. Alias:archiveurl.
      • archive-date: Archive service snapshot date; preceded in display by default text "archived from the original on". Use the same format as other access and archive dates in the citations. This does not necessarily have to be the same format that was used for citing publication dates.[date 1] Do not wikilink; templated dates are discouraged. See"Automatic date formatting" above for details about interaction with{{use dmy dates}} and{{use mdy dates}}. Alias:archivedate.
      • url-status: A control parameter to select one of|url= or|archive-url= to link|title=; requiresurlandarchive-url. Use{{dead link}} to mark dead|url= when there is no|archive-url=.
        Accepts multiple keywords:
        • 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 article
        • unfit – selects|archive-url=; used when|url= links to vice (gambling, pornography), advertising, malware, phishing, compromised, other malicious, or other unsuitablepage; links to|url= are suppressed in the rendering. If an entire domain is unsuitable, consider insteadusurpation orblacklist. Bot help is available atWP:URLREQ
        • usurped – selects|archive-url=; used when thedomain in|url= no longer serves its original intent, particularly when the domain has been (mis)appropriated by other entities such as vice, reseller, malware, phishing, compromised, other malicious, and advertising sites; links to|url= are suppressed in the rendering. Bot help is available atWP:URLREQ
        • bot: 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 inCategory: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.
      • archive-format: File format of the work referred to byarchive-url; for example: DOC or XLS; displayed in parentheses after the archive link. HTML is implied and should not be specified. PDF is auto-detected and should not be specified. Does not change theexternal link icon (except for PDF). Note: External link icons do not includealt text; thus, they do not add file format information for the visually impaired. (This is not a concern with PDF, because the auto-detection will add "(PDF)" as descriptive text.)SeeUsing |format=
    • url-access:SeeAccess indicators discussion
  • format: File format of the work referred to byurl; for example: DOC or XLS; displayed in parentheses aftertitle. (For media format, usetype.) HTML is implied and should not be specified. PDF is auto-detected and should not be specified. Does not change theexternal link icon (except for PDF). Note: External link icons do not includealt text; thus, they do not add file format information for the visually impaired. (This is not a concern with PDF, because the auto-detection will add "(PDF)" as descriptive text.)SeeUsing |format=

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

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

Characterspace"'<>[]{|}
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.

  1. ^abAccess-date and archive-date in references should all have the same format – either the format used for publication dates, or YYYY-MM-DD.SeeMOS:DATEUNIFY.

Options for this field:

  • media uses 'media' in place of 'text of the publication'

chapterurl

[edit subtemplate]

  • chapter-url: URL of an online location where the text of the publication named bychapter orcontribution can be found. Cannot be used if those parameters are wikilinked. Should be at the same site asurl, if any. Ifchapter-url is used,url should only be used if the beginning of the work and the cited chapter are on separate webpages at the site. Aliases:contribution-url,section-url.
  • chapter-format: Format of the work referred to bychapter-url; for example: PDF, DOC, or XLS; displayed in parentheses afterchapter. HTML is implied and should not be specified. Does not change theexternal link icon. Note: External link icons do not includealt text; thus, they do not add format information for the visually impaired.

quote

[edit subtemplate]

  • 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. Ifscript-quote is defined, usequote to hold aRomanization (if available) of the text inscript-quote. When quoting a copyrighted text, onlybrief quotations to attribute a point of view or idea are permitted; extensive quotations are prohibited.
    • 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 inquote (if available). Alias: none. Must be prefixed with one of thesupported 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 byp. 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 bypp. 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, usedouble 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

[edit subtemplate]

  • ref: the citation's HTML anchor identifier, when different from its default. When set,|ref=ID generates an anchor with the givenID (theid= attribute in the citation's<cite id="ID"> HTML tag). Setting|ref=ID identifies the template as a target and allowswikilinking to full references, especially useful with short-form citations likeshortened notes andparenthetical 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 shouldnot be used and may be removed from existing cs1|2 templates. To inhibit anchor ID creation, set|ref=none. Aliases: none.SeeTemplate:Citation/doc § Anchors for Harvard referencing templates.

display

[edit subtemplate]

  • 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...'). These styles correspond to Citation Style 1 and Citation Style 2 respectively. To override default terminal punctuation usepostscript.
  • author-mask:
  • contributor-mask:
  • editor-mask:
  • interviewer-mask:
  • subject-mask:
  • translator-mask:
    Replaces the name of the (first) author withem dashes or text. Set<name>-mask to a numeric valuen to set the dashn 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 asshortened 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.|authorn-mask=) to apply the mask to a specificname.
  • display-authors:
  • display-contributors:
  • display-editors:
  • display-interviewers:
  • display-subjects:
  • display-translators:
    Controls the number of author (or other kind of contributor) names that are displayed. By default, all authors are displayed. To change the displayed number of names, set the parameter 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 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.
  • 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 ifquote is defined.

Options for this field:

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

Subscription or registration required

[edit subtemplate]

Citations of online sources that require registration or a subscription are acceptable in Wikipedia as documented inVerifiability § 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 toverifying claims in articles.

Four access levels can be used:

  • access indicator for named identifiers:
    • Freely accessiblefree: the source is free to read for anyone
  • access indicators for url-holding parameters:
    • Free registration requiredregistration: 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 registration
    • Free access subject to limited trial, subscription normally requiredlimited: free access is subject to limited trial and a subscription is normally required
    • Paid subscription 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.

Access indicators for url-holding parameters
See also:WP:CONLINK

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 asfree. 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-holding and access-indicator parameters
URLAccessAllowed keywords
|url=|url-access=registrationFree registration required
limitedFree access subject to limited trial, subscription normally required
subscriptionPaid subscription required
|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:

"Nifty example data". 2021-04-15.
Access indicator for named identifiers

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 aslimited,registration, orsubscription.

Named-identifier and access-indicator parameters
IdentifierAccessAllowed keywords
|bibcode=|bibcode-access=freeFreely accessible
|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 an embargoedpmc that will become available in the future, seepmc-embargo-date.

Tracking of free DOIs
  • The template is able to recognize known free-to-readDOI registrants, based on a list inModule:Citation/CS1/Configuration. Once a free registrant is identified, the10.xxxx/... part of the DOI associated with the registrant can be added to the list underlocal function build_free_doi_registrants_table(). If|doi-access=free is not set, it will place the page inCategory:CS1 maint: unflagged free DOI, which is routinely cleared byUser:Citation bot.
  • The template is also able to recognize known free-to-read journals, assuming they have a clear10.xxxx/yyyy.... DOI pattern. Once that pattern is identified, it can be added toModule:Citation/CS1/Configuration underlocal extended_registrants_t = { with the format['XXXX'] = {'YYYY'},. If there are multiple journals with the same DOI prefix, they can be grouped together with the format['XXXX'] = {'YYYY', 'ZZZZ', '...'},.
  • If you add a free registrant/free journal to the lists inModule:Citation/CS1/Configuration, leave a note atUser talk:Citation bot so the bot knows about it.

map_series

[edit subtemplate]

  • scale: Scale of map.
  • series: Title of map series.
  • cartography: Person or entity that did the cartography, if this needs to be differentiated from general authorship of the map. Displays preceded by "Cartography by".

map_pages

[edit subtemplate]

  • page: Page in the source that supports the content; overridden byat.
  • 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.
  • inset: The name of the focused inset referenced; example: Downtown Fooburg. Output appends "inset" after the input,|inset=Downtown Fooburg becomes "Downtown Fooburg inset."; overridden byat.
  • section: The map section(s) of the feature referenced; example: A6, B9, L11, etc; overridden byat.
  • at: For sources where a single set of the above parameters is inappropriate or insufficient to describe the in-source location(s).
Examples: page (p.) or pages (pp.); inset(s); section (§) or sections (§§); other custom location on the map or in the atlas.

interview_author

[edit subtemplate]

  • last: Surname ofsubject, not interviewer. Do not wikilink—usesubject-link instead. Where the surname is usually written first—as in Chinese—or for corporate authors, simply uselast to include the same format as the source.
    • first: Given or first names of author, including title(s); example:Firstname Middlename orFirstname M. orFirstname M., Sr. Do not wikilink—usesubject-link instead.
    • OR: for multiple subjects, usefirstn,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, usesubject-linkn.
Aliases:subject,last,lastn,authorn,author,subjectn.

interview_interviewer

[edit subtemplate]

  • interviewer-last: Surname of a single interviewer. Do not wikilink—useinterviewer-link instead. For interviewers for whom only one name is listed by the source, useinterviewer or one of its aliases (e.g.|interviewer=Bono). Aliases:interviewer-last1,interviewer1-last,interviewer-surname,interviewer-surname1,interviewer1-surname,interviewer,interviewer1. Supportsaccept-this-as-written markup.
    • interviewer-first: Given or first names of interviewer; for example:Firstname Middlename orFirstname M. orFirstname M., Sr. Do not wikilink—useinterviewer-link instead. Aliases:interviewer-first1,interviewer1-first,interviewer-given,interviewer-given1,interviewer1-given. Requiresinterviewer-last; interviewer first name will not display ifinterviewer-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, useinterviewer-last1,interviewer-first1 throughinterviewer-lastn,interviewer-firstn, wheren is any consecutive number for an unlimited number of interviewer- (eachinterviewer-firstn requires a correspondinginterviewer-lastn, but not the other way around).See thedisplay parameters to change how many interviewers are displayed. Aliases ofinterviewer-last1 throughinterviewer-lastn:interviewer1 throughinterviewern. For an individual interviewer plus an interviewer with a single name, you can use|interviewer-first1=...|interviewer-last1=...|interviewer2=....

season

[edit subtemplate]

  • 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

[edit subtemplate]

  • 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

[edit subtemplate]

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

conference

[edit subtemplate]

  • conference: Name of the conference, may include location if different fromlocation and date if different fromdate oryear.
    • conference-url: URL of conference proceedings, if different fromurl.

Notes

  1. ^Thepipe trick does not work inside references, so be sure to insert a full wikilink.
  2. ^Comparearchived talk page.
General
templates
{{Cite book}}
books
{{Cite conference}}
conference papers
{{Cite document}}
short, stand-alone, offline documents
{{Cite encyclopedia}}
edited collections
{{Cite interview}}
interviews
{{Cite journal}}
academic journals
{{Cite magazine}}
magazines
{{Cite mailing list}}
public mailing lists
{{Cite map}}
maps
{{Cite news}}
news articles
{{Cite newsgroup}}
online newsgroups
{{Cite press release}}
press releases
{{Cite report}}
unpublished reports
{{Cite sign}}
signs, plaques
{{Cite speech}}
speeches
{{Cite tech report}}
technical reports
{{Cite thesis}}
theses
{{Cite web}}
web sources
Preprint templates
Audiovisual-related
Categories
Documentation
Policies and guidelines
General advice
Citing sources
Inline citations
Help for beginners
Advanced help
Footnote templates
Find references
Citation tools
(External links)
The abovedocumentation istranscluded fromTemplate:Citation Style documentation/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.
Retrieved from "https://en.wikipedia.org/w/index.php?title=Template:Citation_Style_documentation&oldid=1279729499"
Category:
Hidden category:
[8]ページ先頭
©2009-2026 Movatter.jp