Difference between revisions of "Template:As of/doc"
(→Usage: no longer true) |
(→Parameters: note on how to suppress display of any "as of" text) |
||
(3 intermediate revisions by 3 users not shown) | |||
Line 30: | Line 30: | ||
'''Named''' | '''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 | + | *'''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 the invisible zero-width space character entity can be used to suppress display of any "as of" text: {{para|alt|​}} |
*'''df''' – optional; allows use of American date format with ''df=US'' | *'''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'' | *'''lc''' – optional; gives lower case "as of ''date''" when defined; recommended syntax is ''lc=y'' | ||
Line 110: | Line 110: | ||
*[[:Category:All articles containing potentially dated statements]] | *[[:Category:All articles containing potentially dated statements]] | ||
− | <includeonly> | + | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
− | <!-- ADD CATEGORIES BELOW THIS LINE --> | + | | <!-- ADD CATEGORIES BELOW THIS LINE --> |
[[Category:Inline templates]] | [[Category:Inline templates]] | ||
[[Category:Temporal templates]] | [[Category:Temporal templates]] | ||
[[Category:Time and date maintenance templates]] | [[Category:Time and date maintenance templates]] | ||
− | </includeonly> | + | }}</includeonly> |
Revision as of 02:15, 1 September 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; if present but no value defined, this parameter is ignored; if a value is defined, values for df and lc parameters are ignored the invisible zero-width space character entity can be used to suppress display of any "as of" text:
|alt=​
- 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[update]
- {{As of|2010|7}} – As of July 2010[update]
- {{As of|2010|7|5}} – As of 5 July 2010[update]
- {{As of|2010|4|1|alt=as of the [[2010 United States Census]]}} – as of the 2010 United States Census[update]
- {{As of|2010|7|5|df=US}} – As of July 5, 2010[update]
- {{As of|2010|7|5|lc=y}} – as of 5 July 2010[update]
- {{As of|2010|7|url=http://en.wikipedia.org/}} returns:
- for logged in users, with links displayed (see Wikipedia:As of) – As of July 2010[ref]
- for all other users – As of July 2010
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 }, "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