Template:Citation Style documentation/doc
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 source]
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 source]
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[edit source]
Use {{csdoc|lead|content}} to create consistent content for the lead:
Template:Citation Style documentation/edit Template:Citation Style documentation/opt
Markup [[:Template: | Renders as |
---|---|
{{csdoc|lead|books}} |
This Citation Style 1 template is used to create citations for books. |
Lua notice[edit source]
Script error: No such module "Suppress categories".
Usage section[edit source]
Start the usage section with {{csdoc|usage}}:
Parameters to copy are enclosed in tables created by sub-templates.
Full horizontal style[edit source]
- 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= |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=}}
|}
Most commonly used horizontal style[edit source]
- 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}}
Template:Citation Style documentation/usage common
{{cite book |last= |first= |authorlink= |title= |url= |accessdate= |year= |publisher= |location= |isbn= |page= |pages=}}
|}
Full vertical style[edit source]
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;"> last </pre> {{csdoc|usage vertical mid}} <pre style="margin:0px;"> same as last1 same as first1 </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 source]
Usage[edit source]
Template:Citation Style documentation/edit |}
Usage full[edit source]
Template:Citation Style documentation/edit |}
Usage common[edit source]
Template:Citation Style documentation/edit |}
Usage vertical[edit source]
Template:Citation Style documentation/edit |}
Usage vertical mid[edit source]
Template:Citation Style documentation/edit |}
Usage vertical end[edit source]
Template:Citation Style documentation/edit
Examples section[edit source]
Use {{markup2}} to format the examples Template:Crossref.
{{markup2 |t=Basic usage with url (and accessdate) and edition |m={{cite book |title=Mysterious book}} |r={{cite book |title=Mysterious book}} }}
Parameters section[edit source]
syntax[edit source]
Template:Citation Style documentation/edit
COinS[edit source]
Template:Citation Style documentation/edit
sep_period[edit source]
Template:Citation Style documentation/edit
sep_comma[edit source]
Template:Citation Style documentation/edit
required[edit source]
Template:Citation Style documentation/edit
deprecated[edit source]
Template:Citation Style documentation/edit Template:Citation Style documentation/opt
author[edit source]
Template:Citation Style documentation/edit Template:Citation Style documentation/opt
editor[edit source]
Template:Citation Style documentation/edit
title[edit source]
Template:Citation Style documentation/edit
Template:Citation Style documentation/opt
web[edit source]
Template:Citation Style documentation/edit
chapter[edit source]
Template:Citation Style documentation/edit Template:Citation Style documentation/opt
type[edit source]
Template:Citation Style documentation/edit Template:Citation Style documentation/opt
journal[edit source]
Template:Citation Style documentation/edit Template:Citation Style documentation/opt
edition[edit source]
Template:Citation Style documentation/edit
series[edit source]
Template:Citation Style documentation/edit
series_episode[edit source]
Template:Citation Style documentation/edit
event[edit source]
Template:Citation Style documentation/edit
agency[edit source]
Template:Citation Style documentation/edit
volume[edit source]
Template:Citation Style documentation/edit
date[edit source]
Template:Citation Style documentation/edit Template:Citation Style documentation/opt
publisher[edit source]
Template:Citation Style documentation/edit Template:Citation Style documentation/opt
newsgroup[edit source]
Template:Citation Style documentation/edit
language[edit source]
Template:Citation Style documentation/edit
pages[edit source]
Template:Citation Style documentation/edit Template:Citation Style documentation/opt
time[edit source]
Template:Citation Style documentation/edit
id1[edit source]
Template:Citation Style documentation/edit
id2[edit source]
Template:Citation Style documentation/edit
url[edit source]
Template:Citation Style documentation/edit Template:Citation Style documentation/opt
chapterurl[edit source]
Template:Citation Style documentation/edit
lay[edit source]
Template:Citation Style documentation/edit
quote[edit source]
Template:Citation Style documentation/edit Template:Citation Style documentation/opt
ref[edit source]
Template:Citation Style documentation/edit
ref2[edit source]
Template:Citation Style documentation/edit
display[edit source]
Template:Citation Style documentation/edit Template:Citation Style documentation/opt
Subscription or registration required[edit source]
Template:Citation Style documentation/edit
map_series[edit source]
Template:Citation Style documentation/edit
map_pages[edit source]
Template:Citation Style documentation/edit
interview_id[edit source]
Template:Citation Style documentation/edit
interview_author[edit source]
Template:Citation Style documentation/edit
interview_interviewer[edit source]
Template:Citation Style documentation/edit
album_name[edit source]
Template:Citation Style documentation/edit
season[edit source]
Template:Citation Style documentation/edit
network[edit source]
Template:Citation Style documentation/edit
transcript[edit source]
Template:Citation Style documentation/edit
conference[edit source]
Template:Citation Style documentation/edit
See also[edit source]