Template:Citation Style documentation/display: Difference between revisions
Jump to navigation
Jump to search
Content added Content deleted
imported>Tom.Reding (+"author-format: (deprecated) Use name-list-format.") |
m (64 revisions imported) |
||
(16 intermediate revisions by 10 users not shown) | |||
Line 1: | Line 1: | ||
* <span id="csdoc_display" |
* <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_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'''. |
||
* <span id="csdoc_author-name-separator" />{{xtd|'''author-name-separator'''}}: (deprecated) <s>Controls 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.}}</s> Use '''name-list-format'''. |
|||
* <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'''. |
|||
* <span id="csdoc_author-separator" />{{xtd|'''author-separator'''}}: (deprecated) <s>Controls 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.}}</s> Use '''name-list-format'''. |
|||
⚫ | |||
* <span id="csdoc_author-format" />{{xtd|'''author-format'''}}: (deprecated) Use '''name-list-format'''. |
|||
⚫ | * <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. |
||
* <span id="csdoc_display-authors" /><span id="csdoc_displayauthors" />'''display-authors''': {{#if: {{{lua|}}}|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. Aliases: '''displayauthors'''.|Controls 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'''.}} |
|||
{{#if: {{{lua|}}}| |
|||
⚫ | * < |
||
⚫ | |||
⚫ | * < |
||
* <span id="csdoc_separator" />{{xtd|'''separator'''}}: (deprecated) <s>Controls 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.}} }}</s> Use '''mode'''. |
Latest revision as of 20:04, 31 May 2021
- 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: Replaces the name of the first author with 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 Template:Sfnote. 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. 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.|authorn-mask=
) to specify which author the mask should apply to. - display-authors: 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,
|display-authors=2
will display only the first two authors in a citation. By default, all authors are displayed.|display-authors=etal
displays all authors in the list followed by et al. Aliases: displayauthors. - display-editors: 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,
|display-editors=2
will display only the first two editors in a citation. By default, all editors are displayed.|display-editors=etal
displays all editors in the list followed by et al. Aliases: displayeditors. - last-author-amp: Switches the separator between the last two names of the author list to space ampersand space (
&
) when set toy
,yes
, ortrue
. 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.