Difference between revisions of "Template:Citation Style documentation/display"

Revision as of 20:37, 12 October 2020

mode: Sets element separator, default terminal punctuation, and certain capitalization according to the value provided. For |mode=cs1, element separator and terminal punctuation is a period (.); where appropriate, initial letters of certain words are capitalized ('Retrieved...'). For |mode=cs2, element separator is a comma (,); terminal punctuation is omitted; where appropriate, initial letters of certain words are not capitalized ('retrieved...'). To override default terminal punctuation use postscript.
author-mask:
contributor-mask:
editor-mask:
interviewer-mask:
subject-mask:
translator-mask:
Replaces the name of the (first) author with em dashes or text. Set <name>-mask to a numeric value n to set the dash n em spaces wide; set <name>-mask to a text value to display the text without a trailing author separator; for example, "with". The numeric value 0 is a special case to be used in conjunction with <name>-link—in this case, the value of <name>-link will be used as (linked) text. In either case, you must still include the values for all names for metadata purposes. Primarily intended for use with bibliographies or bibliography styles where multiple works by a single author are listed sequentially such as shortened footnotes. Do not use in a list generated by {{reflist}}, <references /> or similar as there is no control of the order in which references are displayed. Mask parameters can take an enumerator in the name of the parameter (e.g. |authorn-mask=) to apply the mask to a specific name.

display-authors:
display-contributors:
display-editors:
display-interviewers:
display-subjects:
display-translators:
Controls the number of author or editor names that are displayed when a citation is published. To change the displayed number of names, set display-authors and/or display-editors to the desired number. For example, |display-authors=2 will display only the first two authors in a citation (and not affect the display of editors). Likewise, |display-editors=2 will display only the first two editors (and all authors). |display-authors=0 and |display-editors=0 are special cases suppressing the display of all authors or editors including the et al. By default, all authors and editors are displayed. |display-authors=etal displays all authors in the list followed by et al. Aliases: displayauthors (deprecated).
last-author-amp (deprecated; use name-list-style): ~~Switches the separator between the last two names of the author list to space ampersand space ( & ) when set to y, yes, or true. Example: |last-author-amp=yes~~
postscript: Controls the closing punctuation for a citation; defaults to a period (.); for no terminating punctuation, specify |postscript=none – leaving |postscript= empty is the same as omitting it, but is ambiguous. Additional text or templates beyond the terminating punctuation may generate an error message. |postscript= is ignored if quote is defined.

@@ Line 1: / Line 1: @@
 * <span id="csdoc_display"></span><b id="csdoc_mode">mode</b>: Sets element separator, default terminal punctuation, and certain capitalization according to the value provided.  For {{para|mode|cs1}}, element separator and terminal punctuation is a period (<code>.</code>); where appropriate, initial letters of certain words are capitalized ('Retrieved...').  For {{para|mode|cs2}}, element separator is a comma (<code>,</code>); terminal punctuation is omitted; where appropriate, initial letters of certain words are not capitalized ('retrieved...'). To override default terminal punctuation use '''postscript'''.
