Template:Citation Style documentation/display: Difference between revisions

From Climate Change AI Wiki
Content added Content deleted
imported>Jonesey95
(Updating documentation per July 2014 RFC)
imported>Trappist the monk
(name-list-format replaces author-format and editor-format;)
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 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_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 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-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>&amp;#32;</code>{{#if: {{{lua|}}}|.|&#32;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" />{{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>&amp;#32;</code>{{#if: {{{lua|}}}|.|&#32;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-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>&amp;#32;</code>{{#if: {{{lua|}}}|.|&#32;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" />{{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>&amp;#32;</code>{{#if: {{{lua|}}}|.|&#32;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_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'''.}}
* <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|}}}|
{{#if: {{{lua|}}}|

Revision as of 13:36, 14 February 2015

  • 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 Template:Tlx, Template:Tag or similar as there is no control of the order in which references are displayed.
  • Template:Xtd: (deprecated) 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 &#32; do not use an asterisk (*), colon (:) or hash (#) as they will be interpreted as wikimarkup. Use name-list-format.
  • Template:Xtd: (deprecated) 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 &#32; do not use an asterisk (*), colon (:) or hash (#) as they will be interpreted as wikimarkup. Use name-list-format.
  • 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, Template:Para 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 Template:Para. Aliases: displayauthors.
  • 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: Template:Para
  • 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.
  • 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 &#32; do not use an asterisk (*), colon (:) or hash (#) as they will be interpreted as wikimarkup.