Difference between revisions of "Template:As of/doc"

Latest revision as of 12:34, 31 December 2021

This is a documentation subpage for Template:As of.
It contains usage information, categories and other content that is not part of the original template page.

File:Ambox warning yellow.svg

This template is used on approximately 71,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

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 date of the most recent 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 {{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.

Usage guidelines

Using this template with values such as {{As of|now}} or variables such as {{As of|{{CURRENTYEAR}}}} is a relative time reference and the equivalent to using "currently", which is generally against the precise language guideline.

Syntax

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

{{As of|year}}

{{As of|year|month}}

{{As of|year|month|day}}

Leading zeroes are optional.

Please do not use {{As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}}} 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 (yyyy)

Optional

month (second parameter) – full, abbreviated, or two-digit numerical formats supported (01 indicating January, 02 February, etc., but also accepting Jan and January)
day (third parameter) – numerical two- or one-digit format only (dd or 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 |df and |lc and |since parameters are ignored.
df – "date format", optional; allows use of American date format with |df=US. This only has an effect when the full |year|month|day format is also used.
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: {{as of|1997|pre=the first week of}} produces "As of the first week of 1997^[update]".
post – text (almost always punctuation) to insert between the date and the superscripted note that is displayed if the user has ".asof-tag { display: inline !important; }," ".asof-tag.ref { display: inline !important; }" or ".asof-tag.ref { display: inline !important; }" added to their common.css page .
For these users,
{{As of|2024|11|22|post=,}} no more bears were found

gives
"As of 22 November 2024,[update] no more bears were found"

(comma before the superscripted note)

while
{{As of|2024|11|22}}, no more bears were found

produces the undesirable result (contrary to WP:REFPUNC) with regard to the location of the comma:
"As of 22 November 2024[update], no more bears were found"

Note: the ^[update] tag is a tag that shows when url is not specified and the user has ".asof-tag { display: inline !important; }" or ".asof-tag.update { display: inline !important; }" 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 ".asof-tag { display: inline !important; }" or ".asof-tag.ref { display: inline !important; }" added to their common.css page. It will show as a hyperlinked ^[ref] tag after the template. See Wikipedia:As of#Article maintenance.

Examples

{{As of|2024}} – As of 2024

{{As of|2024|11}} – As of November 2024

{{As of|2024|11|22}} – As of 22 November 2024

{{As of|2024|11|22|df=US}} – As of November 22, 2024

{{As of|2024|11|22|lc=y}} – as of 22 November 2024

{{As of|2010|4|1|alt=as of the [[2010 United States Census]]}} – as of the 2010 United States Census

{{As of|2024|11|url=https://en.wikipedia.org/}} returns:

for logged in users, with links displayed (see Wikipedia:As of) – As of November 2024^[ref]

for all other users – As of November 2024

{{As of|2024|11|22|df=US|since=y}} – Since November 22, 2024

{{As of|2024|11|22|lc=y|since=y}} – since 22 November 2024

Maintenance categories

Category:Pages using as of template with unknown parameters (0)

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for As of

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).

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Year	`1`	The year the statement is valid to (in full; yyyy) Example 2013	Number	required
Month	`2`	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. Example January, january, Jan, jan, 01, 1	Line	suggested
Day	`3`	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. Example 22	Number	optional
Date format	`df`	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. Example US, us Auto value `US`	Line	optional
Lowercase	`lc`	Enter any text here to make the first letter of the template lowercase. Example y Auto value `y`	Line	suggested
Alternative text	`alt`	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. Example As of Christmas 2018	Content	optional
Since	`since`	Enter any text here to replace the text "As of" with "Since". Example y Auto value `y`	Line	optional
URL	`url`	(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.	URL	optional
Pre-text	`pre`	Text to be added before the date Example the first week of	String	optional
Post-text	`post`	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 .	Line	optional