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

From Wazeopedia
(→‎Syntax: Added other allowed syntax)
m (5 revisions imported)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
{{Distinguish|Template:As of?}}
+
<!--{{Distinguish|Template:As of?}}-->
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
  
 
==Usage==
 
==Usage==
The template {{tl|as of}} is used to mark potentially dated statements, and will add an article to the appropriate [[WP:HIDDENCAT|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 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:Substitution|substituted]].
+
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.'''
 
'''Note: This template MUST NOT be used in infoboxes which emit a microformat, as its emitted date markup will conflict with that.'''
Line 49: Line 49:
 
:<tt>{&#123;As of{{!}}July 4, 2010{{!}}df=US&#125;}</tt> – {{As of|July 4, 2010|df=US}}
 
:<tt>{&#123;As of{{!}}July 4, 2010{{!}}df=US&#125;}</tt> – {{As of|July 4, 2010|df=US}}
  
:<tt>{&#123;As of{{!}}2010{{!}}7{{!}}url=<nowiki>http://en.wikipedia.org/</nowiki>&#125;}</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>
+
=== TemplateData ===
:: ''for all other users'' – As of July&nbsp;2010
+
Template data moved to [[Template:As of/doc/TemplateData]]
 
+
-->
===TemplateData===
 
{{TemplateDataHeader}}
 
<templatedata>{
 
"description": "A template 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.",
 
"params": {
 
  "1": {
 
    "label": "Year",
 
    "description": "The year the statement is valid to. Must be in full numerical format (yyyy)",
 
    "type": "number",
 
    "required": true
 
  },
 
  "2": {
 
    "label": "Month",
 
    "description": "The month the statement is valid to. Full, abbreviated or numerical formats supported (mm recommended)",
 
    "type" : "string/line",
 
    "required": false
 
  },
 
  "3": {
 
    "label": "Day",
 
    "description": "The day the statement is valid to (not included in link). Numerical format only (dd)",
 
    "type": "number",
 
    "required": false
 
  },
 
  "alt": {
 
    "label": "Alternate wording",
 
    "description": "Use different wording for the visible text output; if set, values for 'Date format' (df) and 'Lower case' (lc) parameters are ignored",
 
    "type": "string/line",
 
    "required": false
 
  },
 
  "df": {
 
    "label": "Date format",
 
    "description": "Set to US to use U.S. date format (mdy) (default is dmy)",
 
    "type": "string/line",
 
    "default": "US",
 
    "required": false
 
  },
 
  "lc": {
 
    "label": "Lower case",
 
    "description": "Specify y to use lower case",
 
    "type": "string/line",
 
    "required":false
 
  },
 
  "url": {
 
    "label": "URL",
 
    "description": "A URL for 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",
 
    "type": "string/line",
 
    "required": false
 
  }
 
}}
 
</templatedata>
 
 
 
 
==See also==
 
==See also==
*{{tl|Category as of}}
 
*{{tl|Show by date}}
 
*{{tl|Start date and age}}
 
*{{tl|Update}}
 
*{{tl|Update after}}
 
*{{tl|When}}
 
 
*[[:Category:All articles containing potentially dated statements]]
 
*[[:Category:All articles containing potentially dated statements]]
  

Latest revision as of 10:56, 30 November 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