Module:Citation/CS1/doc: Difference between revisions

Jump to navigation Jump to search
(rating)
m (55 revisions imported)
 
(41 intermediate revisions by 14 users not shown)
Line 1: Line 1:
{{high-risk|2,150,000}}
<section begin=header />
{{Module rating|p}}
{{#ifeq:{{#invoke:String|find|{{FULLPAGENAME}}|sandbox}}|0|
This module contains routines that support the [[Help:Citation Style 1|Citation Style 1]] format for citations on Wikipedia.
{{#switch:{{FULLPAGENAME}}
|Module:Citation/CS1={{high-risk|3000000+}}
|Module:Citation/CS1/Configuration={{high-risk|3000000+}}
|Module:Citation/CS1/Whitelist={{high-risk|3000000+}}
|Module:Citation/CS1/Date validation={{high-risk|3000000+}}
|Module:Citation/CS1/Identifiers={{high-risk|3000000+}}
|Module:Citation/CS1/Utilities={{high-risk|3000000+}}
|Module:Citation/CS1/COinS={{high-risk|3000000+}}
|Module:Citation/CS1/Suggestions={{high-use|10000+}}
}}
{{Module rating|p}}}}<!-- if pagename does not contain sandbox -->
<section end=header />


In general this module is not intended to be called directly, but will be called by using templates such as:
This module and associated sub-modules support the {{cs1}} and {{cs2}} citation templates.  In general, it is not intended to be called directly, but is called by one of the core CS1 and CS2 templates.
<section begin=module_components_table />
These files comprise the module support for cs1|2 citation templates:
{| class="wikitable" style="margin: 1em auto 1em auto;"
|+cs1 {{pipe}} cs2 modules
|-
!&nbsp;!!live!!colspan="2"|sandbox!!description
|-
| rowspan="7"| [[File:Padlock.svg|20x20px|link=|sysop]] || [[Module:Citation/CS1]] || [[Module:Citation/CS1/sandbox]] || {{Plain link|url=https://en.wikipedia.org/w/index.php?title=Module:Citation/CS1/sandbox&action=edit|name=[edit<nowiki>]</nowiki>}} || Rendering and support functions
|-
| [[Module:Citation/CS1/Configuration]] || [[Module:Citation/CS1/Configuration/sandbox]] || {{Plain link|url=https://en.wikipedia.org/w/index.php?title=Module:Citation/CS1/Configuration/sandbox&action=edit|name=[edit<nowiki>]</nowiki>}} || Translation tables; error and identifier handlers
|-
| [[Module:Citation/CS1/Whitelist]] || [[Module:Citation/CS1/Whitelist/sandbox]] || {{Plain link|url=https://en.wikipedia.org/w/index.php?title=Module:Citation/CS1/Whitelist/sandbox&action=edit|name=[edit<nowiki>]</nowiki>}} || List of active, deprecated, and obsolete cs1{{pipe}}2 parameters
|-
| [[Module:Citation/CS1/Date validation]] || [[Module:Citation/CS1/Date validation/sandbox]] || {{Plain link|url=https://en.wikipedia.org/w/index.php?title=Module:Citation/CS1/Date_validation/sandbox&action=edit|name=[edit<nowiki>]</nowiki>}} || Date format validation functions
|-
| [[Module:Citation/CS1/Identifiers]] || [[Module:Citation/CS1/Identifiers/sandbox]] || {{Plain link|url=https://en.wikipedia.org/w/index.php?title=Module:Citation/CS1/Identifiers/sandbox&action=edit|name=[edit<nowiki>]</nowiki>}} || Functions that support the named identifiers (isbn, doi, pmid, etc)
|-
| [[Module:Citation/CS1/Utilities]] || [[Module:Citation/CS1/Utilities/sandbox]] || {{Plain link|url=https://en.wikipedia.org/w/index.php?title=Module:Citation/CS1/Utilities/sandbox&action=edit|name=[edit<nowiki>]</nowiki>}} || Common functions and tables
|-
| [[Module:Citation/CS1/COinS]] || [[Module:Citation/CS1/COinS/sandbox]] || {{Plain link|url=https://en.wikipedia.org/w/index.php?title=Module:Citation/CS1/COinS/sandbox&action=edit|name=[edit<nowiki>]</nowiki>}} || Functions that render a cs1{{pipe}}2 template's metadata
|-
| [[File:Padlock-silver.svg|20x20px|link=|auto confirmed]] || [[Module:Citation/CS1/Suggestions]] || [[Module:Citation/CS1/Suggestions/sandbox]] || {{Plain link|url=https://en.wikipedia.org/w/index.php?title=Module:Citation/CS1/Suggestions/sandbox&action=edit|name=[edit<nowiki>]</nowiki>}} || List that maps common erroneous parameter names to valid parameter names
|}
<section end=module_components_table />


*{{tl|cite news}}
Other documentation:
*{{tl|cite web}}
* [[Module talk:Citation/CS1/Feature requests]]
*{{tl|cite book}}
* [[Module talk:Citation/CS1/COinS]]
*{{tl|cite journal}}
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
 
[[Category:Modules that add a tracking category]]
and others: [[:Category:Citation Style 1 templates]].
}}</includeonly>
 
These files comprise the Lua support for CS1 citations:
{{#invoke:convert/tester|compare|cs1all}}
*[[Module:Citation/CS1/Arguments]]
*[[Module:Citation/CS1/Suggestions]]

Latest revision as of 16:18, 7 February 2017

<section begin=header />

<section end=header />

This module and associated sub-modules support the Citation Style 1 and Citation Style 2 citation templates. In general, it is not intended to be called directly, but is called by one of the core CS1 and CS2 templates. <section begin=module_components_table /> These files comprise the module support for cs1|2 citation templates:

cs1 | cs2 modules
  live sandbox description
sysop 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 cs1|2 parameters
Module:Citation/CS1/Date validation Module:Citation/CS1/Date validation/sandbox [edit] Date format validation functions
Module:Citation/CS1/Identifiers Module:Citation/CS1/Identifiers/sandbox [edit] Functions that support the named identifiers (isbn, doi, pmid, etc)
Module:Citation/CS1/Utilities Module:Citation/CS1/Utilities/sandbox [edit] Common functions and tables
Module:Citation/CS1/COinS Module:Citation/CS1/COinS/sandbox [edit] Functions that render a cs1|2 template's metadata
auto confirmed Module:Citation/CS1/Suggestions Module:Citation/CS1/Suggestions/sandbox [edit] List that maps common erroneous parameter names to valid parameter names

<section end=module_components_table />

Other documentation: