Template:Citation Style documentation

From TechInfoDepot
Jump to navigationJump to search
Documentation icon 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:

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

Markup =scope="col" style="width:50%;"| Renders as
{{csdoc|lead|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. Almost all parameter names are supported only in lower case (some initialisms, such as |isbn= have upper-case aliases like |ISBN=, which are acceptable for use). Use the "|" (pipe) character between each parameter. Unused parameters may be deleted to avoid clutter in the edit window. Some samples on this documentation page may include the current date. If the date is not current, then purge 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}}

Template:Citation Style documentation/usage vertical

{{cite book
| last                  =
| first                 =
| author-link           =
}}

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

|}

Usage full

Template:Citation Style documentation/edit

|}

Usage common

Template:Citation Style documentation/edit

|}

Usage vertical

Template:Citation Style documentation/edit

|}

Usage vertical mid

Template:Citation Style documentation/edit

|}

Usage vertical end

Template:Citation Style documentation/edit

Examples section

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

Basic usage with url (and accessdate) and edition

  • {{cite book |title=Mysterious book}}
    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

See also

Template:Citation Style 1