Difference between revisions of "Template:As of/doc"
(→Examples: updating other examples) |
m (87 revisions imported: Template as of) |
||
(3 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
− | {{ | + | {{Distinguish2|[[Template:As of?]] which redirects to [[Template:When]]}} |
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> | <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> | ||
Line 30: | Line 30: | ||
'''Named''' | '''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 | + | *'''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''' – optional; allows use of American date format with | + | *'''df''' – optional; allows use of American date format with {{para|df|US}}. |
− | *'''lc''' – optional; gives lower case "as of ''date''" | + | *'''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. | *'''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. | ||
Line 47: | Line 48: | ||
:: ''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/ [ref]]</sup> | :: ''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/ [ref]]</sup> | ||
:: ''for all other users'' – As of {{MONTHNAME|{{CURRENTMONTH}}}}{{space}}{{CURRENTYEAR}} | :: ''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}} | ||
===TemplateData=== | ===TemplateData=== | ||
Line 89: | Line 92: | ||
"type": "string/line", | "type": "string/line", | ||
"required":false | "required":false | ||
+ | }, | ||
+ | "since": { | ||
+ | "label": "Since", | ||
+ | "description": "Specify y to replace 'as of' with 'since'.", | ||
+ | "type": "string/line", | ||
+ | "required": false | ||
}, | }, | ||
"url": { | "url": { |
Latest revision as of 16:52, 28 December 2015
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[update]{{As of|2024|05}}
– As of May 2024[update]{{As of|2024|05|23}}
– As of 23 May 2024[update]{{As of|2024|05|23|df=US}}
– As of May 23, 2024[update]{{As of|2024|05|23|lc=y}}
– as of 23 May 2024[update]{{As of|2010|4|1|alt=as of the [[2010 United States Census]]}}
– as of the 2010 United States Census[update]{{As of|2024|05|url=http://en.wikipedia.org/}}
returns:- for logged in users, with links displayed (see Wikipedia:As of) – As of MayScript error: No such module "String".2024[ref]
- for all other users – As of MayScript error: No such module "String".2024
{{As of|2024|05|23|df=US|since=y}}
– Since May 23, 2024[update]{{As of|2024|05|23|lc=y|since=y}}
– since 23 May 2024[update]
TemplateData
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>
See also
- {{Category as of}}
- {{Show by date}}
- {{Start date and age}}
- {{Update}}
- {{Update after}}
- {{When}}
- Wikipedia:As of
- Wikipedia:Avoid statements that will date quickly
- Category:All articles containing potentially dated statements