:Template:Citation Style documentation/doc#author

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.

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

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

{{Citation Style documentation/edit|lead}}

{{Citation Style documentation/opt|1=

One unnamed parameter is used to create the trailing text.}}

{{markup

|{{csdoc|lead|books}}

|{{csdoc|lead|books}}

}}

{{#invoke:Suppress categories|main|{{Citation Style documentation/edit|lua}}}}

{{clear}}

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

: {{csdoc|usage}}

Parameters to copy are enclosed in tables created by sub-templates.

• Start with {{tlx|csdoc|usage full}}
• Precede the sample markup with : to create an indent
• Enclose the sample in {{tag|code|content={{tag|nowiki}}}}
• Close the table with {{tlx|end}}

{{pre|

{{csdoc|usage full}}

:<nowiki>{{cite xxxxx |last1= |first1= |author-link1= |last2= |first2= |author-link2= |last3= |first3= |author-link3= |last4= |first4= |author-link4= |last5= |first5= |author-link5= |name-list-style= |vauthors= |translator-last1= |translator-first1= |translator-link1= |translator-last2= |translator-first2= |translator-link2= |collaboration= |contributor-last1= |contributor-first1= |contributor-link1= |contributor-last2= |contributor-first2= |contributor-link2= |others= |editor-last1= |editor-first1= |editor-link1= |editor-last2= |editor-first2= |editor-link2= |editor-last3= |editor-first3= |editor-link3= |veditors= |title= |script-title= |trans-title= |work= |script-work= |trans-work= |issue= |department= |chapter= |script-chapter= |trans-chapter= |contribution= |type= |edition= |series= |series-link= |episode= |event= |agency= |volume= |date= |year= |orig-date= |df= |publisher= |location= |publication-place= |via= |language= |page= |pages= |no-pp= |at= |minutes= |time= |time-caption= |id= |arxiv= |asin= |asin-tld= |bibcode= |biorxiv= |citeseerx= |doi= |doi-broken-date= |eissn= |hdl= |sbn= |isbn= |ismn= |issn= |jfm= |jstor= |lccn= |mr= |oclc= |ol= |osti= |pmc= |embargo= |pmid= |rfc= |ssrn= |zbl= |url= |format= |archive-url= |archive-format= |url-status= |archive-date= |chapter-url= |chapter-format= |access-date= |no-tracking= |quote= |ref= |mode= |author-mask1= |author-mask2= |author-mask3= |author-mask4= |author-mask5= |display-authors= |translator-mask1= |translator-mask2= |display-translators= |contributor-mask1= |contributor-mask2= |display-contributors= |editor-mask1= |editor-mask2= |editor-mask3= |display-editors= |postscript= |url-access= |chapter-url-access= |bibcode-access= |doi-access= |hdl-access= |jstor-access= |ol-access= |osti-access= |map= |script-map= |trans-map= |map-url= |map-format= |map-url-access= |scale= |cartography= |inset= |sections= |interviewer-last1= |interviewer-first1= |interviewer-link1= |interviewer-last2= |interviewer-first2= |interviewer-link2= |interviewer-mask1= |interviewer-mask2= |display-interviewers= |season= |series-number= |series-separator= |network= |station= |transcript= |transcript-url= |transcript-format= |conference= |conference-url= |conference-format=}}</nowiki>

{{end}}

}}

{{csdoc|usage full}}

:{{cite xxxxx |last1= |first1= |author-link1= |last2= |first2= |author-link2= |last3= |first3= |author-link3= |last4= |first4= |author-link4= |last5= |first5= |author-link5= |name-list-style= |vauthors= |translator-last1= |translator-first1= |translator-link1= |translator-last2= |translator-first2= |translator-link2= |collaboration= |contributor-last1= |contributor-first1= |contributor-link1= |contributor-last2= |contributor-first2= |contributor-link2= |others= |editor-last1= |editor-first1= |editor-link1= |editor-last2= |editor-first2= |editor-link2= |editor-last3= |editor-first3= |editor-link3= |veditors= |title= |script-title= |trans-title= |work= |script-work= |trans-work= |issue= |department= |chapter= |script-chapter= |trans-chapter= |contribution= |type= |edition= |series= |series-link= |episode= |event= |agency= |volume= |date= |year= |orig-date= |df= |publisher= |location= |publication-place= |via= |language= |page= |pages= |no-pp= |at= |minutes= |time= |time-caption= |id= |arxiv= |asin= |asin-tld= |bibcode= |biorxiv= |citeseerx= |doi= |doi-broken-date= |eissn= |hdl= |sbn= |isbn= |ismn= |issn= |jfm= |jstor= |lccn= |mr= |oclc= |ol= |osti= |pmc= |embargo= |pmid= |rfc= |ssrn= |zbl= |url= |format= |archive-url= |archive-format= |url-status= |archive-date= |chapter-url= |chapter-format= |access-date= |no-tracking= |quote= |ref= |mode= |author-mask1= |author-mask2= |author-mask3= |author-mask4= |author-mask5= |display-authors= |translator-mask1= |translator-mask2= |display-translators= |contributor-mask1= |contributor-mask2= |display-contributors= |editor-mask1= |editor-mask2= |editor-mask3= |display-editors= |postscript= |url-access= |chapter-url-access= |bibcode-access= |doi-access= |hdl-access= |jstor-access= |ol-access= |osti-access= |map= |script-map= |trans-map= |map-url= |map-format= |map-url-access= |scale= |cartography= |inset= |sections= |interviewer-last1= |interviewer-first1= |interviewer-link1= |interviewer-last2= |interviewer-first2= |interviewer-link2= |interviewer-mask1= |interviewer-mask2= |display-interviewers= |season= |series-number= |series-separator= |network= |station= |transcript= |transcript-url= |transcript-format= |conference= |conference-url= |conference-format=}}

{{end}}

The above set is organised contextually rather than alphabetically. The following parameters, which are usually available for at least a few cite templates, are not included in the full parameter set above: {{para|authors}}; {{para|book-title}}; {{para|class}}; {{para|degree}}; {{para|docket}}; {{para|encyclopedia}}; {{para|mailing-list}}; {{para|message-id}}; {{para|number}}; {{para|publication-date}}; {{para|section}}; {{para|sheet}}; {{para|sheets}}; {{para|title-link}}; {{para|s2cid}}.

• Start with {{tlx|csdoc|usage common}}
• Precede the sample markup with : to create an indent
• Enclose the sample in {{tag|code|content={{tag|nowiki}}}}
• Close the table with {{tlx|end}}

{{csdoc|usage common}}

:{{cite book |last= |first= |author-link= |title= |url= |access-date= |date= |publisher= |location= |isbn= |page= |pages=}}

{{end}}

}}

