Sjabloon:Citation Style 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 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:
Sjabloon:Citation Style documentation/edit Sjabloon:Citation Style documentation/opt
Markup | Renders as |
---|---|
{{csdoc|lead|books}} |
This Citation Style 1 template is used to create citations for books. |
Lua notice
Sjabloon:Citation Style documentation/edit
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}}
|
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}}
|
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}}
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 |}
Usage vertical end
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
|
CitationClass=book
}} |
Parameters section
syntax
Sjabloon:Citation Style documentation/edit
coins
Sjabloon:Citation Style documentation/edit
sep_period
Sjabloon:Citation Style documentation/edit
sep_comma
Sjabloon:Citation Style documentation/edit
required
Sjabloon:Citation Style documentation/edit
deprecated
Sjabloon:Citation Style documentation/edit Sjabloon:Citation Style documentation/opt
author
Sjabloon:Citation Style documentation/edit Sjabloon:Citation Style documentation/opt
editor
Sjabloon:Citation Style documentation/edit Sjabloon:Citation Style documentation/opt
title
Sjabloon:Citation Style documentation/edit
Sjabloon:Citation Style documentation/opt
web
Sjabloon:Citation Style documentation/edit
chapter
Sjabloon:Citation Style documentation/edit Sjabloon:Citation Style documentation/opt
type
Sjabloon:Citation Style documentation/edit Sjabloon:Citation Style documentation/opt
journal
Sjabloon:Citation Style documentation/edit Sjabloon:Citation Style documentation/opt
edition
Sjabloon:Citation Style documentation/edit
series
Sjabloon:Citation Style documentation/edit
series_episode
Sjabloon:Citation Style documentation/edit
event
Sjabloon:Citation Style documentation/edit
agency
Sjabloon:Citation Style documentation/edit
volume
Sjabloon:Citation Style documentation/edit Sjabloon:Citation Style documentation/opt
date
Sjabloon:Citation Style documentation/edit Sjabloon:Citation Style documentation/opt
publisher
Sjabloon:Citation Style documentation/edit Sjabloon:Citation Style documentation/opt
newsgroup
Sjabloon:Citation Style documentation/edit
language
Sjabloon:Citation Style documentation/edit
pages
Sjabloon:Citation Style documentation/edit Sjabloon:Citation Style documentation/opt
time
Sjabloon:Citation Style documentation/edit
id1
Sjabloon:Citation Style documentation/edit
id2
Sjabloon:Citation Style documentation/edit
url
Sjabloon:Citation Style documentation/edit Sjabloon:Citation Style documentation/opt
chapterurl
Sjabloon:Citation Style documentation/edit
lay
Sjabloon:Citation Style documentation/edit
quote
Sjabloon:Citation Style documentation/edit Sjabloon:Citation Style documentation/opt
ref
Sjabloon:Citation Style documentation/edit
ref2
Sjabloon:Citation Style documentation/edit
display
Sjabloon:Citation Style documentation/edit Sjabloon:Citation Style documentation/opt
map_series
Sjabloon:Citation Style documentation/edit
map_pages
Sjabloon:Citation Style documentation/edit
interview_id
Sjabloon:Citation Style documentation/edit
interview_author
Sjabloon:Citation Style documentation/edit
interview_interviewer
Sjabloon:Citation Style documentation/edit
album_name
Sjabloon:Citation Style documentation/edit
album_artist
Sjabloon:Citation Style documentation/edit
season
Sjabloon:Citation Style documentation/edit
network
Sjabloon:Citation Style documentation/edit
transcript
Sjabloon:Citation Style documentation/edit
notestitle
Sjabloon:Citation Style documentation/edit
conference
Sjabloon:Citation Style documentation/edit
See also
The above documentation is transcluded from Sjabloon:Citation Style documentation/doc. (edit | history) Editors can experiment in this template's sandbox (create) and testcases (create) pages. Please add categories and interwikis to the /doc subpage. Subpages of this template. |