Changes

Template:As of/doc

2,940 bytes removed, 20:27, 9 July 2008
preliminary template documentation
<includeonly>{{Documentation subpagetemplate doc page transcluded}}</includeonly><noinclude>{{Distinguish|Template:As of?template doc page viewed directly}}</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]].
'''NoteThe template {{[[Template: This template MUST NOT be As of|As of]]}} is used in infoboxes which emit 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, as its emitted <nowiki>{{As of}}</nowiki> does not require the editor to give a full date markup will conflict with that.This template should ''' This template does not generate a visible hyperlink in text where it is used''' be subst'd.
==Syntax==
The template can be used in the following forms:
:<code><nowiki>{{As of|year}}</nowiki></code>:<code><nowiki>{{As of|year|month| day }}</nowiki></code>:<code><nowiki>{{As of|month_name year|month|day}}</nowiki></code>(''deprecated'')
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'''
*'''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'')
'''Namedoptional'''*'''alt''' (named parameter) – 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 (defaults to "As of [date]") for ''df'' and ''lc'' parameters are ignoreddifferent wording or use of lower case*'''df''' (named parameter) – optional; allows use of American date format with ''df=value US''*'''lc''' – optional; gives lower case "as of '', only visible to users who have not set their 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.preferences yet
===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]]2008}}:<tt>{&#123;As of{{!}}2010{{!}}7{{!}}5{{!}}df=US&#125;}</ttnowiki> – {returns "''{As of|2010|7|5|df=US}}:<tt>{&#123;As of{{!}}2010{{!}}7{{!}}5{{!}}lc=y&#125;}</tt> – {{As of|2010|7|5|lc=2008}}''"
:<ttnowiki>{&#123;{As of{{!}}2010{{!}}| 2008 | 7{{!}}url=<nowiki>http://en.wikipedia.org/</nowiki>&#125;}</tt> returns::: "''for logged in users, with links displayed (see [[Wikipedia:{{As of#Article maintenance|Wikipedia:As of]])2008|7}}'' – 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>{{TemplateDataHeaderAs of | 2008 | 7 | 5}} <templatedata/nowiki>returns "''{{"description": "A template used to mark potentially dated statements, and will add an article to the appropriate hidden sub-category As of Category:Articles containing potentially dated statements. This allows editors to catalogue statements that may become dated over time.|2008|7|5}}''","params": { "1": <nowiki>{ "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 As of | 2008 | 7 | 5 | alt=from [[5 July]] onwards}, "3": { "label": "Day", "description": "The day the statement is valid to (not included in link). Numerical format only (dd)", "type": "number", "required": false }, </nowiki> returns "alt": { "label": "Alternate wording", "description": "Use different wording for the visible text output; if set, values for 'Date format' (df) and {{As of|2008|7|5|alt=from [[5 July]] onwards}}'Lower case' (lc) parameters are ignored", "type": "string/line", "required": false }, "<nowiki>{{As of | 2008 | 7 | 5 | df": { "label": "Date format", "description": "Set to =US to use U.S. date format (mdy) (default is dmy)", "type": "string}}</line", "default": nowiki> returns "''{{As of|2008|7|5|df=US}}''", "required": false }, "lc": <nowiki>{ "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 As of | April 2006}}}</templatedatanowiki>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:All articles containing potentially dated statementsRedirects from "As of"]][[Category:Time and date maintenance templates|{{PAGENAME}}]][[Category:Temporal templates|{{PAGENAME}}]]
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox || <!-- ADD CATEGORIES INTERWIKIS BELOW THIS LINE -->[[Category:Inline templates]][[Category:Temporal templates]][[Category:Time and date maintenance templates]]}}</includeonly>
Anonymous user