View source for Template:Citation Style documentation/doc

{{Documentation subpage}}
{{template shortcut|csdoc}}
{{notice|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 {{cs1}} templates.

:For example: {{tlx|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.

==Parameters==

===syntax===
{{Citation Style documentation/edit|syntax}}

===coins===
{{Citation Style documentation/edit|coins}}

===sep_period===
{{Citation Style documentation/edit|sep_period}}

===sep_comma===
{{Citation Style documentation/edit|sep_comma}}

===required===
{{Citation Style documentation/edit|required}}

===deprecated===
{{Citation Style documentation/edit|deprecated}}
{{Citation Style documentation/opt|1=
*{{para|date2|yes}} adds:
** date2
** month2
** year2}}

===author===
{{Citation Style documentation/edit|author}}
{{Citation Style documentation/opt|1=
*{{para|coauthors|yes}} adds "'''coauthors''': (deprecated) Names of of coauthors. Use the same format as the authors."
*{{para|others|yes}} adds "'''others''': To record other contributors to the work, such as "Illustrated by Smith" or "Trans. Smith"."
*{{para|aliases}} add aliases for '''last'''.
}}

===editor===
{{Citation Style documentation/edit|editor}}

===title===
{{Citation Style documentation/edit|title}}

{{Citation Style documentation/opt|1=<br />
'''title_format''' sets the display format:
* '''quotes''' = Displays in quotes.
* '''work''' = If '''work''' is defined, then '''title''' is displayed in quotes, else displays in italics.
* default = Displays in italics.

'''title_title''' sets the display title:
* '''encyclopedia''' = encyclopedia
* default = title}}

===web===
{{Citation Style documentation/edit|web}}

===chapter===
{{Citation Style documentation/edit|chapter}}
{{Citation Style documentation/opt|1=<br />
'''title_format''' sets the display format:
*'''italics''' = Displays in italics.
* '''work''' = If '''work''' is defined, then '''title''' is displayed in quotes, else displays in italics.
* default = Displays in quotes.
'''title_title''' sets the display title:
* '''booktitle''' = booktitle
* default = chapter}}

===type===
{{Citation Style documentation/edit|type}}
{{Citation Style documentation/opt|
* '''type_default''': Adds "Defaults to '''type_default'''"}}

===journal===
{{Citation Style documentation/edit|journal}}
{{Citation Style documentation/opt|1=
* '''department''' adds:
:* '''department''': Regular department within the periodical. Displays after '''work''' and is in plain text.
}}

===edition===
{{Citation Style documentation/edit|edition}}

===series===
{{Citation Style documentation/edit|series}}

===series_episode===
{{Citation Style documentation/edit|series_episode}}

===event===
{{Citation Style documentation/edit|event}}

===agency===
{{Citation Style documentation/edit|agency}}

===volume===
{{Citation Style documentation/edit|volume}}

===date===
{{Citation Style documentation/edit|date}}
{{Citation Style documentation/opt|1=
* '''aliases''' includes aliases for '''date'''
* '''began''' adds:
:* OR: '''began''': Full date the first part of the program or episode aired.
:** AND: '''ended''': Full date the last part of the program or episode aired.}}

===publisher===
{{Citation Style documentation/edit|publisher}}
{{Citation Style documentation/opt|1=
*{{para|work|no}} suppresses "; if '''work''' is defined, then '''publisher''' and '''location''' are enclosed in parentheses"
*{{para|map|yes}} changes:
** '''publisher''': Name of publisher. Displays before title. Do not wikilink—use publisher-link instead.
** '''publisher-link''': Title of existing Wikipedia article about the publisher—not the publisher's website; do not wikilink.
}}

===newsgroup===
{{Citation Style documentation/edit|newsgroup}}

===language===
{{Citation Style documentation/edit|language}}

===pages===
{{Citation Style documentation/edit|pages}}
{{Citation Style documentation/opt|1=
* '''work''' adds "or '''work''' is defined"}}

===time===
{{Citation Style documentation/edit|time}}

===id1===
{{Citation Style documentation/edit|id1}}

===id2===
{{Citation Style documentation/edit|id2}}

===url===
{{Citation Style documentation/edit|url}}
{{Citation Style documentation/opt|
* '''pmc''' adds:

 " If '''url''' is not defined but '''pmc''' is, then '''url''' is set to the '''pmc''' link.
:* '''Embargo''': Date that '''pmc''' goes live; if this is in the future, then then '''url''' is not set to the '''pmc''' link until that date."}}

===chapterurl===
{{Citation Style documentation/edit|chapterurl}}

===lay===
{{Citation Style documentation/edit|lay}}

===quote===
{{Citation Style documentation/edit|quote}}
{{Citation Style documentation/opt|1=
* {{para|cs2|yes}} suppresses "When supplied, the citation terminator (a period by default) is suppressed, so the quote needs to include terminating punctuation."}}

===ref===
{{Citation Style documentation/edit|ref}}

===ref2===
{{Citation Style documentation/edit|ref2}}

===display===
{{Citation Style documentation/edit|display}}
{{Citation Style documentation/opt|
* '''cs2''': When set, changes:
**'''postscript''' to "defaults to none"
** '''separator''' to "Defaults to a comma (,)"}}

===map_series===
{{Citation Style documentation/edit|map_series}}

===map_id===
{{Citation Style documentation/edit|map_id}}

===map_pages===
{{Citation Style documentation/edit|map_pages}}

===interview_id===
{{Citation Style documentation/edit|interview_id}}

===interview_author===
{{Citation Style documentation/edit|interview_author}}

===interview_interviewer===
{{Citation Style documentation/edit|interview_interviewer}}

===DVD-notes_date===
{{Citation Style documentation/edit|DVD-notes_date}}

===album_name===
{{Citation Style documentation/edit|album_name}}

===album_artist===
{{Citation Style documentation/edit|album_artist}}

===season===
{{Citation Style documentation/edit|season}}

===network===
{{Citation Style documentation/edit|network}}

===transcript===
{{Citation Style documentation/edit|transcript}}

===notestitle===
{{Citation Style documentation/edit|notestitle}}

===conference===
{{Citation Style documentation/edit|conference}}

{{Citation Style 1}}

<includeonly>
<!-- Categories go here: -->
[[Category:Citation templates]]

</includeonly>