Template:Citation Style documentation

From Communpedia
Jump to: navigation, search
[edit] [purge] Documentation icon Template documentation

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 create 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
      • Laysummary
      • Display options

Lead section

Use {{csdoc|lead|content}} to create consistent content for the lead:

[edit subtemplate]

This Citation Style 1 template is used to create citations for . Template:Citation Style documentation/opt

Markup Renders as
{{csdoc|lead|books}}
Template loop detected: Template:Csdoc

Usage section

Start the usage section with {{csdoc|usage}}:

Template loop detected: Template:Csdoc

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 style="white-space:nowrap;"><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= |month= |origyear= |publisher= |location= |language= |isbn= |oclc= |doi= |id= |page= |pages= |at= |trans_chapter= |chapter= |chapterurl= |quote= |ref= |bibcode= |laysummary= |laydate= |author-mask= |author-name-separator= |author-separator= |display-authors= |separator= |postscript= |lastauthoramp=}}</nowiki></code>
{{end}}

Template loop detected: Template:Csdoc

{{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= |laysummary= |laydate= |author-mask= |author-name-separator= |author-separator= |display-authors= |separator= |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 style="white-space:nowrap;"><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 loop detected: Template:Csdoc

{{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
  • Seperate the next column with:
</pre>
{{csdoc|usage vertical mid}}
<pre style="margin:0px;">
  • Create the prerequisites column; blank lines must include a &nbsp;
  • Seperate 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                 =
| authorlink            =
}}
</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 loop detected: Template:Csdoc

{{cite book
| last                  =
| first                 =
| authorlink            =
}}

Template loop detected: Template:Csdoc

 
 
last
 
 

Template loop detected: Template:Csdoc

 
same as last1
same as first1
 
 

Template loop detected: Template:Csdoc

Sub-templates

Usage

[edit subtemplate]

Template:Citation Style documentation/usage |}

Usage full

[edit subtemplate]

Template:Citation Style documentation/usage full |}

Usage common

[edit subtemplate]

Template:Citation Style documentation/usage common |}

Usage vertical

[edit subtemplate]

Template:Citation Style documentation/usage vertical |}

Usage vertical mid

[edit subtemplate]

Template:Citation Style documentation/usage vertical mid |}

Usage vertical end

[edit subtemplate]

Template:Citation Style documentation/usage vertical end

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><code style="white-space:nowrap;"><nowiki>...</nowiki></code></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
  • {{cite book |title=Mysterious book}}
Mysterious book. 

Parameters section

syntax

[edit subtemplate]

Template:Citation Style documentation/syntax

coins

[edit subtemplate]

Template:Citation Style documentation/coins

sep_period

[edit subtemplate]

Template:Citation Style documentation/sep period

sep_comma

[edit subtemplate]

Template:Citation Style documentation/sep comma

required

[edit subtemplate]

Template:Citation Style documentation/required

deprecated

[edit subtemplate]

Template:Citation Style documentation/deprecated Template:Citation Style documentation/opt

author

[edit subtemplate]

Template:Citation Style documentation/author Template:Citation Style documentation/opt

editor

[edit subtemplate]

Template:Citation Style documentation/editor

title

[edit subtemplate]

Template:Citation Style documentation/title

Template:Citation Style documentation/opt

web

[edit subtemplate]

Template:Citation Style documentation/web

chapter

[edit subtemplate]

Template:Citation Style documentation/chapter Template:Citation Style documentation/opt

type

[edit subtemplate]

Template:Citation Style documentation/type Template:Citation Style documentation/opt

journal

[edit subtemplate]

Template:Citation Style documentation/journal Template:Citation Style documentation/opt

edition

[edit subtemplate]

Template:Citation Style documentation/edition

series

[edit subtemplate]

Template:Citation Style documentation/series

series_episode

[edit subtemplate]

Template:Citation Style documentation/series episode

event

[edit subtemplate]

Template:Citation Style documentation/event

agency

[edit subtemplate]

Template:Citation Style documentation/agency

volume

[edit subtemplate]

Template:Citation Style documentation/volume

date

[edit subtemplate]

Template:Citation Style documentation/date Template:Citation Style documentation/opt

publisher

[edit subtemplate]

Template:Citation Style documentation/publisher Template:Citation Style documentation/opt

newsgroup

[edit subtemplate]

Template:Citation Style documentation/newsgroup

language

[edit subtemplate]

Template:Citation Style documentation/language

pages

[edit subtemplate]

Template:Citation Style documentation/pages Template:Citation Style documentation/opt

time

[edit subtemplate]

Template:Citation Style documentation/time

id1

[edit subtemplate]

Template:Citation Style documentation/id1

id2

[edit subtemplate]

Template:Citation Style documentation/id2

url

[edit subtemplate]

Template:Citation Style documentation/url Template:Citation Style documentation/opt

chapterurl

[edit subtemplate]

Template:Citation Style documentation/chapterurl

lay

[edit subtemplate]

Template:Citation Style documentation/lay

quote

[edit subtemplate]

Template:Citation Style documentation/quote Template:Citation Style documentation/opt

ref

[edit subtemplate]

Template:Citation Style documentation/ref

ref2

[edit subtemplate]

Template:Citation Style documentation/ref2

display

[edit subtemplate]

Template:Citation Style documentation/display Template:Citation Style documentation/opt

map_series

[edit subtemplate]

Template:Citation Style documentation/map series

map_id

[edit subtemplate]

Template:Citation Style documentation/map id

map_pages

[edit subtemplate]

Template:Citation Style documentation/map pages

interview_id

[edit subtemplate]

Template:Citation Style documentation/interview id

interview_author

[edit subtemplate]

Template:Citation Style documentation/interview author

interview_interviewer

[edit subtemplate]

Template:Citation Style documentation/interview interviewer

album_name

[edit subtemplate]

Template:Citation Style documentation/album name

album_artist

[edit subtemplate]

Template:Citation Style documentation/album artist

season

[edit subtemplate]

Template:Citation Style documentation/season

network

[edit subtemplate]

Template:Citation Style documentation/network

transcript

[edit subtemplate]

Template:Citation Style documentation/transcript

notestitle

[edit subtemplate]

Template:Citation Style documentation/notestitle

conference

[edit subtemplate]

Template:Citation Style documentation/conference

See also

Template:Citation Style 1


This page contains information from Wikipedia (view authors). It has been modified so that it meets Communpedia's standards. WP
This page contains information from Wikipedia (view authors). It has been modified so that it meets Communpedia's standards. WP