Difference between revisions of "Template:As of/doc"

From SVR Wiki
Jump to: navigation, search
(Usage: updated)
(Syntax: updated)
Line 20: Line 20:
  
 
'''Required'''
 
'''Required'''
*'''year''' (first parameter) – required; must be in full numerical format (''yyyy'')
+
*'''year''' (first parameter) – must be in full numerical format (''yyyy'')
  
 
'''Optional'''
 
'''Optional'''
*'''month''' (second parameter) – optional; full, abbreviated or numerical (recommended) formats supported
+
*'''month''' (second parameter) – full, abbreviated or numerical (recommended) formats supported
*'''day''' (third parameter) – optional; numerical format only, not included in link
+
*'''day''' (third parameter) – numerical format only, not included in link
  
 
'''Named'''
 
'''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
+
*'''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''' (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''' – optional; allows use of American date format with ''df=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'
+
*'''lc''' – optional; gives lower case "as of [date]" when defined, recommended syntax is ''lc=on''
 +
*'''url''' (non-functional) – optional; use to suggest a website to check for updates to the statement
  
 
===Examples===
 
===Examples===

Revision as of 01:26, 1 August 2008

Template:Template doc page viewed directly

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, only visible to users who have not set their date preferences yet
  • lc – optional; gives lower case "as of [date]" when defined, recommended syntax is lc=on
  • url (non-functional) – optional; use to suggest a website to check for updates to the statement

Examples

{{As of|2008}} returns "As of 2008"
{{As of|2008|7}} returns "As of July 2008"
{{As of|2008|7|5}} returns "As of 5 July 2008"
{{As of|2008|4|1|alt=as of the [[2000 United States Census]]}} returns "as of the 2000 United States Census"
{{As of|2008|7|5|df=US}} returns "As of July 5, 2008"
{{As of|2008|7|5|lc=on}} returns "as of 5 July 2008"

See also