View source for Template:As of/doc

{{tl|as of}} is used to mark potentially dated statements, and will add an article to the appropriate [[Template:hidecat|hidden]] sub-category of [[:Category:All 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 also includes the [[WP:ISO 8601|ISO 8601]] format needed by [[hAtom]] (<code>class="updated"</code>) and [[hCalendar]] (<code>class="dtstart"</code>) [[microformat]]s through use of the {{tl|start date}} template. Unlike the {{tl|update after}} template, {{tl|as of}} does not require the editor to give a full date. This template should '''not''' be [[wikipedia:Wikipedia:Substitution|substituted]].

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 format (''yyyy'')

'''Optional'''
* '''month''' (second parameter) – full, abbreviated or numerical formats supported (''mm'' recommended)
* '''day''' (third parameter) – numerical format only, not included in link (''dd'')

'''Named'''
* '''alt''' – optional; allows substitution of different wording and case for the visible text output; if present but no value defined, this parameter is ignored; if a value is defined, values for ''df'' and ''lc'' parameters are ignored
* '''df''' – optional; allows use of American date format with ''df=US''
* '''lc''' – optional; gives lower case "as of ''date''" when defined; recommended syntax is ''lc=y''
* '''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 ===
:<tt>{{As of{{!}}2010}}</tt> — {{As of|2010}}
:<tt>{{As of{{!}}2010{{!}}7}}</tt> — {{As of|2010|7}}
:<tt>{{As of{{!}}2010{{!}}7{{!}}5}}</tt> — {{As of|2010|7|5}}

:<tt>{{As of{{!}}2010{{!}}4{{!}}1{{!}}alt=as of the <nowiki>[[series 5 (Doctor Who 2005)|]]</nowiki>}}</tt> — {{As of|2010|4|1|alt=as of [[series 5 (Doctor Who 2005)|series 5]]}}
::Note that statements so marked will still be sorted into [[:category:Articles containing potentially dated statements from 2010]], but the text will actually read whatever you set with <code>alt=</code>.  In this case, it will read "As of series 5", rather than "As of 2010".  
:<tt>{{As of{{!}}2010{{!}}7{{!}}5{{!}}df=US}}</tt> — {{As of|2010|7|5|df=US}}
:<tt>{{As of{{!}}2010{{!}}7{{!}}5{{!}}lc=y}}</tt> — {{As of|2010|7|5|lc=}}
::The <code>lc=y</code> option is important when trying to make sure that the ''a'' in ''as of'' is rendered in lower case.  Do not use the [[magic word]] <code><nowiki>{{lc:}}</nowiki></code> to force a lower case, because it will render the ''category'' in lower case as well.  For instance, <code><nowiki>{{lc:{{as of|2010|1}}</nowiki></code> will result in the category, [[:category:articles containing potentially dated statements from january 2010]].  This is problematic,because the ''j'' in ''january'' needs to be capitalised. 
:<tt>{{As of{{!}}2010{{!}}7{{!}}url=<nowiki>http://en.wikipedia.org/</nowiki>}}</tt> returns:
:: for logged in users, with links displayed (see [[Wikipedia:As of#Article maintenance|Wikipedia:As of]]) — As of July&nbsp;2010<sup class="plainlinks">[http://en.wikipedia.org/ &#91;ref&#93;]</sup>
:: for all other users — As of July&nbsp;2010
<noinclude>[[category:template documentation|{{PAGENAME}}]]</noinclude>