Module:Citation/CS1/Configuration/doc
This is the documentation page for Module:Citation/CS1/Configuration
 | This Lua module is used on 2,600,000+ pages. To avoid large-scale disruption and unnecessary server load, any changes to this module should first be tested in its /sandbox or /testcases subpages. The tested changes can then be added to this page in one single edit. Please consider discussing any changes on the talk page before implementing them. |
 | This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
This configuration file contains various data that controls the functioning of Module:Citation/CS1 and hence the way that Lua-based citations are generated.
It has several sections among which are:
- translation tables that contain most of the literal strings that may be included in Lua-based citation. If editors are copying this Module to another wiki using a language other than English, then they should translate each of these values into that language.
- a list of error conditions specifying what text to display, what category to include (if any), and what help page section to refer to when errors are detected
- a list of ID handlers specifying the recognized document IDs, such as ISBN, DOI, etc., and how to format them.
These files comprise the module support for cs1|2 citation templates:
| live | sandbox | description | ||
|---|---|---|---|---|
 | Module:Citation/CS1 | Module:Citation/CS1/sandbox | [edit] | Rendering and support functions |
| Module:Citation/CS1/Configuration | Module:Citation/CS1/Configuration/sandbox | [edit] | Translation tables; error and identifier handlers | |
| Module:Citation/CS1/Whitelist | Module:Citation/CS1/Whitelist/sandbox | [edit] | List of active, deprecated, and obsolete cs1Template:Pipe2 parameters | |
| Module:Citation/CS1/Date validation | Module:Citation/CS1/Date validation/sandbox | [edit] | Date format validation functions | |
| Module:Citation/CS1/Identifiers | [edit] | Functions that support the named identifiers (isbn, doi, pmid, etc) | ||
| Module:Citation/CS1/Utilities | [edit] | Common functions and tables | ||
| Module:Citation/CS1/COinS | [edit] | Functions that render a cs1Template:Pipe2 template's metadata | ||
 | Module:Citation/CS1/Suggestions | Module:Citation/CS1/Suggestions/sandbox | [edit] | List that maps common erroneous parameter names to valid parameter names |