Template:Citation Style documentation
Usage lokiša
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 lokiša
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
- Lay summary
- Display options
Lead section lokiša
Use {{csdoc|lead|content}} to create consistent content for the lead:
Template:Citation Style documentation/edit Template:Citation Style documentation/opt
Markup | Renders asLua error: expandTemplate: template "Markup/row" does not exist.Lua error: expandTemplate: template "Markup/row" does not exist.Lua error: expandTemplate: template "Markup/row" does not exist.Lua error: expandTemplate: template "Markup/row" does not exist.Lua error: expandTemplate: template "Markup/row" does not exist.Lua error: expandTemplate: template "Markup/row" does not exist.Lua error: expandTemplate: template "Markup/row" does not exist.Lua error: expandTemplate: template "Markup/row" does not exist.Lua error: expandTemplate: template "Markup/row" does not exist.Lua error: expandTemplate: template "Markup/row" does not exist.Lua error: expandTemplate: template "Markup/row" does not exist.Lua error: expandTemplate: template "Markup/row" does not exist.Lua error: expandTemplate: template "Markup/row" does not exist.Lua error: expandTemplate: template "Markup/row" does not exist.Lua error: expandTemplate: template "Markup/row" does not exist.Lua error: expandTemplate: template "Markup/row" does not exist.Lua error: expandTemplate: template "Markup/row" does not exist.Lua error: expandTemplate: template "Markup/row" does not exist.Lua error: expandTemplate: template "Markup/row" does not exist.Lua error: expandTemplate: template "Markup/row" does not exist. |
---|---|
Lua notice lokiša
Script error: No such module "Suppress categories".
Usage section lokiša
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 lokiša
- 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}}
Lua error: expandTemplate: template "Citation Style documentation/usage full" does not exist.
{{cite xxxxx |last1= |first1= |author-link1= |last2= |first2= |author-link2= |last3= |first3= |author-link3= |last4= |first4= |author-link4= |last5= |first5= |author-link5= |name-list-style= |vauthors= |translator-last1= |translator-first1= |translator-link1= |translator-last2= |translator-first2= |translator-link2= |collaboration= |contributor-last1= |contributor-first1= |contributor-link1= |contributor-last2= |contributor-first2= |contributor-link2= |others= |editor-last1= |editor-first1= |editor-link1= |editor-last2= |editor-first2= |editor-link2= |editor-last3= |editor-first3= |editor-link3= |veditors= |title= |script-title= |trans-title= |work= |script-work= |trans-work= |issue= |department= |chapter= |script-chapter= |trans-chapter= |contribution= |type= |edition= |series= |series-link= |episode= |event= |agency= |volume= |date= |year= |orig-date= |df= |publisher= |location= |publication-place= |via= |language= |page= |pages= |no-pp= |at= |minutes= |time= |time-caption= |id= |arxiv= |asin= |asin-tld= |bibcode= |biorxiv= |citeseerx= |doi= |doi-broken-date= |eissn= |hdl= |sbn= |isbn= |ismn= |issn= |jfm= |jstor= |lccn= |mr= |oclc= |ol= |osti= |pmc= |embargo= |pmid= |rfc= |ssrn= |zbl= |url= |format= |archive-url= |archive-format= |url-status= |archive-date= |chapter-url= |chapter-format= |access-date= |no-tracking= |quote= |ref= |mode= |author-mask1= |author-mask2= |author-mask3= |author-mask4= |author-mask5= |display-authors= |translator-mask1= |translator-mask2= |display-translators= |contributor-mask1= |contributor-mask2= |display-contributors= |editor-mask1= |editor-mask2= |editor-mask3= |display-editors= |postscript= |url-access= |chapter-url-access= |bibcode-access= |doi-access= |hdl-access= |jstor-access= |ol-access= |osti-access= |map= |script-map= |trans-map= |map-url= |map-format= |map-url-access= |scale= |cartography= |inset= |sections= |interviewer-last1= |interviewer-first1= |interviewer-link1= |interviewer-last2= |interviewer-first2= |interviewer-link2= |interviewer-mask1= |interviewer-mask2= |display-interviewers= |season= |series-number= |series-separator= |network= |station= |transcript= |transcript-url= |transcript-format= |conference= |conference-url= |conference-format=}}
|}
The above set is organised contextually rather than alphabetically. The following parameters, which are usually available for at least a few cite templates, are not included in the full parameter set above: |authors=
; |book-title=
; |class=
; |degree=
; |docket=
; |encyclopedia=
; |mailing-list=
; |message-id=
; |number=
; |publication-date=
; |section=
; |sheet=
; |sheets=
; |title-link=
; |s2cid=
.
Most commonly used horizontal style lokiša
- 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}}
Lua error: expandTemplate: template "Citation Style documentation/usage common" does not exist.
{{cite book |last= |first= |author-link= |title= |url= |access-date= |date= |publisher= |location= |isbn= |page= |pages=}}
|}
Full vertical style lokiša
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 lokiša
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 <code> </code>
* Separate the next column with:
-->
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
<!--
* Create the instructions column; blank lines must include a <code> </code>
* 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;">
last
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
same as last1
same as first1
</pre>
{{csdoc|usage vertical end}}
{{csdoc|usage vertical}}
<pre style="margin:0px;">
{{cite book
| last =
| first =
| author-link =
}}
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
last
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
same as last1
same as first1
{{csdoc|usage vertical end}}
Four-columns format lokiša
{| class="wikitable"
|+ Full parameter set in vertical format
! Parameters !! Prerequisites !! Brief instructions / notes !! Vertical list
|-
| {{Hover title|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>
|-
| {{Hover title|or any of its aliases, including: first; given1; given; author-first1; author-first; (etc.)|first1}}
| {{Hover title|or any of its aliases, including: last; author1; author; author-last1; author-last; (etc.)|last1}}
| Author's first name. Don't link.
|-
| {{Hover title|or any of its aliases, including: author-link; subject-link1; subject-link; (etc.)|author-link1}}
| {{Hover title|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.
|}
Parameters | Prerequisites | Brief instructions / notes | Vertical list |
---|---|---|---|
Template:Hover title | 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 = }} | |
Template:Hover title | Template:Hover title | Author's first name. Don't link. | |
Template:Hover title | Template:Hover title | Title of Wikipedia article about the first author. Don't link. | |
Template:Hover title | Template:Hover title | Like last1 , but for 2nd author.
| |
Template:Hover title | Template:Hover title | Like first1 , but for 2nd author.
| |
Template:Hover title | Template:Hover title | Like author-link1 , but for 2nd author.
| |
Template:Hover title | Template:Hover title | Like last1 , but for 3rd author.
| |
Template:Hover title | Template:Hover title | Like first1 , but for 3rd author.
| |
Template:Hover title | Template:Hover title | Like author-link1 , but for 3rd author.
| |
Template:Hover title | Template:Hover title | Like last1 , but for 4th author.
| |
Template:Hover title | Template:Hover title | Like first1 , but for 4th author.
| |
Template:Hover title | Template:Hover title | Like author-link1 , but for 4th author.
| |
Template:Hover title | Template:Hover title | Like last1 , but for 5th author. Similar: last6, etc.
| |
Template:Hover title | Template:Hover title | Like first1 , but for 5th author. Similar: first6, etc.
| |
Template:Hover title | Template:Hover title | 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 | ||
Template:Hover title | Template:Hover title | 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 lokiša
Usage lokiša
Template:Citation Style documentation/edit
|}
Usage full lokiša
Template:Citation Style documentation/edit
|}
Usage common lokiša
Template:Citation Style documentation/edit
|}
Usage vertical lokiša
Template:Citation Style documentation/edit
|}
Usage vertical mid lokiša
Template:Citation Style documentation/edit
|}
Usage vertical end lokiša
Template:Citation Style documentation/edit
Examples section lokiša
Use {{markup2}} to format the examples Template: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 lokiša
syntax lokiša
Template:Citation Style documentation/edit
COinS lokiša
Template:Citation Style documentation/edit
sep_period lokiša
Template:Citation Style documentation/edit
sep_comma lokiša
Template:Citation Style documentation/edit
required lokiša
Template:Citation Style documentation/edit
whats new lokiša
Template:Citation Style documentation/edit
deprecated lokiša
Template:Citation Style documentation/edit
author lokiša
Template:Citation Style documentation/edit Template:Citation Style documentation/opt
editor lokiša
Template:Citation Style documentation/edit
title lokiša
Template:Citation Style documentation/edit
Template:Citation Style documentation/opt
web lokiša
Template:Citation Style documentation/edit
chapter lokiša
Template:Citation Style documentation/edit Template:Citation Style documentation/opt
type lokiša
Template:Citation Style documentation/edit Template:Citation Style documentation/opt
journal lokiša
Template:Citation Style documentation/edit Template:Citation Style documentation/opt
edition lokiša
Template:Citation Style documentation/edit
series lokiša
Template:Citation Style documentation/edit
series_episode lokiša
Template:Citation Style documentation/edit
event lokiša
Template:Citation Style documentation/edit
agency lokiša
Template:Citation Style documentation/edit
volume lokiša
Template:Citation Style documentation/edit
date lokiša
Template:Citation Style documentation/edit Template:Citation Style documentation/opt
publisher lokiša
Template:Citation Style documentation/edit Template:Citation Style documentation/opt
newsgroup lokiša
Template:Citation Style documentation/edit
language lokiša
Template:Citation Style documentation/edit
pages lokiša
Template:Citation Style documentation/edit Template:Citation Style documentation/opt
time lokiša
Template:Citation Style documentation/edit
id1 lokiša
Template:Citation Style documentation/edit
id2 lokiša
Template:Citation Style documentation/edit
url lokiša
Template:Citation Style documentation/edit Template:Citation Style documentation/opt
chapterurl lokiša
Template:Citation Style documentation/edit
lay lokiša
Template:Citation Style documentation/edit
quote lokiša
Template:Citation Style documentation/edit Template:Citation Style documentation/opt
ref lokiša
Template:Citation Style documentation/edit
display lokiša
Template:Citation Style documentation/edit Template:Citation Style documentation/opt
Subscription or registration required lokiša
Template:Citation Style documentation/edit
map_series lokiša
Template:Citation Style documentation/edit
map_pages lokiša
Template:Citation Style documentation/edit
interview_author lokiša
Template:Citation Style documentation/edit
interview_interviewer lokiša
Template:Citation Style documentation/edit
season lokiša
Template:Citation Style documentation/edit
network lokiša
Template:Citation Style documentation/edit
transcript lokiša
Template:Citation Style documentation/edit
conference lokiša
Template:Citation Style documentation/edit
Notes lokiša
Citation Style 1 | |
---|---|
General templates | ; {{Cite book}}
|
Preprint templates | * {{Cite arXiv}}
|
Audiovisual-related | * {{Cite AV media}}
|
Categories | * Citation Style 1 templates
|
Documentation | * {{Citation Style documentation}} |
Citation Style 1 noticeboard |