Difference between revisions of "Template:As of/doc"
From SVR Wiki
m (Undid revision 520593140 by Animator.anurag (talk) rvv) |
|||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
| − | {{Distinguish|: | + | {{Distinguish|Template:As of?}} |
| − | <!-- | + | <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> |
| − | |||
| − | + | ==Usage== | |
| + | The template {{tl|as of}} is used to mark potentially dated statements, and will add an article to the appropriate [[WP:HIDDENCAT|hidden]] sub-category of [[:Category:Articles containing potentially dated statements]]. This allows editors to catalogue statements that may become dated over time. The date used for a given statement should be the current date (for currently valid statements) or the date on which the cited reference was produced (for example, when using census data). It also includes the [[WP:ISO 8601|ISO 8601]] format needed by [[hAtom]] (<code>class="updated"</code>) and [[hCalendar]] (<code>class="dtstart"</code>) [[microformat]]s through use of the {{tl|start date}} template. Unlike the {{tl|update after}} template, {{tl|as of}} does not require the editor to give a full date. This template should '''not''' be [[Wikipedia:Substitution|substituted]]. | ||
| + | This template does not generate a visible hyperlink in text where it is used. | ||
| − | + | ==Syntax== | |
| + | The template can be used in the following forms: | ||
| − | + | :<code><nowiki>{{As of|year}}</nowiki></code> | |
| − | + | :<code><nowiki>{{As of|year|month}}</nowiki></code> | |
| − | + | :<code><nowiki>{{As of|year|month|day}}</nowiki></code> | |
| − | :<code><nowiki>{{ | ||
| − | :<code><nowiki>{{ | ||
| − | :<code><nowiki>{{ | ||
Please do not use <code><nowiki>{{As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}}}</nowiki></code> or similar; that defeats the point of the template. | Please do not use <code><nowiki>{{As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}}}</nowiki></code> or similar; that defeats the point of the template. | ||
| Line 22: | Line 21: | ||
===Parameters=== | ===Parameters=== | ||
'''Required''' | '''Required''' | ||
| − | *'''year''' ( | + | *'''year''' (first parameter) – must be in full numerical format (''yyyy'') |
'''Optional''' | '''Optional''' | ||
| − | *'''month''' ( | + | *'''month''' (second parameter) – full, abbreviated or numerical formats supported (''mm'' recommended) |
| − | *'''day''' ( | + | *'''day''' (third parameter) – numerical format only, not included in link (''dd'') |
'''Named''' | '''Named''' | ||
*'''alt''' – optional; allows substitution of different wording and case for the visible text output; if present but no value defined, this parameter is ignored; if a value is defined, values for ''df'' and ''lc'' parameters are ignored | *'''alt''' – optional; allows substitution of different wording and case for the visible text output; if present but no value defined, this parameter is ignored; if a value is defined, values for ''df'' and ''lc'' parameters are ignored | ||
| − | *''' | + | *'''df''' – optional; allows use of American date format with ''df=US'' |
| − | *''' | + | *'''lc''' – optional; gives lower case "as of ''date''" when defined; recommended syntax is ''lc=y'' |
| − | *''' | + | *'''url''' – optional; adds an inline external link (hidden by default) suggesting a webpage for future editors to check for updates to the statement; use the full URL with no spaces. See [[Wikipedia:As of#Article maintenance|Wikipedia:As of]] for displaying links. |
===Examples=== | ===Examples=== | ||
| Line 60: | Line 59: | ||
<includeonly> | <includeonly> | ||
<!-- ADD CATEGORIES BELOW THIS LINE --> | <!-- ADD CATEGORIES BELOW THIS LINE --> | ||
| − | [[Category: | + | [[Category:Inline templates]] |
| − | [[Category: | + | [[Category:Temporal templates]] |
[[Category:Time and date maintenance templates]] | [[Category:Time and date maintenance templates]] | ||
Revision as of 06:38, 31 October 2012
Contents
Usage
The template {{as of}} is used to mark potentially dated statements, and will add an article to the appropriate hidden sub-category of Category:Articles containing potentially dated statements. This allows editors to catalogue statements that may become dated over time. The date used for a given statement should be the current date (for currently valid statements) or the date on which the cited reference was produced (for example, when using census data). It also includes the ISO 8601 format needed by hAtom (class="updated") and hCalendar (class="dtstart") microformats through use of the {{start date}} template. Unlike the {{update after}} template, {{as of}} does not require the editor to give a full date. This template should not be substituted.
This template does not generate a visible hyperlink in text where it is used.
Syntax
The template can be used in the following forms:
{{As of|year}}{{As of|year|month}}{{As of|year|month|day}}
Please do not use {{As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}}} or similar; that defeats the point of the template.
Several additional named parameters can also be used (see below).
Parameters
Required
- year (first parameter) – must be in full numerical format (yyyy)
Optional
- month (second parameter) – full, abbreviated or numerical formats supported (mm recommended)
- day (third parameter) – numerical format only, not included in link (dd)
Named
- alt – optional; allows substitution of different wording and case for the visible text output; if present but no value defined, this parameter is ignored; if a value is defined, values for df and lc parameters are ignored
- df – optional; allows use of American date format with df=US
- lc – optional; gives lower case "as of date" when defined; recommended syntax is lc=y
- url – optional; adds an inline external link (hidden by default) suggesting a webpage for future editors to check for updates to the statement; use the full URL with no spaces. See Wikipedia:As of for displaying links.
Examples
- {{As of|2010}} – As of 2010[update]
- {{As of|2010|7}} – As of July 2010[update]
- {{As of|2010|7|5}} – As of 5 July 2010[update]
- {{As of|2010|4|1|alt=as of the [[2010 United States Census]]}} – as of the 2010 United States Census[update]
- {{As of|2010|7|5|df=US}} – As of July 5, 2010[update]
- {{As of|2010|7|5|lc=y}} – as of 5 July 2010[update]
- {{As of|2010|7|url=http://en.wikipedia.org/}} returns:
- for logged in users, with links displayed (see Wikipedia:As of) – As of July 2010[ref]
- for all other users – As of July 2010
See also
- Wikipedia:As of
- Wikipedia:Avoid statements that will date quickly
- Template:As of?
- Template:Category as of
- Template:Out of date
- Template:Show by date
- Template:Update
- Template:Update after
- Category:All articles containing potentially dated statements
