View source for Template:As of/doc

{{Documentation subpage}}
{{high-use|49000+}}
{{Distinguish2|[[Template:As of?]], which redirects to [[Template:When]]}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
==Usage==
The template {{tl|as of}} is used to mark potentially dated statements, and will add an article to the appropriate [[WP:HIDDENCAT|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 {{tl|update after}} instead). This template should '''not''' be [[Wikipedia:Substitution|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:

:<code><nowiki>{{As of|year}}</nowiki></code>
:<code><nowiki>{{As of|year|month}}</nowiki></code>
:<code><nowiki>{{As of|year|month|day}}</nowiki></code>

Please do not use <code><nowiki>{{As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}}}</nowiki></code> 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, <code>01</code> indicating January, <code>02</code> February, etc., but also accepting <code>Jan</code> and <code>January</code>)
*'''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 <code>|df</code> and <code>|lc</code> and <code>|since</code> parameters are ignored.
*'''df''' – "date format", optional; allows use of American date format with {{para|df|US}}.
*'''lc''' – "lower case", optional; if given any value at all (e.g. {{para|lc|y}}) gives lower case "as of ''date''", for use mid-sentence.
*'''since''' – optional; if given any value at all (e.g. {{para|since|y}}) it changes "As of" to "Since". Use of {{para|lc|y}} with {{para|since|y}} gives "since ''date''. Use of {{para|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. {{para|pre|the first week of}} used like this: <code><nowiki>{{asof|1997|pre=the first week of}}</nowiki></code> produces "{{asof|1997|pre=the first week of}}".
*'''post''' &ndash; text (almost always punctuation) to insert between the date and the superscripted note that is displayed if
*:# <code>|url=</code> is used and
*:# the user's '''common.css''' page uses any of <code>.asof-tag</code>, <code>.asof-tag.ref</code>, or <code>.asof-tag.update</code> (see [[Wikipedia:As of#Article maintenance |Wikipedia:As of]]).
**  For example,
**::<code>{{tnl|As of| {{CURRENTYEAR}}| {{CURRENTMONTH}}| {{CURRENTDAY}}| post{{=}},}} no more bears were found</code>
**:gives
**:: "{{As of| {{CURRENTYEAR}}|{{CURRENTMONTH}}| {{CURRENTDAY}}|  post=,}}<sup>&#91;update&#93;</sup> no more bears were found"
**:(comma "," before the superscripted note)
** while
**:: <code>{{tnl|As of| {{CURRENTYEAR}}| {{CURRENTMONTH}}| {{CURRENTDAY}}}}, no more bears were found</code>
**:produces the undesirable result (contrary to [[WP:REFPUNC]]) with regard to the location of the comma:
**:: "{{As of| {{CURRENTYEAR}}| {{CURRENTMONTH}}|{{CURRENTDAY}}}}<sup>&#91;update&#93;</sup>, 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#Article maintenance|Wikipedia:As of]] for displaying links.

===Examples===
<!-- NOTE: DO NOT copy and paste this code to use the template. Copy and paste what it renders for today's date -->
:{{tlc|As of|{{CURRENTYEAR}}}}  – {{As of|{{CURRENTYEAR}}}}
:{{tlc|As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}}}  – {{As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}}}
:{{tlc|As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}|{{CURRENTDAY}}}}  – {{As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}|{{CURRENTDAY}}}}
:{{tlc|As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}|{{CURRENTDAY}}|df{{=}}US}}  –  {{As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}|{{CURRENTDAY}}|df=US}}
:{{tlc|As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}|{{CURRENTDAY}}|lc{{=}}y}}  –  {{As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}|{{CURRENTDAY}}|lc=y}}
<!-- As this next example is referring to the census date, doesn't make sense to use current date -->
:{{tlc|As of|2010|4|1|alt{{=}}as of the <nowiki>[[2010 United States Census]]</nowiki>}} – {{As of|2010|4|1|alt=as of the [[2010 United States Census]]}}
:{{tlc|As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}|url{{=}}<nowiki>http://en.wikipedia.org/</nowiki>}} returns:
:: ''for logged in users, with links displayed (see [[Wikipedia:As of#Article maintenance|Wikipedia:As of]])'' – As of {{MONTHNAME|{{CURRENTMONTH}}}}{{space}}{{CURRENTYEAR}}<sup class="plainlinks">[http://en.wikipedia.org/ &#91;ref&#93;]</sup>
:: ''for all other users'' – As of {{MONTHNAME|{{CURRENTMONTH}}}}{{space}}{{CURRENTYEAR}}
:{{tlc|As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}|{{CURRENTDAY}}|df{{=}}US|since{{=}}y}}  –  {{As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}|{{CURRENTDAY}}|df=US|since=y}}
:{{tlc|As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}|{{CURRENTDAY}}|lc{{=}}y|since{{=}}y}}  –  {{As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}|{{CURRENTDAY}}|lc=y|since=y}}

===TemplateData===
{{TemplateDataHeader}}
<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 {{update after}} 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==
*{{tl|Category as of}}
*{{tl|Show by date}}/{{tls|Show by}}
*{{tl|Start date and age}}
*{{tl|Update}}
*{{tl|Update after}}
*{{tl|When}}
*[[Wikipedia:As of]]
*[[Wikipedia:Avoid statements that will date quickly]]
*[[:Category:All articles containing potentially dated statements]]

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
| <!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Inline templates]]
[[Category:Temporal templates]]
[[Category:Time and date maintenance templates]]
}}</includeonly>