This template is used on1,380,000+ pages, or roughly 21877% of all pages. To avoid major disruption and server load, any changes should be tested in the template's/sandbox or/testcases subpages, or in your ownuser subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on thetalk page before implementing them.
Ghyuap a̱si̱ Lua: expandTemplate: template "Citation Style documentation/cs1" does not existThisCitation Style 1 template is used to createcitations for news articles in print, video, audio or web.
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.
Most commonly used parameters in horizontal format
Before 2014, editors needed to decide whether to use {{Cite web}} or{{Cite news}} based on their features. In 2014, however,most of the differences between the two templates were eliminated.
As ofTa̱mpi̱let:Diff,{{Cite web}} and{{Cite news}} have the following differences:
{{Cite news}} can be used foroffline (paper) sources whereas{{Cite web}} generates a missing URL error when no URL is provided
{{cite news |last=Bourmaud |first=François-Xavier |date=2013-10-17 |title=Hollande dans le bourbier de l'affaire Leonarda |trans-title=Hollande in the quagmire of the Leonarda case |url=http://www.lefigaro.fr/politique/2013/10/17/01002-20131017ARTFIG00575-hollande-dans-le-bourbier-de-l-affaire-leonarda.php |language=French |work=Le Figaro |location=Paris |access-date=2013-10-17}}
A clipped and archived news article that you quote, found on an information aggregation service requiring a subscription
{{cite news |url=https://www.newspapers.com/clip/30201172/daily_news/ |title=Czechs honor Yuri |date=30 April 1961 |newspaper=Daily News|access-date=2 April 2019|archive-url=https://web.archive.org/web/20190402233429/https://www.newspapers.com/clip/30201172/daily_news/|archive-date=2 April 2019|url-status=live |agency=Reuters |location=New York |page=35 |via=Newspapers.com |quote=Czech President [[Antonin Novotny]] today made visiting Soviet spaceman Yuri Gagarin a 'Hero of Socialist Labor'.}}
Displays as:
"Czechs honor Yuri".Daily News. New York. Reuters. 30 April 1961. p. 35.Archived from the original on 2 April 2019. Retrieved2 April 2019 – via Newspapers.com.Czech PresidentAntonin Novotny today made visiting Soviet spaceman Yuri Gagarin a 'Hero of Socialist Labor'.
Ghyuap a̱si̱ Lua: expandTemplate: template "Citation Style documentation/title" does not exist
Script error: No such module "cs1 documentation support".: 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:Script error: No such module "cs1 documentation support".
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=....Ta̱mpi̱let:Crossref 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]: {{[[Template:{{{1}}}|{{{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 ArchiveTa̱mpi̱let:Crossref andarchive.todayTa̱mpi̱let:Crossref; 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]: {{[[Template:{{{1}}}|{{{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.)Ta̱mpi̱let:Crossref
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.)Ta̱mpi̱let:Crossref
↑1.01.1Access-date and archive-date in references should all have the same format – either the format used for publication dates, or YYYY-MM-DD.Ta̱mpi̱let:Crossref
Script error: No such module "cs1 documentation support".: 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:Script error: No such module "cs1 documentation support"..Ta̱mpi̱let:Crossref
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.
registration: 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
limited: free access is subject to limited trial and a subscription is normally required
subscription: 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 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
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}}
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
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 embargoedScript error: No such module "cs1 documentation support". that will become available in the future, seeScript error: No such module "cs1 documentation support"..
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', '...'},.
Script error: No such module "cs1 documentation support".
This template formats a citation to a news article in print, video, audio or web using the provided source information (e.g. author, publication, date) and various formatting options.
The surname of the author; don't wikilink, use 'author-link'.
Line
suggested
First name
firstfirst1
Given or first name, middle names, or initials of the author; don't wikilink, use 'author-link'.
Line
suggested
Author link
author-linkauthor-link1author1-link
Title of existing Wikipedia article about the author; can suffix with a numeral to add additional authors
Page name
optional
Last name 2
last2author2
The surname of the second author; don't wikilink, use 'author-link2'.
Unknown
optional
First name 2
first2
Given or first name, middle names, or initials of the second author; don't wikilink.
Unknown
optional
Author link 2
author-link2author2-link
Title of existing Wikipedia article about the second author. (Up to nine authors can be listed, 3-9 are toward the end of the parameter list)
Page name
optional
Last name 3
last3author3
The surname of the third author; don't wikilink, use 'author-link3'.
Unknown
optional
First name 3
first3
Given or first name, middle names, or initials of the third author; don't wikilink.
Unknown
optional
Author link 3
author-link3author3-link
Title of existing Wikipedia article about the third author.
Page name
optional
Last name 4
last4author4
The surname of the fourth author; don't wikilink, use 'author-link4'.
Unknown
optional
First name 4
first4
Given or first name, middle names, or initials of the fourth author; don't wikilink.
Unknown
optional
Author link 4
author-link4author4-link
Title of existing Wikipedia article about the fourth author.
Page name
optional
Last name 5
last5author5
The surname of the fifth author; don't wikilink, use 'author-link5'.
Unknown
optional
First name 5
first5
Given or first name, middle names, or initials of the fifth author; don't wikilink.
Unknown
optional
Author link 5
author-link5author5-link
Title of existing Wikipedia article about the fifth author.
Page name
optional
Last name 6
last6author6
The surname of the sixth author; don't wikilink, use 'author-link6'.
Unknown
optional
First name 6
first6
Given or first name, middle names, or initials of the sixth author; don't wikilink.
Unknown
optional
Author link 6
author-link6author6-link
Title of existing Wikipedia article about the sixth author.
Page name
optional
Last name 7
last7author7
The surname of the seventh author; don't wikilink, use 'author-link7'.
Unknown
optional
First name 7
first7
Given or first name, middle names, or initials of the seventh author; don't wikilink.
Unknown
optional
Author link 7
author-link7author7-link
Title of existing Wikipedia article about the seventh author.
Page name
optional
Last name 8
last8author8
The surname of the eighth author; don't wikilink, use 'author-link8'.
Unknown
optional
First name 8
first8
Given or first name, middle names, or initials of the eighth author; don't wikilink.
Unknown
optional
Author link 8
author-link8author8-link
Title of existing Wikipedia article about the eighth author.
Page name
optional
Last name 9
last9author9
The surname of the ninth author; don't wikilink, use 'author-link9'. If nine authors are defined, then only eight will show and 'et al.' will show in place of the last author.
Unknown
optional
First name 9
first9
Given or first name, middle names, or initials of the ninth author; don't wikilink.
Unknown
optional
Author link 9
author-link9author9-link
Title of existing Wikipedia article about the ninth author.
Page name
optional
Display authors
display-authors
number of authors to display before 'et al.' is used;
Number
optional
Author mask
author-mask
Replaces the name of the first author with em dashes or text; set to a numeric value 'n' to set the dash 'n' em spaces wide; set to a text value to display the text without a trailing author separator; for example, 'with' instead
String
optional
Name list style
name-list-style
Set to 'amp' or 'and' to change the separator between the last two names of the name list to ' & ' or ' and ', respectively. Set to 'vanc' to display name lists in Vancouver style.
String
optional
Others
others
Used to record other contributions to the work, such as 'Illustrated by John Smith' or 'Translated by John Smith'
String
optional
Source date
date
Full date of the source; do not wikilink
Date
suggested
Year of publication
year
Year of the source being referenced; use 'date' instead, if month and day are also known
String
optional
Original date
orig-date
Original date of publication; provide specifics
String
optional
Source title
title
The title of the article as it appears in the source; displays in quotes
String
required
Script title
script-title
For titles in languages that do not use a Latin-based alphabet (Arabic, Chinese, Cyrillic, Greek, Hebrew, Japanese, Korean, Vietnamese, etc). Prefix with two-character ISO639-1 language code followed by a colon. For Japanese use: |script-title=ja:...
String
optional
Language
language
The language in which the source is written, if not English; use the full language name; do not use icons or templates
String
optional
Translated title
trans-title
An English language title, if the source cited is in a foreign language; 'language' is recommended
String
optional
Edition
edition
When the publication has more than one edition; for example: '2nd', 'Revised' etc.; suffixed with ' ed.'
String
optional
Volume
volume
For one publication published in several volumes. Usually a number. Do not prepend with vol. or v.
Example
3
String
optional
Page
page
Page in the source that supports the content; displays after 'p.'
String
optional
Pages
pages
Pages in the source that support the content (not an indication of the number of pages in the source); displays after 'pp.'
Example
2–3
String
suggested
No pp
no-pp
Set to 'y' to suppress the 'p.' or 'pp.' display with 'page' or 'pages' when inappropriate (such as 'Front cover')
Auto value
y
Boolean
optional
At
at
May be used instead of 'page' or 'pages' where a page number is inappropriate or insufficient
String
optional
Name of publication
workjournalmagazineperiodicalnewspaperwebsite
Name of the newspaper, magazine or periodical; displays after title
Example
[[The Wall Street Journal]]
String
suggested
Publisher
publisherinstitution
Name of the parent institution or company that publishes the newspaper, magazine, or periodical; displays after name of the publication
Example
[[Gannett]]
String
optional
Agency
agency
The news agency (wire service) that provided the content; examples: Associated Press, Reuters, Agence France-Presse
String
optional
Issue
issuenumber
Issue identifier when the source is part of a series that is published periodically. Usually a number. Do not prepend with no.
Example
4
Line
optional
Department
department
Department within the periodical
String
optional
Location of publication
locationplace
Geographical place of publication; usually not wikilinked; omit when the publication name includes place; alias of 'place'
String
optional
Place of publication
publication-place
Publication place shows after title; if 'place' or 'location' are also given, they are displayed before the title prefixed with 'written at'
String
optional
Publication date
publication-date
Date of publication when different from the date the work was written; do not wikilink
The surname of the editor; don't wikilink, use 'editor-link'; can suffix with a numeral to add additional editors; alias of 'editor1-last', 'editor', and 'editors'
Given or first name, middle names, or initials of the editor; don't wikilink, use 'editor-link'; can suffix with a numeral to add additional editors; alias of 'editor1-first'
Unknown
optional
Editor link
editor-linkeditor-link1
Title of existing Wikipedia article about the editor; can suffix with a numeral to add additional editors; alias of 'editor1-link'
Page name
optional
Type
type
Additional information about the media type of the source; format in sentence case
String
optional
Format
format
Format of the work referred to by 'url'; examples: PDF, DOC, XLS; do not specify HTML
String
optional
URL
urlURL
The URL of the online location where the text of the publication can be found. Requires schemes of the type "http://..." or maybe even the protocol relative scheme "//..."
Example
https://www.nytimes.com/...
URL
suggested
URL status
url-status
If set to 'live', the title display is adjusted; useful for when the URL is archived preemptively but still live. Set to "dead" or 'usurped' for broken links. Entering 'unfit' or 'usurped' makes the original link not appear at all.
Suggested values
deadliveusurpedunfit
Default
'dead' if an Archive URL is entered
Example
'dead' or 'live'
String
optional
URL access level
url-access
Classification of the access restrictions on the URL ('registration', 'subscription' or 'limited')
Suggested values
registrationsubscriptionlimited
String
optional
URL access date
access-date
The full date when the original URL was accessed; do not wikilink
Date
suggested
Archive URL
archive-url
The URL of an archived copy of a web page, if or in case the URL becomes unavailable; requires 'archive-date'
String
optional
Archive date
archive-date
Date when the original URL was archived; do not wikilink
String
optional
arXiv identifier
arxiv
An identifier for arXive electronic preprints of scientific papers
String
optional
ASIN
asin
Amazon Standard Identification Number; 10 characters
String
optional
ASIN TLD
asin-tld
ASIN top-level domain for Amazon sites other than the US
International Standard Book Number; use the 13-digit ISBN where possible
String
optional
ISSN
issnISSN
International Standard Serial Number; 8 characters; may be split into two groups of four using a hyphen
String
optional
jfm code
jfm
Jahrbuch über die Fortschritte der Mathematik classification code
String
optional
JSTOR
jstor
JSTOR identifier
String
optional
LCCN
lccn
Library of Congress Control Number
String
optional
MR
mr
Mathematical Reviews identifier
String
optional
OCLC
oclc
Online Computer Library Center number
String
optional
OL
ol
Open Library identifier
String
optional
OSTI
osti
Office of Scientific and Technical Information identifier
String
optional
PMC
pmc
PubMed Center article number
String
optional
PMID
pmid
PubMed Unique Identifier
String
optional
RFC
rfc
Request for Comments number
String
optional
SSRN
ssrn
Social Science Research Network
String
optional
Zbl
zbl
Zentralblatt MATH journal identifier
String
optional
id
id
A unique identifier used where none of the specialized ones are applicable
String
optional
Quote
quote
Relevant text quoted from the source; displays last, enclosed in quotes; needs to include terminating punctuation
String
optional
Ref
ref
An anchor identifier; can be made the target of wikilinks to full references; special value 'harv' generates an anchor suitable for the harv and sfn templates
String
optional
Postscript
postscript
The closing punctuation for the citation; ignored if 'quote' is defined; to suppress use reserved keyword 'none'
Default
.
String
optional
via
via
Identify the aggregator of the resource that provided the digital version (usually a database provider), when it differs from the publisher (e.g., for The Wikipedia Library)
Example
[[EBSCOHost]], [[Proquest]], [[Newspapers.com]]
String
optional
Bibcode access level
bibcode-access
If the full text is available from ADS via this Bibcode, type 'free'.
Suggested values
free
String
optional
DOI access level
doi-access
If the full text is free to read via the DOI, type 'free'.
Suggested values
free
String
optional
HDL access level
hdl-access
If the full text is free to read via the HDL, type 'free'.
Suggested values
free
String
optional
Jstor access level
jstor-access
If the full text is free to read on Jstor, type 'free'.
Suggested values
free
String
optional
OpenLibrary access level
ol-access
If the full text is free to read on OpenLibrary, type 'free'.
Suggested values
free
String
optional
OSTI access level
osti-access
If the full text is free to read on OSTI, type 'free'.