-* <b id="csdoc_author-mask">author-mask</b>: Replaces the name of the first author with [[dash#Em dash|em dashes]] or text. Set '''author-mask''' to a numeric value ''n'' to set the dash ''n'' em spaces wide; set '''author-mask''' to a text value to display the text without a trailing author separator; for example, "with". You must still include the values for all authors for metadata purposes. Primarily intended for use with bibliographies or bibliography styles where multiple works by a single author are listed sequentially such as {{sfnote|lc=y}}. Do not use in a list generated by {{tlx|reflist}}, {{tag|references|s}} or similar as there is no control of the order in which references are displayed. You can also use '''editor-mask''' and '''translator-mask''' in the same way. Mask parameters can take a number in the name of the parameter (e.g. {{para|author<sub>n</sub>-mask}}) to specify which author the mask should apply to.
+* <b id="csdoc_author-mask">author-mask</b>:
-* <b id="csdoc_display-authors"><span id="csdoc_displayauthors"></span>display-authors</b>: Controls the number of author names that are displayed when a citation is published. To change the displayed number of authors, set '''display-authors''' to the desired number. For example, {{para|display-authors|2}} will display only the first two authors in a citation. By default, all authors are displayed. {{para|display-authors|etal}} displays all authors in the list followed by et al. Aliases: '''displayauthors'''.
+* <b id="csdoc_contributor-mask">contributor-mask</b>:
-* <b id="csdoc_display-editors"><span id="csdoc_displayeditors"></span>display-editors</b>: Controls the number of editor names that are displayed when a citation is published. To change the displayed number of editors, set '''display-editors''' to the desired number. For example, {{para|display-editors|2}} will display only the first two editors in a citation. By default, all editors are displayed. {{para|display-editors|etal}} displays all editors in the list followed by et al. Aliases: '''displayeditors'''.
+* <b id="csdoc_editor-mask">editor-mask</b>:
-* <b id="csdoc_lastauthoramp">last-author-amp</b>: Switches the separator between the last two names of the author list to space ampersand space (<code> & </code>) when set to <code>y</code>, <code>yes</code>, or <code>true</code>. Example: {{para|last-author-amp|yes}}
+* <b id="csdoc_interviewer-mask">interviewer-mask</b>:
+* <b id="csdoc_subject-mask">subject-mask</b>:
+* <b id="csdoc_translator-mask">translator-mask</b>:
+*: Replaces the name of the (first) author with [[dash#Em dash|em dashes]] or text. Set '''&lt;{{var|name}}>-mask''' to a numeric value ''n'' to set the dash ''n'' em spaces wide; set '''&lt;{{var|name}}>-mask''' to a text value to display the text without a trailing author separator; for example, "with". The numeric value 0 is a special case to be used in conjunction with '''&lt;{{var|name}}>-link'''&mdash;in this case, the value of '''&lt;{{var|name}}>-link''' will be used as (linked) text. In either case, you must still include the values for all names for metadata purposes. Primarily intended for use with bibliographies or bibliography styles where multiple works by a single author are listed sequentially such as {{sfnote|lc=y}}. Do not use in a list generated by {{tlx|reflist}}, {{tag|references|s}} or similar as there is no control of the order in which references are displayed. Mask parameters can take an enumerator in the name of the parameter (e.g. {{para|author{{var|n}}-mask}}) to apply the mask to a specific {{var|name}}.
+* <b id="csdoc_display-authors"><span id="csdoc_displayauthors"></span>display-authors</b>:
+* <b id="csdoc_display-contributors"><span id="csdoc_displaycontributors"></span>display-contributors</b>:
+* <b id="csdoc_display-editors"><span id="csdoc_displayeditors"></span>display-editors</b>:
+* <b id="csdoc_display-interviewers"><span id="csdoc_displayinterviewers"></span>display-interviewers</b>:
+* <b id="csdoc_display-subjects"><span id="csdoc_displaysubjects"></span>display-subjects</b>:
+* <b id="csdoc_display-translators"><span id="csdoc_displaytranslators"></span>display-translators</b>:
+*: Controls the number of author or editor names that are displayed when a citation is published. To change the displayed number of names, set '''display-authors''' and/or '''display-editors''' to the desired number. For example, {{para|display-authors|2}} will display only the first two authors in a citation (and not affect the display of editors). Likewise, {{para|display-editors|2}} will display only the first two editors (and all authors). {{para|display-authors|0}} and {{para|display-editors|0}} are special cases suppressing the display of all authors or editors including the et al. By default, all authors and editors are displayed. {{para|display-authors|etal}} displays all authors in the list followed by et al. Aliases: '''{{xtd|displayauthors}}''' (deprecated).
+* <b id="csdoc_lastauthoramp">{{xtd|last-author-amp}}</b> (deprecated; use '''name-list-style'''): <s>Switches the separator between the last two names of the author list to space ampersand space (<code> & </code>) when set to <code>y</code>, <code>yes</code>, or <code>true</code>. Example: {{para|last-author-amp|yes}}</s>
 * <b id="csdoc_postscript">postscript</b>: Controls the closing punctuation for a citation; defaults to {{#if: {{{cs2|}}}|none|a period (<code>.</code>); for no terminating punctuation, specify {{para|postscript|none}} – leaving {{para|postscript}} empty is the same as omitting it, but is ambiguous}}. Additional text or templates beyond the terminating punctuation may generate an error message. {{para|postscript}} is ignored if '''quote''' is defined.