Template:Citation Style documentation/display: Difference between revisions
From All Skies Encyclopaedia
imported>Trappist the monk m (Update to reflect Lua-based citation operation;) |
imported>Izno (move the default to the second line) |
||
| (56 intermediate revisions by 17 users not shown) | |||
| 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...'). These styles correspond to Citation Style 1 and Citation Style 2 respectively. To override default terminal punctuation use '''postscript'''. |
|||
| ⚫ | * |
||
* <b id="csdoc_author-mask">author-mask</b>: |
|||
* '''author-name-separator''': Changes the separator between last and first names; defaults to a comma and space (, ); if the parameter is present, but blank, no separator punctuation will be used; a space must be encoded as &#32; do not use an asterisk (*), colon (:) or hash (#) as they will be interpreted as wikimarkup. In Lua-based CS1 citations, when the parameter is present but blank, separator punctuation is set to the default. |
|||
* <b id="csdoc_contributor-mask">contributor-mask</b>: |
|||
* '''author-separator''': Changes the separator between authors; defaults to a semicolon and space (; ); if the parameter is present, but blank, no separator punctuation will be used; a space must be encoded as &#32; do not use an asterisk (*), colon (:) or hash (#) as they will be interpreted as wikimarkup. In Lua-based CS1 citations, when the parameter is present but blank, separator punctuation is set to the default. |
|||
* <b id="csdoc_editor-mask">editor-mask</b>: |
|||
* '''displayauthors''': By default, the number of authors displayed is limited to 8; if 9 are provided, the ninth is displayed as "et al." This parameter allows display of fewer authors before the "et al."; for example, use {{para|displayauthors|2}} for only two authors. The "et al." may be suppressed altogether by setting {{para|displayauthors|9}}. For the Lua-based CS1 citations: The number of authors is not restricted. The Lua-based citation engine cannot know if editors created citations with exactly nine authors because there were only nine authors or, because old-style citations were limited to nine authors. When there are exactly nine authors, Lua-based citations mimic the old-style citations; suppress the automatic "et al." by setting {{para|displayauthors|9}}. |
|||
* <b id="csdoc_interviewer-mask">interviewer-mask</b>: |
|||
* '''lastauthoramp''': When set to any value, changes the separator between the last two names of the author list to space ampersand space ( & ). |
|||
* <b id="csdoc_subject-mask">subject-mask</b>: |
|||
* '''postscript''': The closing punctuation for the citation; defaults to {{#if: {{{cs2|}}}|none|a period (.); if the parameter is present, but blank, no terminating punctuation will be used}}. Ignored if '''quote''' is defined. |
|||
* <b id="csdoc_translator-mask">translator-mask</b>: |
|||
* '''separator''': The punctuation used to separate lists of authors, editors, etc. Defaults to a {{#if: {{{cs2|}}}|comma (,)|period (.)}}; if the parameter is present but blank, no separator punctuation will be used; a space must be encoded as &#32; do not use an asterisk (*), colon (:) or hash (#) as they will be interpreted as wikimarkup. In Lua-based CS1 citations, when the parameter is present but blank, separator punctuation is set to the default. |
|||
| ⚫ | *: Replaces the name of the (first) author with [[dash#Em dash|em dashes]] or text. Set '''<{{var|name}}>-mask''' to a numeric value ''n'' to set the dash ''n'' em spaces wide; set '''<{{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 '''<{{var|name}}>-link'''—in this case, the value of '''<{{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 other kind of contributor) names that are displayed. By default, all authors are displayed. To change the displayed number of names, set the parameter 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 the other kinds of contributors). {{para|display-authors|0}} is a special case suppressing the display of all authors including the et al. {{para|display-authors|etal}} displays all authors in the list followed by et al. Aliases: none. |
|||
* <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 that render more than a single terminating punctuation character, will generate a maintenance message. {{para|postscript}} is ignored if '''quote''' is defined. |
|||
Latest revision as of 18:02, 31 October 2023
- 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...'). These styles correspond to Citation Style 1 and Citation Style 2 respectively. 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.
- 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
- display-authors:
- display-contributors:
- display-editors:
- display-interviewers:
- display-subjects:
- display-translators:
- Controls the number of author (or other kind of contributor) names that are displayed. By default, all authors are displayed. To change the displayed number of names, set the parameter to the desired number. For example,
|display-authors=2will display only the first two authors in a citation (and not affect the display of the other kinds of contributors).|display-authors=0is a special case suppressing the display of all authors including the et al.|display-authors=etaldisplays all authors in the list followed by et al. Aliases: none.
- Controls the number of author (or other kind of contributor) names that are displayed. By default, all authors are displayed. To change the displayed number of names, set the parameter to the desired number. For example,
- 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 that render more than a single terminating punctuation character, will generate a maintenance message.|postscript=is ignored if quote is defined.
