Template:Update after: Difference between revisions

From Vigyanwiki
Template>Rick Block
(→‎Usage: add note about "comment=")
Template>Scott McNay
(Some rewriting)
Line 27: Line 27:
   ##### (Change 0 above to 1, 7, or 31 to cause the category to appear a day, week, or month late) #####
   ##### (Change 0 above to 1, 7, or 31 to cause the category to appear a day, week, or month late) #####
-->|[[Category:{{{4}}}|{{PAGENAME}}]]}}}}<!--
-->|[[Category:{{{4}}}|{{PAGENAME}}]]}}}}<!--
--></sup></includeonly><noinclude><!--
--></sup></includeonly><noinclude><!--
   ##### The next line is our documentation sample #####
   ##### The next line is our documentation sample #####
Line 33: Line 34:


== Usage ==
== Usage ==
This template shows the <sup>[''[[Wikipedia:Updating information|update needed]]'']</sup> note shown above, but the note becomes visible only on a particular (future) date.  The date is specified as a year, followed by a month (1-12), followed by a day, for example '''<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 '''<nowiki>{{update after|2008|11|4|United States Government articles in need of update}}</nowiki>'''.  Please consider adding a comment at the top of the article to direct editors to the section which needs updating.  If the nature of the needed update 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=Someone other than George Bush was elected president on this day.}}</nowiki>'''.


Please read [[Wikipedia:Avoid statements that will date quickly]]; use [[template:update after|update after]] only in exceptional cases.  Do not use [[template:update after|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 [[Help:talk page|talk page]]s.  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.
: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.
 
This template shows the <sup>[''[[Wikipedia:Updating information|update needed]]'']</sup> note shown above, but the note becomes visible only on a 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
 
:'''<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
 
:'''<nowiki>{{update after|2008|11|4|United States Government articles in need of update}}</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 US 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 named parameter should always be last, as in:
 
:'''<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 US news sites.  May also want voter and other reactions.  Check talk page to see if there's anything else which should be mentioned}}</nowiki>'''.
 
 
Please read [[Wikipedia:Avoid statements that will date quickly]]; use [[template:update after|update after]] only in exceptional cases.  Do not use [[template:update after|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 [[Help:talk page|talk page]]s.  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.


Go to [[Wikipedia:Updating information]] for a list of pages currently 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.
Go to [[Wikipedia:Updating information]] for a list of pages currently 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==
== Related templates ==
* [[Template:Update]] can be used to mark an entire article or section needing to be updated.
* [[Template:Update]] can be used to mark an entire article or section needing to be updated. This template adds the article to [[:Category:Wikipedia articles in need of updating]]
* [[Template:Out of date]] is used to mark an article whose factual accuracy may be compromised due to out of date information.
* [[Template:Out of date]] is used to mark an article whose factual accuracy may be compromised (although this may be disputed) due to out of date information. This template adds the article to [[:Category:Articles with obsolete information]]


== History ==
== Discussion ==
This template partially replaces the '''<nowiki>[[As of nnnn]]</nowiki>''' convention.  These pages have multiple problems, such as being in the encyclopedic namespace, frequently not being used correctly or consistently, and editors often unnecessarily torture the prose in order to use it.  This template resolves these problems, since the update warning only appears after an indicated future date, does not appear when a page is printed, does not require artificially linking any text in the article, and the mechanism only works properly for future dates.<!-- This paragraph can be removed after all [[As of]] pages are gone -->
Developmental discussion was originally at [[Wikipedia talk:As of#Template:Update after]] but is now at [[Template talk:Update after]].


== Discussion ==
== Developmental notes ==
Developmental discussion is at [[Wikipedia talk:As of#Template:Update after]].
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 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 alredy 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 [[Wikipedia:Updating information|find pages needing update]].
* Can be modified to work with other techniques, such as <nowiki>{{update}}</nowiki>, <nowiki>{{Out of date}}</nowiki>, 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 ==
== 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, 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 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 same applies to the category; it can be made to appear a day or so later.
* 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 07:51, 16 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.

This template shows the [update needed] note shown above, but the note becomes visible only on a 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

{{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 update}}

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 US 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 named parameter should always be last, as in:

{{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 US news sites. May also want voter and other reactions. Check talk page to see if there's anything else which should be mentioned}}.


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.

Go to Wikipedia:Updating information for a list of pages currently 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 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 alredy 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 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 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.
  • A Template:Review after template will probably be created later, once Template:Update after appears to be working satisfactorily.