Difference between revisions of "Template:Citation Style documentation/display"
From Timelines
(anchors for specific aliases) |
(fx fmt) |
||
| Line 1: | Line 1: | ||
| − | * <span id="csdoc_display" /><span id="csdoc_author-mask" />'''author-mask''': Replaces the name of the first author with [[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 bibliography styles where multiple works by a single author are listed sequentially. 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_display" /><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 bibliography styles where multiple works by a single author are listed sequentially. 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-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.}} | * <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.}} | ||
* <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.}} | * <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.}} | ||
| Line 7: | Line 7: | ||
* <span id="csdoc_display-editors" /><span id="csdoc_displayeditors" />'''display-editors''': By default, all editors are shown unless there are four, then the editor list is truncated to four editors and followed by "et al." This mimics the older version of the template for compatibility. To change the displayed number of editors, set '''display-editors''' to the desired number. Where there are four editors, set {{para|display-editors|4}} to show all editors. Aliases: '''displayeditors'''.}} | * <span id="csdoc_display-editors" /><span id="csdoc_displayeditors" />'''display-editors''': By default, all editors are shown unless there are four, then the editor list is truncated to four editors and followed by "et al." This mimics the older version of the template for compatibility. To change the displayed number of editors, set '''display-editors''' to the desired number. Where there are four editors, set {{para|display-editors|4}} to show all editors. Aliases: '''displayeditors'''.}} | ||
* <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>). | * <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>). | ||
| − | * <span id="csdoc_postscript" />'''postscript''': The closing punctuation for the citation; defaults to {{#if: {{{cs2|}}}|none|a period(<code>.</code>); {{#if: {{{lua|}}}|for no terminating punctuation, specify {{para|postscript|none}} – leaving {{para|postscript}} empty has the same effect but is ambiguous|if the parameter is present, but blank, no terminating punctuation will be used}}}}. Ignored if '''quote''' is defined. | + | * <span id="csdoc_postscript" />'''postscript''': The closing punctuation for the citation; defaults to {{#if: {{{cs2|}}}|none|a period (<code>.</code>); {{#if: {{{lua|}}}|for no terminating punctuation, specify {{para|postscript|none}} – leaving {{para|postscript}} empty has the same effect but is ambiguous|if the parameter is present, but blank, no terminating punctuation will be used}}}}. Ignored if '''quote''' is defined. |
* <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.}} }} | * <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.}} }} | ||
Revision as of 15:25, 29 September 2013
- <span id="csdoc_display" /><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 bibliography styles where multiple works by a single author are listed sequentially. 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. - <span id="csdoc_author-name-separator" />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 do not use an asterisk (*), colon (:) or hash (#) as they will be interpreted as wikimarkup. - <span id="csdoc_author-separator" />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 do not use an asterisk (*), colon (:) or hash (#) as they will be interpreted as wikimarkup. - <span id="csdoc_display-authors" /><span id="csdoc_displayauthors" />display-authors: 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
|display-authors=2for only two authors. The "et al." may be suppressed altogether by setting|display-authors=9. Aliases: displayauthors.
- <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 (
&). - <span id="csdoc_postscript" />postscript: The closing punctuation for the citation; defaults to a period (
.); if the parameter is present, but blank, no terminating punctuation will be used. Ignored if quote is defined. - <span id="csdoc_separator" />separator: The punctuation used to separate lists of authors, editors, etc. Defaults to a period (
.); if the parameter is present, but blank, no separator punctuation will be used; a space must be encoded as do not use an asterisk (*), colon (:) or hash (#) as they will be interpreted as wikimarkup.
