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.
Copy a blank version to use. Almost all parameter names are supported only in lower case (some initialisms, such as |isbn= have upper-case aliases like |ISBN=, which are acceptable for use). Use the "|" (pipe) character between each parameter. Unused parameters may be deleted to avoid clutter in the edit window. Some samples on this documentation page may include the current date. If the date is not current, then purge the page.
Parameters to copy are enclosed in tables created by sub-templates.
Ta̱mpi̱let:End
The above set is organised contextually rather than alphabetically. The following parameters, which are usually available for at least a few cite templates, are not included in the full parameter set above: |authors=; |book-title=; |class=; |degree=; |docket=; |encyclopedia=; |mailing-list=; |message-id=; |number=; |publication-date=; |section=; |sheet=; |sheets=; |title-link=; |s2cid=.
The full vertical style can be implemented in a three-columns format (only practical when the number of parameters is not too extended) or in a four-columns format.
The full vertical style in three columns consists of a "Vertical list", "Prerequisites" and "Brief instructions / notes".
<!--* Start with: -->{{csdoc|usage vertical}}<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
* Separate the next column with:
-->
</pre>{{csdoc|usage vertical mid}}<prestyle="margin:0px;">
<!--
* Create the instructions column; blank lines must include a
* 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;">
last
</pre>{{csdoc|usage vertical mid}}<prestyle="margin:0px;">
same as last1
same as first1
</pre>{{csdoc|usage vertical end}}
Full parameter set in vertical format
Vertical list
Prerequisites
Brief instructions / notes
{{cite book
| last =
| first =
| author-link =
}}
last
same as last1
same as first1
If a field name is listed in the Prerequisites column, it is a prerequisite for the field to the left.
{|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.
|}
Copy a blank version to use. Almost all parameter names are supported only in lower case (some initialisms, such as |isbn= have upper-case aliases like |ISBN=, which are acceptable for use). Use the "|" (pipe) character between each parameter. Unused parameters may be deleted to avoid clutter in the edit window. Some samples on this documentation page may include the current date. If the date is not current, then purge the page.
Ta̱mpi̱let:End
{{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}}
department: Regular department or section within the periodical or journal. Examples include "Communication", "Editorial", "Letter to the Editor", and "Review". Displays after title and is in plain text.
series: The name of the series the episode belongs to; may be wikilinked.
series-link: name of an existing Wikipedia article; used to wikilink series; with proper interwiki prefix, may hold the name of an article at an other-language wikipedia; do not wikilink, do not use a URL.
|work=no suppresses "; if work is defined, then publisher and location are enclosed in parentheses"
|map=yes changes:
publisher: Name of publisher. The publisher is the company that publishes the work being cited. Do not use the publisher parameter for the name of a work (e.g., a book, encyclopedia, newspaper, magazine, journal, website). Displays before title. Do not wikilink—use publisher-link instead.
publisher-link: Title of existing Wikipedia article about the publisher—not the publisher's website; do not wikilink.
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 the ISO 639 language code (preferred) or the full language name. Examples: |language=ru; |lang=fr, pt-br; |lang=Russian; |language=French, Portuguese. See the list of supported codes and names. Do not use templates or wikilinks. Displays in parentheses with "in" before the language name or names. When the only source language is English, no language is displayed in the citation. The use of languages recognized by the citation module adds the page to the appropriate subcategory of Category:CS1 foreign language sources. Because cs1|2 templates are often copied from en.wiki to other wikis, the use of language codes is preferred so that language names render in the correct language and form, e.g. 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 by title can be found. Cannot be used if title 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 as Amazon; use |isbn= or |oclc= to provide neutral search links for books. Invalid URLs, including those containing spaces, will result in an error message.
access-date: Full date when the content pointed to by url was last verified to support the text in the article; do not wikilink; requires url; 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; see WP:CITEWEB. Access dates are not required for links to published research papers or published books. Note that access-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 be hidden or styled by registered editors. Alias: accessdate.
archive-url: The URL of an archived snapshot of a web page. Typically used to refer to services such as Internet ArchiveTa̱mpi̱let:Crossref and archive.todayTa̱mpi̱let:Crossref; requires archive-date and url. 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=; requires urlandarchive-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 unsuitable page; links to |url= are suppressed in the rendering. If an entire domain is unsuitable, consider instead usurpation or blacklist. Bot help is available at WP:URLREQ
usurped – selects |archive-url=; used when the domain in |url= no longer serves its original intent, particularly when the domain has been (mis)appropriated by other entities such as vice, reseller, malware, phishing, compromised, other malicious, and advertising sites; links to |url= are suppressed in the rendering. Bot help is available at WP: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 in Category:CS1 maint: bot: original URL status unknown when this value is present, and per the instructions in that category, editors manually evaluate the state of the URL and change the parameter value appropriately.
archive-format: File format of the work referred to by archive-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 the external link icon (except for PDF). Note: External link icons do not include alt 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 by url; for example: DOC or XLS; displayed in parentheses after title. (For media format, use type.) HTML is implied and should not be specified. PDF is auto-detected and should not be specified. Does not change the external link icon (except for PDF). Note: External link icons do not include alt 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
Options for this field:
media uses 'media' in place of 'text of the publication'
chapter-url: URL of an online location where the text of the publication named by chapter or contribution can be found. Cannot be used if those parameters are wikilinked. Should be at the same site as url, if any. If chapter-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 by chapter-url; for example: PDF, DOC, or XLS; displayed in parentheses after chapter. HTML is implied and should not be specified. Does not change the external link icon. Note: External link icons do not include alt text; thus, they do not add format information for the visually impaired.
|cs2=yes suppresses "When supplied, the citation terminator (a period by default) is suppressed, so the quote needs to include terminating punctuation."
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 given ID (the id= attribute in the citation's <cite id="ID"> HTML tag). Setting |ref=ID identifies the template as a target and allows wikilinking to full references, especially useful with short-form citations like shortened notes and parenthetical referencing. The default anchor ID is suitable for use with {{sfn}} and {{harv}} templates. Since April 2020, the parameter / keyword pair |ref=harv has no special meaning; this deprecated setting should not be used and may be removed from existing cs1|2 templates. To inhibit anchor ID creation, set |ref=none. Aliases: 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 in Verifiability § Access to sources. As a courtesy to readers and other editors, editors should signal restrictions on access to material provided via the external links included in a citation. These levels describe requirements or constraints related to accessing and viewing the cited material; they are not intended to indicate the ability to reuse, or the copyright status, of the material, since that status is not relevant to verifying claims in articles.
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 as free. If the registration/limited/subscription access to the source goes dead and is no longer available, then remove the access-indicator parameter and add |archive-url= and |archive-date= values if possible.
URL-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 as limited, registration, or subscription.
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 embargoed Script error: No such module "cs1 documentation support". that will become available in the future, see Script error: No such module "cs1 documentation support"..
The template is able to recognize known free-to-read DOI registrants, based on a list in Module:Citation/CS1/Configuration. Once a free registrant is identified, the 10.xxxx/... part of the DOI associated with the registrant can be added to the list under local function build_free_doi_registrants_table(). If |doi-access=free is not set, it will place the page in Category:CS1 maint: unflagged free DOI, which is routinely cleared by User:Citation bot.
The template is also able to recognize known free-to-read journals, assuming they have a clear 10.xxxx/yyyy.... DOI pattern. Once that pattern is identified, it can be added to Module:Citation/CS1/Configuration under local 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', '...'},.