{{csdoc|usage common}}

:{{cite book |last= |first= |author-link= |title= |url= |access-date= |date= |publisher= |location= |isbn= |page= |pages=}}

{{end}}

The full vertical style can be implemented in a three-columns format (only practical when the number of parameters is not too extended) or in a four-columns format.

The full vertical style in three columns consists of a "Vertical list", "Prerequisites" and "Brief instructions / notes".

{{csdoc|usage vertical}}

{{csdoc|usage vertical mid}}

{{csdoc|usage vertical mid}}

{{csdoc|usage vertical end}}

Example:

{{csdoc|usage vertical}}

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

{{csdoc|usage vertical mid}}

 
 
last
 
 

{{csdoc|usage vertical mid}}

 
same as last1
same as first1
 
 

{{csdoc|usage vertical end}}

{{csdoc|usage vertical}}

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

{{csdoc|usage vertical mid}}

 
 
last
 
 

{{csdoc|usage vertical mid}}

 
same as last1
same as first1
 
 

{{csdoc|usage vertical end}}

{{Citation Style documentation/edit|usage}}

{{end}}

{{Citation Style documentation/edit|usage full}}

{{end}}

{{Citation Style documentation/edit|usage common}}

{{end}}

{{Citation Style documentation/edit|usage vertical}}

