Template:Citation Style documentation/doc: Difference between revisions

Revision as of 10:38, 10 October 2020

Latest revision as of 06:07, 10 March 2025

(38 intermediate revisions by 14 users not shown)

Line 1:

{{Documentation subpage}}

<!--Categories where indicated at the bottom of this page, please; interwikis at Wikidata (see [[Wikipedia:Wikidata]])-->

{{template shortcut|csdoc}}

{{notice|When updating this template keep in mind that it is used on a number of template documentation pages. If the parameters in question are unique to a template, then either add it manually to the template documentation or create a new section here for transclusion.}}

Line 6 ⟶ 7:

This template is used to build consistent documentation pages for {{cs1}} templates.

: For example: {{tlx|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.

Line 32 ⟶ 33:

*** Quote

*** Editors

*** Lay summary

*** Display options

==Lead section==

Use {{tlx|csdoc|lead|<var>content type</var>}} to create consistent content for the lead:

{{Citation Style documentation/edit|lead}}

Line 53:

==Usage section==

Start the usage section with {{tlx|csdoc|usage}}:

: {{csdoc|usage}}

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

Line 63:

* Close the table with {{tlx|end}}

{{pre2pre|<nowiki>

{{csdoc|usage full}}

:<code>&lt;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-formatstyle= |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-yeardate= |df= |publisher= |___location= |publication-place= |via= |language= |page= |pages= |noppno-pp= |at= |minutes= |time= |time-caption= |id= |arxiv= |asin= |asin-tld= |bibcode= |biorxiv= |citeseerx= |doi= |doi-broken-date= |eissn= |hdl= |sbn= |isbn= |ignore-isbn-error= |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= |lay-url= |lay-format= |lay-source= |lay-date= |access-date= |no-tracking= |quote= |ref= |mode= |author-mask1= |author-mask2= |author-mask3= |author-mask4= |author-mask5= |display-authors= |last-author-amp= |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=}}&lt;/nowiki></code>

{{end}}</nowiki>

}}

{{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-formatstyle= |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-yeardate= |df= |publisher= |___location= |publication-place= |via= |language= |page= |pages= |noppno-pp= |at= |minutes= |time= |time-caption= |id= |arxiv= |asin= |asin-tld= |bibcode= |biorxiv= |citeseerx= |doi= |doi-broken-date= |eissn= |hdl= |sbn= |isbn= |ignore-isbn-error= |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= |lay-url= |lay-format= |lay-source= |lay-date= |access-date= |no-tracking= |quote= |ref= |mode= |author-mask1= |author-mask2= |author-mask3= |author-mask4= |author-mask5= |display-authors= |last-author-amp= |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}}

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: {{para|authors}}; {{para|book-title}}; {{para|class}}; {{para|degree}}; {{para|docket}}; <s>{{para|editors}}</s> (deprecated); {{para|encyclopedia}}; {{para|mailinglistmailing-list}}; {{para|message-id}}; {{para|number}}; {{para|publicationdatepublication-date}}; {{para|section}}; {{para|sheet}}; {{para|sheets}}; {{para|title-link}}; {{para|s2cid}}.

===Most commonly used horizontal style===

Line 79:

* Close the table with {{tlx|end}}

</syntaxhighlight lang="wikitext">

{{pre2|<nowiki>

{{csdoc|usage common}}

:<code>&lt;<nowiki>{{cite book |last= |first= |author-link= |title= |url= |access-date= |date= |publisher= |___location= |isbn= |page= |pages=}}&lt;</nowiki></code>

{{end}}</nowiki>

}}

</syntaxhighlight>

{{csdoc|usage common}}

:<code><nowiki>{{cite book |last= |first= |author-link= |title= |url= |access-date= |date= |publisher= |___location= |isbn= |page= |pages=}}</nowiki></code>

Line 89 ⟶ 90:

===Full vertical style===

The full vertical style can be implemented in a three -columns format (only practical when the number of parameters is not too extended), or in a four -columns format.

====Three -columns format====

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

<syntaxhighlight lang="htmlwikitext">

<!--

* Start with:

Line 107 ⟶ 108:

<pre style="margin:0px;">

<!--

* Create the prerequisites column; blank lines must include a <code>&nbsp;</code>

* Separate the next column with:

-->

Line 114 ⟶ 115:

<pre style="margin:0px;">

<!--

* Create the instructions column; blank lines must include a <code>&nbsp;</code>

* End with:

-->

Line 121 ⟶ 122:

</syntaxhighlight>

Example:

<syntaxhighlight lang="htmlwikitext">

{{csdoc|usage vertical}}

<pre style="margin:0px;">

Line 147 ⟶ 148:

</pre>

{{csdoc|usage vertical end}}

</syntaxhighlight>

{{csdoc|usage vertical}}

<pre style="margin:0px;">

Line 170 ⟶ 172:

&nbsp;

&nbsp;

</pre>

{{csdoc|usage vertical end}}

</syntaxhighlight>

====Four -columns format====

<syntaxhighlight lang="htmlwikitext">

