Difference between revisions of "Template:As of/doc"
From SVR Wiki
m (→Examples: implementing templates) |
(added lower case param) |
||
| Line 27: | Line 27: | ||
'''Named''' | '''Named''' | ||
| − | *'''alt''' (named parameter) – optional; allows substitution of visible text output (defaults to "As of [date]") for different wording | + | *'''alt''' (named parameter) – 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''' (named parameter) – optional; allows use of American date format with value US, only visible to users who have not set their date preferences yet | + | *'''df''' (named parameter) – optional; allows use of American date format with value 'US', only visible to users who have not set their date preferences yet |
| + | *'''lc''' (named parameter) – optional; gives lower case "as of [date]" text output with value 'on' | ||
===Examples=== | ===Examples=== | ||
| Line 38: | Line 39: | ||
:<tt>{{As of{{!}}2008{{!}}4{{!}}1{{!}}alt=as of the <nowiki>[[2000 United States Census]]</nowiki>}}</tt> returns "''{{As of|2008|4|1|alt=as of the [[2000 United States Census]]}}''" | :<tt>{{As of{{!}}2008{{!}}4{{!}}1{{!}}alt=as of the <nowiki>[[2000 United States Census]]</nowiki>}}</tt> returns "''{{As of|2008|4|1|alt=as of the [[2000 United States Census]]}}''" | ||
:<tt>{{As of{{!}}2008{{!}}7{{!}}5{{!}}df=US}}</tt> returns "''{{As of|2008|7|5|df=US}}''" | :<tt>{{As of{{!}}2008{{!}}7{{!}}5{{!}}df=US}}</tt> returns "''{{As of|2008|7|5|df=US}}''" | ||
| + | :<tt>{{As of{{!}}2008{{!}}7{{!}}5{{!}}lc=on}}</tt> returns "''{{As of|2008|7|5|lc=on}}''" | ||
==See also== | ==See also== | ||
Revision as of 15:45, 24 July 2008
Template:Template doc page viewed directly
Contents
Usage
The template {{As of}} is used to link a section of text to an appropriate "As of..." page without creating a visible link on the page itself. This allows editors to catalogue statements that may become dated over time. 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) – required; must be in full numerical format (yyyy)
Optional
- month (second parameter) – optional; full, abbreviated or numerical (recommended) formats supported
- day (third parameter) – optional; numerical format only, not included in link
Named
- alt (named parameter) – 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 (named parameter) – optional; allows use of American date format with value 'US', only visible to users who have not set their date preferences yet
- lc (named parameter) – optional; gives lower case "as of [date]" text output with value 'on'
Examples
- {{As of|2008}} returns "As of 2008[update]"
- {{As of|2008|7}} returns "As of July 2008[update]"
- {{As of|2008|7|5}} returns "As of 5 July 2008[update]"
- {{As of|2008|4|1|alt=as of the [[2000 United States Census]]}} returns "as of the 2000 United States Census[update]"
- {{As of|2008|7|5|df=US}} returns "As of July 5, 2008[update]"
- {{As of|2008|7|5|lc=on}} returns "as of 5 July 2008[update]"
See also
- Wikipedia:As of
- Wikipedia:Avoid statements that will date quickly
- Category:Articles containing potentially dated statements
- Template:Cat ASOF
- Template:Update after
