Template:Citation Style documentation

Template documentation

Shortcut {{csdoc}}

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[edit]

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[edit]

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
  - Laysummary
  - Display options

Lead section[edit]

Use {{csdoc|lead|content}} to create consistent content for the lead:

Template:Citation Style documentation/edit Template:Citation Style documentation/opt

Markup	Renders as
[markup]	[rendering]

Lua notice[edit]

Template:Citation Style documentation/edit

Usage section[edit]

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

Template:Citation Style documentation/usage

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

Full horizontal style[edit]

Start with {{csdoc|usage full}}
Precede the sample markup with : to create an indent
Enclose the sample in <code><code class="nowrap" style=""><nowiki>...</nowiki></code></code>
Close the table with {{end}}

{{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= |month= |origyear= |publisher= |location= |language= |isbn= |oclc= |doi= |id= |page= |pages= |at= |trans_chapter= |chapter= |chapterurl= |quote= |ref= |bibcode= |laysummary= |laydate= |author-mask= |author-name-separator= |author-separator= |display-authors= |separator= |postscript= |lastauthoramp=}}</nowiki></code>
{{end}}

Template:Citation Style documentation/usage full

{{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= |month= |origyear= |publisher= |location= |language= |isbn= |oclc= |doi= |id= |page= |pages= |at= |trans_chapter= |chapter= |chapterurl= |quote= |ref= |bibcode= |laysummary= |laydate= |author-mask= |author-name-separator= |author-separator= |display-authors= |separator= |postscript= |lastauthoramp=}}

Template:End

Most commonly used horizontal style[edit]

Start with {{csdoc|usage common}}
Precede the sample markup with : to create an indent
Enclose the sample in <code><code class="nowrap" style=""><nowiki>...</nowiki></code></code>
Close the table with {{end}}

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

Template:Citation Style documentation/usage common

{{cite book |last= |first= |authorlink= |title= |url= |accessdate= |year= |publisher= |location= |isbn= |page= |pages=}}

Template:End

Full vertical style[edit]

The full vertical style is created in three columns: 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  
Separate the next column with:

</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">

Create the instructions column; blank lines must include a  
End with:

</pre>
{{csdoc|usage vertical end}}

Example:

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

Template:Citation Style documentation/usage vertical

{{cite book
| last                  =
| first                 =
| authorlink            =
}}

Template:Citation Style documentation/usage vertical mid

 
 
last

Template:Citation Style documentation/usage vertical mid

 
same as last1
same as first1

Template:Citation Style documentation/usage vertical end

Sub-templates[edit]

Examples section[edit]

When creating examples, use these styles for consistency:

A title before the example, formatted in bold by the use of '''
The sample markup for the example: preceded by * to create a bullet, then the markup enclosed in <code><code class="nowrap" style=""><nowiki>...</nowiki></code></code>
The live markup: preceded by : to create an indent