Template:Citation Style documentation/display: Difference between revisions
From All Skies Encyclopaedia
(update opening phrases to mimic other entries) |
imported>Izno (move the default to the second line) |
||
| (38 intermediate revisions by 15 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>: |
|||
* <span id="csdoc_author-name-separator" />'''author-name-separator''': Changes the separator between last and first names; defaults to a comma and space (<code>, </code>); {{#if: {{{lua|}}}|if the parameter is present, but blank, separator punctuation is set to the default|if the parameter is present, but blank, no separator punctuation will be used}}; a space must be encoded as <code>&#32;</code>{{#if: {{{lua|}}}|.| do not use an asterisk (<code>*</code>), colon (<code>:</code>) or hash (<code>#</code>) as they will be interpreted as wikimarkup.}} |
|||
* <b id="csdoc_contributor-mask">contributor-mask</b>: |
|||
* <span id="csdoc_author-separator" />'''author-separator''': Changes the separator between authors; defaults to a semicolon and space (<code>; </code>); {{#if: {{{lua|}}}|if the parameter is present, but blank, separator punctuation is set to the default|if the parameter is present, but blank, no separator punctuation will be used}}; a space must be encoded as <code>&#32;</code>{{#if: {{{lua|}}}|.| do not use an asterisk (<code>*</code>), colon (<code>:</code>) or hash (<code>#</code>) as they will be interpreted as wikimarkup.}} |
|||
* <b id="csdoc_editor-mask">editor-mask</b>: |
|||
* <span id="csdoc_display-authors" /><span id="csdoc_displayauthors" />'''display-authors''': {{#if: {{{lua|}}}|Allows one to control 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 except when there are nine authors, then the author list in the citation is truncated to eight authors, followed by "et al." This exception mimics the older version of the template for compatibility. If a citation contains nine author names and one wishes all nine author names to display, "et al." may be suppressed by setting {{para|display-authors|9}}. Aliases: '''displayauthors'''.|Allows one to control the number of author names that are displayed when a citation is published. To control the displayed number of author names, 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, the only the first eight cited authors are displayed; subsequent authors beyond eight are represented in the published citation by "et al." If a citation contains nine author names and one wishes all nine author names to display, "et al." may be suppressed by setting {{para|display-authors|9}}. Aliases: '''displayauthors'''.}} |
|||
* <b id="csdoc_interviewer-mask">interviewer-mask</b>: |
|||
{{#if: {{{lua|}}}| |
|||
* <b id="csdoc_subject-mask">subject-mask</b>: |
|||
* <span id="csdoc_display-editors" /><span id="csdoc_displayeditors" />'''display-editors''': Allows one to control 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 except when there are four editors, then the editor list in the citation is truncated to three editors, followed by "et al." This exception mimics the older version of the template for compatibility. If a citation contains four editor names and one wishes all four editor names to display, "et al." may be suppressed by setting {{para|display-editors|4}}. Aliases: '''displayeditors'''.}} |
|||
* <b id="csdoc_translator-mask">translator-mask</b>: |
|||
* <span id="csdoc_lastauthoramp" />'''lastauthoramp''': When set to any value, changes the separator between the last two names of the author list to space ampersand space (<code> & </code>). |
|||
| ⚫ | *: 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}}. |
||
| ⚫ | * < |
||
* <span id="csdoc_separator" />'''separator''': The punctuation used to separate lists of authors, editors, etc. Defaults to a {{#if: {{{cs2|}}}|comma and space (<code>, </code>)|period (<code>.</code>)}}; {{#if: {{{lua|}}}|if the parameter is present, but blank, separator punctuation is set to the default|if the parameter is present, but blank, no separator punctuation will be used}}; a space must be encoded as <code>&#32;</code>{{#if: {{{lua|}}}|.|{{#if: {{{cs2|}}}|.| do not use an asterisk (<code>*</code>), colon (<code>:</code>) or hash (<code>#</code>) as they will be interpreted as wikimarkup.}} }} |
|||
* <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.
