View source for Template:Citation Style documentation/doc

{{Documentation subpage}}
{{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.}}

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

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

==Section usage==
When creating template documentation, use the following order of sections and content:
* Lead: a brief overview of the template intent
* Usage: samples of blank parameters that can be copied and pasted
* Examples: examples of various usage
* Parameters: detailed descriptions of each parameter
** Syntax: overview of the template syntax
** Deprecated: list of deprecated parameters
** Description: parameter descriptions separated by function in this general order:
*** Authors
*** Title
*** Date
*** Publisher
*** Edition, series, volume
*** In-source locations
*** URL
*** Anchor
*** Identifiers
*** Quote
*** Editors
*** Lay summary
*** Display options

==Lead section==
Use {{tlx|csdoc|lead|content}} to create consistent content for the lead:

{{Citation Style documentation/edit|lead}}
{{Citation Style documentation/opt|1=
One unnamed parameter is used to create the trailing text.}}

{{markup
|<nowiki>{{csdoc|lead|books}}</nowiki>
|{{csdoc|lead|books}}
}}

===Lua notice===
{{#invoke:Suppress categories|main|{{Citation Style documentation/edit|lua}}}}

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

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

===Full horizontal style===
* Start with {{tlx|csdoc|usage full}}
* Precede the sample markup with <code>:</code> to create an indent
* Enclose the sample in {{tag|code|content={{tag|nowiki}}}}
* Close the table with {{tlx|end}}

{{pre2|<nowiki>
{{csdoc|usage full}}
:<code>&lt;nowiki>{{cite book |last1= |first1= |authorlink1= |last2= |first2= |authorlink2= |editor1-first= |editor1-last= |editor1-link= |others= |title= |trans_title= |url= |archiveurl= |archivedate= |format= |accessdate= |type= |edition= |series= |volume= |date= |year= |origyear= |publisher= |location= |language= |isbn= |oclc= |doi= |id= |page= |pages= |at= |trans_chapter= |chapter= |chapterurl= |quote= |ref= |bibcode= |layurl= |laysource= |laydate= |author-mask= |display-authors= |postscript= |lastauthoramp=}}&lt;/nowiki></code>
{{end}}</nowiki>
}}
{{csdoc|usage full}}
:<code><nowiki>{{cite book |last1= |first1= |authorlink1= |last2= |first2= |authorlink2= |editor1-first= |editor1-last= |editor1-link= |others= |title= |trans_title= |url= |archiveurl= |archivedate= |format= |accessdate= |type= |edition= |series= |volume= |date= |year= |origyear= |publisher= |location= |language= |isbn= |oclc= |doi= |id= |page= |pages= |at= |trans_chapter= |chapter= |chapterurl= |quote= |ref= |bibcode= |layurl= |laysource= |laydate= |author-mask= |display-authors= |postscript= |lastauthoramp=}}</nowiki></code>
{{end}}

===Most commonly used horizontal style===
* Start with {{tlx|csdoc|usage common}}
* Precede the sample markup with <code>:</code> to create an indent
* Enclose the sample in {{tag|code|content={{tag|nowiki}}}}
* Close the table with {{tlx|end}}

{{pre2|<nowiki>
{{csdoc|usage common}}
:<code>&lt;nowiki>{{cite book |last= |first= |authorlink= |title= |url= |accessdate= |year= |publisher= |location= |isbn= |page= |pages=}}&lt;/nowiki></code>
{{end}}</nowiki>
}}
{{csdoc|usage common}}
:<code><nowiki>{{cite book |last= |first= |authorlink= |title= |url= |accessdate= |year= |publisher= |location= |isbn= |page= |pages=}}</nowiki></code>
{{end}}

===Full vertical style===
The full vertical style is created in three columns: Vertical list, Prerequisites and Brief instructions / notes.

* Start with:
{{pre2|<nowiki>
{{csdoc|usage vertical}}
<pre style="margin:0px;">
</nowiki>}}
* Create the vertical list column
* Separate the next column with:
{{pre2|<nowiki>
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
</nowiki>}}
* Create the prerequisites column; blank lines must include a <code>&amp;nbsp;</code>
* Separate the next column with:
{{pre2|<nowiki>
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
</nowiki>}}
* Create the instructions column; blank lines must include a <code>&amp;nbsp;</code>
* End with:
{{pre2|<nowiki>
</pre>
{{csdoc|usage vertical end}}
</nowiki>}}

Example:
{{pre2|<nowiki>
{{csdoc|usage vertical}}
<pre style="margin:0px;">
{{cite book
| last                  =
| first                 =
| authorlink            =
}}
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
&amp;nbsp;
&amp;nbsp;
last
&amp;nbsp;
&amp;nbsp;
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
&amp;nbsp;
same as last1
same as first1
&amp;nbsp;
&amp;nbsp;
</pre>
{{csdoc|usage vertical end}}
</nowiki>}}
{{csdoc|usage vertical}}
<pre style="margin:0px;">
{{cite book
| last                  =
| first                 =
| authorlink            =
}}
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
&nbsp;
&nbsp;
last
&nbsp;
&nbsp;
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
&nbsp;
same as last1
same as first1
&nbsp;
&nbsp;
</pre>
{{csdoc|usage vertical end}}

===Sub-templates===

====Usage====
{{Citation Style documentation/edit|usage}}
{{end}}

====Usage full====
{{Citation Style documentation/edit|usage full}}
{{end}}

====Usage common====
{{Citation Style documentation/edit|usage common}}
{{end}}

====Usage vertical====
{{Citation Style documentation/edit|usage vertical}}
{{end}}

====Usage vertical mid====
{{Citation Style documentation/edit|usage vertical mid}}
{{end}}

====Usage vertical end====
{{Citation Style documentation/edit|usage vertical end}}

==Examples section==
Use {{tl|markup2}} to format the examples; see the template documentation for use.

<pre>{{markup2 |t=Basic usage with url (and accessdate) and edition
|m=<nowiki>{{cite book |title=Mysterious book}}</nowiki>
|r={{cite book |title=Mysterious book}}
}}
</pre>

{{markup2 |t=Basic usage with url (and accessdate) and edition
|m=<nowiki>{{cite book |title=Mysterious book}}</nowiki>
|r={{cite book |title=Mysterious book}}
}}

==Parameters section==

===syntax===
{{Citation Style documentation/edit|syntax}}

===COinS===
{{Citation Style documentation/edit|coins}}

===sep_period===
{{Citation Style documentation/edit|sep_period}}

===sep_comma===
{{Citation Style documentation/edit|sep_comma}}

===required===
{{Citation Style documentation/edit|required}}

===deprecated===
{{Citation Style documentation/edit|deprecated}}
{{Citation Style documentation/opt|1=
*{{para|date2|yes}} adds:
** date2
** month2
** year2}}

===author===
{{Citation Style documentation/edit|author}}
{{Citation Style documentation/opt|1=
*{{para|coauthors|yes}} adds "'''coauthors''': (deprecated) Names of coauthors. Use the same format as the authors."
*{{para|others|yes}} adds "'''others''': To record other contributors to the work, such as "Illustrated by Smith" or "Trans. Smith"."
*{{para|aliases}} add aliases for '''last'''.
}}

===editor===
{{Citation Style documentation/edit|editor}}

===title===
{{Citation Style documentation/edit|title}}

{{Citation Style documentation/opt|1=<br />
'''title_title''' sets the display title:
* '''encyclopedia''' = encyclopedia
* default = title}}

===web===
{{Citation Style documentation/edit|web}}

===chapter===
{{Citation Style documentation/edit|chapter}}
{{Citation Style documentation/opt|1=<br />
'''title_format''' sets the display format:
*'''italics''' = Displays in italics.
* '''work''' = If '''work''' is defined, then '''title''' is displayed in quotes, else displays in italics.
* default = Displays in quotes.
'''title_title''' sets the display title:
* '''booktitle''' = booktitle
* default = chapter}}

===type===
{{Citation Style documentation/edit|type}}
{{Citation Style documentation/opt|
* '''type_default''': Adds "Defaults to '''type_default'''"}}

===journal===
{{Citation Style documentation/edit|journal}}
{{Citation Style documentation/opt|1=
* '''department''' adds:
:* '''department''': Regular department or section within the periodical or journal. Examples include "Communication", "Editorial", "Letter to the Editor", and "Review". Displays after '''title''' and is in plain text.
}}

===edition===
{{Citation Style documentation/edit|edition}}

===series===
{{Citation Style documentation/edit|series}}

===series_episode===
{{Citation Style documentation/edit|series_episode}}

===event===
{{Citation Style documentation/edit|event}}

===agency===
{{Citation Style documentation/edit|agency}}

===volume===
{{Citation Style documentation/edit|volume}}

===date===
{{Citation Style documentation/edit|date}}
{{Citation Style documentation/opt|1=
* '''aliases''' includes aliases for '''date'''
* '''began''' adds:
:* OR: '''began''': Full date the first part of the program or episode aired.
:** AND: '''ended''': Full date the last part of the program or episode aired.}}

===publisher===
{{Citation Style documentation/edit|publisher}}
{{Citation Style documentation/opt|1=
*{{para|work|no}} suppresses "; if '''work''' is defined, then '''publisher''' and '''location''' are enclosed in parentheses"
*{{para|map|yes}} changes:
** '''publisher''': Name of publisher. The [[publisher]] is the company that publishes the work being cited. Do not use the '''publisher''' parameter for the name of a work (e.g., a book, encyclopedia, newspaper, magazine, journal, website). Displays before title. Do not wikilink—use publisher-link instead.
** '''publisher-link''': Title of existing Wikipedia article about the publisher—not the publisher's website; do not wikilink.
}}

===newsgroup===
{{Citation Style documentation/edit|newsgroup}}

===language===
{{Citation Style documentation/edit|language}}

===pages===
{{Citation Style documentation/edit|pages}}
{{Citation Style documentation/opt|1=
* '''work''' adds "or '''work''' (or an alias) is defined"}}

===time===
{{Citation Style documentation/edit|time}}

===id1===
{{Citation Style documentation/edit|id1}}

===id2===
{{Citation Style documentation/edit|id2}}

===url===
{{Citation Style documentation/edit|url}}
{{Citation Style documentation/opt|
* '''pmc''' adds:

 " If '''url''' is not defined but '''pmc''' is, then '''url''' is set to the '''pmc''' link.
:* '''Embargo''': Date that '''pmc''' goes live; if this is in the future, then '''url''' is not set to the '''pmc''' link until that date."}}

===chapterurl===
{{Citation Style documentation/edit|chapterurl}}

===lay===
{{Citation Style documentation/edit|lay}}

===quote===
{{Citation Style documentation/edit|quote}}
{{Citation Style documentation/opt|1=
* {{para|cs2|yes}} suppresses "When supplied, the citation terminator (a period by default) is suppressed, so the quote needs to include terminating punctuation."}}

===ref===
{{Citation Style documentation/edit|ref}}

===ref2===
{{Citation Style documentation/edit|ref2}}

===display===
{{Citation Style documentation/edit|display}}
{{Citation Style documentation/opt|
* '''cs2''': When set, changes:
**'''postscript''' to "defaults to none"
** '''separator''' to "Defaults to a comma (,)"}}

===Subscription or registration required===
{{Citation Style documentation/edit|registration}}

===map_series===
{{Citation Style documentation/edit|map_series}}

===map_pages===
{{Citation Style documentation/edit|map_pages}}

===interview_id===
{{Citation Style documentation/edit|interview_id}}

===interview_author===
{{Citation Style documentation/edit|interview_author}}

===interview_interviewer===
{{Citation Style documentation/edit|interview_interviewer}}

===album_name===
{{Citation Style documentation/edit|album_name}}

===season===
{{Citation Style documentation/edit|season}}

===network===
{{Citation Style documentation/edit|network}}

===transcript===
{{Citation Style documentation/edit|transcript}}

===conference===
{{Citation Style documentation/edit|conference}}

==See also==

{{Citation Style 1}}

<includeonly>
<!-- Categories and interwikis go here: -->
[[Category:Documentation assistance templates]]

</includeonly>