Difference between revisions of "Template:Citation Style documentation/display"
From Timelines
(Remove deprecated parameters that have moved to unsupported) |
(Stub documentation for editor-mask and translator-mask.) |
||
| Line 1: | Line 1: | ||
* <span id="csdoc_display" /><span id="csdoc_mode" />'''mode''': Sets element separator, default terminal punctuation, and certain capitalization according to the value provided. For {{para|mode|cs1}}, element separator is a semicolon (<code>;</code>); 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'''. | * <span id="csdoc_display" /><span id="csdoc_mode" />'''mode''': Sets element separator, default terminal punctuation, and certain capitalization according to the value provided. For {{para|mode|cs1}}, element separator is a semicolon (<code>;</code>); 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'''. | ||
| − | * <span id="csdoc_author-mask" />'''author-mask''': 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}}. 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. | + | * <span id="csdoc_author-mask" />'''author-mask''': 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}}. 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. |
* <span id="csdoc_display-authors" /><span id="csdoc_displayauthors" />'''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, {{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_display-authors" /><span id="csdoc_displayauthors" />'''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, {{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_display-editors" /><span id="csdoc_displayeditors" />'''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, {{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}}. {{para|display-editors|etal}} displays all editors in the list followed by et al. Aliases: '''displayeditors'''. | * <span id="csdoc_display-editors" /><span id="csdoc_displayeditors" />'''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, {{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}}. {{para|display-editors|etal}} displays all editors in the list followed by et al. Aliases: '''displayeditors'''. | ||
* <span id="csdoc_lastauthoramp" />'''last-author-amp''': Switches the separator between the last two names of the author list to space ampersand space (<code> & </code>) when set to any value. Example: {{para|last-author-amp|yes}} | * <span id="csdoc_lastauthoramp" />'''last-author-amp''': Switches the separator between the last two names of the author list to space ampersand space (<code> & </code>) when set to any value. Example: {{para|last-author-amp|yes}} | ||
* <span id="csdoc_postscript" />'''postscript''': 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}}. Ignored if '''quote''' is defined. | * <span id="csdoc_postscript" />'''postscript''': 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}}. Ignored if '''quote''' is defined. | ||
Revision as of 09:42, 26 September 2015
- <span id="csdoc_display" /><span id="csdoc_mode" />mode: Sets element separator, default terminal punctuation, and certain capitalization according to the value provided. For
|mode=cs1, element separator is a semicolon (;); 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. - <span id="csdoc_author-mask" />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 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. You can also use editor-mask and translator-mask in the same way. - <span id="csdoc_display-authors" /><span id="csdoc_displayauthors" />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=2will display only the first two authors in a citation. By default, all authors are displayed.|display-authors=etaldisplays all authors in the list followed by et al. Aliases: displayauthors. - <span id="csdoc_display-editors" /><span id="csdoc_displayeditors" />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=2will 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|display-editors=4.|display-editors=etaldisplays all editors in the list followed by et al. Aliases: displayeditors. - <span id="csdoc_lastauthoramp" />last-author-amp: Switches the separator between the last two names of the author list to space ampersand space (
&) when set to any value. Example:|last-author-amp=yes - <span id="csdoc_postscript" />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. Ignored if quote is defined.
