Template:As of/doc

Not to be confused with Template:As of?.

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 outdated 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

Main page: OODA WIKI:As of

{{#section-h:OODA WIKI:As of|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".
• 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. |pre=the first week of used like this: {{as of|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 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
  (see OODA WIKI:As of § Article maintenance)
  .
  • For these users,

    Template:Tnl no more bears were found

    gives

    "As of 19 September 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 19 September 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 OODA WIKI:As of#Article maintenance.

Examples

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

{{As of|2024|09}} – As of September 2024

{{As of|2024|09|19}} – As of 19 September 2024

{{As of|2024|09|19|df=US}} – As of September 19, 2024

{{As of|2024|09|19|lc=y}} – as of 19 September 2024

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

{{As of|2024|09|url=https://en.OODA WIKI.org/}} returns:

for logged in users, with links displayed (see OODA WIKI:As of) – As of September 2024^{WIKI.org/ [ref]}

for all other users – As of September 2024

{{As of|2024|09|19|df=US|since=y}} – Since September 19, 2024

{{As of|2024|09|19|lc=y|since=y}} – since 19 September 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 in articles 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	Boolean	optional
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	Boolean	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
Bare?	bare	Set to yes to display only the date with no accompanying text.	Boolean	suggested

See also

• {{As of?}}
• {{Category as of}}
• {{date}}
• {{Present-day}}
• {{Show by date}} /

This template, often abbreviated as {{}}, is used to provide stylized formatting to template displays without actually using the template itself. The code generated will be displayed inline. For a multi-line output, see {{tj}}.

Parameters

With the exception of alttext, the named parameters are toggles that are either omitted (default in most cases) or activated (by being assigned a value such as "on", "yes", "true", "include", etc.). They may be included in any order (see Examples below). Certain templates have the parameter "on" by default; see the main table for all alternate options.

Parameter	Action	Use with {{example}}	Default active
	Default (without accessory parameters)	{{example}}
brace	Include braces as part of the template link	{{example}}	{{tlw}}/{{tn}}
braceinside	Include innermost braces as part of the template link	{{example}}
bold	Renders the template link/name in bold	{{example}}	{{tlb}}, {{tlxb}}
code	Display output using HTML ‎<code>...‎</code> tags (monospaced font)	{{example}}	{{tlc}}, {{Template link expanded}}, etc.
italic	Display any parameters accompanying the template link/name in italics	{{example|param}}	{{tlxi}}
kbd	Display output using HTML ‎<kbd>...‎</kbd> tags (monospaced font)	{{example}}
nolink	Don't render the template name as a link	{{example}}	{{tlf}}, {{tnull}}
nowrap	Prevent the insertion of line breaks (word wrap) in the output	{{example}}
nowrapname	Prevent word wrapping in the output of template name/link (parameters will wrap if needed)	{{example}}
plaincode	Uses ‎<code style="border:none; background:transparent;">...‎</code>	{{example}}	{{tltss}}
subst	Include a subst: prefix before the template link/name	{{subst:example}}	{{tls}}, {{tlxs}}, etc
alttext=[text]	Replace [text] with the actual label to be displayed for the template link	{{Other}}	{{tla}}
_show_result	Will also display the result of the template	{{Min|7|-5}} → -5
_expand	Will add a link to the expanded template page	{{Min|7|-5}} [1]

Unnamed (Positional)

This template can take any number of unnamed parameters as parameters accompanying the template link (or name); see Examples below.

Examples

Code	Output	Remarks
{{Show by|Banner}}	Template:Show by	Template:Banner does not exist. (Non-existent template is redlinked.)
{{Show by|Abc}}	Template:Show by	Template:Abc exists.
{{Show by|abC}}	Template:Show by	Template names are case-sensitive
{{Show by|abc}}	Template:Show by	(but the first letter is case-insensitive).
{{Show by|x0}}	Template:Show by	no parameters
{{Show by|x1|one}}	Template:Show by	one parameter
{{Show by|x2|one|two}}	Template:Show by	two parameters
{{Show by|x3|1|2|3|4|5|6|7|8|9|10}}	Template:Show by	ten parameters
{{tlg|convert|<nowiki>14|m|ftin|abbr=out|sp=us</nowiki>}}	Template:Show by	Unlimited parameters, as one ‎<nowiki>...‎</nowiki> string.
{{Show by|x2||two||}}	Template:Show by	Empty parameters are discarded.
{{Show by|x0|code=on}}	Template:Show by	<code> style
{{Show by|x0|plaincode=on}}	Template:Show by	plaincode style
{{Show by|x0|kbd=on}}	Template:Show by	<kbd> style
{{Show by|x0|bold=on}}	Template:Show by	bold link/name
{{Show by|x1|one|italic=on}}	Template:Show by	parameter(s) in italics
{{Show by|x0|nolink=on}}	Template:Show by
{{Show by|x0|subst=on}}	Template:Show by
{{Show by|x0|brace=on}}	Template:Show by	all braces in link
{{Show by|x0|braceinside=on}}	Template:Show by	inside braces in link
{{Show by|x0|alttext=x0 link}}	Template:Show by
{{Show by|x0|bold=on|code=on|brace=on}}	Template:Show by	Combine multiple parameter settings.
{{tlg|x1|{{spaces}}one{{spaces}}}}	Template:Show by	Using {{spaces}} before and after a parameter.
{{Show by|x2|bold=on|code=on|one|two}}	Template:Show by	Can combine named and anonymous parameters ...
{{Show by|x2|one|two|bold=on|code=on}}	Template:Show by	... in any order ...
{{Show by|x2|one|code=on|two|bold=on|three}}	Template:Show by	... even intermixed ...
{{Show by|x2|one|code=on|two|bold=on|three|italic=on}}	Template:Show by	... with many configurations.
{{tlg|x1|x=u}}	Template:Show by	= won't work
{{tlg|x1|x&#61;u}}	Template:Show by	&#61; is okay
{{tlg|x1|x{{=}}u}}	Template:Show by	{{=}} is okay (see Template:=)
{{tlg|x1|x<nowiki>=</nowiki>u}}	Template:Show by	Sticky nowiki is okay.
{{Show by|x2|3=two|2=one}}	Template:Show by	Right-to-left is okay
{{Show by}}	Show by	With no arguments, it emits the current page name without braces.
{{Show by|x2|3=one|4=two}}	Template:Show by	Null parameter stops parsing.

Wrapping of long names (default)

Code	Output
{{Show by|long template name that would wrap to new line|this is a long value for the 1st parameter that would wrap}}	Template:Show by

Wrapping of long names (nowrap=on)

Code	Output
{{Show by|nowrap=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}}	Template:Show by

Wrapping of long names (nowrapname=on)

Code	Output
{{Show by|nowrapname=on|long template name that would wrap to new line|long value for the 1st parameter that would wrap}}	Template:Show by

See also

General-purpose formatting

Comparison of template-linking templates according to the styles of generated text and link produced

Text style ↓	{{tlg}} options to achieve text style	Link style
		Linked	Unlinked	Linked with subst	Unlinked with subst	Linked including braces	Linked with alternative text
{{tlg}} options to achieve link style	—	DEFAULT	nolink=yes	subst=yes	nolink=yes|subst=yes	braceinside=yes	alttext=Foo 2=Foo
normal	DEFAULT	{{tlg}} {{tl}} {{tlp|1|2|...}} {{Template:tlu}}	{{tlf}} <template link>	{{subst:Template:tlsu}}	{{subst:tlsf}} <template link>	{{tn}}	{{tla}}
code	code=yes	{{tl2}} {{tlx}} {{Template:tlxu}}	{{tlc}} <template link> {{tnull}}<template link>	{{subst:tlxs}}	{{subst:tlsc}} <template link>	—
monospace	plaincode=yes	—		{{subst:tltss}}	—
kbd	kbd=yes
bold	bold=yes	{{tlb}}	—
bold+code	bold=yes|code=yes	{{tlxb}}
italic+code	italic=yes|code=yes	{{tlxi}}

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters

Code example	Effect	Notes
{{Tj|Hatnote|Some text|selfref: yes|category: no|lang: fr}}	{{Hatnote | Some text | selfref = yes | category = no | lang = fr }}	Supports colors, placeholder texts, named and unnamed parameters
<syntaxhighlight lang="wikitext"> {{Hatnote | Some text | selfref = yes | category = no | lang = fr }} </syntaxhighlight>	{{Hatnote | Some text | selfref = yes | category = no | lang = fr }}	Same as above
{{Tji|Hatnote|Some text|selfref: yes|category: no|lang: fr}}	{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}	Supports colors, placeholder texts, named and unnamed parameters
<syntaxhighlight lang="wikitext" inline>{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}</syntaxhighlight>	{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}	Same as above
{{tl2|Hatnote|lang=fr}}	{{hatnote}}	Supports linking to sister projects (e.g., fr:Hatnote)
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}	{{hatnote|lang=fr|Some text}} Some text	Shows code and example
{{tln|Hatnote}}	Template:Hatnote	Produces a normal link to the template
{{elc|Template:Hatnote}} {{elc|Template:Hatnote|Hatnote}}	[[Template:Hatnote]] [[Template:Hatnote|Hatnote]]	Formats wikilink, with optional piped link text and blended suffix
{{ml|Example|hello}}	{{#invoke:Example|hello}}	Counterpart to {{tl}} for linking to Lua modules
{{mfl|Example|hello}}	{{#invoke:Example|hello}}	Similar to {{ml}}, but expects the function to be documented and creates a link to the corresponding section
{{mlx|Example|hello}}	{{#invoke:Example|hello}}	Counterpart to {{tlx}} for linking to Lua modules
{{ml-lua|Module:Example|hello}}	require('Module:Example')	Link to Lua modules and built-in libraries, showing Lua code.
{{para|title|<var>book title</var>}}	|title=book title	Formats template parameters for display, with or without values
{{sclx|LASTING}}	[[WP:LASTING]]	Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a ‎<code>...‎</code> tag.
{{tag|ref}} {{xtag|templatedata}}	‎<ref>...‎</ref> <templatedata>	Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
{{dtl|Ping project}}	{{d:Ping project}}	Wikidata counterpart to {{tl}}
{{pf|if}} {{pf|if|{{{1}}}|true|false}}	{{#if}} {{#if:{{{1}}}|true|false}}	Parser function equivalent to {{tl}}
{{magic word|uc:}}	{{uc:}}	Magic word links

With utility links

Templates producing utility links for a given template (Hatnote used here as example)

Code example	Effect
{{lt|Hatnote}}	[[Template:]]
{{lts|Hatnote}}	Template:Hatnote(edit talk links history)
{{t links|Hatnote}}	{{Hatnote}} (edit talk history links # /subpages /doc /doc edit /sbox /sbox diff /test)
{{tfd links|Hatnote}}	Template:Hatnote (talk · history · transclusions · logs · subpages)
{{tetl|Hatnote}}	{{Hatnote}} links talk edit
{{tsetl|Hatnote}}	{{subst:Hatnote}}  links talk edit
{{ti|Hatnote}}	{{Hatnote}}
{{tic|Hatnote}}	Template:Hatnote (talk links edit)
{{tim|Hatnote}}	m:Template:Hatnote (backlinks edit)
{{tiw|Hatnote}}	Template:Hatnote (backlinks edit)
{{tlt|Hatnote}}	{{Hatnote}} (talk)
{{ttl|Hatnote}}	{{Hatnote}} (t/l)
{{twlh|Hatnote}}	Template:Hatnote (links, talk)

• {{Start date and age}}
• {{Update}}
• {{Update after}}
• {{Update inline}}
• {{Updated}} Like {{As of}}, with reference as additional parameter
• {{When}}
• OODA WIKI:As of for details of dealing with statements that date quickly
• OODA WIKI: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 {{as of}} template