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

Latest revision as of 16:52, 28 December 2015

Not to be confused with Template:As of? which redirects to Template:When.

Usage

The template {{as of}} is 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. 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 {{update after}} template, {{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}}

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 (including the date); if present but no value defined, this parameter is ignored; if a value is defined, values for |df and |lc and |since parameters are ignored.
df – optional; allows use of American date format with |df=US.
lc – optional; if given any value at all (e.g. |lc=y) gives lower case "as of date", for use in mid-sentence.
since – optional; if given any value at all (e.g. |since=y) it changes "As of" to "Since". Use of |lc=y with |since=y gives "since date. Use of |alt= will replace the entire output, including the "Since", as it will with the default "As of".
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|2024}} – As of 2024

{{As of|2024|04}} – As of April 2024

{{As of|2024|04|29}} – As of 29 April 2024

{{As of|2024|04|29|df=US}} – As of April 29, 2024

{{As of|2024|04|29|lc=y}} – as of 29 April 2024

{{As of|2010|4|1|alt=as of the [[2010 United States Census]]}} – as of the 2010 United States Census

{{As of|2024|04|url=http://en.wikipedia.org/}} returns:

for logged in users, with links displayed (see Wikipedia:As of) – As of AprilScript error: No such module "String".2024^[ref]

for all other users – As of AprilScript error: No such module "String".2024

{{As of|2024|04|29|df=US|since=y}} – Since April 29, 2024

{{As of|2024|04|29|lc=y|since=y}} – since 29 April 2024

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

As of/doc

<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
 },
 "since": {
   "label": "Since",
   "description": "Specify y to replace 'as of' with 'since'.",
   "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>

@@ Line 1: / Line 1: @@
-<includeonly>{{template doc page transcluded}}</includeonly>
+{{Documentation subpage}}
-<noinclude>{{template doc page viewed directly}}</noinclude>
+{{Distinguish2|[[Template:As of?]] which redirects to [[Template:When]]}}
 <!-- 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 [[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]].
-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.
+'''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>
+Please do not use <code><nowiki>{{As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}}}</nowiki></code> or similar; that defeats the point of the template.
-:<nowiki>{{ As of | year | month | day }}</nowiki>
+Several additional named parameters can also be used (see below).
-:<nowiki>{{ As of | month_name year }}</nowiki> (''deprecated'')
 ===Parameters===
 '''Required'''
-*'''year''' (first parameter) – required; must be in full numerical format (''yyyy'')
+*'''year''' (first parameter) – 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
+*'''month''' (second parameter) – full, abbreviated or numerical formats supported (''mm'' recommended)
-*'''day''' (third parameter) – optional; numerical format only, not included in link
+*'''day''' (third parameter) – numerical format only, not included in link (''dd'')
-'''Named optional'''
+'''Named'''
-*'''alt''' (named parameter) – optional; allows substitution of visible text output (defaults to "As of [date]") for different wording or use of lower case
+*'''alt''' – optional; allows substitution of different wording and case for the visible text output (including the date); if present but no value defined, this parameter is ignored; if a value is defined, values for <code>|df</code> and <code>|lc</code> and <code>|since</code> parameters are ignored.
-*'''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
+*'''df''' – optional; allows use of American date format with {{para|df|US}}.
+*'''lc''' – optional; if given any value at all (e.g. {{para|lc|y}}) gives lower case "as of ''date''", for use in mid-sentence.
+*'''since''' – optional; if given any value at all (e.g. {{para|since|y}}) it changes "As of" to "Since". Use of {{para|lc|y}} with {{para|since|y}} gives "since ''date''. Use of {{para|alt}} will replace the entire output, including the "Since", as it will with the default "As of".
+*'''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===
+<!-- NOTE: DO NOT copy and paste this code to use the template. Copy and paste what it renders for today's date -->
+:{{tlc|As of|{{CURRENTYEAR}}}}  – {{As of|{{CURRENTYEAR}}}}
+:{{tlc|As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}}}  – {{As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}}}
+:{{tlc|As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}|{{CURRENTDAY}}}}  – {{As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}|{{CURRENTDAY}}}}
+:{{tlc|As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}|{{CURRENTDAY}}|df{{=}}US}}  –  {{As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}|{{CURRENTDAY}}|df=US}}
+:{{tlc|As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}|{{CURRENTDAY}}|lc{{=}}y}}  –  {{As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}|{{CURRENTDAY}}|lc=y}}
+<!-- As this next example is referring to the census date, doesn't make sense to use current date -->
+:{{tlc|As of|2010|4|1|alt{{=}}as of the <nowiki>[[2010 United States Census]]</nowiki>}} – {{As of|2010|4|1|alt=as of the [[2010 United States Census]]}}
+:{{tlc|As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}|url{{=}}<nowiki>http://en.wikipedia.org/</nowiki>}} returns:
+:: ''for logged in users, with links displayed (see [[Wikipedia:As of#Article maintenance|Wikipedia:As of]])'' – As of {{MONTHNAME|{{CURRENTMONTH}}}}{{space}}{{CURRENTYEAR}}<sup class="plainlinks">[http://en.wikipedia.org/ &#91;ref&#93;]</sup>
+:: ''for all other users'' – As of {{MONTHNAME|{{CURRENTMONTH}}}}{{space}}{{CURRENTYEAR}}
+:{{tlc|As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}|{{CURRENTDAY}}|df{{=}}US|since{{=}}y}}  –  {{As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}|{{CURRENTDAY}}|df=US|since=y}}
+:{{tlc|As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}|{{CURRENTDAY}}|lc{{=}}y|since{{=}}y}}  –  {{As of|{{CURRENTYEAR}}|{{CURRENTMONTH}}|{{CURRENTDAY}}|lc=y|since=y}}
-:<nowiki>{{As of | 2008}}</nowiki> returns "''{{As of|2008}}''"
+===TemplateData===
+{{TemplateDataHeader}}
-:<nowiki>{{As of | 2008 | 7}}</nowiki> returns "''{{As of|2008|7}}''"
+<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.",
-:<nowiki>{{As of | 2008 | 7 | 5}}</nowiki> returns "''{{As of|2008|7|5}}''"
+"params": {
+  "1": {
-:<nowiki>{{As of | 2008 | 7 | 5 | alt=from [[5 July]] onwards}}</nowiki> returns "''{{As of|2008|7|5|alt=from [[5 July]] onwards}}''"
+    "label": "Year",
+    "description": "The year the statement is valid to. Must be in full numerical format (yyyy)",
-:<nowiki>{{As of | 2008 | 7 | 5 | df=US}}</nowiki> returns "''{{As of|2008|7|5|df=US}}''"
+    "type": "number",
+    "required": true
-:<nowiki>{{As of | April 2006}}</nowiki> returns "''{{As of|April 2006}}''"
+  },
+  "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
+  },
+  "since": {
+    "label": "Since",
+    "description": "Specify y to replace 'as of' with 'since'.",
+    "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==
+*{{tl|Category as of}}
+*{{tl|Show by date}}
+*{{tl|Start date and age}}
+*{{tl|Update}}
+*{{tl|Update after}}
+*{{tl|When}}
 *[[Wikipedia:As of]]
 *[[Wikipedia:Avoid statements that will date quickly]]
-*[[Template:Update after]]
+*[[:Category:All articles containing potentially dated statements]]
-<includeonly>
-<!-- ADD CATEGORIES BELOW THIS LINE -->
-[[Category:Redirects from "As of"]]
-[[Category:Time and date maintenance templates|{{PAGENAME}}]]
-[[Category:Temporal templates|{{PAGENAME}}]]
-<!-- ADD INTERWIKIS BELOW THIS LINE -->
+<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
-</includeonly>
+| <!-- ADD CATEGORIES BELOW THIS LINE -->
+[[Category:Inline templates]]
+[[Category:Temporal templates]]
+[[Category:Time and date maintenance templates]]
+}}</includeonly>

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

Latest revision as of 16:52, 28 December 2015

Contents

Usage

Syntax

Parameters

Examples

TemplateData

See also

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Navigation

Tools