Sjabloon:Citation Style documentation/doc

Usage

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

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 {{csdoc|lead|content}} to create consistent content for the lead:

Markup	Renders as
{{csdoc|lead|books}}	This Citation Style 1 template is used to create citations for books.

Usage section

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

Copy a blank version to use. All parameter names must be in lowercase. Use the "|" (pipe) character between each parameter. Delete unused parameters to avoid clutter in the edit window. Some samples 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

• 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 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= |layurl= |laysource= |laydate= |author-mask= |author-name-separator= |author-separator= |display-authors= |separator= |postscript= |lastauthoramp=}}</nowiki></code>
{{end}}

Full parameter set in horizontal format

{{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= |layurl= |laysource= |laydate= |author-mask= |author-name-separator= |author-separator= |display-authors= |separator= |postscript= |lastauthoramp=}}

Most commonly used horizontal style

• 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= |authorlink= |title= |url= |accessdate= |year= |publisher= |location= |isbn= |page= |pages=}}</nowiki></code>
{{end}}

Most commonly used parameters in horizontal format

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

Full vertical style

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

Full parameter set in vertical format

Vertical list	Prerequisites	Brief instructions / notes
{{cite book | last = | first = | authorlink = }}	last	same as last1 same as first1

• If a field name is listed in the Prerequisites column it is a prerequisite for the field to the left.

Sub-templates

Usage

Sjabloon:Citation Style documentation/edit |}

Usage full

Sjabloon:Citation Style documentation/edit |}

Usage common

Sjabloon:Citation Style documentation/edit |}

Usage vertical

Sjabloon:Citation Style documentation/edit |}

Usage vertical mid

Sjabloon:Citation Style documentation/edit |}

Examples section

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><nowiki>...</nowiki></code>
• The live markup: preceded by : to create an indent

Markup	Renders as
'''Title''' *<code><nowiki>{{cite book |title=Mysterious book}}</nowiki></code> :{{cite book |title=Mysterious book}}	Title {{cite book |title=Mysterious book}} {{#invoke:citation/CS1|citation	CitationClass=book }}