Template:As of/doc

From Wikibooks, open books for an open world
Jump to navigation Jump to search

Template:Distinguish2

Usage[edit source]

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). Unlike the {{update after}} template, {{as of}} does not require the editor to give a full date. This template should not be substituted.

Notes:

  • This template MUST NOT be used in infoboxes that emit a microformat, as its emitted date markup will conflict with that.
  • This template is not necessary within quotations, and use of the template in such cases should be avoided.

This template does not generate a visible hyperlink in text where it is used.

Syntax[edit source]

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[edit source]

Required

  • year (first parameter) – must be in full numerical four-digit format (yyyy)

Optional

  • month (second parameter) – full, abbreviated or two-digit numerical formats supported (mm recommended, 01 indicating January, 02 February, etc., but also accepting Jan and January)
  • day (third parameter) – numerical two-digit format only, not included in link (dd)

Named

  • alt – optional; allows substitution of different wording and case for the visible text output (including the date). If present with no value defined, this parameter is ignored; if a value is defined, values for |df and |lc and |since parameters are ignored.
  • df – "date format", optional; allows use of American date format with |df=US.
  • lc – "lower case", optional; if given any value at all (e.g. |lc=y) gives lower case "as of date", for use in mid-sentence.
  • since – optional; if given any value at all (e.g. |since=y) it changes "As of" to "Since". Use of |lc=y with |since=y gives "since date. Use of |alt= will replace the entire output, including the "Since", as it will with the default "As of".
  • pre – text to insert before the date, and after "[A|a]s of" or "[S|s]ince", e.g. |pre=the first week of used like this: {{asof|1997|pre=the first week of}} produces "Template:Asof".
  • post – text (almost always punctuation) to insert between the date and the superscripted note that is displayed if
    1. |url= is used and
    2. the user's common.css page uses any of .asof-tag, .asof-tag.ref, or .asof-tag.update (see Wikipedia:As of).
    • For example,
      Template:Tnl no more bears were found
      gives
      "As of 16 April 2024,[update] no more bears were found"
      (comma "," before the superscripted note)
    • while
      Template:Tnl, no more bears were found
      produces the undesirable result (contrary to WP:REFPUNC) with regard to the location of the comma:
      "As of 16 April 2024[update], no more bears were found".
  • 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[edit source]

Template:Tlc – As of 2024
Template:Tlc – As of April 2024
Template:Tlc – As of 16 April 2024
Template:Tlc – As of April 16, 2024
Template:Tlc – as of 16 April 2024
Template:Tlc – as of the 2010 United States Census
Template:Tlc returns:
for logged in users, with links displayed (see Wikipedia:As of) – As of April 2024[ref]
for all other users – As of April 2024
Template:Tlc – Since April 16, 2024
Template:Tlc – since 16 April 2024

TemplateData[edit source]

This is the TemplateData documentation for the template used by the new VisualEditor.

As of

A template 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.

Template parameters

ParameterDescriptionTypeStatus
Year1

The year the statement is valid to. Must be in full numerical format (yyyy)

Numberrequired
Month2

The month the statement is valid to. Full, abbreviated or numerical formats supported (mm recommended)

Lineoptional
Day3

The day the statement is valid to (not included in link). Numerical format only (dd)

Numberoptional
Alternate wordingalt

Use different wording for the visible text output; if set, values for 'Date format' (df) and 'Lower case' (lc) parameters are ignored

Lineoptional
Date formatdf

Set to US to use U.S. date format (mdy) (default is dmy)

Default
US
Lineoptional
Lower caselc

Specify y to use lower case

Lineoptional
Sincesince

Specify y to replace 'as of' with 'since'.

Lineoptional
URLurl

A URL for 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

Lineoptional

See also[edit source]