Difference between revisions of "Template:Citation Style documentation"

[view] [edit] [history] [purge] Template Documentation

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 Template:Cs1 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:

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

{{csdoc|lead|books}} 

Lua notice

{{#invoke:Suppress categories|main|Template:Citation Style documentation/edit}}

Usage section

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

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

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

Template:End

Most commonly used horizontal style

• 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

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

Usage

Template:Citation Style documentation/edit Template:End

Usage full

Template:Citation Style documentation/edit Template:End

Usage common

Template:Citation Style documentation/edit Template:End

Usage vertical

Template:Citation Style documentation/edit Template:End

Usage vertical mid

Template:Citation Style documentation/edit Template:End

Usage vertical end

Template:Citation Style documentation/edit

Examples section

Use {{markup2}} to format the examples; see the template documentation for use.

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

Template:Markup2

Parameters section

syntax

Template:Citation Style documentation/edit

COinS

Template:Citation Style documentation/edit

sep_period

Template:Citation Style documentation/edit

sep_comma

Template:Citation Style documentation/edit

required

Template:Citation Style documentation/edit

deprecated

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

author

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

editor

Template:Citation Style documentation/edit

title

Template:Citation Style documentation/edit

Template:Citation Style documentation/opt

web

Template:Citation Style documentation/edit

chapter

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

type

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

journal

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

edition

Template:Citation Style documentation/edit

series

Template:Citation Style documentation/edit

series_episode

Template:Citation Style documentation/edit

event

Template:Citation Style documentation/edit

agency

Template:Citation Style documentation/edit

volume

Template:Citation Style documentation/edit

date

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

publisher

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

newsgroup

Template:Citation Style documentation/edit

language

Template:Citation Style documentation/edit

pages

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

time

Template:Citation Style documentation/edit

id1

Template:Citation Style documentation/edit

id2

Template:Citation Style documentation/edit

url

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

chapterurl

Template:Citation Style documentation/edit

lay

Template:Citation Style documentation/edit

quote

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

ref

Template:Citation Style documentation/edit

ref2

Template:Citation Style documentation/edit

display

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

Subscription or registration required

Template:Citation Style documentation/edit

map_series

Template:Citation Style documentation/edit

map_pages

Template:Citation Style documentation/edit

interview_id

Template:Citation Style documentation/edit

interview_author

Template:Citation Style documentation/edit

interview_interviewer

Template:Citation Style documentation/edit

album_name

Template:Citation Style documentation/edit

season

Template:Citation Style documentation/edit

network

Template:Citation Style documentation/edit

transcript

Template:Citation Style documentation/edit

conference

Template:Citation Style documentation/edit

See also

Template:Citation Style 1