Template:CS1 config/doc

For consistency, this template sets certain parameters for all CS1 and CS2 templates on a page. Module:Citation/CS1 generates widely used citation templates like cite book, cite journal, and cite web. This Module checks the article for CS1 config. When found, Module:Citation/CS1 extracts the settings parameters and their assigned values and applies those settings to all CS1 and CS2 templates in the article. This provides stylistic consistency in the rendered output without editing every template in the article. For example, instead of adding cs1 to each Citation template on a page using mostly CS1 templates,  can be added once to the article and will have the same effect.

Usage
Determine which of the available settings are desired and place this template in the article. For editor convenience, this template should probably be placed adjacent to or  (if present).

As an example, if you want all cs1|2 templates in the article to render as if they were templates (cs2) and to have all namelists in these templates include an ampersand between the last two names in each list, you might write:

Settings parameters
supports these settings parameters:

Mode
The commonly-used citation templates on Wikipedia have two style modes. These modes change how the citation is punctuated when it's rendered. Use cs1 to choose Citation Style 1. CS1 primarily uses a full stop to separate elements. Use cs2 to choose Citation Style 2. CS2 primarily uses the comma as a separator.

CS1
cs1


 * Full stops, also known as periods, separate the individual elements of the rendered citation.
 * A full stop comes at the end of the rendered citation.
 * A full stop comes at the end of the rendered citation.

CS2
cs2


 * Commas separate the individual elements of the rendered citation.
 * No terminal punctuation comes at the end of the rendered citation.
 * No terminal punctuation comes at the end of the rendered citation.

If a template wraps another citation template and sets its mode, then it should use Module:Citation mode to obey mode. See cite gnis2 for an example.

Name list style
Use name-list-style to change how the list of authors is formatted.

Ampersand
amp, ampersand, or &


 * Inserts an ampersand (&) between the last two names in a name list when there are multiple authors.
 * Inserts an ampersand (&) between the last two names in a name list when there are multiple authors.

Conjunction "and"
and or serial


 * Inserts the conjunction "and" between the last two names of a name list when there are multiple authors.
 * Inserts the conjunction "and" between the last two names of a name list when there are multiple authors.

Vancouver style
vanc


 * Abbreviates first names as done in the Vancouver style.
 * Uses neither an ampersand nor the conjunction "and".
 * Only applies when using the separate first type parameters for first names.
 * Vancouver style restricts author or editor names to the Latin alphabet.
 * Vancouver style restricts author or editor names to the Latin alphabet.

Caveats
None of the display-authors, display-contributors, display-editors, display-interviewers, and display-translators will accept the  keyword. Were they to do so, 'et al.' would be attached to every name list that correctly has only one name. For example, we do not want 'Darwin, Charles; et al.' for On the Origin of Species because there are no other authors whose names have been omitted.

When has a setting parameter that matches a setting parameter in a cs1|2 template (regardless of the assigned values), Module:Citation/CS1 will add a CS1 maint: overridden setting message and category.

This template is ignored when used in the Template namespace.

Error handling
For technical reasons, errors occurring in this template (etal for example) cannot be annotated. When such errors occur, Module:Citation/CS1 ignores the malformed setting.