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

From SVR Wiki
Jump to: navigation, search
(Examples: removed active templates)
(formatting and reference)
Line 5: Line 5:
 
==Usage==
 
==Usage==
  
The template {{[[Template:As of|As of]]}} is used to link a section of text to an appropriate "As of..." page without creating a visible link on the page itself. This allows editors to catalogue statements that may become dated over time. It also includes the [[ISO 8601]] format needed by [[hAtom]] (<code>class="updated"</code>) and [[HCalendar|hCalendar]] (<code>class="dtstart"</code>) [[microformat]]s through use of the {{[[Template:Start date|Start date]]}} template. Unlike the {{[[Template:Update after|Update after]]}} template, <nowiki>{{As of}}</nowiki> does not require the editor to give a full date. This template should '''not''' be subst'd.
+
The template {{tlx|As of}} is used to link a section of text to an appropriate "As of..." page without creating a visible link on the page itself. This allows editors to catalogue statements that may become dated over time. It also includes the [[ISO 8601]] format needed by [[hAtom]] (<code>class="updated"</code>) and [[HCalendar|hCalendar]] (<code>class="dtstart"</code>) [[microformat]]s through use of the {{tlx|Start date}} template. Unlike the {{tlx|Update after}} template, <nowiki>{{As of}}</nowiki> does not require the editor to give a full date. This template should '''not''' be subst'd.
  
 
==Syntax==
 
==Syntax==
  
:<nowiki>{{ As of | year | month | day }}</nowiki>
+
:<tt>{&#123;As of{{!}}year{{!}}month{{!}}day&#125;}</tt>
:<nowiki>{{ As of | month_name year }}</nowiki> (''deprecated'')
+
:<tt>{&#123;As of{{!}}month_name year&#125;}</tt> (''deprecated'')
  
 
===Parameters===
 
===Parameters===
Line 28: Line 28:
 
===Examples===
 
===Examples===
  
:<nowiki>{{As of | 2008}}</nowiki> returns "''As of {{Start date|2008|df=yes}}''"
+
:<tt>{&#123;As of{{!}}2008&#125;}</tt> returns "''As of {{Start date|2008|df=yes}}''"
 +
:<tt>{&#123;As of{{!}}2008{{!}}7&#125;}</tt> returns "''As of {{Start date|2008|7|df=yes}}''"
 +
:<tt>{&#123;As of{{!}}2008{{!}}7{{!}}5&#125;}</tt> returns "''As of {{Start date|2008|7|5|df=yes}}''"
  
:<nowiki>{{As of | 2008 | 7}}</nowiki> returns "''As of {{Start date|2008|7|df=yes}}''"
+
:<tt>{&#123;As of{{!}}2008{{!}}4{{!}}1{{!}}alt=as of the [[2000 United States Census]]&#125;}</tt> returns "''as of the [[2000 United States Census]]''"
 +
:<tt>{&#123;As of{{!}}2008{{!}}7{{!}}5{{!}}df=US&#125;}</tt> returns "''As of {{Start date|2008|7|5}}''"
  
:<nowiki>{{As of | 2008 | 7 | 5}}</nowiki> returns "''As of {{Start date|2008|7|5|df=yes}}''"
+
:<tt>{&#123;As of{{!}}April 2006&#125;}</tt> returns "''As of {{Start date|April 2006}}''"
 
 
:<nowiki>{{As of | 2000 | 4 | 1 | alt=as of the [[2000 United States Census]]}}</nowiki> returns "''as of the [[2000 United States Census]]''"
 
 
 
:<nowiki>{{As of | 2008 | 7 | 5 | df=US}}</nowiki> returns "''As of {{Start date|2008|7|5}}''"
 
 
 
:<nowiki>{{As of | April 2006}}</nowiki> returns "''As of {{Start date|April 2006}}''"
 
  
 
==See also==
 
==See also==
Line 44: Line 41:
 
*[[Wikipedia:As of]]
 
*[[Wikipedia:As of]]
 
*[[Wikipedia:Avoid statements that will date quickly]]
 
*[[Wikipedia:Avoid statements that will date quickly]]
 +
*[[:Category:Articles containing potentially dated statements]]
 +
*[[Template:Cat ASOF]]
 
*[[Template:Update after]]
 
*[[Template:Update after]]
  

Revision as of 01:19, 20 July 2008

Template:Template doc page viewed directly

Usage

The template {{As of}} is used to link a section of text to an appropriate "As of..." page without creating a visible link on the page itself. This allows editors to catalogue statements that may become dated over time. It also includes the ISO 8601 format needed by hAtom (class="updated") and hCalendar (class="dtstart") microformats through use of the {{Start date}} template. Unlike the {{Update after}} template, {{As of}} does not require the editor to give a full date. This template should not be subst'd.

Syntax

{{As of|year|month|day}}
{{As of|month_name year}} (deprecated)

Parameters

Required

  • year (first parameter) – required; must be in full numerical format (yyyy)
    month_name year (first parameter, deprecated) – required; month_name must be capitalised full name, and year must be in full numerical format (e.g. "April 2006")

Optional

  • month (second parameter) – optional; full, abbreviated or numerical (recommended) formats supported
  • day (third parameter) – optional; numerical format only, not included in link

Named optional

  • alt (named parameter) – optional; allows substitution of visible text output (defaults to "As of [date]") for different wording or use of lower case
  • df (named parameter) – optional; allows use of American date format with value US, only visible to users who have not set their date preferences yet

Examples

{{As of|2008}} returns "As of 2008 (2008)"
{{As of|2008|7}} returns "As of July 2008 (2008-07)"
{{As of|2008|7|5}} returns "As of 5 July 2008 (2008-07-05)"
{{As of|2008|4|1|alt=as of the 2000 United States Census}} returns "as of the 2000 United States Census"
{{As of|2008|7|5|df=US}} returns "As of July 5, 2008 (2008-07-05)"
{{As of|April 2006}} returns "As of April 2006 (April 2006)"

See also