{| class="wikitable"

|+ Full parameter set in vertical format

! Parameters !! Prerequisites !! Brief instructions / notes !! Vertical list

|-

| {{Hover titletooltip|2=or any of its aliases, including: last; author1; author; author-last1; author-last; (etc.)|last1}}

|

| Author's last name or single name author. Don't link.

Line 190 ⟶ 192:

</pre>

|-

| {{Hover titletooltip|2=or any of its aliases, including: first; given1; given; author-first1; author-first; (etc.)|first1}}

| {{Hover titletooltip|2=or any of its aliases, including: last; author1; author; author-last1; author-last; (etc.)|last1}}

| Author's first name. Don't link.

|-

| {{Hover titletooltip|2=or any of its aliases, including: author-link; authorlink1; authorlink; subject-link1; subject-link; (etc.)|author-link1}}

| {{Hover titletooltip|2=or any of its aliases, including: last; author1; author; author-last1; author-last; (etc.)|last1}}

| Title of Wikipedia article about the first author. Don't link.

|}

Line 201 ⟶ 203:

{| class="wikitable"

|+ Full parameter set in vertical format

! Parameters !! Prerequisites !! Brief instructions / notes !! Vertical list

|-

| {{Hover titletooltip|2=or any of its aliases, including: last; author1; author; author-last1; author-last; (etc.)|last1}}

|

| Author's last name or single name author. Don't link.

| rowspan="179173" style="vertical-align:top;" | <pre style="margin:0px; border:none;">

{{cite xxxxx

|last1 =

Line 224 ⟶ 226:

|first5 =

|author-link5 =

|name-list-formatstyle =

|vauthors =

|translator-last1 =

Line 272 ⟶ 274:

|date =

|year =

|orig-yeardate =

|df =

|publisher =

Line 281 ⟶ 283:

|page =

|pages =

|nopp no-pp =

|at =

|minutes =

Line 299 ⟶ 301:

|sbn =

|isbn =

|ignore-isbn-error =

|ismn =

|issn =

Line 323 ⟶ 324:

|chapter-url =

|chapter-format =

|lay-url =

|lay-format =

|lay-source =

|lay-date =

|access-date =

|no-tracking =

Line 338 ⟶ 335:

|author-mask5 =

|display-authors =

|last-author-amp =

|translator-mask1 =

|translator-mask2 =

Line 377 ⟶ 373:

|interviewer-mask2 =

|display-interviewers =

|lay-urlseason =

&nbsp;|season&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;=

|series-number =

|series-separator =

Line 391 ⟶ 387:

</pre>

|-

| {{Hover titletooltip|2=or any of its aliases, including: first; given1; given; author-first1; author-first; (etc.)|first1}}

| {{Hover titletooltip|2=or any of its aliases, including: last; author1; author; author-last1; author-last; (etc.)|last1}}

| Author's first name. Don't link.

|-

| {{Hover titletooltip|2=or any of its aliases, including: author-link; authorlink1; authorlinkauthor1-link; subject-link1; subject-link; (etc.)|author-link1}}

| {{Hover titletooltip|2=or any of its aliases, including: last; author1; author; author-last1; author-last; (etc.)|last1}}

| Title of Wikipedia article about the first author. Don't link.

|-

| {{Hover titletooltip|2=or any of its aliases, including: author2; author-last2; (etc.)|last2}}

| {{Hover titletooltip|2=or any of its aliases, including: last; author1; author; author-last1; author-last; (etc.)|last1}}

| Like <code>last1</code>, but for 2nd author.

|-

| {{Hover titletooltip|2=or any of its aliases, including: given2; author-first2; (etc.)|first2}}

| {{Hover titletooltip|2=or any of its aliases, including: author2; author-last2; (etc.)|last2}}

| Like <code>first1</code>, but for 2nd author.

|-

| {{Hover titletooltip|2=or any of its aliases, including: authorlink2author2-link; subject-link2; (etc.)|author-link2}}

| {{Hover titletooltip|2=or any of its aliases, including: author2; author-last2; (etc.)|last2}}

| Like <code>author-link1</code>, but for 2nd author.

|-

| {{Hover titletooltip|2=or any of its aliases, including: author3; author-last3; (etc.)|last3}}

| {{Hover titletooltip|2=or any of its aliases, including: author2; author-last2; (etc.)|last2}}

| Like <code>last1</code>, but for 3rd author.

|-

| {{Hover titletooltip|2=or any of its aliases, including: given3; author-first3; (etc.)|first3}}

| {{Hover titletooltip|2=or any of its aliases, including: author3; author-last3; (etc.)|last3}}

| Like <code>first1</code>, but for 3rd author.

|-

| {{Hover titletooltip|2=or any of its aliases, including: authorlink3author3-link; subject-link3; (etc.)|author-link3}}

| {{Hover titletooltip|2=or any of its aliases, including: author3; author-last3; (etc.)|last3}}

| Like <code>author-link1</code>, but for 3rd author.

|-

| {{Hover titletooltip|2=or any of its aliases, including: author4; author-last4; (etc.)|last4}}

| {{Hover titletooltip|2=or any of its aliases, including: author3; author-last3; (etc.)|last3}}

| Like <code>last1</code>, but for 4th author.

|-

| {{Hover titletooltip|2=or any of its aliases, including: given4; author-first4; (etc.)|first4}}

| {{Hover titletooltip|2=or any of its aliases, including: author4; author-last4; (etc.)|last4}}

| Like <code>first1</code>, but for 4th author.

|-

| {{Hover titletooltip|2=or any of its aliases, including: authorlink4author4-link; subject-link4; (etc.)|author-link4}}

| {{Hover titletooltip|2=or any of its aliases, including: author4; author-last4; (etc.)|last4}}

| Like <code>author-link1</code>, but for 4th author.

|-

| {{Hover titletooltip|2=or any of its aliases, including: author5; author-last5; (etc.)|last5}}

| {{Hover titletooltip|2=or any of its aliases, including: author4; author-last4; (etc.)|last4}}

| Like <code>last1</code>, but for 5th author. Similar: last6, etc.

|-

| {{Hover titletooltip|2=or any of its aliases, including: given5; author-first5; (etc.)|first5}}

| {{Hover titletooltip|2=or any of its aliases, including: author5; author-last5; (etc.)|last5}}

| Like <code>first1</code>, but for 5th author. Similar: first6, etc.

|-

| {{Hover titletooltip|2=or any of its aliases, including: authorlink5author5-link; subject-link5; (etc.)|author-link5}}

| {{Hover titletooltip|2=or any of its aliases, including: author5; author-last5; (etc.)|last5}}

| Like <code>author-link1</code>, but for 5th author. Similar: author-link6, etc.

|-

|| name-list-formatstyle || || <code>vanc</code> to emulate [[Vancouver style]]

|-

|| vauthors || ||

Line 487 ⟶ 483:

|| 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 || ||

Line 515 ⟶ 511:

|| department || ||

|-

|| chapter || || Chapter title can be wikilinked unless when a <code>chapterurlchapter-url</code> is given

|-

|| script-chapter || ||

Line 543 ⟶ 539:

|| year || ||

|-

|| orig-yeardate || yeardate or dateyear ||

|-

|| df || ||

Line 561 ⟶ 557:

|| pages || || choose one: "page", "pages", or "at". Use when content on multiple pages supports the article text.

|-

|| noppno-pp || page or pages || set noppno-pp to "yes" to suppress the "p." or "pp." before page numbers

|-

|| at || || choose one: "page", "pages", or "at"

Line 596 ⟶ 592:

|-

|| isbn || || '''always include ISBN''', if one has been assigned

|-

|| ignore-isbn-error || ||

|-

|| ismn || ||

Line 644 ⟶ 638:

|-

|| chapter-format || chapter-url ||

|-

|| lay-url || ||

|-

|| lay-format || lay-url ||

|-

|| lay-source || lay-url ||

|-

|| lay-date || lay-url ||

|-

|| access-date || url ||

Line 673 ⟶ 659:

|| author-mask5 || last5 ||

|-

| {{Hover titletooltip|2=or alias displayauthors|display-authors}}

| {{Hover titletooltip|2=or any of its aliases, including: last; author1; author; author-last1; author-last; (etc.)|last1}}

| number (number of authors displayed) or <code>etal</code> (more authors)

|-

|| last-author-amp || last1 ||

|-

|| translator-mask1 || translator-last1 ||

Line 790 ⟶ 774:

|-

|| || || || {{para|docket}}

|-

|| || || || {{para|editors}}

|-

|| || || || {{para|encyclopedia}}

|-

|| || || || {{para|mailinglistmailing-list}}

|-

|| || || || {{para|message-id}}

Line 801 ⟶ 783:

|| || || || {{para|number}}

|-

|| || || || {{para|publicationdatepublication-date}}

|-

|| || || || {{para|section}}

Line 842 ⟶ 824:

Use {{tl|markup2}} to format the examples {{crossref|(see that template's documentation for use)}}.

<pre>{{markup2 |t=Basic usage with url (and accessdate) 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}}

}}

</pre>

{{markup2 |t=Basic usage with url (and accessdate) 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}}

}}

Line 947 ⟶ 929:

{{Citation Style documentation/edit|date}}

{{Citation Style documentation/opt|1=

* '''limited_param_list''' hides '''orig-yeardate''' because not allowed in limited-parameter templates

}}

Line 996 ⟶ 978:

===chapterurl===

{{Citation Style documentation/edit|chapterurl}}

===lay===

{{Citation Style documentation/edit|lay}}

===quote===

Line 1,042 ⟶ 1,021:

{{Citation Style documentation/edit|conference}}

==See alsoNotes==

<references/>

{{Citation Style 1}}

{{Wikipedia referencing}}

<includeonly>{{Sandbox other||

<!-- Categories andbelow this line, interwikis goto Wikidata please; thank here:you -->

<includeonly>{{Sandbox other||

<!-- Categories and interwikis go here: -->

[[Category:Documentation assistance templates]]

}}</includeonly>