Template: Citation Style documentation/doc

From Break Into Chat - BBS wiki
Jump to: navigation, search

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:

[edit subtemplate]

This Citation Style 1 template is used to create citations for .

Options for this field:

One unnamed parameter is used to create the trailing text.

Markup Renders as
{{csdoc|lead|books}}

This Citation Style 1 template is used to create citations for books.

Lua notice

[edit subtemplate]

Usage section

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

Template loop detected: Template:Citation Style documentation/usage

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= |author1-link= |last2= |first2= |author2-link= |editor1-first= |editor1-last= |editor1-link= |others= |title= |trans-title= |url= |archive-url= |archive-date= |format= |access-date= |type= |edition= |series= |volume= |date= |year= |orig-year= |publisher= |location= |language= |isbn= |oclc= |doi= |id= |page= |pages= |at= |trans-chapter= |chapter= |chapter-url= |quote= |ref= |bibcode= |lay-url= |lay-source= |lay-date= |author-mask= |display-authors= |postscript= |last-author-amp=}}</nowiki></code>
{{end}}
Full parameter set in horizontal format
{{cite book |last1= |first1= |author1-link= |last2= |first2= |author2-link= |editor1-first= |editor1-last= |editor1-link= |others= |title= |trans-title= |url= |archive-url= |archive-date= |format= |access-date= |type= |edition= |series= |volume= |date= |year= |orig-year= |publisher= |location= |language= |isbn= |oclc= |doi= |id= |page= |pages= |at= |trans-chapter= |chapter= |chapter-url= |quote= |ref= |bibcode= |lay-url= |lay-source= |lay-date= |author-mask= |display-authors= |postscript= |last-author-amp=}}

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= |author-link= |title= |url= |access-date= |year= |publisher= |location= |isbn= |page= |pages=}}</nowiki></code>
{{end}}
Most commonly used parameters in horizontal format
{{cite book |last= |first= |author-link= |title= |url= |access-date= |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 &nbsp;
  • Separate the next column with:
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
  • Create the instructions column; blank lines must include a &nbsp;
  • End with:
</pre>
{{csdoc|usage vertical end}}

Example:

{{csdoc|usage vertical}}
<pre style="margin:0px;">
{{cite book
| last                  =
| first                 =
| author-link           =
}}
</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                 =
| author-link           =
}}
 
 
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

[edit subtemplate]

Template:Citation Style documentation/ |}

Usage full

[edit subtemplate]

Full parameter set in horizontal format

Usage common

[edit subtemplate]

Most commonly used parameters in horizontal format

Usage vertical

[edit subtemplate]

Full parameter set in vertical format
Vertical list Prerequisites Brief instructions / notes

Usage vertical mid

[edit subtemplate]

| style="vertical-align:top;" | |}

Usage vertical end

[edit subtemplate]

|}

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

Examples section

Use {{markup2}} to format the examples