Template:Citation Style documentation
Note to editors: Please don't categorize this template by editing it directly. Instead, place the category in its documentation page, in its "includeonly" section.
Contents
- 1 Usage
- 2 Section usage
- 3 Lead section
- 4 Usage section
- 5 Examples section
- 6 Parameters section
- 6.1 syntax
- 6.2 COinS
- 6.3 sep_period
- 6.4 sep_comma
- 6.5 required
- 6.6 deprecated
- 6.7 author
- 6.8 editor
- 6.9 title
- 6.10 web
- 6.11 chapter
- 6.12 type
- 6.13 journal
- 6.14 edition
- 6.15 series
- 6.16 series_episode
- 6.17 event
- 6.18 agency
- 6.19 volume
- 6.20 date
- 6.21 publisher
- 6.22 newsgroup
- 6.23 language
- 6.24 pages
- 6.25 time
- 6.26 id1
- 6.27 id2
- 6.28 url
- 6.29 chapterurl
- 6.30 lay
- 6.31 quote
- 6.32 ref
- 6.33 ref2
- 6.34 display
- 6.35 Subscription or registration required
- 6.36 map_series
- 6.37 map_pages
- 6.38 interview_id
- 6.39 interview_author
- 6.40 interview_interviewer
- 6.41 album_name
- 6.42 season
- 6.43 network
- 6.44 transcript
- 6.45 conference
- 7 See also
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
Markup | Renders as |
---|---|
{{csdoc|lead|books}} |
|
Lua notice
{{#invoke:Suppress categories|main|Template:Citation Style documentation/edit}}
Usage section
Start the usage section with {{csdoc|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=}}
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=}}
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;"> 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
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}} }}
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