Changes

Jump to: navigation, search

Template:As of/doc

4,314 bytes added, 16:52, 28 December 2015
m
87 revisions imported: Template as of
<includeonly>{{template doc page transcludedDocumentation subpage}}</includeonly><noinclude>{{template doc page viewed directlyDistinguish2|[[Template:As of?]] which redirects to [[Template:When]]}}</noinclude>
<!-- 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 '''Note: This template {{[[Template:As of|As of]]}} is MUST NOT be used to link a section of text to an appropriate "As of..." page without creating in infoboxes which emit 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 as its emitted datemarkup will conflict with that. This template should ''' This template does not''' be subst'dgenerate 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>:<nowiki>{{ As of | month_name year }}</nowiki> Several additional named parameters can also be used (''deprecated''see below).
===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 formats supported (''mm'' recommended) formats supported*'''day''' (third parameter) – optional; numerical format only, not included in link(''dd'')
'''Named optional'''*'''alt''' (named parameter) – optional; allows substitution of different wording and case for the visible text output (defaults to "As of [including the date]") ; if present but no value defined, this parameter is ignored; if a value is defined, values for different wording or use of lower case<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 {{para|df|US}}.*'''lc''' – optional; if given any value USat all (e.g. {{para|lc|y}}) gives lower case "as of ''date''", only visible for use in mid-sentence.*'''since''' – optional; if given any value at all (e.g. {{para|since|y}}) it changes "As of" to users who have not set their "Since". Use of {{para|lc|y}} with {{para|since|y}} gives "since ''date preferences yet''. 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>===TemplateData==={{As of | 2008TemplateDataHeader}}</nowikitemplatedata> returns {"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": {As of|2008 "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":<nowiki>{{As of | 2008 | 7false }}</nowiki> returns , "3"'': {{As of|2008|7 "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":<nowiki>{{As of | 2008 | 7 | 5}}</nowiki> returns "Use different wording for the visible text output; if set, values for 'Date format'{{As of|2008|7|5}}(df) and 'Lower case'(lc) parameters are ignored", "type": "string/line", "required":<nowiki>{{As of | 2008 | 7 | 5 | alt=from [[5 July]] onwardsfalse }}</nowiki> returns , "df"'': {{As of|2008|7|5|alt=from [[5 July]] onwards}}'' "label": "Date format", "description": "Set to US to use U.S. date format (mdy) (default is dmy)", "type": "string/line", "default":<nowiki>{{As of | 2008 | 7 | 5 | df="US", "required": false }, "lc": { "label": "Lower case", "description": "Specify y to use lower case", "type": "string/line", "required":false }</nowiki> returns , "since": { "label": "Since", "description": "Specify y to replace 'as of'{{As of|2008|7|5|df=US}}with 'since'.", "type": "string/line", "required": false }, "url":<nowiki>{{As of | April 2006 "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 }}}</nowikitemplatedata> returns "''{{As of|April 2006}}''"
==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]] <includeonly><!-- ADD CATEGORIES BELOW THIS LINE -->[[Category:Redirects from "As of"]][[Category:Time and date maintenance templates|{{PAGENAME}}]][[Category:Temporal templates|{{PAGENAME}}All articles containing potentially dated statements]]
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox || <!-- ADD INTERWIKIS CATEGORIES BELOW THIS LINE -->[[Category:Inline templates]][[Category:Temporal templates]][[Category:Time and date maintenance templates]]}}</includeonly>

Navigation menu