Module:Citation/CS1/doc: Difference between revisions

From escforumwiki
Jump to navigation Jump to search
m (1 revision imported)
 
m (1 revision imported)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
<section begin=header />
<section begin=header />
{{#ifeq:{{#invoke:String|find|{{FULLPAGENAME}}|sandbox}}|0|
{{sandbox other||
{{#switch:{{FULLPAGENAME}}
{{#switch:{{FULLPAGENAME}}
|Module:Citation/CS1={{high-risk|3000000+}}
|Module:Citation/CS1={{high-risk |article-space=yes}} {{Uses TemplateStyles|Module:Citation/CS1/styles.css}}
|Module:Citation/CS1/Configuration={{high-risk|3000000+}}
|Module:Citation/CS1/Configuration={{high-risk |article-space=yes}}
|Module:Citation/CS1/Whitelist={{high-risk|3000000+}}
|Module:Citation/CS1/Whitelist={{high-risk |article-space=yes}}
|Module:Citation/CS1/Date validation={{high-risk|3000000+}}
|Module:Citation/CS1/Date validation={{high-risk |article-space=yes}}
|Module:Citation/CS1/Identifiers={{high-risk|3000000+}}
|Module:Citation/CS1/Identifiers={{high-risk |article-space=yes}}
|Module:Citation/CS1/Utilities={{high-risk|3000000+}}
|Module:Citation/CS1/Utilities={{high-risk |article-space=yes}}
|Module:Citation/CS1/COinS={{high-risk|3000000+}}
|Module:Citation/CS1/COinS={{high-risk |article-space=yes}}
|Module:Citation/CS1/Suggestions={{high-use|10000+}}
|Module:Citation/CS1/Suggestions={{high-use |article-space=yes}}
}}
}}
{{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
|-
|-
!&nbsp;!!live!!colspan="2"|sandbox!!description
!colspan="2"|live!!colspan="2"|sandbox!!diff!!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
| rowspan="8"| [[File:Full-protection-shackle.svg|20px|alt=Gold padlock|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>}} ||[https://en.wikipedia.org/wiki/Special:ComparePages?page1=Module%3ACitation%2FCS1&rev1=&page2=Module%3ACitation%2FCS1%2Fsandbox&rev2=&action=&diffonly=&unhide= diff]|| 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/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>}} ||[https://en.wikipedia.org/wiki/Special:ComparePages?page1=Module%3ACitation%2FCS1%2FConfiguration&rev1=&page2=Module%3ACitation%2FCS1%2FConfiguration%2Fsandbox&rev2=&action=&diffonly=&unhide= diff]|| 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>}} ||[https://en.wikipedia.org/wiki/Special:ComparePages?page1=Module%3ACitation%2FCS1%2FWhitelist&rev1=&page2=Module%3ACitation%2FCS1%2FWhitelist%2Fsandbox&rev2=&action=&diffonly=&unhide= diff]|| 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>}} ||[https://en.wikipedia.org/wiki/Special:ComparePages?page1=Module%3ACitation%2FCS1%2FDate+validation&rev1=&page2=Module%3ACitation%2FCS1%2FDate+validation%2Fsandbox&rev2=&action=&diffonly=&unhide= diff] || 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>}} ||[https://en.wikipedia.org/wiki/Special:ComparePages?page1=Module%3ACitation%2FCS1%2FIdentifiers&rev1=&page2=Module%3ACitation%2FCS1%2FIdentifiers%2Fsandbox&rev2=&action=&diffonly=&unhide= diff]|| 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>}} ||[https://en.wikipedia.org/wiki/Special:ComparePages?page1=Module%3ACitation%2FCS1%2FUtilities&rev1=&page2=Module%3ACitation%2FCS1%2FUtilities%2Fsandbox&rev2=&action=&diffonly=&unhide= diff]|| 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>}} ||[https://en.wikipedia.org/wiki/Special:ComparePages?page1=Module%3ACitation%2FCS1%2FCOinS&rev1=&page2=Module%3ACitation%2FCS1%2FCOinS%2Fsandbox&rev2=&action=&diffonly=&unhide= diff]|| 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
| [[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>}} ||[https://en.wikipedia.org/wiki/Special:ComparePages?page1=Module%3ACitation%2FCS1%2Fstyles.css&rev1=&page2=Module%3ACitation%2FCS1%2Fsandbox%2Fstyles.css&rev2=&action=&diffonly=&unhide= diff]|| [[CSS]] styles applied to the CS1{{pipe}}2 templates
|-
| [[File:Template-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>}} ||[https://en.wikipedia.org/wiki/Special:ComparePages?page1=Module%3ACitation%2FCS1%2FSuggestions&rev1=&page2=Module%3ACitation%2FCS1%2FSuggestions%2Fsandbox&rev2=&action=&diffonly=&unhide= diff]|| List that maps common erroneous parameter names to valid parameter names
|}
|}
<section end=module_components_table />
<section end=module_components_table />
Line 43: 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
*[[Module:Citation/CS1/testcases/anchor]] ([[Module talk:Citation/CS1/testcases/anchor|run]]) – CITEREF anchors
 
<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 20:45, 15 June 2022



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.

These files comprise the module support for CS1|2 citation templates:

CS1 | CS2 modules
live sandbox diff description
Gold padlock Module:Citation/CS1 Module:Citation/CS1/sandbox [edit] diff Rendering and support functions
Module:Citation/CS1/Configuration Module:Citation/CS1/Configuration/sandbox [edit] diff Translation tables; error and identifier handlers
Module:Citation/CS1/Whitelist Module:Citation/CS1/Whitelist/sandbox [edit] diff List of active and deprecated CS1|2 parameters
Module:Citation/CS1/Date validation Module:Citation/CS1/Date validation/sandbox [edit] diff Date format validation functions
Module:Citation/CS1/Identifiers Module:Citation/CS1/Identifiers/sandbox [edit] diff Functions that support the named identifiers (ISBN, DOI, PMID, etc.)
Module:Citation/CS1/Utilities Module:Citation/CS1/Utilities/sandbox [edit] diff Common functions and tables
Module:Citation/CS1/COinS Module:Citation/CS1/COinS/sandbox [edit] diff Functions that render a CS1|2 template's metadata
Module:Citation/CS1/styles.css Module:Citation/CS1/sandbox/styles.css [edit] diff CSS styles applied to the CS1|2 templates
Silver padlock Module:Citation/CS1/Suggestions Module:Citation/CS1/Suggestions/sandbox [edit] diff List that maps common erroneous parameter names to valid parameter names


Other documentation:

testcases