Template:Citation Style documentation/display: Difference between revisions

m
(update display-editors language)
 
(27 intermediate revisions by 13 users not shown)
Line 1:
* <span id="csdoc_display"></span><b id="csdoc_mode">mode</b>: Sets element separator, default terminal punctuation, and certain capitalization according to the value provided. For {{para|mode|cs1}}, element separator and 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" /><spanb id="csdoc_author-mask" />'''author-mask'''</b>: 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|lc=y}}. 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. Mask parameters can take a number in the name of the parameter (e.g. {{para|author<sub>n</sub>-mask}}) to specify which author the mask should apply to.
* <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>&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.}}
* <spanb id="csdoc_display-editorsauthors" /><span id="csdoc_displayeditorscsdoc_displayauthors" ></span>'''display-editors'''authors</b>: This parameter allows one to controlControls the number of editorauthor names that are displayed when a citation is published. To change the displayed number of editorsauthors, set '''display-editorsauthors''' to the desired number. For example, {{para|display-authors|2}} will display only the first two editorsauthors in a citation. By default, all editorsauthors are displayed. except{{para|display-authors|etal}} whendisplays thereall areauthors four editors, thenin 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: '''displayeditorsdisplayauthors'''.}}
* <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>&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.}}
* <spanb id="csdoc_display-authorseditors" /><span id="csdoc_displayauthorscsdoc_displayeditors" ></span>'''display-authors'''editors</b>: {{#if: {{{lua|}}}|This parameter allows one to controlControls the number of authoreditor names that are displayed when a citation is published. To change the displayed number of authorseditors, set '''display-authorseditors''' to the desired number. For example, {{para|display-authorseditors|2}} will display only the first two authorseditors in a citation. By default, all authorseditors 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-authorseditors|9etal}}. Aliases:displays '''displayauthors'''.|Thisall parameter allows one to control 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 authorseditors in a citation. By default, the onlylist the first eight cited authors are displayed; subsequent authors beyond eight are represented in the published citationfollowed 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: '''displayauthorsdisplayeditors'''.}}
* <spanb id="csdoc_lastauthoramp" >last-author-amp</b>'''lastauthoramp''': When set to any value, changesSwitches the separator between the last two names of the author list to space ampersand space (<code> & </code>) when set to <code>y</code>, <code>yes</code>, or <code>true</code>. Example: {{para|last-author-amp|yes}}
{{#if: {{{lua|}}}|
* <spanb id="csdoc_postscript" />'''postscript'''</b>: TheControls the closing punctuation for thea citation; defaults to {{#if: {{{cs2|}}}|none|a period (<code>.</code>); {{#if: {{{lua|}}}|for no terminating punctuation, specify {{para|postscript|none}} – leaving {{para|postscript}} empty hasis the same effectas omitting it, but is ambiguous|if}}. theAdditional parametertext isor present,templates butbeyond blank, nothe terminating punctuation willmay begenerate usedan error message. {{para|postscript}}}}. Ignoredis ignored if '''quote''' is defined.
* <span id="csdoc_display-editors" /><span id="csdoc_displayeditors" />'''display-editors''': This parameter allows one to control 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-authors|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''': 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_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>&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.}} }}