Template:Citation Style documentation/doc: Difference between revisions

Revision as of 06:47, 1 June 2022

Latest revision as of 06:07, 10 March 2025

(13 intermediate revisions by 7 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 11 ⟶ 12:

Each module of text is a subtemplate that can be edited using the link.

* <b id="csdoc_publisher">publisher</b>: Name of publisher; may be wikilinked if relevant. '''Please don't misuse this parameter: in most cases, you need {{para|website}} (or its alias {{para|work}}) instead.''' The [[publisher]] is the {{em|company}}, {{em|organization}} or other legal entity that publishes the work being cited. Do {{em|not}} use the '''publisher''' parameter for the name of a [[#csdoc_work|work]] (e.g. a website, book, encyclopedia, newspaper, magazine, journal, etc.). If the name of the publisher changed over time, use 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). Displays after '''title'''.

* <span id="csdoc_location"></span><b id="csdoc_place">place</b>: 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. In earlier versions of the template this was the publication place, and for compatibility, will be treated as the publication place if the publication-place parameter is absent; see that parameter for further information. Alias: '''___location'''

* <span id="csdoc_location"></span><b id="csdoc_place">place</b>: 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. In earlier versions of the template this was the publication place, and for compatibility, will be treated as the publication place if the publication-place parameter is absent; see that parameter for further information. Alias: '''___location'''

* <b id="csdoc_publication-place">publication-place</b>: Geographical place of publication; generally not wikilinked; omit when the name of the work includes the publication place, for example, ''The Boston Globe'', ''The Times of India''. Displays after the title. If the name of the publication place changed over time, use the name as stated in the publication or used 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 publication place and will show after the title; if '''publication-place''' and '''place''' or '''___location''' are defined, then '''place''' or '''___location''' is shown before the title prefixed with "written at" and '''publication-place''' is shown after the title.

* <b id="csdoc_publication-place">publication-place</b>: Geographical place of publication; generally not wikilinked; omit when the name of the work includes the publication place, for example, ''The Boston Globe'', ''The Times of India''. Displays after the title. If the name of the publication place changed over time, use the name as stated in the publication or used 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 publication place and will show after the title; if '''publication-place''' and '''place''' or '''___location''' are defined, then '''place''' or '''___location''' is shown before the title prefixed with "written at" and '''publication-place''' is shown after the title.

==Section usage==

Line 37 ⟶ 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 84 ⟶ 79:

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

</syntaxhighlight lang="wikitext">

{{pre|<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 98 ⟶ 94:

====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 112 ⟶ 108:

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

<!--

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

* Separate the next column with:

-->

Line 119 ⟶ 115:

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

<!--

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

* End with:

-->

Line 126 ⟶ 122:

</syntaxhighlight>

Example:

<syntaxhighlight lang="htmlwikitext">

{{csdoc|usage vertical}}

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

Line 152 ⟶ 148:

</pre>

{{csdoc|usage vertical end}}

</syntaxhighlight>

{{csdoc|usage vertical}}

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

Line 175 ⟶ 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 195 ⟶ 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; 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 209 ⟶ 206:

! 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 390 ⟶ 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; author1-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: author2-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: author3-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: author4-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: author5-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.

|-

Line 662 ⟶ 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)

|-

Line 798 ⟶ 795:

|| || || (available from late April 2020) || {{para|s2cid}}

|}

{{csdoc|usage full}}

:<code><nowiki>{{cite xxxxx |last1= |first1= |author-link1= |last2= |first2= |author-link2= |last3= |first3= |author-link3= |last4= |first4= |author-link4= |last5= |first5= |author-link5= |name-list-style= |vauthors= |translator-last1= |translator-first1= |translator-link1= |translator-last2= |translator-first2= |translator-link2= |collaboration= |contributor-last1= |contributor-first1= |contributor-link1= |contributor-last2= |contributor-first2= |contributor-link2= |others= |editor-last1= |editor-first1= |editor-link1= |editor-last2= |editor-first2= |editor-link2= |editor-last3= |editor-first3= |editor-link3= |veditors= |title= |script-title= |trans-title= |work= |script-work= |trans-work= |issue= |department= |chapter= |script-chapter= |trans-chapter= |contribution= |type= |edition= |series= |series-link= |episode= |event= |agency= |volume= |date= |year= |orig-date= |df= |publisher= |___location= |publication-place= |via= |language= |page= |pages= |no-pp= |at= |minutes= |time= |time-caption= |id= |arxiv= |asin= |asin-tld= |bibcode= |biorxiv= |citeseerx= |doi= |doi-broken-date= |eissn= |hdl= |sbn= |isbn= |ismn= |issn= |jfm= |jstor= |lccn= |mr= |oclc= |ol= |osti= |pmc= |embargo= |pmid= |rfc= |ssrn= |zbl= |url= |format= |archive-url= |archive-format= |url-status= |archive-date= |chapter-url= |chapter-format= |access-date= |no-tracking= |quote= |ref= |mode= |author-mask1= |author-mask2= |author-mask3= |author-mask4= |author-mask5= |display-authors= |translator-mask1= |translator-mask2= |display-translators= |contributor-mask1= |contributor-mask2= |display-contributors= |editor-mask1= |editor-mask2= |editor-mask3= |display-editors= |postscript= |url-access= |chapter-url-access= |bibcode-access= |doi-access= |hdl-access= |jstor-access= |ol-access= |osti-access= |map= |script-map= |trans-map= |map-url= |map-format= |map-url-access= |scale= |cartography= |inset= |sections= |interviewer-last1= |interviewer-first1= |interviewer-link1= |interviewer-last2= |interviewer-first2= |interviewer-link2= |interviewer-mask1= |interviewer-mask2= |display-interviewers= |season= |series-number= |series-separator= |network= |station= |transcript= |transcript-url= |transcript-format= |conference= |conference-url= |conference-format=}}</nowiki></code>

{{end}}

Full parameter set in horizontal format

{{cite xxxxx |last1= |first1= |author-link1= |last2= |first2= |author-link2= |last3= |first3= |author-link3= |last4= |first4= |author-link4= |last5= |first5= |author-link5= |name-list-style= |vauthors= |translator-last1= |translator-first1= |translator-link1= |translator-last2= |translator-first2= |translator-link2= |collaboration= |contributor-last1= |contributor-first1= |contributor-link1= |contributor-last2= |contributor-first2= |contributor-link2= |others= |editor-last1= |editor-first1= |editor-link1= |editor-last2= |editor-first2= |editor-link2= |editor-last3= |editor-first3= |editor-link3= |veditors= |title= |script-title= |trans-title= |work= |script-work= |trans-work= |issue= |department= |chapter= |script-chapter= |trans-chapter= |contribution= |type= |edition= |series= |series-link= |episode= |event= |agency= |volume= |date= |year= |orig-date= |df= |publisher= |___location= |publication-place= |via= |language= |page= |pages= |no-pp= |at= |minutes= |time= |time-caption= |id= |arxiv= |asin= |asin-tld= |bibcode= |biorxiv= |citeseerx= |doi= |doi-broken-date= |eissn= |hdl= |sbn= |isbn= |ismn= |issn= |jfm= |jstor= |lccn= |mr= |oclc= |ol= |osti= |pmc= |embargo= |pmid= |rfc= |ssrn= |zbl= |url= |format= |archive-url= |archive-format= |url-status= |archive-date= |chapter-url= |chapter-format= |access-date= |no-tracking= |quote= |ref= |mode= |author-mask1= |author-mask2= |author-mask3= |author-mask4= |author-mask5= |display-authors= |translator-mask1= |translator-mask2= |display-translators= |contributor-mask1= |contributor-mask2= |display-contributors= |editor-mask1= |editor-mask2= |editor-mask3= |display-editors= |postscript= |url-access= |chapter-url-access= |bibcode-access= |doi-access= |hdl-access= |jstor-access= |ol-access= |osti-access= |map= |script-map= |trans-map= |map-url= |map-format= |map-url-access= |scale= |cartography= |inset= |sections= |interviewer-last1= |interviewer-first1= |interviewer-link1= |interviewer-last2= |interviewer-first2= |interviewer-link2= |interviewer-mask1= |interviewer-mask2= |display-interviewers= |season= |series-number= |series-separator= |network= |station= |transcript= |transcript-url= |transcript-format= |conference= |conference-url= |conference-format=}}

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

{{csdoc|usage full}}

:<code><nowiki>{{cite xxxxx |last1= |first1= |author-link1= |last2= |first2= |author-link2= |last3= |first3= |author-link3= |last4= |first4= |author-link4= |last5= |first5= |author-link5= |name-list-style= |vauthors= |translator-last1= |translator-first1= |translator-link1= |translator-last2= |translator-first2= |translator-link2= |collaboration= |contributor-last1= |contributor-first1= |contributor-link1= |contributor-last2= |contributor-first2= |contributor-link2= |others= |editor-last1= |editor-first1= |editor-link1= |editor-last2= |editor-first2= |editor-link2= |editor-last3= |editor-first3= |editor-link3= |veditors= |title= |script-title= |trans-title= |work= |script-work= |trans-work= |issue= |department= |chapter= |script-chapter= |trans-chapter= |contribution= |type= |edition= |series= |series-link= |episode= |event= |agency= |volume= |date= |year= |orig-date= |df= |publisher= |___location= |publication-place= |via= |language= |page= |pages= |no-pp= |at= |minutes= |time= |time-caption= |id= |arxiv= |asin= |asin-tld= |bibcode= |biorxiv= |citeseerx= |doi= |doi-broken-date= |eissn= |hdl= |sbn= |isbn= |ismn= |issn= |jfm= |jstor= |lccn= |mr= |oclc= |ol= |osti= |pmc= |embargo= |pmid= |rfc= |ssrn= |zbl= |url= |format= |archive-url= |archive-format= |url-status= |archive-date= |chapter-url= |chapter-format= |access-date= |no-tracking= |quote= |ref= |mode= |author-mask1= |author-mask2= |author-mask3= |author-mask4= |author-mask5= |display-authors= |translator-mask1= |translator-mask2= |display-translators= |contributor-mask1= |contributor-mask2= |display-contributors= |editor-mask1= |editor-mask2= |editor-mask3= |display-editors= |postscript= |url-access= |chapter-url-access= |bibcode-access= |doi-access= |hdl-access= |jstor-access= |ol-access= |osti-access= |map= |script-map= |trans-map= |map-url= |map-format= |map-url-access= |scale= |cartography= |inset= |sections= |interviewer-last1= |interviewer-first1= |interviewer-link1= |interviewer-last2= |interviewer-first2= |interviewer-link2= |interviewer-mask1= |interviewer-mask2= |display-interviewers= |season= |series-number= |series-separator= |network= |station= |transcript= |transcript-url= |transcript-format= |conference= |conference-url= |conference-format=}}</nowiki></code>

{{end}}

Full parameter set in horizontal format

{{cite xxxxx |last1= |first1= |author-link1= |last2= |first2= |author-link2= |last3= |first3= |author-link3= |last4= |first4= |author-link4= |last5= |first5= |author-link5= |name-list-style= |vauthors= |translator-last1= |translator-first1= |translator-link1= |translator-last2= |translator-first2= |translator-link2= |collaboration= |contributor-last1= |contributor-first1= |contributor-link1= |contributor-last2= |contributor-first2= |contributor-link2= |others= |editor-last1= |editor-first1= |editor-link1= |editor-last2= |editor-first2= |editor-link2= |editor-last3= |editor-first3= |editor-link3= |veditors= |title= |script-title= |trans-title= |work= |script-work= |trans-work= |issue= |department= |chapter= |script-chapter= |trans-chapter= |contribution= |type= |edition= |series= |series-link= |episode= |event= |agency= |volume= |date= |year= |orig-date= |df= |publisher= |___location= |publication-place= |via= |language= |page= |pages= |no-pp= |at= |minutes= |time= |time-caption= |id= |arxiv= |asin= |asin-tld= |bibcode= |biorxiv= |citeseerx= |doi= |doi-broken-date= |eissn= |hdl= |sbn= |isbn= |ismn= |issn= |jfm= |jstor= |lccn= |mr= |oclc= |ol= |osti= |pmc= |embargo= |pmid= |rfc= |ssrn= |zbl= |url= |format= |archive-url= |archive-format= |url-status= |archive-date= |chapter-url= |chapter-format= |access-date= |no-tracking= |quote= |ref= |mode= |author-mask1= |author-mask2= |author-mask3= |author-mask4= |author-mask5= |display-authors= |translator-mask1= |translator-mask2= |display-translators= |contributor-mask1= |contributor-mask2= |display-contributors= |editor-mask1= |editor-mask2= |editor-mask3= |display-editors= |postscript= |url-access= |chapter-url-access= |bibcode-access= |doi-access= |hdl-access= |jstor-access= |ol-access= |osti-access= |map= |script-map= |trans-map= |map-url= |map-format= |map-url-access= |scale= |cartography= |inset= |sections= |interviewer-last1= |interviewer-first1= |interviewer-link1= |interviewer-last2= |interviewer-first2= |interviewer-link2= |interviewer-mask1= |interviewer-mask2= |display-interviewers= |season= |series-number= |series-separator= |network= |station= |transcript= |transcript-url= |transcript-format= |conference= |conference-url= |conference-format=}}

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

===Sub-templates===

Line 998 ⟶ 978:

===chapterurl===

{{Citation Style documentation/edit|chapterurl}}

===lay===

{{Citation Style documentation/edit|lay}}

===quote===

Line 1,048 ⟶ 1,025:

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