Template:CS1 config/doc

This is a documentation subpage for Template:CS1 config.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used on approximately 8,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua:

Module:Citation/CS1 (sandbox)

For consistency, this template sets certain parameters for all CS1 and CS2 templates on a page.^[1] 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.^[2] This provides stylistic consistency in the rendered output without editing every template in the article. For example, instead of adding |mode=cs1 to each {{Citation}} template on a page using mostly CS1 templates, {{CS1 config|mode=cs1}} 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 {{use dmy dates}} or {{use mdy dates}} (if present).

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

{{cs1 config |name-list-style=amp |mode=cs2}}

Settings parameters

{{CS1 config}} supports these settings parameters:

Supported settings parameters
Parameters	Acceptable values
`\|display-authors=`	numeric values only
`\|display-contributors=`
`\|display-editors=`
`\|display-interviewers=`
`\|display-translators=`
`\|mode=`	`cs1`, `cs2`
`\|name-list-style=`	`amp`, `ampersand`, `and`, `&`, `serial`, `vanc`

Mode

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

CS1

|mode=cs1

Bloggs, Joe (1974). Book of Bloggs.
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.

CS2

|mode=cs2

Bloggs, Joe (1974), Book of Bloggs
Commas separate the individual elements 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

|name-list-style=amp, |name-list-style=ampersand, or |name-list-style=&

Bloggs, Joe; Smith, John & Smythe, Jim (1990). 1000 Acres.
Inserts an ampersand (&) between the last two names in a name list when there are multiple authors.

Conjunction "and"

|name-list-style=and or |name-list-style=serial

Bloggs, Joe; Smith, John; and Smythe, Jim (1990). 1000 Acres.
Inserts the conjunction "and" between the last two names of a name list when there are multiple authors.

Vancouver style

|name-list-style=vanc

Bloggs J, Smith J, Smythe J (1990). 1000 Acres.
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.

Caveats

None of the |display-authors=, |display-contributors=, |display-editors=, |display-interviewers=, and |display-translators= will accept the etal 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 {{CS1 config}} 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 (|display-authors=etal for example) cannot be annotated. When such errors occur, Module:Citation/CS1 ignores the malformed setting.

Notes

^ ^a ^b This covers all templates that directly invoke Module:Citation/CS1, including the CS1 templates {{cite web}}, {{cite news}}, {{cite book}}, {{cite journal}}, {{cite magazine}}, and so on. It includes the general purpose CS2 template {{Citation}}. It also includes templates are wrappers for these templates like {{cite CE1913}}, {{cite Google Maps}}, {{cite tweet}}, or {{cite ADB}}. There are some templates with "cite xxx" names, like {{cite patent}}, that are technically unrelated, do not invoke Module:Citation/CS1, and will be unaffected by any parameters of {{cs1 config}}.
^ The CS1 config template produces no output of its own.

[covered-templates-1] This covers all templates that directly invoke Module:Citation/CS1, including the CS1 templates {{cite web}}, {{cite news}}, {{cite book}}, {{cite journal}}, {{cite magazine}}, and so on. It includes the general purpose CS2 template {{Citation}}. It also includes templates are wrappers for these templates like {{cite CE1913}}, {{cite Google Maps}}, {{cite tweet}}, or {{cite ADB}}. There are some templates with "cite xxx" names, like {{cite patent}}, that are technically unrelated, do not invoke Module:Citation/CS1, and will be unaffected by any parameters of {{cs1 config}}.

[2] The CS1 config template produces no output of its own.

[1]

[2]