Template:Update/doc: Difference between revisions
m (Vinifera7 moved page Template:Out of date/doc to Template:Update/doc without leaving a redirect) |
(New documentation) |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
{{ | This template displays a notice that the page or section it appears on needs to be updated to account for newly available information. | ||
{{ | |||
==Usage== | |||
This template should be placed at the top of a page or section that contains outdated information. | |||
Always specify the reason an update is needed using <code>|reason=</code>, unless that reason is very obvious. This helps other editors know at a glance what needs to be changed. | |||
<pre>{{Update|reason=Curses are now classified as Hexes and Marks since [[version 3.12.0]]}}</pre> | |||
To specify that certain parts of a page need to be updated, use the first unnamed parameter or <code>|part=</code>. | |||
<pre>{{Update|part=general description, mechanics and interactions}}</pre> | |||
To indicate that a section needs to be updated, place this template at the top of the section and use "section" for the value of the first unnamed parameter or <code>|part=</code>. | |||
<pre>{{Update|section}}</pre> | |||
The notice produced by this template will show a link to the talk page if it exists. To have it link to a specific section of the talk page where the update is being discussed, use <code>|talk=<var>Section title</var></code>. | |||
<pre>{{Update|talk=Changes in version 3.12.0}}</pre> | |||
This template detects which namespace it is used in and changes accordingly. Using this template on a [[gphelp:Namespaces#.28Main.29|mainspace]] article will automatically add it to [[:Category:Articles needing updates]]. | |||
===Examples=== | |||
Update notice at the top of an article: | |||
<pre>{{Update|reason=Curses are now classified as Hexes and Marks since [[version 3.12.0]]}}</pre> | |||
{{Update|space=article|reason=Curses are now classified as Hexes and Marks since [[version 3.12.0]]}} | |||
Update notice at the top of an article about specific parts of the article: | |||
<pre>{{Update|part=general description, mechanics and interactions|reason=Skill rework in [[version 3.9.0]]}}</pre> | |||
{{Update|space=article|part=general description, mechanics and interactions|reason=Skill rework in [[version 3.9.0]]}} | |||
Update notice at the top of a section within an article: | |||
<pre>{{Update|section|reason=Legacy altering changes in [[version 2.3.0]]}}</pre> | |||
{{Update|space=article|section|reason=Legacy altering changes in [[version 2.3.0]]}} | |||
{{Documentation categories| | {{Documentation categories| | ||
Revision as of 07:14, 7 December 2020
This subpage provides documentation for Template:Update.
This template displays a notice that the page or section it appears on needs to be updated to account for newly available information.
Usage
This template should be placed at the top of a page or section that contains outdated information.
Always specify the reason an update is needed using |reason=, unless that reason is very obvious. This helps other editors know at a glance what needs to be changed.
{{Update|reason=Curses are now classified as Hexes and Marks since [[version 3.12.0]]}}
To specify that certain parts of a page need to be updated, use the first unnamed parameter or |part=.
{{Update|part=general description, mechanics and interactions}}
To indicate that a section needs to be updated, place this template at the top of the section and use "section" for the value of the first unnamed parameter or |part=.
{{Update|section}}
The notice produced by this template will show a link to the talk page if it exists. To have it link to a specific section of the talk page where the update is being discussed, use |talk=Section title.
{{Update|talk=Changes in version 3.12.0}}
This template detects which namespace it is used in and changes accordingly. Using this template on a mainspace article will automatically add it to Category:Articles needing updates.
Examples
Update notice at the top of an article:
{{Update|reason=Curses are now classified as Hexes and Marks since [[version 3.12.0]]}}
This article needs to be updated.
Reason: Curses are now classified as Hexes and Marks since version 3.12.0
Please update this article to reflect newly available information.
Update notice at the top of an article about specific parts of the article:
{{Update|part=general description, mechanics and interactions|reason=Skill rework in [[version 3.9.0]]}}
Parts of this article related to general description, mechanics and interactions need to be updated.
Reason: Skill rework in version 3.9.0
Please update this article to reflect newly available information.
Update notice at the top of a section within an article:
{{Update|section|reason=Legacy altering changes in [[version 2.3.0]]}}
This section needs to be updated.
Reason: Legacy altering changes in version 2.3.0
Please update this article to reflect newly available information.