Template:As of/doc

From Timelines
Jump to: navigation, search
Not to be confused with Template:As of?, which redirects to Template:When.

Usage

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). It should not be used for future dates (use {{update after}} instead). 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

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

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 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 "As of the first week of 1997".
  • 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,
      <code>{{As of| 2024| 03| 28| post=,}} no more bears were found</code>
      gives
      "As of 28 March 2024,[update] no more bears were found"
      (comma "," before the superscripted note)
    • while
      <code>{{As of| 2024| 03| 28}}, no more bears were found</code>
      produces the undesirable result (contrary to WP:REFPUNC) with regard to the location of the comma:
      "As of 28 March 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

{{As of|2024}} – As of 2024
{{As of|2024|03}} – As of March 2024
{{As of|2024|03|28}} – As of 28 March 2024
{{As of|2024|03|28|df=US}} – As of March 28, 2024
{{As of|2024|03|28|lc=y}} – as of 28 March 2024
{{As of|2010|4|1|alt=as of the [[2010 United States Census]]}} – as of the 2010 United States Census
{{As of|2024|03|url=http://en.wikipedia.org/}} returns:
for logged in users, with links displayed (see Wikipedia:As of) – As of March 2024[ref]
for all other users – As of March 2024
{{As of|2024|03|28|df=US|since=y}} – Since March 28, 2024
{{As of|2024|03|28|lc=y|since=y}} – since 28 March 2024

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

See the monthly error report for this template.

TemplateData for As of

<templatedata>{ "description": "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. It should not be used for future dates (use [needs update] instead).", "params": {

 "1": {
   "label": "Year",
   "description": "The year the statement is valid to. Must be in full numerical format (yyyy)",
   "type": "number",
   "required": true
 },
 "2": {
   "label": "Month",
   "description": "The month the statement is valid to. Full, abbreviated or numerical formats supported (mm recommended)",
   "type" : "string/line",
   "required": false
 },
 "3": {
   "label": "Day",
   "description": "The day the statement is valid to (not included in link). Numerical format only (dd)",
   "type": "number",
   "required": false
 },
 "alt": {
   "label": "Alternate wording",
   "description": "Use different wording for the visible text output; if set, values for 'Date format' (df) and 'Lower case' (lc) parameters are ignored",
   "type": "string/line",
   "required": false
 },
 "df": {
   "label": "Date format",
   "description": "Set to US to use U.S. date format (mdy) (default is dmy)",
   "type": "string/line",
   "default": "US",
   "required": false
 },
 "lc": {
   "label": "Lower case",
   "description": "Specify y to use lower case",
   "type": "string/line",
   "required":false
 },
 "since": {
   "label": "Since",
   "description": "Specify y to replace 'as of' with 'since'.",
   "type": "string/line",
   "required": false
 },
 "url": {
   "label": "URL",
   "description": "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",
   "type": "string/line",
   "required": false
 }

}} </templatedata>

See also