Template:As of/doc

From SVR Wiki
Revision as of 20:27, 9 July 2008 by Ikara (talk) (preliminary template documentation)
Jump to: navigation, search

Template:Template doc page viewed directly

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

{{ As of | year | month | day }}
{{ As of | month_name year }} (deprecated)

Parameters

Required

  • year (first parameter) – required; must be in full numerical format (yyyy)
    month_name year (first parameter, deprecated) – required; month_name must be capitalised full name, and year must be in full numerical format (e.g. "April 2006")

Optional

  • month (second parameter) – optional; full, abbreviated or numerical (recommended) formats supported
  • day (third parameter) – optional; numerical format only, not included in link

Named optional

  • alt (named parameter) – optional; allows substitution of visible text output (defaults to "As of [date]") for different wording or use of lower case
  • 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

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 | 7 | 5 | alt=from [[5 July]] onwards}} returns "from 5 July onwards"
{{As of | 2008 | 7 | 5 | df=US}} returns "As of July 5, 2008"
{{As of | April 2006}} returns "As of April 2006"

See also