{{end}}

{{Citation Style documentation/edit|usage vertical mid}}

{{end}}

{{Citation Style documentation/edit|usage vertical end}}

Use {{tl|markup2}} to format the examples {{crossref|(see that template's documentation for use)}}.

{{markup2 |t=Basic usage with url and edition

|m={{cite book |title=Mysterious book |url=https://www.example.com |edition=2nd}}
|r={{cite book |title=Mysterious book |url=https://www.example.com |edition=2nd}}
}}

{{markup2 |t=Basic usage with url and edition

|m={{cite book |title=Mysterious book |url=https://www.example.com |edition=2nd}}

|r={{cite book |title=Mysterious book |url=https://www.example.com |edition=2nd}}

}}

{{Citation Style documentation/edit|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|whats new}}

{{Citation Style documentation/edit|deprecated}}

{{Citation Style documentation/edit|author}}

{{Citation Style documentation/opt|1=

• {{para|contributor|yes}} adds contributors (use with cite book and citation only)
• {{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.

}}

{{Citation Style documentation/edit|editor}}

{{Citation Style documentation/edit|title}}

{{Citation Style documentation/opt|1=

title_title sets the display title:

• encyclopedia = encyclopedia
• default = title}}

{{Citation Style documentation/edit|web}}

{{Citation Style documentation/edit|chapter}}

{{Citation Style documentation/opt|1=

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

{{Citation Style documentation/edit|type}}

{{Citation Style documentation/opt|

• type_default: Adds "Defaults to type_default"}}

{{Citation Style documentation/edit|journal}}

{{Citation Style documentation/opt|1=

• department adds:

:* department: Regular department or section within the periodical or journal. Examples include "Communication", "Editorial", "Letter to the Editor", and "Review". Displays after title and is in plain text.

}}

{{Citation Style documentation/edit|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/opt|1=

• limited_param_list hides orig-date because not allowed in limited-parameter templates

}}

{{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. The publisher is the company that publishes the work being cited. Do not use the publisher parameter for the name of a work (e.g., a book, encyclopedia, newspaper, magazine, journal, website). 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.

}}

{{Citation Style documentation/edit|newsgroup}}

{{Citation Style documentation/edit|language}}

{{Citation Style documentation/edit|pages}}

{{Citation Style documentation/opt|1=

• work adds "or work (or an alias) is defined"}}

{{Citation Style documentation/edit|time}}

{{Citation Style documentation/edit|id1}}

{{Citation Style documentation/edit|id2}}

{{Citation Style documentation/edit|url}}

{{Citation Style documentation/opt|1=

• media uses 'media' in place of 'text of the publication'

}}

{{Citation Style documentation/edit|chapterurl}}

{{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."}}

{{Citation Style documentation/edit|ref}}

{{Citation Style documentation/edit|display}}

{{Citation Style documentation/opt|

• cs2: When set, changes:
• postscript to "defaults to none"
• separator to "Defaults to a comma (,)"}}

{{Citation Style documentation/edit|registration}}

{{Citation Style documentation/edit|map_series}}

{{Citation Style documentation/edit|map_pages}}

{{Citation Style documentation/edit|interview_author}}

{{Citation Style documentation/edit|interview_interviewer}}

{{Citation Style documentation/edit|season}}

{{Citation Style documentation/edit|network}}

{{Citation Style documentation/edit|transcript}}

{{Citation Style documentation/edit|conference}}

{{Citation Style 1}}

{{Wikipedia referencing}}

{{Sandbox other||

Category:Documentation assistance templates

}}