Template:Citation Style documentation/display: Difference between revisions

From Climate Change AI Wiki
Content added Content deleted
imported>Trappist the monk
(name-list-format replaces author-format and editor-format;)
imported>Trappist the monk
(mode replaces separator;)
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_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.
* <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-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" />{{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_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'''.
Line 7: Line 8:
* <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>); {{#if: {{{lua|}}}|for no terminating punctuation, specify {{para|postscript|none}} – leaving {{para|postscript}} empty is the same as omitting it, 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 is the same as omitting it, 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>&amp;#32;</code>{{#if: {{{lua|}}}|.|{{#if: {{{cs2|}}}|.|&#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_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>&amp;#32;</code>{{#if: {{{lua|}}}|.|{{#if: {{{cs2|}}}|.|&#32;do not use an asterisk (<code>*</code>), colon (<code>:</code>) or hash (<code>#</code>) as they will be interpreted as wikimarkup.}} }}</s>

Revision as of 15:32, 14 February 2015

  • mode: Sets element separator, default terminal punctuation, and certain capitalization according to the value provided. For Template:Para, element separator is a semicolon (;); terminal punctuation is a period (.); where appropriate, initial letters of certain words are capitalized ('Retrieved...'). For Template:Para, 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 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.
  • Template:Xtd: (deprecated) 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.