Template:Update after: Difference between revisions

From Vigyanwiki
Template>Scott McNay
(Version w/banner, thanks to CBD's suggestion.)
Template>Scott McNay
(Oops, might help to document it, eh?)
Line 19: Line 19:
   ##### Next line shows up on year pages  #####
   ##### Next line shows up on year pages  #####
-->[[Wikipedia:Updating information/{{{1}}}|<s />]]<!--
-->[[Wikipedia:Updating information/{{{1}}}|<s />]]<!--
   ##### This section causes the message to appear in the text, with specified date offset. #####
   ##### This section causes the message or banner to appear in the text, with specified date offset. #####
-->{{#ifexpr: {{JULIANDAY| {{CURRENTYEAR}} | {{CURRENTMONTH}} | {{CURRENTDAY}} }}  >=
-->{{#ifexpr: {{JULIANDAY| {{CURRENTYEAR}} | {{CURRENTMONTH}} | {{CURRENTDAY}} }}  >=
   {{JULIANDAY| {{{1}}} | {{{2}}} | {{{3}}} }} + 0  <!--
   {{JULIANDAY| {{{1}}} | {{{2}}} | {{{3}}} }} + 0  <!--
   ##### (Change 0 above to 1, 7, or 31 to cause the msg to appear a day, week, or month late) #####
   ##### (Change 0 above to 1, 7, or 31 to cause the message or banner to appear a day, week, or month late) #####
-->|{{#ifeq: {{uc:{{{BANNER| {{{banner| {{{Banner|N}}} }}} }}} }}| Y |  
-->|{{#ifeq: {{uc:{{{BANNER| {{{banner| {{{Banner|N}}} }}} }}} }}| Y |<!--
 
  ##### Following is the banner; note that pipe characters are "escaped" as {{!}}. #####
{{{!}} class="messagebox current" style="width: auto;"
-->{{{!}} class="messagebox current" style="width: auto;"
{{!}}-
{{!}}-
{{!}} [[Image:Current event marker.svg|50px| ]]
{{!}} [[Image:Current event marker.svg|50px| ]]
Line 32: Line 32:
Please update the article to reflect recent events, and remove this template when finished.
Please update the article to reflect recent events, and remove this template when finished.
{{!}} [[Image:Nuvola apps important.svg|50px| ]]
{{!}} [[Image:Nuvola apps important.svg|50px| ]]
{{!}}}
{{!}}}<!--
 
  ##### End of banner #####
|&#91;[[Wikipedia:Updating information|''update needed'']]&#93;}} }}<!--
-->|&#91;[[Wikipedia:Updating information|''update needed'']]&#93;}} }}<!--
   ##### This section causes the category to appear at the specfied time, if someone edits (or maybe views) the page. #####
   ##### This section causes the category to appear at the specfied time, if someone edits (or maybe views) the page. #####
-->{{#if:{{{4|}}}|{{#ifexpr: {{JULIANDAY| {{CURRENTYEAR}} | {{CURRENTMONTH}} | {{CURRENTDAY}} }}  >=
-->{{#if:{{{4|}}}|{{#ifexpr: {{JULIANDAY| {{CURRENTYEAR}} | {{CURRENTMONTH}} | {{CURRENTDAY}} }}  >=
Line 55: Line 55:
== Usage ==
== Usage ==


:Parameter 1 is the year
*Parameter 1 is the year
:Parameter 2 is the month number
*Parameter 2 is the month number
:Parameter 3 is the day of the month
*Parameter 3 is the day of the month
:Optional parameter 4 is the category
*Optional parameter 4 is the category
:Optional named parameter COMMENT= is for leaving a note to the next editor about what exactly needs to be changed (if it's not obvious or if there are multiple items) and where to find the new information.
*Optional named parameter COMMENT= is for leaving a note to the next editor about what exactly needs to be changed (if it's not obvious or if there are multiple items) and where to find the new information.
*Optional named parameter BANNER=Y is for showing a banner (same as the banner for [[Template:Update|<nowiki>{{Update}}</nowiki>]]) instead of "update needed".  This is for marking an entire article or section as needing update.  Please write this parameter in UPPER-CASE.


This template shows the <sup>[''[[Wikipedia:Updating information|update needed]]'']</sup> note shown above, but the note is only visible on or after particular (future) date.  The date is specified as a year, followed by a month (1-12; leading zero is okay), followed by a day (again, leading zero is okay), for example
This template shows the <sup>[''[[Wikipedia:Updating information|update needed]]'']</sup> note shown above (or a banner, if that is enabled), but the message is only visible on or after the specified (future) date.  The date is specified as a year, followed by a month (1-12; leading zero is okay), followed by a day (again, leading zero is okay), for example


:'''<nowiki>{{update after|2008|11|4}}</nowiki>'''
:'''<nowiki>{{update after | 2008 | 11 | 4}}</nowiki>'''


for [[November 4]], [[2008]].  An optional 4th parameter is for a category for the article to be put into on the specified date, although the page probably needs to be viewed before this occurs.  An example of this would be
for [[November 4]], [[2008]].  An optional 4th parameter is for a category for the article to be put into on the specified date, although the page probably needs to be viewed before this occurs.  An example of this would be


:'''<nowiki>{{update after|2008|11|4|United States Government articles in need of update}}</nowiki>'''
:'''<nowiki>{{update after | 2008 | 11 | 4 | United States Government articles in need of updating}}</nowiki>'''
 
If the nature of the needed update(s) or the source of the updated information might not be clear, this should be mentioned also by adding a '''COMMENT=''' parameter.  An example of this might be:
 
:'''<nowiki>{{update after | 2008 | 11 | 4 | COMMENT=Show name of new president, and list the election statistics, such as how many Electoral College votes there were for each candidate (perhaps broken down by state), and how the actual votes compared to predictions; information will be available on virtually all U.S. news sites.  May also want voter and other reactions.  Check talk page to see if there's anything else which should be mentioned}}</nowiki>'''.
 
For clarity, named parameters should follow unnamed parameters, as in:


If the nature of the needed update(s) or the source of the updated information might not be clear, this should be mentioned also by adding a "comment=" parameter. An example of this might be:
:'''<nowiki>{{</nowiki>update after | 2008 | 11 | 4'''
:'''| United States Government articles in need of updating'''
:'''| COMMENT=Show name of new president, and list the election statistics, such as how many Electoral College votes there were for each candidate (perhaps broken down by state), and how the actual votes compared to predictions; information will be available on virtually all U.S. news sites.  May also want voter and other reactions.  Check talk page to see if there's anything else which should be mentioned<nowiki>}}</nowiki>'''.


:'''<nowiki>{{update after|2008|11|4|comment=Show name of new president, and list the election statistics, such as how many Electoral College votes there were for each candidate (perhaps broken down by state), and how the actual votes compared to predictions; information will be available on virtually all U.S. news sites.  May also want voter and other reactions.  Check talk page to see if there's anything else which should be mentioned}}</nowiki>'''.
Note that the sample above is broken into multiple lines for readability; it should still work fine.


Note that the named parameter should always be last, as in:
A banner can be shown, instead of "update needed", by using the '''BANNER=Y''' named parameter:


:'''<nowiki>{{update after|2008|11|4|United States Government articles in need of update|comment=Show name of new president, and list the election statistics, such as how many Electoral College votes there were for each candidate (perhaps broken down by state), and how the actual votes compared to predictions; information will be available on virtually all U.S. news sites.  May also want voter and other reactions.  Check talk page to see if there's anything else which should be mentioned}}</nowiki>'''.
:'''<nowiki>{{update after | 2008 | 11 | 4 | United States Government articles in need of updating | BANNER=Y | COMMENT=If G.W. Bush gets elected to a third term, this article will need massive rewriting}}</nowiki>'''.




Line 109: Line 118:


== Notes for future reference ==
== Notes for future reference ==
* The <sup>[''[[Wikipedia:Updating information|update needed]]'']</sup> message currently appears on the day specified, but does not need to; as a cosmetic issue with regards to non-editors (readers), the template can be modified to show this at a later day than the date on which the article is scheduled to be updated.  Specifically, it may be desirable to have the message not appear until the next day or so, to give update editors a chance to update the page before readers see the notice.
* The <sup>[''[[Wikipedia:Updating information|update needed]]'']</sup> message or the banner currently appear on the day specified, but does not need to; as a cosmetic issue with regards to non-editors (readers), the template can be modified to show this at a later day than the date on which the article is scheduled to be updated.  Specifically, it may be desirable to have the message or banner not appear until the next day or so, to give update editors a chance to update the page before readers see the notice.
* A [[Template:Review after]] template will probably be created later, once [[Template:Update after]] appears to be working satisfactorily.
* A [[Template:Review after]] template will probably be created later, once [[Template:Update after]] appears to be working satisfactorily.
[[Category:Wikipedia maintenance templates|{{PAGENAME}}]]
[[Category:Wikipedia maintenance templates|{{PAGENAME}}]]


</noinclude>
</noinclude>

Revision as of 08:30, 18 October 2006

[update needed]


Usage

  • Parameter 1 is the year
  • Parameter 2 is the month number
  • Parameter 3 is the day of the month
  • Optional parameter 4 is the category
  • Optional named parameter COMMENT= is for leaving a note to the next editor about what exactly needs to be changed (if it's not obvious or if there are multiple items) and where to find the new information.
  • Optional named parameter BANNER=Y is for showing a banner (same as the banner for {{Update}}) instead of "update needed". This is for marking an entire article or section as needing update. Please write this parameter in UPPER-CASE.

This template shows the [update needed] note shown above (or a banner, if that is enabled), but the message is only visible on or after the specified (future) date. The date is specified as a year, followed by a month (1-12; leading zero is okay), followed by a day (again, leading zero is okay), for example

{{update after | 2008 | 11 | 4}}

for November 4, 2008. An optional 4th parameter is for a category for the article to be put into on the specified date, although the page probably needs to be viewed before this occurs. An example of this would be

{{update after | 2008 | 11 | 4 | United States Government articles in need of updating}}

If the nature of the needed update(s) or the source of the updated information might not be clear, this should be mentioned also by adding a COMMENT= parameter. An example of this might be:

{{update after | 2008 | 11 | 4 | COMMENT=Show name of new president, and list the election statistics, such as how many Electoral College votes there were for each candidate (perhaps broken down by state), and how the actual votes compared to predictions; information will be available on virtually all U.S. news sites. May also want voter and other reactions. Check talk page to see if there's anything else which should be mentioned}}.

For clarity, named parameters should follow unnamed parameters, as in:

{{update after | 2008 | 11 | 4
| United States Government articles in need of updating
| COMMENT=Show name of new president, and list the election statistics, such as how many Electoral College votes there were for each candidate (perhaps broken down by state), and how the actual votes compared to predictions; information will be available on virtually all U.S. news sites. May also want voter and other reactions. Check talk page to see if there's anything else which should be mentioned}}.

Note that the sample above is broken into multiple lines for readability; it should still work fine.

A banner can be shown, instead of "update needed", by using the BANNER=Y named parameter:

{{update after | 2008 | 11 | 4 | United States Government articles in need of updating | BANNER=Y | COMMENT=If G.W. Bush gets elected to a third term, this article will need massive rewriting}}.


Please read Wikipedia:Avoid statements that will date quickly; use update after only in exceptional cases. Do not use update after on pages which simply need to be reviewed later to see if they might need updating. It should only be used when there is a 100% probability that an update is needed. Do not use this template on talk pages. It is probably not necessary to use this template on frequently edited articles such as for current events. Never add this template referring to the current day or any date in the past. Do not use this template within section headers, as it will break the header. Do not use this template as part of a parameter of another template.

It is acceptable to continue to use this template when an expected event does not occur; the date can be updated to expire a reasonable time later (such as a week, month, or quarter; this should be fairly commonsensical) after which an editor can check again; by that time, if the event still has not occurred, the source material should at least have an explanation of the reason and a new target date. For the benefit of readers, a note can be provided to indicate that the expected event has not occurred as of such-n-such a date, so that they will know that someone is keeping on top of the matter.

Effects

Go to Wikipedia:Updating information for a list of pages currently needing updates. For compatibility/interoperability, Category:Wikipedia articles in need of updating as well as As of also contain links to pages needing updates. See Wikipedia talk:Updating information for links to future years, if you're curious about what has been linked but has not yet expired.

Related templates

Discussion

Developmental discussion was originally at Wikipedia talk:As of#Template:Update after but is now at Template talk:Update after.

Developmental notes

This template was developed in order to resolve a number of problems seen with the As of links.

  • The template is outside of the standard Wikipedia namespace; there is no sign of it in "flattened" print or CD versions except maybe when the prose passes the expiration date.
  • Carefully-planned usage instructions, which are partially enforced by the template mechanism.
  • Can be extended and/or modified, and all pages that it is already used on will show the changes.
  • Prose does not need to be altered to accomodate it; it is invisible to readers until the "due date".
  • NO maintenance is needed; the built-in Wikipedia "what links here' mechanism is used to determine which pages need to be updated for a particular day, and a formula is used to generate the correct links.
  • The template is very simple to use, and it is very simple to find pages needing update.
  • Can be Has been modified to work with other techniques, such as {{update}}, {{Out of date}}, and As of.
  • The template itself is modular and heavily commented, in case future changes to the template are desired.
  • The dates of the text display, linking to Wikipedia:Updating information subpages, and linking to categories are all calculated independently, so that each of these events can be set to occur on different days.
  • A full date is required; this helps force/remind editors to be careful to select and specify a date when a change WILL be needed.

Notes for future reference

  • The [update needed] message or the banner currently appear on the day specified, but does not need to; as a cosmetic issue with regards to non-editors (readers), the template can be modified to show this at a later day than the date on which the article is scheduled to be updated. Specifically, it may be desirable to have the message or banner not appear until the next day or so, to give update editors a chance to update the page before readers see the notice.
  • A Template:Review after template will probably be created later, once Template:Update after appears to be working satisfactorily.