View source for Template:Citation Style documentation/names

{{#invoke:cs1 documentation support|header_make|Author names|{{{header-level|}}}}}
* {{#invoke:cs1 documentation support|canonical_name_get|AuthorList-Last|id=csdoc_author}}: Surname of a single author. May be [[#Parameter enumeration|enumerated]].  Do not wikilink—use {{#invoke:cs1 documentation support|canonical_name_get|AuthorList-Link}} instead. Aliases: {{#invoke:cs1 documentation support|alias_names_get|AuthorList-Last}} {{#if:{{{aliases|}}}|, {{{aliases}}}}}.
** {{#invoke:cs1 documentation support|canonical_name_get|AuthorList-Last|author#}}: Complete name of a single author (first and last), name of an author who goes by a single name (e.g. {{para|author|Bono}}), name of a corporate or institutional author.  May be [[#Parameter enumeration|enumerated]].  This parameter should never hold the names of more than one author.
* {{#invoke:cs1 documentation support|canonical_name_get|AuthorList-First}}: Given or first names of author; for example: ''Firstname Middlename'' or ''Firstname M.'' or ''Firstname M., Sr.'' May be [[#Parameter enumeration|enumerated]].  Do not wikilink—use {{#invoke:cs1 documentation support|canonical_name_get|AuthorList-Link}} instead. Requires {{#invoke:cs1 documentation support|canonical_name_get|AuthorList-Last}}; first name will not display if {{#invoke:cs1 documentation support|canonical_name_get|AuthorList-Last}} is empty.  Aliases: {{#invoke:cs1 documentation support|alias_names_get|AuthorList-First}}.
* {{#invoke:cs1 documentation support|canonical_name_get|Vauthors}}: comma-separated list of author names in [[Vancouver style]]; enclose corporate or institutional author names in [[Help:Citation_Style_1#Accept-this-as-written_markup|doubled parentheses]]:
*:{{para|vauthors|Smythe JB, ((Megabux Corp.))}}
*: {{#invoke:cs1 documentation support|canonical_name_get|AuthorList-Link}} and {{#invoke:cs1 documentation support|canonical_name_get|AuthorList-Mask}} may be used for the individual names in {{#invoke:cs1 documentation support|canonical_name_get|Vauthors}}.
* {{#invoke:cs1 documentation support|canonical_name_get|Collaboration|id=csdoc_collaboration}}: Name of a group of authors or collaborators; requires author-name parameter(s) to list the primary author(s); follows author-name list; appends et al. to author-name list.  Aliases: {{#invoke:cs1 documentation support|alias_names_get|Collaboration}}
* {{#invoke:cs1 documentation support|canonical_name_get|Authors}}: Free-form list of author names; use of this parameter is discouraged because it does not contribute to a citation's metadata; not an alias of {{#invoke:cs1 documentation support|canonical_name_get|AuthorList-Last}}.  Aliases: {{#invoke:cs1 documentation support|alias_names_get|Authors}}
* {{#invoke:cs1 documentation support|canonical_name_get|AuthorList-Link}}: See [[#csdoc_name-list-link|link option]].  Aliases: {{#invoke:cs1 documentation support|alias_names_get|AuthorList-Link}}.
* {{#invoke:cs1 documentation support|canonical_name_get|AuthorList-Mask|id=csdoc_author-mask}}: See [[#csdoc_name-list-mask|mask option]].  Aliases: {{#invoke:cs1 documentation support|alias_names_get|AuthorList-Mask}}.
* {{#invoke:cs1 documentation support|canonical_name_get|DisplayAuthors|id=csdoc_display-authors}}: See [[#csdoc_display-names|display option]].  Aliases: {{#invoke:cs1 documentation support|alias_names_get|DisplayAuthors}}.
{{#if:{{#invoke:cs1 documentation support|is_limited_param_template}}||{{#if:{{#invoke:cs1 documentation support|is_book_cite_template}}|{{#invoke:cs1 documentation support|header_make|Contributor names|{{{header-level|}}}}}
* {{#invoke:cs1 documentation support|canonical_name_get|ContributorList-Last|id=csdoc_contributor}}: (book cites only) surname of a single author of {{#invoke:cs1 documentation support|canonical_name_get|Contribution}} (which is required). May be [[#Parameter enumeration|enumerated]].  Do not wikilink—use {{#invoke:cs1 documentation support|canonical_name_get|ContributorList-Link}} instead. Aliases: {{#invoke:cs1 documentation support|alias_names_get|ContributorList-Last}}
** {{#invoke:cs1 documentation support|canonical_name_get|ContributorList-Last|contributor#}}: Complete name of a single contributor (first and last), name of a contributor who goes by a single name (e.g. {{para|contributor|Bono}}), name of a corporate or institutional contributor.  May be [[#Parameter enumeration|enumerated]].  This parameter should never hold the names of more than one contributor.
* {{#invoke:cs1 documentation support|canonical_name_get|ContributorList-First}}: Given or first names of contributor; for example: ''Firstname Middlename'' or ''Firstname M.'' or ''Firstname M., Sr.'' May be [[#Parameter enumeration|enumerated]].  Do not wikilink—use {{#invoke:cs1 documentation support|canonical_name_get|ContributorList-Link}} instead. Requires {{#invoke:cs1 documentation support|canonical_name_get|ContributorList-Last}}; first name will not display if {{#invoke:cs1 documentation support|canonical_name_get|ContributorList-Last}} is empty.  Aliases: {{#invoke:cs1 documentation support|alias_names_get|ContributorList-First}}.
* {{#invoke:cs1 documentation support|canonical_name_get|ContributorList-Link}}:  See [[#csdoc_name-list-link|link option]].  Aliases: {{#invoke:cs1 documentation support|alias_names_get|ContributorList-Link}}.
* {{#invoke:cs1 documentation support|canonical_name_get|ContributorList-Mask|id=csdoc_contributor-mask}}: See [[#csdoc_name-list-mask|mask option]].  Aliases: {{#invoke:cs1 documentation support|alias_names_get|ContributorList-Mask}}.
* {{#invoke:cs1 documentation support|canonical_name_get|DisplayContributors|id=csdoc_display-contributors}}: See [[#csdoc_display-names|display option]].  Aliases: {{#invoke:cs1 documentation support|alias_names_get|DisplayContributors}}.}}<!-- end of is_book_cite_template -->
{{#invoke:cs1 documentation support|header_make|Editor names|{{{header-level|}}}}}
* {{#invoke:cs1 documentation support|canonical_name_get|EditorList-Last|id=csdoc_editors}}: Surname of a single editor. May be [[#Parameter enumeration|enumerated]].  Do not wikilink—use {{#invoke:cs1 documentation support|canonical_name_get|EditorList-Link}} instead. Aliases: {{#invoke:cs1 documentation support|alias_names_get|EditorList-Last}}.
** {{#invoke:cs1 documentation support|canonical_name_get|EditorList-Last|editor#}}: Complete name of a single editor (first and last), name of an editor who goes by a single name (e.g. {{para|editor|Bono}}), name of a corporate or institutional editor.  May be [[#Parameter enumeration|enumerated]].  This parameter should never hold the names of more than one editor.
* {{#invoke:cs1 documentation support|canonical_name_get|EditorList-First}}: Given or first names of editor; for example: ''Firstname Middlename'' or ''Firstname M.'' or ''Firstname M., Sr.'' May be [[#Parameter enumeration|enumerated]].  Do not wikilink—use {{#invoke:cs1 documentation support|canonical_name_get|EditorList-Link}} instead. Requires {{#invoke:cs1 documentation support|canonical_name_get|EditorList-Last}}; first name will not display if {{#invoke:cs1 documentation support|canonical_name_get|EditorList-Last}} is empty.  Aliases: {{#invoke:cs1 documentation support|alias_names_get|EditorList-First}}.
* {{#invoke:cs1 documentation support|canonical_name_get|Veditors}}: comma-separated list of editor names in [[Vancouver style]]; enclose corporate or institutional editor names in [[Help:Citation_Style_1#Accept-this-as-written_markup|doubled parentheses]]:
*: {{para|veditors|Smythe JB, ((Megabux Corp.))}}
*: {{#invoke:cs1 documentation support|canonical_name_get|EditorList-Link}} and {{#invoke:cs1 documentation support|canonical_name_get|EditorList-Mask}} may be used for the individual names in {{#invoke:cs1 documentation support|canonical_name_get|Veditors}}.
* {{#invoke:cs1 documentation support|canonical_name_get|Editors}}: Free-form list of editor names; use of this parameter is discouraged because it does not contribute to a citation's metadata.
* {{#invoke:cs1 documentation support|canonical_name_get|EditorList-Link}}: See [[#csdoc_name-list-link|link option]].  Aliases: {{#invoke:cs1 documentation support|alias_names_get|EditorList-Link}}.
* {{#invoke:cs1 documentation support|canonical_name_get|EditorList-Mask|id=csdoc_editor-mask}}: See [[#csdoc_name-list-mask|mask option]].  Aliases: {{#invoke:cs1 documentation support|alias_names_get|EditorList-Mask}}.
* {{#invoke:cs1 documentation support|canonical_name_get|DisplayEditors|id=csdoc_display-editors}}: See [[#csdoc_display-names|display option]].  Aliases: {{#invoke:cs1 documentation support|alias_names_get|DisplayEditors}}.
{{#invoke:cs1 documentation support|header_make|Interviewer names|{{{header-level|}}}}}
* {{#invoke:cs1 documentation support|canonical_name_get|InterviewerList-Last|id=csdoc_interviewer}}: Surname of a single interviewer. May be [[#Parameter enumeration|enumerated]].  Do not wikilink—use {{#invoke:cs1 documentation support|canonical_name_get|InterviewerList-Link}} instead. Aliases: {{#invoke:cs1 documentation support|alias_names_get|InterviewerList-Last}}.
** {{#invoke:cs1 documentation support|canonical_name_get|InterviewerList-Last|interviewer#}}: Complete name of a single interviewer (first and last), name of an interviewer who goes by a single name (e.g. {{para|interviewer|Bono}}), name of a corporate or institutional interviewer.  May be [[#Parameter enumeration|enumerated]].  This parameter should never hold the names of more than one interviewer.
* {{#invoke:cs1 documentation support|canonical_name_get|InterviewerList-First}}: Given or first names of interviewer; for example: ''Firstname Middlename'' or ''Firstname M.'' or ''Firstname M., Sr.'' May be [[#Parameter enumeration|enumerated]].  Do not wikilink—use {{#invoke:cs1 documentation support|canonical_name_get|InterviewerList-Link}} instead. Requires {{#invoke:cs1 documentation support|canonical_name_get|InterviewerList-Last}}; first name will not display if {{#invoke:cs1 documentation support|canonical_name_get|InterviewerList-Last}} is empty.  Aliases: {{#invoke:cs1 documentation support|alias_names_get|InterviewerList-First}}.
* {{#invoke:cs1 documentation support|canonical_name_get|InterviewerList-Link}}: See [[#csdoc_name-list-link|link option]].  Aliases: {{#invoke:cs1 documentation support|alias_names_get|InterviewerList-Link}}.
* {{#invoke:cs1 documentation support|canonical_name_get|InterviewerList-Mask|id=csdoc_interviewer-mask}}: See [[#csdoc_name-list-mask|mask option]].  Aliases: {{#invoke:cs1 documentation support|alias_names_get|InterviewerList-Mask}}.
* {{#invoke:cs1 documentation support|canonical_name_get|DisplayInterviewers|id=csdoc_display-interviewers}}: See [[#csdoc_display-names|display option]].  Aliases: {{#invoke:cs1 documentation support|alias_names_get|DisplayInterviewers}}.
{{#invoke:cs1 documentation support|header_make|Translator names|{{{header-level|}}}}}
* {{#invoke:cs1 documentation support|canonical_name_get|TranslatorList-Last|id=csdoc_translator}}: Surname of a single translator. May be [[#Parameter enumeration|enumerated]].  Do not wikilink—use {{#invoke:cs1 documentation support|canonical_name_get|TranslatorList-Link}} instead. Aliases: {{#invoke:cs1 documentation support|alias_names_get|TranslatorList-Last}}.
** {{#invoke:cs1 documentation support|canonical_name_get|TranslatorList-Last|translator#}}: Complete name of a single translator (first and last), name of a translator who goes by a single name (e.g. {{para|translator|Bono}}), name of a corporate or institutional translator.  May be [[#Parameter enumeration|enumerated]].  This parameter should never hold the names of more than one translator.
* {{#invoke:cs1 documentation support|canonical_name_get|TranslatorList-First}}: Given or first names of translator; for example: ''Firstname Middlename'' or ''Firstname M.'' or ''Firstname M., Sr.'' May be [[#Parameter enumeration|enumerated]].  Do not wikilink—use {{#invoke:cs1 documentation support|canonical_name_get|TranslatorList-Link}} instead. Requires {{#invoke:cs1 documentation support|canonical_name_get|TranslatorList-Last}}; first name will not display if {{#invoke:cs1 documentation support|canonical_name_get|TranslatorList-Last}} is empty.  Aliases: {{#invoke:cs1 documentation support|alias_names_get|TranslatorList-First}}.
* {{#invoke:cs1 documentation support|canonical_name_get|TranslatorList-Link}}: See [[#csdoc_name-list-link|link option]].  Aliases: {{#invoke:cs1 documentation support|alias_names_get|TranslatorList-Link}}.
* {{#invoke:cs1 documentation support|canonical_name_get|TranslatorList-Mask|id=csdoc_translator-mask}}: See [[#csdoc_name-list-mask|mask option]].  Aliases: {{#invoke:cs1 documentation support|alias_names_get|TranslatorList-Mask}}.
* {{#invoke:cs1 documentation support|canonical_name_get|DisplayTranslators|id=csdoc_display-translators}}: See [[#csdoc_display-names|display option]].  Aliases: {{#invoke:cs1 documentation support|alias_names_get|DisplayTranslators}}.
{{#invoke:cs1 documentation support|header_make|Other names|{{{header-level|}}}}}
* <b id="csdoc_others">others</b>: To record other contributors to the work, including illustrators. For the parameter value, write ''Illustrated by John Smith''.}}<!-- end of is_limited_param_template -->
{{#invoke:cs1 documentation support|header_make|Name-list display control|{{{header-level|}}}}}
* {{#invoke:cs1 documentation support|canonical_name_get|NameListFormat}}: accepts the single value <code>vanc</code>; when set, displays name-lists using [[Vancouver style]] and when the list uses <code>last</code>/<code>first</code> parameters for the name list(s).
* <b id="csdoc_display-names">display-&lt;{{var|name-list}}></b>: Controls the number of names that are displayed in &lt;{{var|name-list}}> when a citation is published. By default, all are displayed. To change the number of names that are displayed, set '''display-&lt;{{var|name-list}}>''' to the desired number.  For example, {{para|display-authors|2}} will display the first two authors listed in the author-name list. Appends et al. to the list when the number of displayed names is less than the number of names in the list.  {{para|display-authors|etal}} displays all names in the list and appends et al.  Omit when the number of names in the template is the same as the number of names to be displayed.
* <b id="csdoc_name-list-link">&lt;{{var|name-list}}>-link#</b>: Title of existing Wikipedia article about &lt;{{var|name#}}>—not &lt;{{var|name#}}>'s website. May be [[#Parameter enumeration|enumerated]].  Do not wikilink. 
* <b id="csdoc_name-list-mask">&lt;{{var|name-list}}>-mask#</b>: Replaces &lt;{{var|name#}}> with [[dash#Em dash|em dashes]] or text. May be [[#Parameter enumeration|enumerated]].  Set '''&lt;{{var|name-list}}>-mask#''' to a positive integer value {{var|n}} to replace &lt;{{var|name#}}> with a dash that is {{var|n}} em spaces wide; set '''&lt;{{var|name-list}}>-mask#''' to a text value to display the text ahead of the &lt;{{var|name#}}>; for example, "with". You must still include a value for the matching '''{{var|name-list#}}>''' parameter for metadata purposes.  Primarily intended for use with bibliographies or bibliography styles where multiple works by &lt;{{var|name#}}> are listed sequentially such as {{sfnote|lc=y}}. Do not use in a list generated by {{tlx|reflist}}, {{tag|references|s}} or similar (in-line citations) as there is no control of the order in which such references are displayed.
{{#invoke:cs1 documentation support|header_make|Parameter enumeration|{{{header-level|}}}}}
Parameter names that contain the placeholder character '#', may be enumerated.  Enumerators are consecutive positive integers beginning at '1' and continuing without gaps; there is no upper limit.  In use:
*digits must replace the '#' placeholder:
*:{{para|last15|mxt=y}} not {{para|last#|!mxt=y}} → {{error-small|Unknown parameter {{para|last#|plain=yes}} ignored}}
*for all parameters that are enumerable, the absence of an enumerator has the same meaning as an enumerator of '1':
*:{{para|author-link}} and {{para|author-link1}} have the same meaning → {{error-small|More than one of {{para|author-link1|plain=yes}} and {{para|author-link|plain=yes}} specified}}
*simultaneous use of a non-enumerated parameter and its enumerator '1' equivalent is redundant:
*:{{para|translator-last|!mxt=y}} and {{para|translator1-last|!mxt=y}} have the same meaning → {{error-small|More than one of {{para|translator1-last|plain=yes}} and {{para|translator-last|plain=yes}} specified}}
*simultaneous use of same-parameter enumerations where the enumerators are in different positions is redundant:
*:{{para|editor-first3|!mxt=y}} and {{para|editor3-first|!mxt=y}} have the same meaning → {{error-small|More than one of {{para|editor3-first|plain=yes}} and {{para|editor-first3|plain=yes}} specified}}
*simultaneous use of same-enumeration aliases is redundant:
*:{{para|contributor-last1|!mxt=y}} and {{para|contributor|!mxt=y}} have the same meaning → {{error-small|More than one of {{para|contributor-last1|plain=yes}} and {{para|contributor|plain=yes}} specified}}
*simultaneous use of same-parameter enumerations where the enumerators are in the same position is redundant:
*:{{para|interviewer-link2|!mxt=y}} and {{para|interviewer-link2|!mxt=y}} are identical; this condition not caught by cs1|2 error detection; see [[Help:Duplicate parameters]]
{{#invoke:cs1 documentation support|header_make|Notes|{{{header-level|}}}}}