Template:Citation Style documentation/doc

From Zoophilia Wiki
Jump to navigationJump to search

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 template subpage; each module of text is a subpage that can be edited using the normal link for doing so.

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 use cases
  • Parameters: detailed descriptions of each parameter
    • Syntax: overview of the template syntax
    • Deprecated: list of deprecated parameters
    • Description: parameter descriptions separated by function in the following order:
      • Authors
      • Title
      • Date
      • Publisher
      • Edition, series, volume
      • In-source locations
      • URL
      • Anchor
      • Identifiers
      • Quote
      • Editors
      • Display options

Lead section

Use {{Citation Style documentation|lead|content type}} to create consistent content for the lead:

[edit subtemplate]

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

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

Markup Renders as
{{Citation Style documentation|lead|books}}

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

Lua notice

[edit subtemplate]

Usage section

Start the usage section with {{Citation Style documentation|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 | (vertical bar or "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 subtemplates.

Full horizontal style

  • Start with {{Citation Style documentation|usage full}}
  • Precede the sample markup with : to create an indent
  • Enclose the sample in <code><nowiki>...</nowiki></code>
  • Close the table with {{End}}
{{Citation Style documentation|usage full}}
:<code><nowiki>{{Cite … |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 (inline layout)
{{Cite … |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= and |s2cid=.

Most commonly used horizontal style

  • Start with {{Citation Style documentation|usage common}}
  • Precede the sample markup with : to create an indent
  • Enclose the sample in <code><nowiki>...</nowiki></code>
  • Close the table with {{End}}
{{Citation Style documentation|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 (inline layout)
{{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-column format (only practical when the number of parameters is not overextended) or in a four-column format.

Three-columns

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

<!--
* Start with: 
-->
{{Citation Style documentation|usage vertical}}
<pre style="margin: 0;"><!--
* Create the vertical list column
* Separate the next column with:
-->
| style="vertical-align: top;" |
<!--
* Create the prerequisites column; blank lines must include a  
* Separate the next column with:
-->
| style="vertical-align: top;" |
<!--
* Create the instructions column; blank lines must include a  
* End with:
-->
|}
  • If a field name is listed in the Prerequisites column, it is a prerequisite for the field to the left.

Example:

{{Citation Style documentation|usage vertical}}
<pre style="margin: 0;">{{Cite book
 | last                  = 
 | first                 = 
 | author-link           = 
}}
| style="vertical-align: top;" |
 
 
last
 
 
| style="vertical-align: top;" |
 
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

{| class="wikitable"
 |+ Full parameter set in vertical format
 ! Parameters !! Prerequisites !! Brief instructions / notes !! Vertical list
 |-
 | {{Tooltip|last1|or any of its aliases, including: last; author1; author; author-last1; author-last; (etc.)}}
 | 
 | Author's last name or single name author; don't link.
 | rowspan="3" style="vertical-align: top;" | <pre style="border: none; margin: 0;">
{{Cite …
 | last1                = 
 | first1               = 
 | author-link1         = 
}}
|-
| first1
| last1
| Author's first name; don't link.
|-
| author-link1
| last1
| Title of the Zoophilia Wiki article about the first author; don't link.
|}
Full parameter set in vertical format
Parameters Prerequisites Brief instructions / notes Vertical list
last1 Author's last name or single name author; don't link.
{{Cite …
  | last1                = 
  | first1               = 
  | author-link1         = 
  | last2                = 
  | first2               = 
  | author-link2         = 
  | last3                = 
  | first3               = 
  | author-link3         = 
  | last4                = 
  | first4               = 
  | author-link4         = 
  | last5                = 
  | first5               = 
  | author-link5         = 
  | name-list-style      = 
  | vauthors             = 
  | translator-last1     = 
  | translator-first1    = 
  | translator-link1     = 
  | translator-last2     = 
  | translator-first2    = 
  | translator-link2     = 
  | collaboration        = 
  | contributor-last1    = 
  | contributor-first1   = 
  | contributor-link1    = 
  | contributor-last2    = 
  | contributor-first2   = 
  | contributor-link2    = 
  | others               = 
  | editor-last1         = 
  | editor-first1        = 
  | editor-link1         = 
  | editor-last2         = 
  | editor-first2        = 
  | editor-link2         = 
  | editor-last3         = 
  | editor-first3        = 
  | editor-link3         = 
  | veditors             = 
  | title                = 
  | script-title         = 
  | trans-title          = 
  | work                 = 
  | script-work          = 
  | trans-work           = 
  | issue                = 
  | department           = 
  | chapter              = 
  | script-chapter       = 
  | trans-chapter        = 
  | contribution         = 
  | type                 = 
  | edition              = 
  | series               = 
  | series-link          = 
  | episode              = 
  | event                = 
  | agency               = 
  | volume               = 
  | date                 = 
  | year                 = 
  | orig-date            = 
  | df                   = 
  | publisher            = 
  | location             = 
  | publication-place    = 
  | via                  = 
  | language             = 
  | page                 = 
  | pages                = 
  | no-pp                = 
  | at                   = 
  | minutes              = 
  | time                 = 
  | time-caption         = 
  | id                   = 
  | arxiv                = 
  | asin                 = 
  | asin-tld             = 
  | bibcode              = 
  | biorxiv              = 
  | citeseerx            = 
  | doi                  = 
  | doi-broken-date      = 
  | eissn                = 
  | hdl                  = 
  | sbn                  = 
  | isbn                 = 
  | ismn                 = 
  | issn                 = 
  | jfm                  = 
  | jstor                = 
  | lccn                 = 
  | mr                   = 
  | oclc                 = 
  | ol                   = 
  | osti                 = 
  | pmc                  = 
  | embargo              = 
  | pmid                 = 
  | rfc                  = 
  | ssrn                 = 
  | zbl                  = 
  | url                  = 
  | format               = 
  | archive-url          = 
  | archive-format       = 
  | url-status           = 
  | archive-date         = 
  | chapter-url          = 
  | chapter-format       = 
  | access-date          = 
  | no-tracking          = 
  | quote                = 
  | ref                  = 
  | mode                 = 
  | author-mask1         = 
  | author-mask2         = 
  | author-mask3         = 
  | author-mask4         = 
  | author-mask5         = 
  | display-authors      = 
  | translator-mask1     = 
  | translator-mask2     = 
  | display-translators  = 
  | contributor-mask1    = 
  | contributor-mask2    = 
  | display-contributors = 
  | editor-mask1         = 
  | editor-mask2         = 
  | editor-mask3         = 
  | display-editors      = 
  | postscript           = 
  | url-access           = 
  | chapter-url-access   = 
  | bibcode-access       = 
  | doi-access           = 
  | hdl-access           = 
  | jstor-access         = 
  | ol-access            = 
  | osti-access          = 
  | map                  = 
  | script-map           = 
  | trans-map            = 
  | map-url              = 
  | map-format           = 
  | map-url-access       = 
  | scale                = 
  | cartography          = 
  | inset                = 
  | sections             = 
  | interviewer-last1    = 
  | interviewer-first1   = 
  | interviewer-link1    = 
  | interviewer-last2    = 
  | interviewer-first2   = 
  | interviewer-link2    = 
  | interviewer-mask1    = 
  | interviewer-mask2    = 
  | display-interviewers = 
  | season               = 
  | series-number        = 
  | series-separator     = 
  | network              = 
  | station              = 
  | transcript           = 
  | transcript-url       = 
  | transcript-format    = 
  | conference           = 
  | conference-url       = 
  | conference-format    = 
 }}
first1 last1 Author's first name; don't link.
author-link1 last1 Title of Zoophilia Wiki article about the first author; don't link.
last2 last1 Like last1, but for the second author.
first2 last2 Like first1, but for the second author.
author-link2 last2 Like author-link1, but for the second author.
last3 last2 Like last1, but for the third author.
first3 last3 Like first1, but for the third author.
author-link3 last3 Like author-link1, but for the third author.
last4 last3 Like last1, but for the fourth author.
first4 last4 Like first1, but for the fourth author.
author-link4 last4 Like author-link1, but for the fourth author.
last5 last4 Like last1, but for the fifth author. Similar: last6, etc.
first5 last5 Like first1, but for the fifth author. Similar: first6, etc.
author-link5 last5 Like author-link1, but for the fifth author. Similar: author-link6, etc.
name-list-style vanc to emulate Vancouver style
vauthors
translator-last1
translator-first1 translator-last1
translator-link1 translator-last1
translator-last2 translator-last1 Additional translators: translator-last3, etc.
translator-first2 translator-last2
translator-link2 translator-last2
collaboration
contributor-last1
contributor-first1
contributor-link1
contributor-last2
contributor-first2
contributor-link2
others
editor-last1
editor-first1 editor-last1
editor-link1 editor-last1
editor-last2 editor-last1
editor-first2 editor-last2
editor-link2 editor-last2
editor-last3 editor-last2
editor-first3 editor-last3
editor-link3 editor-last3
veditors
title
script-title
trans-title title or script-title
work
script-work
trans-work work or script-work
issue
department
chapter Chapter title can be wikilinked unless when a chapter-url is given
script-chapter
trans-chapter chapter or script-chapter
contribution
type
edition Ordinal number
series
series-link
episode
event
agency
volume
date
year
orig-date date or year
df
publisher
location publisher
publication-place
via
language
page choose one: "page", "pages", or "at"
pages choose one: "page", "pages", or "at". Use when content on multiple pages supports the article text.
no-pp page or pages set no-pp to "yes" to suppress the "p." or "pp." before page numbers
at choose one: "page", "pages", or "at"
minutes
time
time-caption
id
arxiv
asin
asin-tld
bibcode
biorxiv
citeseerx
doi
doi-broken-date doi
eissn
hdl
sbn
isbn always include ISBN, if one has been assigned
ismn
issn
jfm
jstor
lccn
mr
oclc
ol
osti
pmc
embargo
pmid
rfc
ssrn
zbl
url title or script-title
format url
archive-url archive-date, url
archive-format
url-status archive-url
archive-date archive-url
chapter-url chapter or script-chapter
chapter-format chapter-url
access-date url
no-tracking
quote
ref
mode cs1 or cs2
author-mask1 last1
author-mask2 last2
author-mask3 last3
author-mask4 last4
author-mask5 last5
display-authors last1 number (number of authors displayed) or etal (more authors)
translator-mask1 translator-last1
translator-mask2 translator-last2
display-translators
contributor-mask1
contributor-mask2
display-contributors
editor-mask1 editor-last1
editor-mask2 editor-last2
editor-mask3 editor-last3
display-editors
postscript
url-access
chapter-url-access
bibcode-access
doi-access
hdl-access
jstor-access
ol-access
osti-access
map
script-map
trans-map
map-url
map-format
map-url-access
scale
cartography
inset
sections
interviewer-last1
interviewer-first1
interviewer-link1
interviewer-last2
interviewer-first2
interviewer-link2
interviewer-mask1
interviewer-mask2
display-interviewers
season
series-number
series-separator
network
station
transcript
transcript-url
transcript-format
conference
conference-url
conference-format
If a field name is listed in the Prerequisites column it is a prerequisite for the field to the left.
Additional parameters (available for at least some cite templates)
|authors=
|book-title=
|class=
|degree=
|docket=
|encyclopedia=
|mailing-list=
|message-id=
|number=
|publication-date=
|section=
|sheet=
|sheets=
|title-link=
(available from late April 2020) |s2cid=

Subtemplates

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 | (vertical bar or "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.

|}

Usage full

[edit subtemplate]

Full parameter set (inline layout)

Usage common

[edit subtemplate]

Most commonly used parameters (inline layout)

Usage vertical

[edit subtemplate]

Full parameter set (block layout)
Vertical list Prerequisites Instructions / Notes

Usage vertical mid

[edit subtemplate]

| style="vertical-align: top;" |

|}

Usage vertical end

[edit subtemplate]

|}

  • 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 (see that template's documentation for usage guidance).

{{Markup2|t=Basic usage with url and edition
 | m = <nowiki>{{Cite book|title=Mysterious book|url=https://www.example.com/|edition=2nd}}</nowiki>
 | 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 of parent
    • child—may be used with parent (and is ignored if parent is not used)
    • OR: child2—may be used instead of child (and is ignored if parent2 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 embeds COinS metadata in the HTML output, allowing reference management software to retrieve bibliographic metadata. (See Wikipedia:COinS) As a general rule, supply only one data item per parameter and do not include explanatory or alternate text.

  • Use |date=September 27, 2007, not |date=September 27, 2007 (print version September 25, 2007).

Use of other templates as parameter values for {{Citation}}-family templates is discouraged because many of them add supplementary HTML or CSS code that will be included verbatim in the COinS metadata. Also, HTML entities such as &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 while other are aliases of another parameter, and some require other parameters to be present. A full list of this template's supported parameters, its aliases and their dependencies is shown in the § Usage section near the top of this documentation page.

  • |periodical=, |journal=, |newspaper=, |magazine=, |work=, |website=, |encyclopedia=, |encyclopaedia= and/or |dictionary=
  • |chapter=, |script-chapter=, |contribution=, |script-contribution=, |entry=, |script-entry=, |article=, |script-article=, |section= and/or |script-section=
  • |title=, |script-title= and/or |book-title=
  • |publication-place=, |place= and/or |location=
  • |date=, |year= and/or |publication-date=
  • |series= and/or |version=
  • |volume=, |issue= and/or |number=
  • |page=, |pages=, |at=, |quote-page= and/or |quote-pages=
  • |edition=
  • |publisher= and/or |institution=
  • |url=, |chapter-url=, |contribution-url= and/or |section-url=
  • |author-last=, |author-last#=, |author#-last=, |author-surname=, |author-surname#=, |author#-surname=, |last=, |last#=, |surname=, |surname#=, |author=, |author#=, |subject=, |subject#=, |host= and/or |host#=
  • |author-first=, |author-first#=, |author#-first=, |author-given=, |author-given#=, |author#-given=, |first=, |first#=, |given= and/or |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= and/or |zbl=

sep_period

[edit subtemplate]

By default, sets of fields are terminated with a full stop . or "period."

sep_comma

[edit subtemplate]

Template:Citation Style documentation/sep comma

required

[edit subtemplate]

This parameter is required and will generate an error if not defined. On errors, Main, Help and Template namespace pages are placed into Category:Articles with incorrect citation syntax. Set |no-tracking=true to disable categorization; mainly used for in-place documentation where the error is demonstrated.

whats new

[edit subtemplate]

What's new or changed recently
Parameter Description Date
N/A

deprecated

[edit subtemplate]

Deprecated CS1/CS2 parameters
Deprecated parameter(s) Replacement parameter(s) Date Note
None deprecated at present.
Recently removed CS1/CS2 parameters
Removed parameter(s) Replacement parameter(s) Date Note
|authors= |lastn= / |firstn=, |authorn= or |vauthors= August 2024

author

[edit subtemplate]

  • last: Surname of a single author; do not wikilink—use author-link instead. Use this or one of its aliases for corporate authors or those for whom only one name is listed by the source (e.g. |author=Bono). Aliases: surname, author, lastn, surnamen, authorn.
    • author: The name of an organizational author (e.g. a committee) or the complete name (given names and surname) of a single person; for the latter, prefer the use of first and last. This parameter should never hold the information of more than a single author. Supports accept-this-as-written markup. Do not use italics in this field, as doing so produces corrupt metadata.
    • first: Given or first names of a single author, as in Firstname Middlename or Firstname M. or Firstname M. Sr.; do not wikilink—use author-link instead. Requires last, first name will not display if last is undefined. Aliases: given, firstn, givenn.
    • For multiple authors use last1, first1 through lastn, firstn, where n is any consecutive number for an unlimited number of authors (each firstn requires a corresponding lastn, but not the other way around. See the display parameters to change how many authors are displayed.) Aliases: surname1, given1 through surnamen, givenn, or author1 through authorn. For an individual author along with an institutional author, you can use |first1=…, |last1=… and |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.
      • For multiple authors use author-link1 through author-linkn. Aliases: author1-link through authorn-link.
    • name-list-style: One of the following keywords:
      • amp, ampersand or &: Inserts an ampersand between the last two entries in the list of names.
      • and: Inserts the conjunction 'and' between the last two entries in the list of names.
      • vanc: Displays listed names in Vancouver style when the lists use the last/first forms of the author name parameters.
  • vauthors: A comma-delimited list of author names in Vancouver style; enclose corporate or institutional author names in doubled parentheses and conclude with "et al." if appropriate (e.g. |vauthors=Smythe JB, ((Megabux Corp.)), et al.).
    • author-link and author-mask: Used for the individual names in |vauthors= as described above.
  • authors: Deprecated. Free-form list of author names; use of this parameter is discouraged because it does not contribute to a citation's metadata. Not an alias of last.
  • translator-last: The surname of a single translator; do not wikilink—use translator-link instead. Aliases: translator-surname, translator1, translator1-last, translator-last1. Supports accept-this-as-written markup.
    • translator-first: The given or first names of a single translator; do not wikilink—use translator-link instead. Aliases: translator-given, translator1-first, translator-first1.
    • For multiple translators use translator-last1, translator-first1 through translator-lastn, translator-firstn, where n is any consecutive number for an unlimited number of translators (each translator-firstn requires a corresponding translator-lastn, but not the other way around). Aliases: translator1-last, translator1-first through translatorn-last, translatorn-first, or translator1 through translatorn.
    • translator-link: The title of an existing Wikipedia article about the translator—not the translator's website; do not wikilink. Aliases: translator-link1, translator1-link.
    • For multiple translators use translator-link1 through translator-linkn. Aliases: translator1-link through translatorn-link.
  • collaboration: The name of a group of authors or collaborators; requires author, last or vauthors listing one or more primary authors; follows author name-list, appending "et al." when needed.
  • Note: When using {{Sfnote}} or {{Paren}} 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 records other contributors to the work, such as "Illustrated by…" or "Trans. …"
  • |aliases= add aliases for last

editor

[edit subtemplate]

  • editor-last: The surname of a single editor; do not wikilink—instead use editor-link. Where the surname is usually written first—as in Chinese—or for corporate authors, simply use editor-last to include the same format as the source. Aliases: editor-last1, editor1-last, editor-surname, editor-surname1, editor1-surname, editor and editor1.
    • editor: This parameter is used to hold the complete name of a single editor (first, middle and last, with honorifics, post-nominals and suffixes) or the name of an editorial committee. This parameter should never hold the names of more than one individual editor, save collectively.
    • editor-first: The given or first names of a single editor, including title(s); do not wikilink—instead use editor-link. Examples: Firstname Middlename, Firstname M., Dr. Firstname M., Sr.. Aliases: editor-first1, editor1-first, editor-given, editor-given1 and editor1-given.
    • For multiple editors, use editor-last1, editor-first1 through editor-lastn, editor-firstn. For an individual editor plus an institutional editor, use |editor-first1=…, |editor-last1=… and |editor2=…. Aliases: editorn-last, editor-surnamen or editorn-surname; editorn-first, editor-givenn or editorn-given; editorn.
    • editor-link: The title of an existing Wikipedia article about the editor—not the editor's website; do not wikilink. Aliases: editor-link1.
    • For multiple editors, use editor-link1 through editor-linkn. Alias: editorn-link.
    • name-list-style: One of the following keywords:
      • amp, ampersand or &: Inserts an ampersand between the last two entries in the list of names.
      • and: Inserts the conjunction 'and' between the last two entries in the list of names.
      • vanc: Displays listed names in Vancouver style when the lists use the last/first forms of the author name parameters.
  • veditors: A comma-delimited list of editor names in Vancouver style; enclose corporate or institutional editor names in doubled parentheses and conclude with "et al." if appropriate. Example: |veditors=Smythe JB, ((Megabux Corp.)), et al.
    • editor-linkn and editor-maskn may be used for the individual names in veditors, as described above.
  • Display: Use display-editors to control the length of the displayed editor name list, and to specify when "et al." is included.
    • If authors are listed: Authors are first, followed by the included work, then "In" and the editors, then the main work.
    • If no authors are listed: Editors appear before the included work; a single editor is followed by "ed." while multiple editors are followed by "eds."

title

[edit subtemplate]

See also: Help:Citation Style 1 § Titles and chapters.
  • title: Title of source. Can be wikilinked to an existing Zoophilia Wiki article or url may be used to add an external link, but not both. Displays in italics. If script-title is defined, use title to hold a Romanization (if available) of the title in script-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, following italicized Romanization defined in title (if present). Must be prefixed with one of the supported 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 after title. Use of the language parameter is recommended.
Titles containing certain characters will not display and link correctly unless those characters are encoded.
New line [ ] |
space &#91; &#93; {{!}} (preferred)
{{Bracket|text}} &verbar; or &#124; – See also Help:Table § Rendering the pipe
  • title-link: Title of existing Zoophilia Wiki article about the source named in title – do not use a web address and do not wikilink.

Options for this field:

title_title sets the display title:

  • encyclopedia = encyclopedia
  • default = title

web

[edit subtemplate]

See also: Help:Citation Style 1 § Titles and chapters
  • title: The title of the source page, displays in quotation marks. For titles containing quotation marks, convert double quotation marks (") to single quotation marks ('). If script-title is defined, use title to hold a Romanization (if available) of the title in script-title.
    • script-title: The original title, for languages that do not use a Latin-alphabet script (Arabic, Chinese, Cyrillic, Greek, Hebrew, Japanese, Korean, etc.); follows Romanization defined in title (if present). Must be prefixed with one of the supported language codes to help browsers properly display the script:
      …|title=Tōkyō tawā|script-title=ja:東京タワー|trans-title=Tokyo Tower…
    • trans-title: The English translation of the title, if the source cited is in a foreign language; displays in square brackets after title with trans-title included in the link. Use of the language 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 also Help:Table § Rendering pipe itself.
This parameter is required and will generate an error if not defined. On errors, Main, Help and Template namespace pages are placed into Category:Articles with incorrect citation syntax. Set |no-tracking=true to disable categorization; mainly used for in-place documentation where the error is demonstrated.
  • website: The title of the hosting website of the source (when the website has a clear name, use that rather than the domain name), shown in italics; may be wikilinked. Aliases: work.

chapter

[edit subtemplate]

  • chapter: The chapter heading of the source, may be wikilinked or may use chapter-url, but not both. Displays in quotes. If script-chapter is defined, use chapter to hold a Romanization (if available) of the title in script-chapter.
    • script-chapter: Chapter heading for languages that do not use a Latin-based script (Arabic, Chinese, Cyrillic, Greek, Hebrew, Japanese, Korean, etc.); follows Romanization defined in chapter (if present). Must be prefixed with one of the supported 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 the chapter field. If chapter-url is defined, then trans-chapter is included in the link. Use of the language parameter is recommended.
  • contribution: A separately-authored part of author's book; may be wikilinked or may use contribution-url, but not both. Values of Afterword, Foreword, Introduction, or Preface will display unquoted; any other value will display in quotation marks. The author of the contribution is given in contributor.

Options for this field:

title_format sets the display format:

  • italics displays in italics.
  • work displays title in "quotes" if work is defined, 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 displayed in parentheses following the title; may alternatively be used to identify the type of manuscript linked to in the title, if not the manuscript's final version (e.g. if a preprint of a manuscript is freely available, but the version of record is behind a paywall). Format in sentence case. The reserved keyword |type=none can be used to disable the display of a type, if desired. Examples: Thesis, Booklet, Accepted manuscript, CD liner, Press release. Alias: medium.

Options for this field:

  • type_default adds "Defaults to type_default"

journal

[edit subtemplate]

  • work (required by {{Cite journal}} and {{Cite magazine}}): The name of the work containing the source (may be wikilinked if relevant), displayed in italics. If the name of the periodical changed over time, provide the name in use at the time of the source's publication. If script-work is defined, use work to hold a Romanization (if available) of the title in script-work using Latin script; for languages written in non-Latin based scripts (Arabic, Chinese, Cyrillic, Greek, Hebrew, Indic, Japanese, Korean, etc.) use a standard Romanization in this field. Aliases: journal, newspaper, magazine, periodical, website.
    • script-work: The work's title in its original, non-Latin script; shown unitalicized following the italicized Romanization defined in work (if present). Must be prefixed with one of the supported 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: The English translation of the work's title if the source cited is in a foreign language, displayed in square brackets after work or script-work, as in …|work=Zhōngguó piàofáng|script-work=zh:中国票房|trans-work=China Box Office|…. Aliases: trans-journal, trans-newspaper, trans-magazine, trans-periodical, trans-website.
    • issue: Used to indicate when the publication is one of a series that is published periodically, displayed in parentheses following volume (if present). 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 issue and number designations (typically one being year-relative and the other an independently incrementing value), provide them both in one parameter, for example |issue=2 #143. Alias: number.
    • When set, work changes the formatting of other parameters in the same citation:
      • title is not italicized and is enclosed in quotes, and
      • chapter is not displayed (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 after title 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: For use when the source is part of a series, such as a book series or a journal, where the issue numbering has restarted. Aliases: version.

series_episode

[edit subtemplate]

Template:Citation Style documentation/series episode

event

[edit subtemplate]

Template:Citation Style documentation/event

agency

[edit subtemplate]

  • agency: The news 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, use work or publisher. May be wikilinked if relevant.

volume

[edit subtemplate]

  • volume: For one publication published in several volumes, displays after the title and series fields; volume numbers should be entered as a bare number, e.g. 37. Volume values that are wholly digits, 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]

  • date: The date of the referenced source, displayed after the authors enclosed in parentheses; can be a full date (month, day and year) or partial (month and year, season and year, or year). Use same format as other publication dates in the citations[date 1] and do not wikilink. If there is no author, then displays after the website and publisher. For acceptable date formats, see Help: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 or ref is required to disambiguate the link targets.

For no date, or "undated", use |date=n.d., and for approximate years precede with "c. ", as in |date=c. 1900.
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 a created or updated date; a comment for editors such as |date=2021-12-25<!-- Date from page source. -->|orig-date=Original date 2011-01-01 can be added.
  • year: The year of publication, however the more flexible date parameter detailed above also handles a year by itself. Do not use in combination with the |date= parameter, unless both of the following conditions are met:
    1. Shortened footnotes target multiple citations with same last name and year of publication. This situation warrants a citation reference anchor disambiguator, usually a lowercase letter suffixed to the year.)
    2. The |date= value is formatted as YYYY-MM-DD, which prevents the addition of a disambiguating letter to the year.
  • orig-date: The original publication date or year, displayed in square brackets after the date or year; 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, by |cs1-dates=) or as used in the |date= parameter. Alias: orig-year.
  • df: The date format for rendered dates; does not support date ranges or seasonal dates and overrides the automatic date formatting described above. Accepts one keyword value which may be one of:
    • mdy – Set publication dates to month day, year format; access- and archive-dates are not modified
    • dmy – As above for day month year format
    • ymd – As above for year-first numeric format YYYY-MM-DD
    • mdy-all – Set publication, access- and archive-dates to month day, year format
    • dmy-all – As above for day month year format
    • ymd-all – As above for year-first 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.

Options for this field:

  • limited_param_list hides orig-date because not allowed in limited-parameter templates

publisher

[edit subtemplate]

  • publisher: The name of the publisher of the source, displayed after title; may be wikilinked[publishers 1] if relevant. The publisher is the company, organization or other legal entity that publishes the work being cited. Do not use the publisher parameter for the name of a work (e.g. a website, book, encyclopedia, newspaper, magazine, journal, etc.). If the name of the publisher changed over time, provide 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. Not normally used for periodicals. Omit where the publisher's name is substantially the same as the name of the work (for example, The New York Times Co. publishes The New York Times newspaper, so there is no reason to name the publisher).
  • place: For news stories with a dateline, 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. This will be treated as the place of publication if the publication-place parameter is absent; see below for further information. Alias: location.
  • publication-place: The geographical place of publication shown after title, generally not wikilinked; omit when the name of the work includes the publication place, as in The Boston Globe or The Times of India. If the name of the publication place changed over time, use the name as stated in the publication or in use at the time of the source's publication. If only one of publication-place, place or location is defined, it will be treated as the place of publication and be shown after the title; however if publication-place is defined along with place or location then the latter is shown before the title prefixed with "written at" and publication-place is shown after the title.
  • publication-date: The source's date of publication, when different from the date it was written. If date (or year) is also defined and holds a different value, then publication-date displays preceded by "published" and enclosed in parentheses, following publisher. If date (or year) is not defined, publication-date is displayed as date. Use the same format as other dates in the article and do not wikilink.
  • via: The name of the content deliverer (if different from publisher); not a replacement for publisher but providing additional detail to it. It may be used 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 (EBSCO), or if the deliverer requests attribution. See the access level parameters to display access restrictions.

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 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, but use publisher-link instead.
    • publisher-link: title of existing Zoophilia Wiki article about the publisher—not the publisher's website; do not wikilink.

newsgroup

[edit subtemplate]

Template:Citation Style documentation/newsgroup

language

[edit subtemplate]

  • language: The language or a comma-delimited list of the languages in which the source is written, as either the ISO 639 language code(s) (preferred) or the full language name, displayed in parentheses after the title with "in" before the language name or names. Examples: |language=ru; |lang=fr, pt-PT; |lang=Russian; |language=French, Portuguese. See the list of supported codes and names. Do not use templates or wikilinks. 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. Aliases: lang

pages

[edit subtemplate]

  • page: The number of a single page in the source that supports the content, shown preceded by p. unless |no-pp=yes; use either page or pages, but not both. 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.
  • pages: A range of pages in the source that supports the content, shown preceded by pp. unless |no-pp=yes; use either page or pages, but not both. Separate sequential pages using an en dash (–) and non-sequential pages with a comma (,); do not use to indicate the total number of pages in the source. If hyphens are appropriate because individual page numbers contain hyphens, for example: pp. 3-1–3-15, use double parentheses to tell the template to display the value without processing it and {{Hyphen}} to indicate to other editors that a hyphen is really intended, as in |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 to yes, y, or true to suppress the "p." or "pp." page notations where inappropriate; for example, where |page=Front cover or |pages=passim.
  • 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), see here.

Options for this field:

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

time

[edit subtemplate]

Template:Citation Style documentation/time

id1

[edit subtemplate]

  • id: A unique identifier, used where none of the specialized identifiers are applicable; wikilink or use an external link template as applicable. For example, |id=CoL 4JQ8 will append "CoL 4JQ8" at the end of the citation (see {{Catalogue of Life}}), or you can use templates such as |id={{MSW3|id=13801049|pages=391–393}} to append Template:MSW3 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: An arXiv document identifier, for example: |arxiv=hep-th/9205027 (pre-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: An Amazon Standard Identification Number (ASIN); if the first character is a digit, use isbn instead. Example: |asin=B00005N5PF. Aliases: ASIN.
    • asin-tld: The top-level domain for Amazon sites used to resolve the asin value (other than the US); valid values are: ae (United Arab Emirates), au (Australia), br (Brazil), ca (Canada), cn (People's Republic of China), de (Germany), es (Spain), fr (France), in (India), it (Italy), jp (Japan), mx (Mexico), nl (the Netherlands), pl (Poland), sa (Saudi Arabia), se (Sweden), sg (Singapore), tr (Turkey), uk (United Kingdom). Aliases: none.
  • bibcode: A Bibcode reference identifier, used by a number of astronomical data systems. Example: |bibcode=1974AJ.....79..819H. Aliases: none.
  • biorxiv: A bioRxiv ("Bio Archive") ID, as in the entire DOI. Example: |biorxiv=10.1101/078733 for https://biorxiv.org/content/early/2016/10/01/078733 or |biorxiv=10.1101/2020.07.24.220400 for https://doi.org/10.1101/2020.07.24.220400. Aliases: none.
  • citeseerx: A CiteSeerX ID, the string of digits and dots found in a CiteSeerX URL. Example: |citeseerx=10.1.1.176.341 for https://citeseerx.ist.psu.edu/viewdoc/summary?doi=10.1.1.176.341. Aliases: none.
  • doi: A digital object identifier (DOI). Example: |doi=10.1038/news070508-7. It must begins with 10. to successfully pass validation. Aliases: DOI.
    • Supports accept-this-as-written markup to bypass the validation process for DOIs using a non-standard format.
    • doi-broken-date: The date a valid DOI was found to be non-working or inactive at https://doi.org/; use the same format as other dates in the article. Aliases: none.
  • eissn: An International Standard Serial Number for the electronic media (eISSN) of a serial publication, consisting of eight characters that may be split into two groups of four using a hyphen, but not an en dash or a space. Example: |eissn=1557-2986. Aliases: EISSN.
  • hdl: A Handle System identifier for digital objects and other resources on the Internet. Example: |hdl=20.1000/100. Aliases: HDL.
  • isbn: An International Standard Book Number (ISBN); use the code actually printed on or in the book, giving preference to the newer 13-digit format beginning with 978/979 when it is available, though the older 10-digit format still generates valid links if that is the only one present. Do not convert a 10-digit code to the 13-digit format just by adding the 978 prefix; the terminal digit is a calculated checksum and making changes to the numbers will make the code invalid. Hyphens in the ISBN are optional, but preferred. 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). (See WP:ISBN and ISBN § Overview.) For sources with the even older 9-digit Standard Book Number (SBN) codes, use sbn. This parameter should hold only the ISBN, without any additional information; it is checked for length and invalid characters: anything other than numbers, spaces and hyphens, with "X" permitted as the last character for the 10-digit format or the proper check digit. Example: |isbn=978-0-8126-9593-9. 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 value should be hyphenated, as the pattern varies by country and publisher.
    • Supports accept-this-as-written markup to bypass the validation process for ISBNs using a non-standard format.
  • ismn: An International Standard Music Number (ISMN); use the ISMN actually printed on or in the work, hyphens or spaces are optional. This parameter should hold only the ISMN code without any additional information; it is checked for length and invalid characters: anything other than numbers, spaces and hyphens, and the proper check digit. Example: |ismn=979-0-9016791-7-7. Aliases: ISMN.
  • issn: An International Standard Serial Number (ISSN), consisting of eight characters which may be split into two groups of four using a hyphen, but not an en dash or a space. Example: |issn=2049-3630. Aliases: ISSN.
  • jfm: A Jahrbuch über die Fortschritte der Mathematik identifier (German for 'Yearbook on the Progress of Mathematics'); do not include "JFM" in the value. Example: |jfm=53.0144.01. Aliases: JFM.
  • jstor: A Journal Storage (JSTOR) reference number. Example: |jstor=3793107. Aliases: JSTOR.
  • lccn: A Library of Congress Control Number (LCCN); when present, alphabetic prefix characters are to be lower case and without a space. Examples: |lccn=79-57364, |lccn=2004042477, |lccn=e09001178. Aliases: LCCN.
  • mr: A Mathematical Reviews (MR) identifier. Example: |mr=630583. Aliases: MR.
  • oclc: An OCLC Control Number (OCN) for looking up publications in the WorldCat union catalog. Example: |oclc=9355469. Aliases: OCLC.
  • ol: An Open Library (OL) identifier; do not include "OL" in the value. Example: |ol=7030731M. Aliases: OL.
  • osti: An Office of Scientific and Technical Information (OSTI) identifier. Example: |osti=4367507. Aliases: OSTI.
  • pmc: A PubMed Central (PMC) identifier; use article number for open repository full-text of a journal article and do not include "PMC" in the value. (Also see the pmid parameter; these are two distinct identifiers.) Example: |pmc=345678. Aliases: PMC.
    • pmc-embargo-date: The date that the PubMed Central identifier specified in pmc goes live; if this date is in the future, then the pmc link is not displayed until that date. Aliases: none.
  • pmid: A PubMed unique identifier. (Also see the pmc parameter; these are two distinct identifiers.) Example: |pmid=17322060. Aliases: PMID.
  • rfc: An IETF Request for Comments (RFC) number. Example: |rfc=3143. Aliases: RFC.
  • sbn: A Standard Book Number (SBN) code consisting of nine digits, optionally formatted using hyphens or spaces. Do not include "SBN" in the value. Example: |sbn=356-02201-3. Aliases: SBN.
  • ssrn: A Social Science Research Network (SSRN) numeric identifier. Example: |ssrn=1900856. Aliases: SSRN.
  • s2cid: A Semantic Scholar corpus ID. Example: |s2cid=37220927. Aliases: S2CID.
  • zbl: A zbMATH Open (formerly Zentralblatt MATH) document ID code. For zbMATH search results like JFM 35.0387.02, use |jfm=35.0387.02 instead. Example: |zbl=0472.53010. Aliases: ZBL.

In very rare cases, identifiers are published which do not follow their defined standard format, or use non-conforming checksums, which would typically cause an error message to be shown by the CS1 & CS2 template families. If you encounter such a situation, do not alter them to match a different checksum. In order to suppress the error message, some identifiers (doi, eissn, isbn, issn and sbn) support a special accept-this-as-written markup which can be applied to disable the templates' error-checking function (as |<param>=((<value>))). However, if the problem is down to a mere typographical error in a third-party source, correct the identifier value instead of overriding the error message.

For some identifiers, it is possible to specify the access status using the corresponding |<param>-access= parameter.

For {{Cite journal}}, some identifiers (specifying free resources) will automatically be linked to the title when the url and title-link parameters are not present to explicitly define a link target. This behaviour can be overridden by one of a number of special keywords for the title-link parameter to manually select a specific source (such as |title-link=pmc or |title-link=doi) for auto-linking, or to disable the feature (with |title-link=none).

It is not necessary to specify a URL to a link identical to a link also produced by an identifier. The url parameter (or title-link) can then be used for providing a direct deep link to the corresponding document, or a convenience link to a resource that would not otherwise be obviously accessible.

url

[edit subtemplate]

  • url: The 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. Use isbn or oclc to provide neutral search links for books, and 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, see Wikipedia:PAGELINKS.) Invalid URLs, including those containing spaces, will result in an error message.
    • access-date: The full date when the content pointed to by url was last verified to resolve successfully and 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] Not required for linked documents that do not change, such as links to published research papers or published books. For example, access-date is required for online sources, such as personal websites, that do not have a publication date; see Wikipedia:Citing sources § Web pages. Can be hidden or styled by registered editors. Alias: accessdate.
    • url-access: See § Access indicators for url-holding parameters.
    • archive-url: The URL of an archived snapshot of a web page, typically used to refer to services such as Internet Archive (see Using the Wayback Machine) and archive.today (see Using archive.today); 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: The archive service's snapshot-date, displayed with "archived from the original on date" prepended; 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. Alias: archivedate.
      • archive-format: The file format of the work referred to by archive-url, such DOC or XLS; displayed in parentheses after the archive snapshot link (HTML is implied and should not be specified). PDF is auto-detected and need not be specified; does not change the external link icon, except for PDFs. Note: External link icons do not include alt text, thus they do not add file format information for the visually impaired, but this is not a concern for PDFs because the auto-detection will add "(PDF)" as descriptive text. (See Using |format=.)
    • url-status: A control parameter to select one of url or archive-url to link title to; requires url and archive-url. Use {{Dead link}} to mark dead URLs when there is no archive service snapshot link.
      Accepts multiple keywords:
      • dead – Default condition when url-status is undefined or value is null; links title to archive-url.
      • live – Links title to url; use when original source is preemptively archived with an archive service while it still resolves.
      • deviated – Use when url still resolves but the content no longer supports the text in the wiki article; links title to archive-url.
      • unfit – Use when source page contains elements related to vice (gambling, pornography), advertising or other unsuitable content; links title to archive-url and suppresses url in the rendered article. If an entire domain is unsuitable, consider using the usurped keyword instead.
      • usurped – Use when the domain in url no longer serves its original intent, particularly when the domain has been (mis)appropriated by other entities such as vice, reseller and advertising sites; links title to archive-url and suppresses links to url in the rendered page.
  • format: The file format of the work referred to by url, such as DOC or XLS; displayed in parentheses after title. For media formats, use type; HTML is implied and should not be specified, while PDF is auto-detected and need not be specified. Does not change the external link icon, except for PDFs. Note: External link icons do not include alt text, thus they do not add file format information for the visually impaired, but this is not a concern for PDFs because the auto-detection will add "(PDF)" as descriptive text. (See Using |format=.)

URLs must begin with a supported URI scheme. http:// and https:// will be supported by all browsers; however, ftp://, gopher://, irc://, ircs://, mailto:, news: and tel: may require additional extensions or an external application and should normally be avoided. Bare IPv6 host names are currently not supported.

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

Character (space) " ' < > [ ] { | }
Encoding %20 %22 %27 %3C %3E %5B %5D %7B %7C %7D

Single apostrophes do not need to be encoded; however, unencoded multiples of them 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. 1.0 1.1 Access-date and archive-date in references should all have the same format – either the format used for publication dates, or YYYY-MM-DD.

Options for this field:

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

chapterurl

[edit subtemplate]

  • chapter-url: the URL of a web page where the text of the publication named by chapter or contribution can be accessed; cannot be used if those parameters are wikilinked. Should target the same web 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 different pages at the site. Aliases: contribution-url, section-url.
  • chapter-format: the file format of the work referred to by chapter-url, for example: PDF, DOC, or XLS; shown in parentheses after chapter and does not change the external link icon. HTML is the implied default and should not be specified. Note: External link icons do not include alternative text for images and thus do not add format information for the visually impaired.

quote

[edit subtemplate]

  • quote: A relevant text snippet quoted from the source, displayed enclosed in double quotation marks. When supplied, the citation terminator (a full stop . or "period" by default) is suppressed, so the quote must include terminating punctuation. If script-quote is defined, use quote to hold a Romanization (if available) of the text in script-quote.
    • script-quote: The original quotation supplied to quote, for languages that do not use a Latin-based script (Arabic, Chinese, Cyrillic, Greek, Hebrew, Japanese, Korean, etc.), shown unitalicized following the italicized Romanization defined in quote (if available). Must be prefixed with one of the supported language codes to help browsers properly display the script. Alias: none.
      …|quote=Tōkyō tawā|script-quote=ja:東京タワー|trans-quote=Tokyo Tower…
    • trans-quote: The English translation of the quotation, if the source quoted is in a foreign language, displayed enclosed by 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. This should be a subset of the page(s) specified in page, pages or at. Shown preceded by p., unless |no-pp=yes is specified. If hyphenated, use {{Hyphen}} to indicate this is intentional (e.g. |quote-page=3{{Hyphen}}12). Alias: none.
  • quote-pages: A list or range of pages quoted in quote; use either quote-page or quote-pages, but not both. This should be a subset of the pages specified in pages or at. Use an en dash (–) to indicate the page range, separating non-sequential pages with a comma ,. Output is preceded by pp. unless |no-pp=yes is defined. Hyphens are automatically converted to en dashes; if hyphens are appropriate because individual page numbers contain hyphens, such as: pp. 3-1–3-15, use doubled parentheses to force the template to display the value of quote-pages without processing it, and use {{Hyphen}} to indicate to other editors that a hyphen is really intended, as in: |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]

display

[edit subtemplate]

  • mode: Sets the element separator, default terminal punctuation and certain capitalization choices. For |mode=cs1 the element separator and terminal punctuation is a full stop (.) or "period" and where appropriate, initial letters of certain words are capitalized ('Retrieved…'); for |mode=cs2 the element separator is a comma (,), terminal punctuation is omitted, and 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 only, use the postscript parameter.
  • author-mask, contributor-mask, editor-mask, interviewer-mask, subject-mask and translator-mask: Replaces the name of the (first) author with em dashes or text. Set <name>-mask to a numeric value n to set the dash n em spaces wide and/or set <name>-mask to a text value to display the text without a trailing author separator, such as "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 listing the names for all associated people/entities for metadata purposes. This parameter is primarily intended for use with bibliographies, especially when styled so multiple works by a single author are listed sequentially, such as Template:Sfnote. Do not use in a list generated by {{Reflist}}, the <references /> tag or anything similar, as there is no control of the order in which references are placed. Mask parameters can take an enumerator in the name of the parameter (e.g. |authorn-mask=) to apply the mask to a specific name.
  • display-authors, display-contributors, display-editors, display-interviewers, display-subjects and display-translators: Controls the number of author (or other contributor type) names that are displayed; by default, all are. To limit the number of names shown, 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 contributor types). |display-authors=0 is a special case that suppresses 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: Determines the closing punctuation for a citation, defaulting to a full stop . or "period"; for no terminating punctuation, specify |postscript=none – leaving this parameter empty is the same as omitting it, but unhelpfully ambiguous to other editors. Additional text or templates that render more than a single terminating punctuation character will generate a maintenance message. This parameter is ignored if quote is defined.

Options for this field:

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

Subscription or registration required

[edit subtemplate]

Citations of online sources that require registration or a paid subscription are acceptable on Zoophilia Wiki. As a courtesy to readers and other editors, editors should signal restrictions on access to material provided via the external links included in citations. 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 providing evidence in support of the information found in articles here.

Four access levels can be defined for citation template links.

  • § Access indicators for named identifiers:
    • Freely accessible free: The source is free to be read by anyone.
  • § Access indicators for url-holding parameters:
    • Free registration required registration: Registration with the provider is required to access the source without any cost, even if a limited preview, abstract or review may still be available without registration.
    • Free limited access trial, afterwards paid subscription required limited: Free access is subject to a limited trial period after which a paid subscription is normally required.
    • Paid subscription required subscription: The source is only accessible via a paid subscription with the provider (behind a "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

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, 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 cannot be explicitly 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 value for the archive-url and archive-date parameters, if possible.

URL access-indicator parameter mappings
URL holder Access indicator Valid keywords
url url-access registration Free registration required
limited Free limited access trial, afterwards paid subscription required
subscription Paid 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|df=mdy}}

…which gets rendered as…

"Nifty example data". April 15, 2021.
Access indicator for named identifiers

Links inserted by named identifiers, such as doi, are presumed to lie behind a paywall or registration barrier and lack free full-text access by default, with exceptions listed below. When they are free-to-read, editors should mark those sources with the corresponding |indicator-access=free key/value pair 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 free-to-read full-text access (as when they're just abstracting services), they may not be marked as limited, registration or subscription.

Named identifier access-indicator parameter mappings
Identifier parameter Access indicator Valid keywords
bibcode bibcode-access free Freely accessible
The source is free to be read by anyone
(not supported by url-access)
doi doi-access
hdl hdl-access
jstor jstor-access
ol ol-access
osti osti-access
s2cid s2cid-access

Some identifiers always offer free full-text access, and if so the access level is automatically indicated by the template. This is the case for:

  • arxiv
  • biorxiv
  • citeseerx
  • medrxiv
  • pmc
  • rfc
  • ssrn.

For embargoed pmc documents that will become available in the future, see pmc-embargo-date.

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.
  • 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', '...'},.

map_series

[edit subtemplate]

Template:Citation Style documentation/map series

map_pages

[edit subtemplate]

Template:Citation Style documentation/map pages

interview_author

[edit subtemplate]

Template:Citation Style documentation/interview author

interviewer

[edit subtemplate]

Template:Citation Style documentation/interviewer

season

[edit subtemplate]

Template:Citation Style documentation/season

network

[edit subtemplate]

Template:Citation Style documentation/network

transcript

[edit subtemplate]

Template:Citation Style documentation/transcript

conference

[edit subtemplate]

  • conference: the name of the conference; may include location, if different from the value of the location parameter, and date, if different from date or year.
    • conference-url: the URL at which the conference's proceedings are published, if different from url.

Notes