Difference between revisions of "Template:Citation Style documentation/display"
From Timelines
(minor language updates) |
(update lastauthoramp) |
||
| 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 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''': | + | * <span id="csdoc_author-name-separator" />'''author-name-separator''': 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.}} |
| − | * <span id="csdoc_author-separator" />'''author-separator''': | + | * <span id="csdoc_author-separator" />'''author-separator''': 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.}} |
* <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 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'''.|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'''.}} | * <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 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'''.|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|}}}| | {{#if: {{{lua|}}}| | ||
* <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}}. 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}}. Aliases: '''displayeditors'''.}} | ||
| − | * <span id="csdoc_lastauthoramp" />'''lastauthoramp''': | + | * <span id="csdoc_lastauthoramp" />'''lastauthoramp''': 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|lastauthoramp|yes}} |
* <span id="csdoc_postscript" />'''postscript''': Controls the closing punctuation for a 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''': Controls the closing punctuation for a 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''': 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.}} }} | * <span id="csdoc_separator" />'''separator''': 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.}} }} | ||
Revision as of 10:02, 18 October 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: Controls 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: Controls 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: 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,
|display-authors=2will 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|display-authors=9. Aliases: displayauthors.
- <span id="csdoc_lastauthoramp" />lastauthoramp: Switches the separator between the last two names of the author list to space ampersand space (
&) when set to any value. Example:|lastauthoramp=yes - <span id="csdoc_postscript" />postscript: Controls the closing punctuation for a 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: Controls 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.
