Template:Update/doc: Difference between revisions

From Path of Exile Wiki
Jump to navigation Jump to search
(Created page with "{{documentation subpage}} {{wikipedia template}} <includeonly> <!-- CATEGORIES AND INTERWIKIS HERE, THANKS --> Category:Notice templates </includeonly>")
 
(This template now requires a reason to be given.)
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{documentation subpage}}
{{Documentation subpage}}
{{wikipedia template}}


<includeonly>
This template displays a notice that the page or section it appears on needs to be updated to account for newly available information.
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 
==Usage==
This template should be placed at the top of a page or section that contains outdated information.
 
'''You must always specify the reason an update is needed''' using <code>|reason=</code>. This lets other editors know at a glance what needs to be changed. It also informs them about when the update notice can be removed. This template will display an error if the reason is omitted.
 
<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 [[Help:Namespaces|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]]}}
 
==TemplateData==
<templatedata>
{
"params": {
"part": {
"aliases": [
"1"
],
"label": "Part",
"type": "content",
"description": "Part of the page that needs to be updated – Set to \"section\" when using this template in a section.",
"example": "general description, mechanics and interactions"
},
"reason": {
"aliases": [
"2"
],
"label": "Reason",
"description": "Reason the article needs to be updated",
"type": "content",
"required": true,
"example": "Curses are now classified as Hexes and Marks since [[version 3.12.0]]"
},
"talk": {
"aliases": [
"talksection",
"discuss"
],
"label": "Talk page section",
"description": "Title of the relevant talk page section",
"example": "Section title",
"type": "string"
},
"space": {
"aliases": [
"type"
],
"label": "Space",
"description": "Override for the name of the space the outdated information appears in",
"example": "article",
"type": "string",
"default": "{{SUBJECTSPACE formatted}}"
}
},
"format": "inline",
"description": "Displays a notice that a page or section has outdated information",
"paramOrder": [
"part",
"reason",
"talk",
"space"
]
}
</templatedata>
 
{{Documentation categories|
<!-- Categories and interwikis go here. -->
[[Category:Notice templates]]
[[Category:Notice templates]]
</includeonly>
[[Category:Cleanup templates]]
}}

Latest revision as of 18:13, 19 July 2023

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.

You must always specify the reason an update is needed using |reason=. This lets other editors know at a glance what needs to be changed. It also informs them about when the update notice can be removed. This template will display an error if the reason is omitted.

{{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.

TemplateData

Displays a notice that a page or section has outdated information

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Partpart 1

Part of the page that needs to be updated – Set to "section" when using this template in a section.

Example
general description, mechanics and interactions
Contentoptional
Reasonreason 2

Reason the article needs to be updated

Example
Curses are now classified as Hexes and Marks since [[version 3.12.0]]
Contentrequired
Talk page sectiontalk talksection discuss

Title of the relevant talk page section

Example
Section title
Stringoptional
Spacespace type

Override for the name of the space the outdated information appears in

Default
{{SUBJECTSPACE formatted}}
Example
article
Stringoptional