Template documentation[view] [edit] [history] [purge]

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:

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit ᱪᱷᱟᱸᱪ:Citation Style documentation/opt

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

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

Lua noticeᱥᱟᱯᱲᱟᱣ

Script error: No such module "Suppress categories".

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 Italic textpurge 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= |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ᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit |}

Usage fullᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit |}

Usage commonᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit |}

Usage verticalᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit |}

Usage vertical midᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit |}

Usage vertical endᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

Examples sectionᱥᱟᱯᱲᱟᱣ

Use {{markup2}} to format the examples (see that template's 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}}
}}

ᱪᱷᱟᱸᱪ:Markup2

Parameters sectionᱥᱟᱯᱲᱟᱣ

syntaxᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

COinSᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

sep_periodᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

sep_commaᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

requiredᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

deprecatedᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

authorᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit ᱪᱷᱟᱸᱪ:Citation Style documentation/opt

editorᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

titleᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

ᱪᱷᱟᱸᱪ:Citation Style documentation/opt

webᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

chapterᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit ᱪᱷᱟᱸᱪ:Citation Style documentation/opt

typeᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit ᱪᱷᱟᱸᱪ:Citation Style documentation/opt

journalᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit ᱪᱷᱟᱸᱪ:Citation Style documentation/opt

editionᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

seriesᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

series_episodeᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

eventᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

agencyᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

volumeᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

dateᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit ᱪᱷᱟᱸᱪ:Citation Style documentation/opt

publisherᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit ᱪᱷᱟᱸᱪ:Citation Style documentation/opt

newsgroupᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

languageᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

pagesᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit ᱪᱷᱟᱸᱪ:Citation Style documentation/opt

timeᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

id1ᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

id2ᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

urlᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit ᱪᱷᱟᱸᱪ:Citation Style documentation/opt

chapterurlᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

layᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

quoteᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit ᱪᱷᱟᱸᱪ:Citation Style documentation/opt

refᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

ref2ᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

displayᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit ᱪᱷᱟᱸᱪ:Citation Style documentation/opt

Subscription or registration requiredᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

map_seriesᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

map_pagesᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

interview_idᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

interview_authorᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

interview_interviewerᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

album_nameᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

seasonᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

networkᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

transcriptᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

conferenceᱥᱟᱯᱲᱟᱣ

ᱪᱷᱟᱸᱪ:Citation Style documentation/edit

See alsoᱥᱟᱯᱲᱟᱣ