Ta‌̱mpi‌̱let:Citation Style documentation

Template documentation[view] [edit] [history] [purge]

Usage

This template is used to build consistent documentation pages for Citation 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:

This Citation Style 1 template is used to create citations for .

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

Markup [[:Ta‌̱mpi‌̱let:	Renders as
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]
[markup]	[rendering]

Lua notice

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

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

Full horizontal style

• Start with {{csdoc|usage full}}
• Precede the sample markup with : to create an indent
• 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=}} 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=. 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}} <pre style="margin:0px;"> <!-- * Create the vertical list column * Separate the next column with: --> </pre> {{csdoc|usage vertical mid}} <pre style="margin:0px;"> <!-- * Create the prerequisites column; blank lines must include a &nbsp; * Separate the next column with: --> </pre> {{csdoc|usage vertical mid}} <pre style="margin:0px;"> <!-- * Create the instructions column; blank lines must include a &nbsp; * End with: --> </pre> {{csdoc|usage vertical end}} Example: {{csdoc|usage vertical}} <pre style="margin:0px;"> {{cite book | last = | first = | author-link = }} </pre> {{csdoc|usage vertical mid}} <pre style="margin:0px;"> &nbsp; &nbsp; last &nbsp; &nbsp; </pre> {{csdoc|usage vertical mid}} <pre style="margin:0px;"> &nbsp; same as last1 same as first1 &nbsp; &nbsp; </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. 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;" | <pre style="margin:0px; border:none;"> {{cite xxxxx |last1 = |first1 = |author-link1 = }} </pre> |- | {{tooltip|2=or any of its aliases, including: first; given1; given; author-first1; author-first; (etc.)|first1}} | {{tooltip|2=or any of its aliases, including: last; author1; author; author-last1; author-last; (etc.)|last1}} | Author's first name. Don't link. |- | {{tooltip|2=or any of its aliases, including: author-link; subject-link1; subject-link; (etc.)|author-link1}} | {{tooltip|2=or any of its aliases, including: last; author1; author; author-last1; author-last; (etc.)|last1}} | Title of Wikipedia article about the first author. Don't link. |} Full parameter set in vertical format Parameters Prerequisites Brief instructions / notes Vertical list Ta‌̱mpi‌̱let:Tooltip Author's last name or single name author. Don't link. {{cite xxxxx |last1 = |first1 = |author-link1 = |last2 = |first2 = |author-link2 = |last3 = |first3 = |author-link3 = |last4 = |first4 = |author-link4 = |last5 = |first5 = |author-link5 = |name-list-style = |vauthors = |translator-last1 = |translator-first1 = |translator-link1 = |translator-last2 = |translator-first2 = |translator-link2 = |collaboration = |contributor-last1 = |contributor-first1 = |contributor-link1 = |contributor-last2 = |contributor-first2 = |contributor-link2 = |others = |editor-last1 = |editor-first1 = |editor-link1 = |editor-last2 = |editor-first2 = |editor-link2 = |editor-last3 = |editor-first3 = |editor-link3 = |veditors = |title = |script-title = |trans-title = |work = |script-work = |trans-work = |issue = |department = |chapter = |script-chapter = |trans-chapter = |contribution = |type = |edition = |series = |series-link = |episode = |event = |agency = |volume = |date = |year = |orig-date = |df = |publisher = |location = |publication-place = |via = |language = |page = |pages = |no-pp = |at = |minutes = |time = |time-caption = |id = |arxiv = |asin = |asin-tld = |bibcode = |biorxiv = |citeseerx = |doi = |doi-broken-date = |eissn = |hdl = |sbn = |isbn = |ismn = |issn = |jfm = |jstor = |lccn = |mr = |oclc = |ol = |osti = |pmc = |embargo = |pmid = |rfc = |ssrn = |zbl = |url = |format = |archive-url = |archive-format = |url-status = |archive-date = |chapter-url = |chapter-format = |access-date = |no-tracking = |quote = |ref = |mode = |author-mask1 = |author-mask2 = |author-mask3 = |author-mask4 = |author-mask5 = |display-authors = |translator-mask1 = |translator-mask2 = |display-translators = |contributor-mask1 = |contributor-mask2 = |display-contributors = |editor-mask1 = |editor-mask2 = |editor-mask3 = |display-editors = |postscript = |url-access = |chapter-url-access = |bibcode-access = |doi-access = |hdl-access = |jstor-access = |ol-access = |osti-access = |map = |script-map = |trans-map = |map-url = |map-format = |map-url-access = |scale = |cartography = |inset = |sections = |interviewer-last1 = |interviewer-first1 = |interviewer-link1 = |interviewer-last2 = |interviewer-first2 = |interviewer-link2 = |interviewer-mask1 = |interviewer-mask2 = |display-interviewers = |season = |series-number = |series-separator = |network = |station = |transcript = |transcript-url = |transcript-format = |conference = |conference-url = |conference-format = }} Ta‌̱mpi‌̱let:Tooltip Ta‌̱mpi‌̱let:Tooltip Author's first name. Don't link. Ta‌̱mpi‌̱let:Tooltip Ta‌̱mpi‌̱let:Tooltip Title of Wikipedia article about the first author. Don't link. Ta‌̱mpi‌̱let:Tooltip Ta‌̱mpi‌̱let:Tooltip Like last1, but for 2nd author. Ta‌̱mpi‌̱let:Tooltip Ta‌̱mpi‌̱let:Tooltip Like first1, but for 2nd author. Ta‌̱mpi‌̱let:Tooltip Ta‌̱mpi‌̱let:Tooltip Like author-link1, but for 2nd author. Ta‌̱mpi‌̱let:Tooltip Ta‌̱mpi‌̱let:Tooltip Like last1, but for 3rd author. Ta‌̱mpi‌̱let:Tooltip Ta‌̱mpi‌̱let:Tooltip Like first1, but for 3rd author. Ta‌̱mpi‌̱let:Tooltip Ta‌̱mpi‌̱let:Tooltip Like author-link1, but for 3rd author. Ta‌̱mpi‌̱let:Tooltip Ta‌̱mpi‌̱let:Tooltip Like last1, but for 4th author. Ta‌̱mpi‌̱let:Tooltip Ta‌̱mpi‌̱let:Tooltip Like first1, but for 4th author. Ta‌̱mpi‌̱let:Tooltip Ta‌̱mpi‌̱let:Tooltip Like author-link1, but for 4th author. Ta‌̱mpi‌̱let:Tooltip Ta‌̱mpi‌̱let:Tooltip Like last1, but for 5th author. Similar: last6, etc. Ta‌̱mpi‌̱let:Tooltip Ta‌̱mpi‌̱let:Tooltip Like first1, but for 5th author. Similar: first6, etc. Ta‌̱mpi‌̱let:Tooltip Ta‌̱mpi‌̱let:Tooltip Like author-link1, but for 5th author. Similar: author-link6, etc. name-list-style vanc to emulate Vancouver style vauthors translator-last1 translator-first1 translator-last1 translator-link1 translator-last1 translator-last2 translator-last1 Additional translators: translator-last3, etc. translator-first2 translator-last2 translator-link2 translator-last2 collaboration contributor-last1 contributor-first1 contributor-link1 contributor-last2 contributor-first2 contributor-link2 others editor-last1 editor-first1 editor-last1 editor-link1 editor-last1 editor-last2 editor-last1 editor-first2 editor-last2 editor-link2 editor-last2 editor-last3 editor-last2 editor-first3 editor-last3 editor-link3 editor-last3 veditors title script-title trans-title title or script-title work script-work trans-work work or script-work issue department chapter Chapter title can be wikilinked unless when a chapter-url is given script-chapter trans-chapter chapter or script-chapter contribution type edition Ordinal number series series-link episode event agency volume date year orig-date date or year df publisher location publisher publication-place via language page choose one: "page", "pages", or "at" pages choose one: "page", "pages", or "at". Use when content on multiple pages supports the article text. no-pp page or pages set no-pp to "yes" to suppress the "p." or "pp." before page numbers at choose one: "page", "pages", or "at" minutes time time-caption id arxiv asin asin-tld bibcode biorxiv citeseerx doi doi-broken-date doi eissn hdl sbn isbn always include ISBN, if one has been assigned ismn issn jfm jstor lccn mr oclc ol osti pmc embargo pmid rfc ssrn zbl url title or script-title format url archive-url archive-date, url archive-format url-status archive-url archive-date archive-url chapter-url chapter or script-chapter chapter-format chapter-url access-date url no-tracking quote ref mode cs1 or cs2 author-mask1 last1 author-mask2 last2 author-mask3 last3 author-mask4 last4 author-mask5 last5 Ta‌̱mpi‌̱let:Tooltip Ta‌̱mpi‌̱let:Tooltip number (number of authors displayed) or etal (more authors) translator-mask1 translator-last1 translator-mask2 translator-last2 display-translators contributor-mask1 contributor-mask2 display-contributors editor-mask1 editor-last1 editor-mask2 editor-last2 editor-mask3 editor-last3 display-editors postscript url-access chapter-url-access bibcode-access doi-access hdl-access jstor-access ol-access osti-access map script-map trans-map map-url map-format map-url-access scale cartography inset sections interviewer-last1 interviewer-first1 interviewer-link1 interviewer-last2 interviewer-first2 interviewer-link2 interviewer-mask1 interviewer-mask2 display-interviewers season series-number series-separator network station transcript transcript-url transcript-format conference conference-url conference-format If a field name is listed in the Prerequisites column it is a prerequisite for the field to the left. Additional parameters (available for at least some cite templates) |authors= |book-title= |class= |degree= |docket= |encyclopedia= |mailing-list= |message-id= |number= |publication-date= |section= |sheet= |sheets= |title-link= (available from late April 2020) |s2cid= Sub-templates Usage Copy a blank version to use. Almost all parameter names are supported only in lower case (some initialisms, such as |isbn= have upper-case aliases like |ISBN=, which are acceptable for use). Use the "|" (pipe) character between each parameter. Unused parameters may be deleted to avoid clutter in the edit window. Some samples on this documentation page may include the current date. If the date is not current, then the page. Ta‌̱mpi‌̱let:End Usage full Full parameter set in horizontal format Usage common Most commonly used parameters in horizontal format Usage vertical Full parameter set in vertical format Vertical list Prerequisites Brief instructions / notes Usage vertical mid Usage vertical end If a field name is listed in the Prerequisites column, it is a prerequisite for the field to the left. Examples section Use {{markup2}} to format the examples Ta‌̱mpi‌̱let:Crossref. {{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 COinS sep_period sep_comma required whats new What's new or changed recently Parameter Description Date N/A deprecated author 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 for last. editor title Options for this field: title_title sets the display title: encyclopedia = encyclopedia default = title web chapter Options for this field: title_format sets the display format: italics = Displays in italics. work = If work is defined, then title is displayed in quotes, else displays in italics. default = Displays in quotes. title_title sets the display title: booktitle = booktitle default = chapter type Options for this field: type_default: Adds "Defaults to type_default" journal Options for this field: department adds: department: Regular department or section within the periodical or journal. Examples include "Communication", "Editorial", "Letter to the Editor", and "Review". Displays after title and is in plain text. edition series series or version: When the source is part of a series, such as a book series or a journal where the issue numbering has restarted. series_episode 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. event agency volume date Options for this field: limited_param_list hides orig-date because not allowed in limited-parameter templates publisher Options for this field: |work=no suppresses "; if work is defined, then publisher and location are enclosed in parentheses" |map=yes changes: publisher: Name of publisher. The publisher is the company that publishes the work being cited. Do not use the publisher parameter for the name of a work (e.g., a book, encyclopedia, newspaper, magazine, journal, website). Displays before title. Do not wikilink—use publisher-link instead. publisher-link: Title of existing Wikipedia article about the publisher—not the publisher's website; do not wikilink. newsgroup language : The language (or a comma-separated list of the languages) in which the source is written, as either the ISO 639 language code (preferred) or the full language name. Examples: |language=ru; |lang=fr, pt-br; |lang=Russian; |language=French, Portuguese. See the list of supported codes and names. Do not use templates or wikilinks. Displays in parentheses with "in" before the language name or names. When the only source language is English, no language is displayed in the citation. The use of languages recognized by the citation module adds the page to the appropriate subcategory of Category:CS1 foreign language sources. Because cs1|2 templates are often copied from en.wiki to other wikis, the use of language codes is preferred so that language names render in the correct language and form, e.g. espagnol at a French-language wiki instead of the English word "Spanish". Aliases: pages Options for this field: work adds "or work (or an alias) is defined" time id1 id2 url 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. 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 Archive Ta‌̱mpi‌̱let:Crossref and archive.today Ta‌̱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. 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 url and archive-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 url-access: 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 Options for this field: media uses 'media' in place of 'text of the publication' chapterurl 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. quote 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 : 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: . Ta‌̱mpi‌̱let:Crossref display Options for this field: cs2: When set, changes: postscript to "defaults to none" separator to "Defaults to a comma (,)" Subscription or registration required Citations of online sources that require registration or a subscription are acceptable in Wikipedia as documented in Verifiability § Access to sources. As a courtesy to readers and other editors, editors should signal restrictions on access to material provided via the external links included in a citation. These levels describe requirements or constraints related to accessing and viewing the cited material; they are not intended to indicate the ability to reuse, or the copyright status, of the material, since that status is not relevant to verifying claims in articles. Four access levels can be used: access indicator for named identifiers: free: the source is free to read for anyone access indicators for url-holding parameters: 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. Access indicators for url-holding parameters Bu nwuan: 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 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}} 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 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 that will become available in the future, see . Tracking of free DOIs 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', '...'},. If you add a free registrant/free journal to the lists in Module:Citation/CS1/Configuration, leave a note at User talk:Citation bot so the bot knows about it. map_series map_pages interview_author interview_interviewer season network transcript conference Notes Ta‌̱mpi‌̱let:Citation Style 1 Ta‌̱mpi‌̱let:Wikipedia referencing The above documentation is transcluded from Ta‌̱mpi‌̱let: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.