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

From Wazeopedia
Line 1: Line 1:
#REDIRECT [[Private_message_(forum)]]
+
{{Documentation subpage}}
 +
<!--{{Distinguish|Template:As of?}}-->
 +
<!-- 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 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). {{tl|as of}} does not require the editor to give a full date. This template should '''not''' be [[Wikipedia:Substitution|substituted]].
 +
 
 +
'''Note: This template MUST NOT be used in infoboxes which emit a microformat, as its emitted date markup will conflict with that.'''
 +
 
 +
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>
 +
:<code><nowiki>{{As of|month-name day, year}}</nowiki></code>
 +
:<code><nowiki>{{As of|month-name year}}</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>{&#123;As of{{!}}2010&#125;}</tt> – {{As of|2010}}
 +
:<tt>{&#123;As of{{!}}2010{{!}}7&#125;}</tt> – {{As of|2010|7}}
 +
:<tt>{&#123;As of{{!}}2010{{!}}7{{!}}5&#125;}</tt> – {{As of|2010|7|5}}
 +
 
 +
:<tt>{&#123;As of{{!}}2010{{!}}4{{!}}1{{!}}alt=as of the <nowiki>[[2010 United States Census]]</nowiki>&#125;}</tt> – {{As of|2010|4|1|alt=as of the [[2010 United States Census]]}}
 +
:<tt>{&#123;As of{{!}}2010{{!}}7{{!}}5{{!}}df=US&#125;}</tt> – {{As of|2010|7|5|df=US}}
 +
:<tt>{&#123;As of{{!}}2010{{!}}7{{!}}5{{!}}lc=y&#125;}</tt> – {{As of|2010|7|5|lc=}}
 +
 
 +
:<tt>{&#123;As of{{!}}July 2010&#125;}</tt> – {{As of|July 2010}}
 +
:<tt>{&#123;As of{{!}}July 4, 2010{{!}}df=US&#125;}</tt> – {{As of|July 4, 2010|df=US}}
 +
 
 +
<!--
 +
=== TemplateData ===
 +
Template data moved to [[Template:As of/doc/TemplateData]]
 +
-->
 +
==See also==
 +
*[[:Category:All articles containing potentially dated statements]]
 +
 
 +
<includeonly>
 +
<!-- ADD CATEGORIES BELOW THIS LINE -->
 +
[[Category:Inline templates]]
 +
[[Category:Temporal templates]]
 +
[[Category:Time and date maintenance templates]]
 +
[[Category:Incomplete templates]]
 +
</includeonly>

Revision as of 12:15, 31 March 2015

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.

Usage

The template {{as of}} is used to mark potentially dated statements, and will add an article to the appropriate 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). {{as of}} does not require the editor to give a full date. This template should not be substituted.

Note: This template MUST NOT be used in infoboxes which emit a microformat, as its emitted date markup will conflict with that.

This template does not generate a visible hyperlink in text where it is used.

Syntax

The template can be used in the following forms:

{{As of|year}}
{{As of|year|month}}
{{As of|year|month|day}}
{{As of|month-name day, year}}
{{As of|month-name year}}

Please do not use {{As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}}} 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 for displaying links.

Examples

{{As of|2010}} – As of 2010
{{As of|2010|7}} – As of July 2010
{{As of|2010|7|5}} – As of 5 July 2010 (2010-07-05)
{{As of|2010|4|1|alt=as of the [[2010 United States Census]]}} – as of the 2010 United States Census
{{As of|2010|7|5|df=US}} – As of July 5, 2010 (2010-07-05)
{{As of|2010|7|5|lc=y}} – as of 5 July 2010 (2010-07-05)
{{As of|July 2010}} – As of July 2010
{{As of|July 4, 2010|df=US}} – As of July 4, 2010

See also