View source for Template:As of/doc

{{distinguish|text=[[Template:As of?]]}}
{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
<!--{{high-use| 60702 }}-->

==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 outdated over time. The date used for a given statement should be the date of the most recent {{Wikipedia|WP:RS|reliable source}} (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|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.

===Usage guidelines===
{{main|Wikipedia:As of}}
{{#section-h:Wikipedia:As of|Usage guidelines}}

Using this template with values such as {{tlx|As of|now}} or variables such as {{tlx|As of|<nowiki>{{CURRENTYEAR}}</nowiki>}} is a {{Wikipedia|MOS:RELTIME|relative time reference}} and the equivalent to using "currently", which is generally against the {{Wikipedia|Wikipedia:As of#Precise language|precise language}} guideline.

==Syntax==
The template can be used in the following forms, with numeric date information:

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

Leading zeroes are optional.

Please do not use <!--Except in examples, as here!--> <code><nowiki>{{As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}}}</nowiki></code> or similar; that defeats the purpose of the template.

Several additional named parameters can also be used, including some non-numeric input (see below).

===Parameters===
====Required====
* '''year''' (first parameter) – must be in full numerical four-digit format ({{var|yyyy}})

====Optional====
* '''month''' (second parameter) – full, abbreviated, or two-digit numerical formats supported (<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- or one-digit format only ({{var|dd}} or {{var|d}})

====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}}.  This only has an effect when the full <code>{{!}}{{var|year}}{{!}}{{var|month}}{{!}}{{var|day}}</code> format is also used.
* '''lc''' – "lower case", optional; if given any value at all (e.g. {{para|lc|y}}) gives lower case "as of {{var|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 {{var|date}}. Use of {{para|alt}} will replace the entire output, including the "Since", as it will with the default "As of".
* '''bare''' – Set to yes to display only the date with no accompanying text.
* '''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>{{as of|1997|pre=the first week of}}</nowiki></code> produces "{{as of|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 the user has "<code>.asof-tag { display: inline !important; }</code>," "<code>.asof-tag.ref { display: inline !important; }</code>" or "<code>.asof-tag.ref { display: inline !important; }</code>" added to their {{Wikipedia|Wikipedia:Common.js and common.css|common.css}} page {{crossref|(see {{section link|Wikipedia:As of#Article maintenance}})}}.
**  For these users,
**:: <code>{{tnl|As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}|{{CURRENTDAY}}|post{{=}},}} no more bears were found</code>
**: gives
**:: <!--This example is hand-constructed on purpose!-->"As of {{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}},<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 {{Wikipedia|WP:REFPUNC}}) with regard to the location of the comma:
**:: <!--This example is hand-constructed on purpose!-->"As of {{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}}<sup>&#91;update&#93;</sup>, no more bears were found"
:Note: the <sup>&#91;update&#93;</sup> tag is a tag that shows when '''url''' is not specified and the user has "<code><nowiki>.asof-tag { display: inline !important; }</nowiki></code>" or "<code><nowiki>.asof-tag.update { display: inline !important; }</nowiki></code>" added to their common.css page. It contains a link to edit the page.
* '''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. 
::Note: This will only show if the user has "<code><nowiki>.asof-tag { display: inline !important; }</nowiki></code>" or "<code><nowiki>.asof-tag.ref { display: inline !important; }</nowiki></code>" added to their common.css page. It will show as a hyperlinked <sup>&#91;ref&#93;</sup> tag after the template. See {{Wikipedia|Wikipedia:As of#Article maintenance}}.

===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 &#91;&#91;2010 United States Census&#93;&#93;}} – {{As of|2010|4|1|alt=as of the [[2010 United States Census]]}}
:{{tlc|As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}|url{{=}}<nowiki>https://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">[https://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}}

===Maintenance categories===
* {{clc|Pages using as of template with unknown parameters}}

===TemplateData===
{{TemplateDataHeader}}
<!--<templatedata>-->
<syntaxhighlight lang="JSON">
{
	"description": "Use this template to mark potentially dated statements. It will add the article to a corresponding monthly or yearly hidden subcategory 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 statements mentioning future dates (use {{Update after}} instead).",
	"format": "inline",
	"params": {
		"1": {
			"label": "Year",
			"description": "The year the statement is valid to (in full; yyyy)",
			"type": "number",
			"example": "2013",
			"required": true
		},
		"2": {
			"label": "Month",
			"description": "The month the statement is valid to. Full (January, january), abbreviated (Jan, jan) or numerical formats (01, 1) are supported. \"01\" provides the most consistency in wikitext, but all will be converted to \"January\" in articles and for categories.",
			"type": "line",
			"example": "January, january, Jan, jan, 01, 1",
			"suggested": true
		},
		"3": {
			"label": "Day",
			"description": "The day the statement is valid to, in numerical format (01 or 1; both will be converted to 1). This will show to users, but it will not be used to categorise the article.",
			"type": "number",
			"example": "22"
		},
		"df": {
			"label": "Date format",
			"description": "If a day has been specified, enter \"US\" or \"us\" here to use the US date format (January 1, 2013). The default format is 1 January 2013.",
			"type": "line",
			"example": "US, us",
			"autovalue": "US"
		},
		"lc": {
			"label": "Lowercase",
			"description": "Enter any text here to make the first letter of the template lowercase.",
			"type": "line",
			"example": "y",
			"autovalue": "y"
		},
		"alt": {
			"label": "Alternative text",
			"description": "Text to replace the \"As of [date]\". This will override the display of the template, but the values under month and year will still be used to categorise the article. Wiki markup is allowed.",
			"type": "content",
			"example": "As of Christmas 2018"
		},
		"since": {
			"label": "Since",
			"description": "Enter any text here to replace the text \"As of\" with \"Since\".",
			"type": "line",
			"example": "y",
			"autovalue": "y"
		},
		"url": {
			"label": "URL",
			"description": "(Hidden by default) A URL containing future updates to the statement for other editors to check. This will only show if the user has \".asof-tag { display: inline !important; }\" or \".asof-tag.ref { display: inline !important; }\" added to their common.css page. It will show as a hyperlinked superscript \"[ref]\" tag after the template. Enter the full URL with no spaces.",
			"type": "url"
		},
		"pre": {
			"label": "Pre-text",
			"description": "Text to be added before the date",
			"example": "the first week of",
			"type": "string"
		},
		"post": {
			"label": "Post-text",
			"description": "Text to be added after the date, usually punctuation. Only necessary if the user wishes to ensure the punctuation/text is positioned before the superscript tags that are enabled by adding \".asof-tag.ref { display: inline !important; }\" to the commons.css page.",
			"example": ".",
			"type": "line"
		},
		"bare": {
			"label": "Bare?",
			"description": "Set to yes to display only the date with no accompanying text.",
			"type": "boolean",
			"suggested": true
		}
	},
	"paramOrder": [
		"1",
		"2",
		"3",
		"df",
		"lc",
		"alt",
		"since",
		"url",
		"pre",
		"post",
		"bare"
	]
}
<!--</templatedata>-->
</syntaxhighlight>

==See also==
* {{tl|Category as of}}
* {{tl|date}}
* {{tl|Show by date}} / {{tls|Show by}}
* {{tl|Start date and age}}
* {{tl|Update}}
* {{tl|Update after}}
* {{tl|Update inline}}
* {{tl|When}}
* [[Wikipedia:As of]] for details of dealing with statements that date quickly
* [[Wikipedia:Avoid statements that will date quickly]] for guidelines on using precise language when dealing with information that may date quickly
* [[:Category:Articles containing potentially dated statements]] and the accompanying {{tl|as of}} template


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