https://portlandwiki.org/index.php?title=Template:Citation_Style_documentation&feed=atom&action=historyTemplate:Citation Style documentation - Revision history2024-03-28T23:47:13ZRevision history for this page on the wikiMediaWiki 1.40.1https://portlandwiki.org/index.php?title=Template:Citation_Style_documentation&diff=22710&oldid=prevMitch Gore: Created page with "{{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 par..."2012-11-01T03:46:32Z<p>Created page with "{{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 par..."</p>
<p><b>New page</b></p><div>{{Documentation subpage}}<br />
{{template shortcut|csdoc}}<br />
{{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.}}<br />
<br />
==Usage==<br />
This template is used to build consistent documentation pages for {{cs1}} templates.<br />
<br />
:For example: {{tlx|Citation Style documentation|author}} will show the author documentation.<br />
<br />
Where a particular section of documentation is not appropriate for a certain template, simply add the text manually or create a new subtemplate.<br />
<br />
Each module of text is a subtemplate that can be edited using the link.<br />
<br />
==Parameters==<br />
<br />
===syntax===<br />
{{Citation Style documentation/edit|syntax}}<br />
<br />
===coins===<br />
{{Citation Style documentation/edit|coins}}<br />
<br />
===sep_period===<br />
{{Citation Style documentation/edit|sep_period}}<br />
<br />
===sep_comma===<br />
{{Citation Style documentation/edit|sep_comma}}<br />
<br />
===required===<br />
{{Citation Style documentation/edit|required}}<br />
<br />
===deprecated===<br />
{{Citation Style documentation/edit|deprecated}}<br />
{{Citation Style documentation/opt|1=<br />
*{{para|date2|yes}} adds:<br />
** date2<br />
** month2<br />
** year2}}<br />
<br />
===author===<br />
{{Citation Style documentation/edit|author}}<br />
{{Citation Style documentation/opt|1=<br />
*{{para|coauthors|yes}} adds "'''coauthors''': (deprecated) Names of of coauthors. Use the same format as the authors."<br />
*{{para|others|yes}} adds "'''others''': To record other contributors to the work, such as "Illustrated by Smith" or "Trans. Smith"."<br />
*{{para|aliases}} add aliases for '''last'''.<br />
}}<br />
<br />
===editor===<br />
{{Citation Style documentation/edit|editor}}<br />
<br />
===title===<br />
{{Citation Style documentation/edit|title}}<br />
<br />
{{Citation Style documentation/opt|1=<br /><br />
'''title_format''' sets the display format:<br />
* '''quotes''' = Displays in quotes.<br />
* '''work''' = If '''work''' is defined, then '''title''' is displayed in quotes, else displays in italics.<br />
* default = Displays in italics.<br />
<br />
'''title_title''' sets the display title:<br />
* '''encyclopedia''' = encyclopedia<br />
* default = title}}<br />
<br />
===web===<br />
{{Citation Style documentation/edit|web}}<br />
<br />
===chapter===<br />
{{Citation Style documentation/edit|chapter}}<br />
{{Citation Style documentation/opt|1=<br /><br />
'''title_format''' sets the display format:<br />
*'''italics''' = Displays in italics.<br />
* '''work''' = If '''work''' is defined, then '''title''' is displayed in quotes, else displays in italics.<br />
* default = Displays in quotes.<br />
'''title_title''' sets the display title:<br />
* '''booktitle''' = booktitle<br />
* default = chapter}}<br />
<br />
===type===<br />
{{Citation Style documentation/edit|type}}<br />
{{Citation Style documentation/opt|<br />
* '''type_default''': Adds "Defaults to '''type_default'''"}}<br />
<br />
===journal===<br />
{{Citation Style documentation/edit|journal}}<br />
{{Citation Style documentation/opt|1=<br />
* '''department''' adds:<br />
:* '''department''': Regular department within the periodical. Displays after '''work''' and is in plain text.<br />
}}<br />
<br />
===edition===<br />
{{Citation Style documentation/edit|edition}}<br />
<br />
===series===<br />
{{Citation Style documentation/edit|series}}<br />
<br />
===series_episode===<br />
{{Citation Style documentation/edit|series_episode}}<br />
<br />
===event===<br />
{{Citation Style documentation/edit|event}}<br />
<br />
===agency===<br />
{{Citation Style documentation/edit|agency}}<br />
<br />
===volume===<br />
{{Citation Style documentation/edit|volume}}<br />
<br />
===date===<br />
{{Citation Style documentation/edit|date}}<br />
{{Citation Style documentation/opt|1=<br />
* '''aliases''' includes aliases for '''date'''<br />
* '''began''' adds:<br />
:* OR: '''began''': Full date the first part of the program or episode aired.<br />
:** AND: '''ended''': Full date the last part of the program or episode aired.}}<br />
<br />
===publisher===<br />
{{Citation Style documentation/edit|publisher}}<br />
{{Citation Style documentation/opt|1=<br />
*{{para|work|no}} suppresses "; if '''work''' is defined, then '''publisher''' and '''location''' are enclosed in parentheses"<br />
*{{para|map|yes}} changes:<br />
** '''publisher''': Name of publisher. Displays before title. Do not wikilink—use publisher-link instead.<br />
** '''publisher-link''': Title of existing Wikipedia article about the publisher—not the publisher's website; do not wikilink.<br />
}}<br />
<br />
===newsgroup===<br />
{{Citation Style documentation/edit|newsgroup}}<br />
<br />
===language===<br />
{{Citation Style documentation/edit|language}}<br />
<br />
===pages===<br />
{{Citation Style documentation/edit|pages}}<br />
{{Citation Style documentation/opt|1=<br />
* '''work''' adds "or '''work''' is defined"}}<br />
<br />
===time===<br />
{{Citation Style documentation/edit|time}}<br />
<br />
===id1===<br />
{{Citation Style documentation/edit|id1}}<br />
<br />
===id2===<br />
{{Citation Style documentation/edit|id2}}<br />
<br />
===url===<br />
{{Citation Style documentation/edit|url}}<br />
{{Citation Style documentation/opt|<br />
* '''pmc''' adds:<br />
<br />
" If '''url''' is not defined but '''pmc''' is, then '''url''' is set to the '''pmc''' link.<br />
:* '''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."}}<br />
<br />
===chapterurl===<br />
{{Citation Style documentation/edit|chapterurl}}<br />
<br />
===lay===<br />
{{Citation Style documentation/edit|lay}}<br />
<br />
===quote===<br />
{{Citation Style documentation/edit|quote}}<br />
{{Citation Style documentation/opt|1=<br />
* {{para|cs2|yes}} suppresses "When supplied, the citation terminator (a period by default) is suppressed, so the quote needs to include terminating punctuation."}}<br />
<br />
===ref===<br />
{{Citation Style documentation/edit|ref}}<br />
<br />
===ref2===<br />
{{Citation Style documentation/edit|ref2}}<br />
<br />
===display===<br />
{{Citation Style documentation/edit|display}}<br />
{{Citation Style documentation/opt|<br />
* '''cs2''': When set, changes:<br />
**'''postscript''' to "defaults to none"<br />
** '''separator''' to "Defaults to a comma (,)"}}<br />
<br />
===map_series===<br />
{{Citation Style documentation/edit|map_series}}<br />
<br />
===map_id===<br />
{{Citation Style documentation/edit|map_id}}<br />
<br />
===map_pages===<br />
{{Citation Style documentation/edit|map_pages}}<br />
<br />
===interview_id===<br />
{{Citation Style documentation/edit|interview_id}}<br />
<br />
===interview_author===<br />
{{Citation Style documentation/edit|interview_author}}<br />
<br />
===interview_interviewer===<br />
{{Citation Style documentation/edit|interview_interviewer}}<br />
<br />
===DVD-notes_date===<br />
{{Citation Style documentation/edit|DVD-notes_date}}<br />
<br />
===album_name===<br />
{{Citation Style documentation/edit|album_name}}<br />
<br />
===album_artist===<br />
{{Citation Style documentation/edit|album_artist}}<br />
<br />
===season===<br />
{{Citation Style documentation/edit|season}}<br />
<br />
===network===<br />
{{Citation Style documentation/edit|network}}<br />
<br />
===transcript===<br />
{{Citation Style documentation/edit|transcript}}<br />
<br />
===notestitle===<br />
{{Citation Style documentation/edit|notestitle}}<br />
<br />
===conference===<br />
{{Citation Style documentation/edit|conference}}<br />
<br />
==See also==<br />
<br />
{{Citation Style 1}}<br />
<br />
<includeonly><br />
<!---CATEGORIES HERE---><br />
<br />
[[Category:Documentation assistance templates]]<br />
<br />
<!---INTERWIKIS HERE---><br />
<br />
</includeonly></div>Mitch Gore