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

From SVR Wiki
Jump to: navigation, search
m (2 revisions imported: Importing As Of template and dependencies)
(preliminary template documentation)
(81 intermediate revisions by 52 users not shown)
Line 1: Line 1:
−
{{Documentation subpage}}
+
<includeonly>{{template doc page transcluded}}</includeonly>
−
{{Distinguish|Template:As of?}}
+
<noinclude>{{template doc page viewed directly}}</noinclude>
 
<!-- 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). 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]].
 
  
−
'''Note: This template MUST NOT be used in infoboxes which emit a microformat, as its emitted date markup will conflict with that.'''
+
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.
−
 
 
−
This template does not generate a visible hyperlink in text where it is used.
 
  
 
==Syntax==
 
==Syntax==
−
The template can be used in the following forms:
 
  
−
:<code><nowiki>{{As of|year}}</nowiki></code>
+
:<nowiki>{{ As of | year | month | day }}</nowiki>
−
:<code><nowiki>{{As of|year|month}}</nowiki></code>
+
:<nowiki>{{ As of | month_name year }}</nowiki> (''deprecated'')
−
:<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.
+
===Parameters===
  
−
Several additional named parameters can also be used (see below).
 
−
 
−
===Parameters===
 
 
'''Required'''
 
'''Required'''
−
*'''year''' (first parameter) – must be in full numerical format (''yyyy'')
+
*'''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'''
 
'''Optional'''
−
*'''month''' (second parameter) – full, abbreviated or numerical formats supported (''mm'' recommended)
+
*'''month''' (second parameter) – optional; full, abbreviated or numerical (recommended) formats supported
−
*'''day''' (third parameter) – numerical format only, not included in link (''dd'')
+
*'''day''' (third parameter) – optional; numerical format only, not included in link
  
−
'''Named'''
+
'''Named optional'''
−
*'''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
+
*'''alt''' (named parameter) – optional; allows substitution of visible text output (defaults to "As of [date]") for different wording or use of lower case
−
*'''df''' – optional; allows use of American date format with ''df=US''
+
*'''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
−
*'''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===
 
===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]]}}
+
:<nowiki>{{As of | 2008}}</nowiki> returns "''{{As of|2008}}''"
−
:<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{{!}}2010{{!}}7{{!}}url=<nowiki>http://en.wikipedia.org/</nowiki>&#125;}</tt> returns:
+
:<nowiki>{{As of | 2008 | 7}}</nowiki> returns "''{{As of|2008|7}}''"
−
:: ''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
 
  
−
===TemplateData===
+
:<nowiki>{{As of | 2008 | 7 | 5}}</nowiki> returns "''{{As of|2008|7|5}}''"
−
{{TemplateDataHeader}}  
+
 
−
<templatedata>{
+
:<nowiki>{{As of | 2008 | 7 | 5 | alt=from [[5 July]] onwards}}</nowiki> returns "''{{As of|2008|7|5|alt=from [[5 July]] onwards}}''"
−
"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": {
+
:<nowiki>{{As of | 2008 | 7 | 5 | df=US}}</nowiki> returns "''{{As of|2008|7|5|df=US}}''"
−
  "1": {
+
 
−
    "label": "Year",
+
:<nowiki>{{As of | April 2006}}</nowiki> returns "''{{As of|April 2006}}''"
−
    "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}}
 
 
*[[Wikipedia:As of]]
 
*[[Wikipedia:As of]]
 
*[[Wikipedia:Avoid statements that will date quickly]]
 
*[[Wikipedia:Avoid statements that will date quickly]]
−
*[[:Category:All articles containing potentially dated statements]]
+
*[[Template:Update after]]
 +
 
 +
<includeonly>
 +
<!-- ADD CATEGORIES BELOW THIS LINE -->
 +
[[Category:Redirects from "As of"]]
 +
[[Category:Time and date maintenance templates|{{PAGENAME}}]]
 +
[[Category:Temporal templates|{{PAGENAME}}]]
  
−
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
+
<!-- ADD INTERWIKIS BELOW THIS LINE -->
−
| <!-- ADD CATEGORIES BELOW THIS LINE -->
+
</includeonly>
−
[[Category:Inline templates]]
 
−
[[Category:Temporal templates]]
 
−
[[Category:Time and date maintenance templates]]
 
−
}}</includeonly>
 

Revision as of 20:27, 9 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"
{{As of | 2008 | 7}} returns "As of July 2008"
{{As of | 2008 | 7 | 5}} returns "As of 5 July 2008"
{{As of | 2008 | 7 | 5 | alt=from [[5 July]] onwards}} returns "from 5 July onwards"
{{As of | 2008 | 7 | 5 | df=US}} returns "As of July 5, 2008"
{{As of | April 2006}} returns "As of April 2006"

See also


Retrieved from ‘https://www.svrwiki.com/mediawiki-1.28.2/index.php?title=Template:As_of/doc&oldid=6972’