Open main menu

Difference between revisions of "Module:Citation/CS1/doc"

< Module:Citation/CS1
(Reverted 1 edit by 140.213.57.249 (talk) (TW))
 
m (1 revision imported)
 
(4 intermediate revisions by 3 users not shown)
Line 2: Line 2:
 
{{sandbox other||
 
{{sandbox other||
 
{{#switch:{{FULLPAGENAME}}
 
{{#switch:{{FULLPAGENAME}}
|Module:Citation/CS1={{high-risk| approximately 3920000}} {{Uses TemplateStyles|Module:Citation/CS1/styles.css}}
+
|Module:Citation/CS1={{high-risk}} {{Uses TemplateStyles|Module:Citation/CS1/styles.css}}
|Module:Citation/CS1/Configuration={{high-risk| approximately 3930000}}
+
|Module:Citation/CS1/Configuration={{high-risk}}
|Module:Citation/CS1/Whitelist={{high-risk| approximately 3920000}}
+
|Module:Citation/CS1/Whitelist={{high-risk}}
|Module:Citation/CS1/Date validation={{high-risk| approximately 3920000}}
+
|Module:Citation/CS1/Date validation={{high-risk}}
|Module:Citation/CS1/Identifiers={{high-risk| approximately 3920000}}
+
|Module:Citation/CS1/Identifiers={{high-risk}}
|Module:Citation/CS1/Utilities={{high-risk| approximately 3920000}}
+
|Module:Citation/CS1/Utilities={{high-risk}}
|Module:Citation/CS1/COinS={{high-risk| approximately 3920000}}
+
|Module:Citation/CS1/COinS={{high-risk}}
|Module:Citation/CS1/Suggestions={{high-use| 20000+ }}
+
|Module:Citation/CS1/Suggestions={{high-use}}
 
}}
 
}}
 
{{Module rating|p}}}}<!-- if pagename does not contain sandbox -->
 
{{Module rating|p}}}}<!-- if pagename does not contain sandbox -->
Line 16: Line 16:
 
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.
 
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 />
 
<section begin=module_components_table />
These files comprise the module support for cs1|2 citation templates:
+
These files comprise the module support for CS1|2 citation templates:
 
{| class="wikitable" style="margin: 1em auto 1em auto;"
 
{| class="wikitable" style="margin: 1em auto 1em auto;"
|+cs1 {{pipe}} cs2 modules
+
|+CS1 {{pipe}} CS2 modules
 
|-
 
|-
 
!colspan="2"|live!!colspan="2"|sandbox!!description
 
!colspan="2"|live!!colspan="2"|sandbox!!description
Line 26: Line 26:
 
| [[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/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/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 and deprecated 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/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/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/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
+
| [[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
 
|-
 
|-
| [[Module:Citation/CS1/styles.css]] || [[Module:Citation/CS1/sandbox/styles.css]] || {{Plain link|url=https://en.wikipedia.org/w/index.php?title=Module:Citation/CS1/sandbox/styles.css&action=edit|name=[edit<nowiki>]</nowiki>}} || [[CSS]] styles applied to the cs1{{pipe}}2 templates
+
| [[Module:Citation/CS1/styles.css]] || [[Module:Citation/CS1/sandbox/styles.css]] || {{Plain link|url=https://en.wikipedia.org/w/index.php?title=Module:Citation/CS1/sandbox/styles.css&action=edit|name=[edit<nowiki>]</nowiki>}} || [[CSS]] styles applied to the CS1{{pipe}}2 templates
 
|-
 
|-
 
| [[File:Semi-protection-shackle.svg|20px|alt=Silver padlock|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
 
| [[File:Semi-protection-shackle.svg|20px|alt=Silver padlock|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
Line 45: Line 45:
 
* [[Module talk:Citation/CS1/Feature requests]]
 
* [[Module talk:Citation/CS1/Feature requests]]
 
* [[Module talk:Citation/CS1/COinS]]
 
* [[Module talk:Citation/CS1/COinS]]
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
+
* [[Module:Cs1 documentation support]] – a set of functions (some experimental) that extract information from the module suite for the purpose of documenting CS1|2
 +
** [[Module:Citation/CS1/doc/Category list]] – lists of category names taken directly from [[Module:Citation/CS1/Configuration]] and [[Module:Citation/CS1/Configuration/sandbox]]
 +
testcases
 +
*[[Module:Citation/CS1/testcases]] ([[Module talk:Citation/CS1/testcases|run]])
 +
*[[Module:Citation/CS1/testcases/errors]] ([[Module talk:Citation/CS1/testcases/errors|run]]) – error and maintenance messaging
 +
*[[Module:Citation/CS1/testcases/dates]] ([[Module talk:Citation/CS1/testcases/dates|run]]) – date validation
 +
*[[Module:Citation/CS1/testcases/identifiers]] ([[Module talk:Citation/CS1/testcases/identifiers|run]]) – identifiers
 +
 
 +
<includeonly>{{sandbox other||
 
[[Category:Modules that add a tracking category]]
 
[[Category:Modules that add a tracking category]]
 +
{{#ifeq:{{SUBPAGENAME}}|Identifiers|[[Category:Modules using data from Wikidata]]}}
 
}}</includeonly>
 
}}</includeonly>

Latest revision as of 05:13, 17 December 2020

<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
Gold padlock 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 and deprecated 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
Module:Citation/CS1/styles.css Module:Citation/CS1/sandbox/styles.css [edit] CSS styles applied to the CS1|2 templates
Silver padlock 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:

testcases