View source for Template:Outdated as of/doc

{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
After the specified date has passed, this template calls the {{Tlx|Update}} template to display a message box indicating that the page contains out of date information. Use to set a page to display the '''outdated''' message only after a known future date has arrived, such as for regularly recurring sporting events like the [[Olympics]], [[Canada Games]], etc.

This template should be transcluded at the top of the page; it is '''NOT''' suitable for substitution.

==Usage==
 {{Tlx|Outdated as of|<year>|<month>|<day>|<last updated>|6=topic=<topic>}}
or
 {{Tlx|Outdated as of|2=year=<year>|3=month=<month>|4=day=<day>|5=last updated=<last updated>|6=topic=<topic>}}
'''where''' named parameters {{resize|(appearing in any sequence)}}
{|
|- style="vertical-align:baseline;"
| rowspan="9" width="15px" | &nbsp;
| '''''year'''''
| rowspan="9" width="3px" | &nbsp;  
| <big>→</big>
| rowspan="9" width="3px" | &nbsp;  
| the four digit year when the page will next need to be updated&nbsp; (e.g. year = {{#expr:( {{CURRENTYEAR}} + ( {{CURRENTYEAR}} MOD 2 ) + 1 ) }} )
|- style="vertical-align:baseline;"
| '''''month'''''
| <big>→</big>
| the numeric month when this page will next need to be updated&nbsp; (e.g. Month = {{#if: {{#expr:( {{CURRENTYEAR}} + ( {{CURRENTYEAR}} MOD 2 ) + 1 ) MOD 4 ) = 3}}|2|8}} )
|- style="vertical-align:baseline;"
| '''''day'''''
| <big>→</big>
| the day of the month when this page next needs to be updated&nbsp; (e.g. day = 12 )
|- style="vertical-align:baseline;"
| '''''last updated'''''
| <big>→</big>
| any text to indicate when the information was last updated; typically this is the full date when this page was last brought up to date&nbsp; (e.g. last updated = {{CURRENTMONTHNAME}}&nbsp;{{CURRENTDAY}},&nbsp;{{CURRENTYEAR}} )
|- style="vertical-align:baseline;"
| '''''topic'''''
| <big>→</big>
| a custom message may be added to clarify which part(s) of the page are/will be out-of-date; this is added to the message stating "Parts of this article (those related to '''''topic''''') are outdated."
|}
During multi-day events, set the '''''day''''' to the next day {{Resize|(that the information on the page may change)}} and set the '''''last updated''''' parameter each day after the complete day's results have been updated.&nbsp; This will prevent the '''outdated''' message from appearing at the top of the page on the current day once the information is current, but will automatically display the message the following day if results have not been posted.<br />
Due to the nature of WikiMedia, and browser caching, the message might not appear until some time after the midnight changeover; also, midnight is UTC midnight as opposed to local time.&nbsp; There is currently no support in this template for specifying what time that the message will appear.<br />
Can be used with the {{Tlx|Update after}} template for similar inline notations.<br />
After the date specified by '''''year'''&thinsp;/&thinsp;'''month'''&thinsp;/&thinsp;'''day''''' is reached the page is added to the [[:Category:Wikipedia articles in need of updating]].
<br />
{| class="wikitable"
|+ style="text-align:left;" | The template automatically detects which [[WP:namespace|namespace]] it is used in and changes accordingly:
|-
! Article
| {{Outdated as of | year = 1999 | month = 1 | day = 1 | type=Article | demospace=main }}
|-
! Category
| {{Outdated as of | year = 1999 | month = 1 | day = 1 | type=Category | demospace=category }}
|-
! Template
| {{Outdated as of | year = 1999 | month = 1 | day = 1 | type=Template | demospace=template }}
|}

==Examples==
{{resize|(Note: All examples simulate the Article namespace.)}}
<!-- <span style="margin:2px"> -->
 <nowiki>{{</nowiki>Outdated as of | {{CURRENTYEAR}} | {{CURRENTMONTH}} | {{#expr:{{CURRENTDAY}} + 1}} }}
or
 <nowiki>{{</nowiki>Outdated as of | year = {{CURRENTYEAR}} | month = {{CURRENTMONTH}} | day = {{#expr:{{CURRENTDAY}} + 1}} }}
'''yields'''
{{Outdated as of | type=Article | demospace=main | year = {{CURRENTYEAR}} | month = {{CURRENTMONTH}} | day = {{#expr:{{CURRENTDAY}} + 1}} }}&nbsp; &nbsp; &nbsp;''[Nothing since this date has not yet been reached]''
<br /><br />
 <nowiki>{{</nowiki>Outdated as of | year = {{CURRENTYEAR}} | month = {{CURRENTMONTH}} | day = {{CURRENTDAY}} | last updated = {{CURRENTMONTHNAME}} {{CURRENTDAY}}, {{CURRENTYEAR}} }}
'''yields'''
{{Outdated as of | type=Article | demospace=main | year = {{CURRENTYEAR}} | month = {{CURRENTMONTH}} | day = {{CURRENTDAY}} | last updated = {{CURRENTMONTHNAME}} {{CURRENTDAY}}, {{CURRENTYEAR}} }}
<br />
 <nowiki>{{</nowiki>Outdated as of | topic = Hockey results | last updated = Game 3 | year = {{CURRENTYEAR}} | month = {{CURRENTMONTH}} | day = {{#expr:{{CURRENTDAY}} - 1}} }}
'''yields'''
{{Outdated as of | topic = Hockey results | last updated = Game 3 | year = {{CURRENTYEAR}} | month = {{CURRENTMONTH}} | day = {{#expr:{{CURRENTDAY}} - 1}} | type= Article | demospace=main }}
<br />
 <nowiki>{{</nowiki>Outdated as of | year = {{#expr:( {{CURRENTYEAR}} + ( {{CURRENTYEAR}} MOD 2 ) + 1 ) }} | month = {{#if: {{#expr:( {{CURRENTYEAR}} + ( {{CURRENTYEAR}} MOD 2 ) + 1 ) MOD 4 ) = 3}}|2|8}}  | day = 12 | last updated = {{CURRENTMONTHNAME}} {{CURRENTDAY}}, {{CURRENTYEAR}} }}
'''yields'''
{{Outdated as of | type=Article | demospace=main | year = {{#expr:( {{CURRENTYEAR}} + ( {{CURRENTYEAR}} MOD 2 ) + 5 ) }} | month = {{#if: {{#expr:( {{CURRENTYEAR}} + ( {{CURRENTYEAR}} MOD 2 ) + 1 ) MOD 4 ) = 3}}|2|8}}  | day = 12 | LastUpdated = {{CURRENTMONTHNAME}} {{CURRENTDAY}}, {{CURRENTYEAR}} }}&nbsp; &nbsp; &nbsp;''[Nothing since this date is far in the future.]''

==See also==
* {{Tl|Update}}
* {{Tl|Update after}}
* {{Tl|As of}}
* {{Tl|Show by date}}/{{tls|Show by}}
* See [[Wikipedia:Template messages/Cleanup#Time-sensitive]] for alternatives unrelated to out-of-date information.
<includeonly>{{Sandbox other||
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Time and date maintenance templates]]
[[Category:Cleanup templates]]
[[Category:Temporal templates]] 
[[Category:Templates needing talk links and other improvements]]
}}</includeonly>