Difference between revisions of "Template:As of/doc"
From SVR Wiki
(clean up documentation subpage templates using AWB) |
m (link to WP:ISO 8601 using AWB) |
||
| Line 3: | Line 3: | ||
==Usage== | ==Usage== | ||
| − | + | The template {{tlx|As of}} is used to mark potentially dated statements, and add an article in the appropriate "As of..." category. 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 {{tlx|Start date}} template. Unlike the {{tlx|Update after}} template, <tt>{{As of}}</tt> does not require the editor to give a full date. This template should '''not''' be subst'd. | |
| − | The template {{tlx|As of}} is used to mark potentially dated statements, and add an article in the appropriate "As of..." category. 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]] (<code>class="updated"</code>) and [[hCalendar]] (<code>class="dtstart"</code>) [[microformat]]s through use of the {{tlx|Start date}} template. Unlike the {{tlx|Update after}} template, <tt>{{As of}}</tt> does not require the editor to give a full date. This template should '''not''' be subst'd. | ||
==Syntax== | ==Syntax== | ||
| − | |||
The template can be used in the following forms: | The template can be used in the following forms: | ||
| Line 17: | Line 15: | ||
===Parameters=== | ===Parameters=== | ||
| − | |||
'''Required''' | '''Required''' | ||
*'''year''' (first parameter) – must be in full numerical format (''yyyy'') | *'''year''' (first parameter) – must be in full numerical format (''yyyy'') | ||
| Line 32: | Line 29: | ||
===Examples=== | ===Examples=== | ||
| − | |||
:<tt>{{As of{{!}}2008}}</tt> — {{As of|2008}} | :<tt>{{As of{{!}}2008}}</tt> — {{As of|2008}} | ||
:<tt>{{As of{{!}}2008{{!}}7}}</tt> — {{As of|2008|7}} | :<tt>{{As of{{!}}2008{{!}}7}}</tt> — {{As of|2008|7}} | ||
| Line 46: | Line 42: | ||
==See also== | ==See also== | ||
| − | |||
*[[Wikipedia:As of]] | *[[Wikipedia:As of]] | ||
*[[Wikipedia:Avoid statements that will date quickly]] | *[[Wikipedia:Avoid statements that will date quickly]] | ||
| Line 59: | Line 54: | ||
<includeonly> | <includeonly> | ||
<!-- ADD CATEGORIES BELOW THIS LINE --> | <!-- ADD CATEGORIES BELOW THIS LINE --> | ||
| − | [[Category:Time and date maintenance templates | + | [[Category:Time and date maintenance templates]] |
| − | [[Category:Temporal templates | + | [[Category:Temporal templates]] |
| − | [[Category:Inline templates | + | [[Category:Inline templates]] |
<!-- ADD INTERWIKIS BELOW THIS LINE --> | <!-- ADD INTERWIKIS BELOW THIS LINE --> | ||
Revision as of 01:35, 5 September 2010
Contents
Usage
The template {{As of}} is used to mark potentially dated statements, and add an article in the appropriate "As of..." category. 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 subst'd.
Syntax
The template can be used in the following forms:
- {{As of|year|month|day}}
- {{As of|year|month}}
- {{As of|year}}
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 (recommended) formats supported
- day (third parameter) – numerical format only, not included in link
Named
- alt – optional; allows substitution of visible text output (defaults to "As of date") for different wording and case, if 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=on
- 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|2008}} — As of 2008[update]
- {{As of|2008|7}} — As of July 2008[update]
- {{As of|2008|7|5}} — As of 5 July 2008[update]
- {{As of|2008|4|1|alt=as of the [[2000 United States Census]]}} — as of the 2000 United States Census[update]
- {{As of|2008|7|5|df=US}} — As of July 5, 2008[update]
- {{As of|2008|7|5|lc=on}} — as of 5 July 2008[update]
- {{As of|2008|7|url=http://en.wikipedia.org/}} returns:
- for logged in users, with links displayed (see Wikipedia:As of) — As of July 2008[ref]
- for all other users — As of July 2008
See also
- Wikipedia:As of
- Wikipedia:Avoid statements that will date quickly
- Category:All articles containing potentially dated statements
- Template:Cat ASOF
- Template:As of?
- Template:Update
- Template:Update after
- Template:Out of date
- Template:Show by date
