Template:Update/doc: Difference between revisions
No edit summary |
m fix line wrapping |
||
(27 intermediate revisions by 20 users not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} |
{{Documentation subpage}} |
||
⚫ | |||
{{High-use| |
{{High-use| 20176 }} |
||
{{Twinkle standard installation}} |
{{Twinkle standard installation}} |
||
{{Lua|Module:Unsubst}} |
{{Lua|Module:Unsubst}} |
||
⚫ | |||
⚫ | |||
⚫ | |||
This template can be used to mark ''entire articles or sections'' that contain outdated information. To assist the editor in the future, include the reason why an article needs updating (using {{para|reason}} and what part needs updating using {{para|part}}). |
|||
⚫ | * To specify what parts of the page need updating, use the first unnamed parameter (or name it {{para|part}} or number it {{para|1}}): {{ |
||
⚫ | |||
⚫ | |||
⚫ | |||
{{notice|text={{clear}} |
|||
* {{Tnull|Update}} is used to mark ''entire articles'' or ''entire sections'' that contain outdated information. To assist the editor in the future, include the reason why an article needs updating using {{para|reason}}, and what part needs updating {{para|part}}. |
|||
* If the article now has factual inaccuracies (not just missing or outdated information) due to being outdated, use {{para|inaccurate|yes}}; this is to be distinguished from [[Wikipedia:Accuracy dispute|disputed content]]. |
|||
}} |
|||
⚫ | |||
⚫ | * To specify what parts of the page need updating, use the first unnamed parameter (or name it {{para|part}} or number it {{para|1}}): {{tnull|{{BASEPAGENAME}}|part{{=}}the later-life and death material and the <nowiki>[[#Legacy|Legacy]]</nowiki> section|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} |
||
⚫ | |||
⚫ | |||
*: Note: The parameter name or number must be used if the first numbered/unnamed parameter is not used. |
*: Note: The parameter name or number must be used if the first numbered/unnamed parameter is not used. |
||
* To add the date when the tag was added (this is used for cleanup categorization), use: {{ |
* To add the date when the tag was added (this is used for cleanup categorization), use: {{tnull|{{BASEPAGENAME}}|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} |
||
*: You can also do: {{ |
*: You can also do: {{tnull|{{BASEPAGENAME}}|{{tls|DATE}}}} |
||
* To explain that the article now has inaccuracies (not just missing information) due to being outdated, use {{para|inaccurate|yes}}: {{ |
* To explain that the article now has inaccuracies (not just missing information) due to being outdated, use {{para|inaccurate|yes}}: {{tnull|{{BASEPAGENAME}}|inaccurate{{=}}yes|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}. This is to be distinguished from [[Wikipedia:Accuracy dispute|disputed content]], where {{tnull|Disputed}} or {{tnull|Disputed-section}} should be used instead. |
||
* To link to a particular section of the talk page where the update is being discussed, use {{para|talk|{{var|Section title}}}} ({{para|talksection}} and {{para|discuss}} are equivalent to {{para|talk}}): {{ |
* To link to a particular section of the talk page where the update is being discussed, use {{para|talk|{{var|Section title}}}} ({{para|talksection}} and {{para|discuss}} are equivalent to {{para|talk}}): {{tnull|{{BASEPAGENAME}}|talk{{=}}Shall we update this for {{CURRENTYEAR}}?|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} |
||
* To display a reason |
* To display a reason, use {{para|reason|{{var|a short comment here}}}}, e.g. {{tnull|{{BASEPAGENAME}}|reason{{=}}Is missing the {{CURRENTMONTHNAME}} {{CURRENTYEAR}} election results|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} |
||
* These parameters can be combined |
* These parameters can be combined: {{tnull|{{BASEPAGENAME}}|part{{=}}The <nowiki>[[#Production|Production]]</nowiki> section and follow-on material|reason{{=}}the film is released, so this needs a "Critical reception" section, too|inaccurate{{=}}yes|talk{{=}}Post-release updating|updated{{=}}{{#time:F Y|-3 month}}|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} |
||
==Example== |
==Example== |
||
{{ |
{{tnull|{{BASEPAGENAME}}|documentation|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} |
||
{{{{BASEPAGENAME}}|documentation}} |
{{{{BASEPAGENAME}}|documentation}} |
||
Line 34: | Line 40: | ||
|} |
|} |
||
{{ |
{{tnull|{{BASEPAGENAME}}|section|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} |
||
produces: |
|||
{| class="wikitable" |
{| class="wikitable" |
||
! Article |
! Article |
||
Line 50: | Line 57: | ||
For factual inaccuracies, stronger wording is used and mainspace articles will be added to [[:Category:Articles with obsolete information]]. |
For factual inaccuracies, stronger wording is used and mainspace articles will be added to [[:Category:Articles with obsolete information]]. |
||
{{ |
{{tnull|{{BASEPAGENAME}}|inaccurate{{=}}yes|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} |
||
{{{{BASEPAGENAME}}|type=article|demospace=main|inaccurate=yes}} |
{{{{BASEPAGENAME}}|type=article|demospace=main|inaccurate=yes}} |
||
Line 61: | Line 68: | ||
"date": { |
"date": { |
||
"label": "Month and year", |
"label": "Month and year", |
||
"description": "Provides the month and year of the |
"description": "Provides the month and year of the update request; e.g., 'January 2018', but not 'jan18'", |
||
"type": "string", |
"type": "string", |
||
"required": false, |
"required": false, |
||
Line 93: | Line 100: | ||
"label": "Reason", |
"label": "Reason", |
||
"description": "Explanation why the article is out of date", |
"description": "Explanation why the article is out of date", |
||
"type": "content" |
"type": "content", |
||
"suggested": true |
|||
}, |
}, |
||
" |
"part": { |
||
"aliases": [ |
"aliases": [ |
||
⚫ | |||
"1" |
"1" |
||
], |
], |
||
Line 105: | Line 112: | ||
"type": "string", |
"type": "string", |
||
"default": "article", |
"default": "article", |
||
"autovalue": "" |
"autovalue": "", |
||
"suggested": true |
|||
}, |
|||
"type": { |
|||
"label": "Type", |
|||
"description": "Type of page, overriding [[:mw:Help:Magic words#Namespaces|SUBJECTSPACE]]", |
|||
"type": "string", |
|||
"example": "article", |
|||
"suggested": false |
|||
}, |
|||
"demospace": { |
|||
"label": "Demospace", |
|||
"type": "string", |
|||
"required": false |
|||
}, |
|||
"cat": { |
|||
"label": "Cat", |
|||
"description": "Only required if a specific maintenance category is needed.", |
|||
"type": "string", |
|||
"required": false |
|||
} |
} |
||
}, |
}, |
||
"format": "inline", |
"format": "inline", |
||
"paramOrder": [ |
"paramOrder": [ |
||
" |
"part", |
||
"date", |
"date", |
||
"updated", |
"updated", |
||
"inaccurate", |
"inaccurate", |
||
"talksection", |
"talksection", |
||
"reason" |
"reason", |
||
"demospace", |
|||
⚫ | |||
"type" |
|||
] |
] |
||
} |
} |
||
Line 125: | Line 154: | ||
==See also== |
==See also== |
||
* {{tl|Update section}} |
|||
* {{tl|As of}} |
* {{tl|As of}} |
||
* {{tl|Current}} |
* {{tl|Current}} |
||
⚫ | |||
* {{tl|Recentism}} |
* {{tl|Recentism}} |
||
* {{tl|Show by date}}/{{tls|Show by}} |
* {{tl|Show by date}}/{{tls|Show by}} |
||
Line 133: | Line 164: | ||
* {{tl|Updated}} |
* {{tl|Updated}} |
||
* {{tl|When}} |
* {{tl|When}} |
||
⚫ | |||
<includeonly>{{sandbox other|| |
<includeonly>{{sandbox other|| |
Latest revision as of 00:43, 17 December 2024
This is a documentation subpage for Template:Update. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 33,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
Any breaking changes to this template, including moving it or nominating it for deletion, must be communicated in advance to Twinkle's users and maintainers at Wikipedia talk:Twinkle. The standard installation of Twinkle relies on this template. Thank you. |
This template uses Lua: |
This template can be used to mark entire articles or sections that contain outdated information. To assist the editor in the future, include the reason why an article needs updating (using |reason=
and what part needs updating using |part=
).
Usage
[edit]
|
This template can be used to mark articles or sections that have old or out-of-date information. Include the reason why an article needs updating, unless the reason is very obvious.
- To specify what parts of the page need updating, use the first unnamed parameter (or name it
|part=
or number it|1=
):{{Update|part=the later-life and death material and the [[#Legacy|Legacy]] section|date=January 2025}}
- To use the template in one specific section, and change its wording to refer to the section instead of the page, use
|section
and insert the template at the top of the section:{{Update|section|date=January 2025}}
- To display the date (in whatever format) of the last significant update to the page, use the second unnamed parameter (or name it
|updated=
or number it|2=
):{{Update|updated=5 December 2024|date=January 2025}}
- Note: The parameter name or number must be used if the first numbered/unnamed parameter is not used.
- To add the date when the tag was added (this is used for cleanup categorization), use:
{{Update|date=January 2025}}
- You can also do:
{{Update|{{subst:DATE}}}}
- You can also do:
- To explain that the article now has inaccuracies (not just missing information) due to being outdated, use
|inaccurate=yes
:{{Update|inaccurate=yes|date=January 2025}}
. This is to be distinguished from disputed content, where{{Disputed}}
or{{Disputed-section}}
should be used instead. - To link to a particular section of the talk page where the update is being discussed, use
|talk=Section title
(|talksection=
and|discuss=
are equivalent to|talk=
):{{Update|talk=Shall we update this for 2025?|date=January 2025}}
- To display a reason, use
|reason=a short comment here
, e.g.{{Update|reason=Is missing the January 2025 election results|date=January 2025}}
- These parameters can be combined:
{{Update|part=The [[#Production|Production]] section and follow-on material|reason=the film is released, so this needs a "Critical reception" section, too|inaccurate=yes|talk=Post-release updating|updated=October 2024|date=January 2025}}
Example
[edit]{{Update|documentation|date=January 2025}}
Parts of this template (those related to documentation) need to be updated. Please help update this template to reflect recent events or newly available information. Relevant discussion may be found on the talk page. |
The template detects which namespace it is used in and changes accordingly:
Article |
| ||
---|---|---|---|
Category |
| ||
Template |
|
{{Update|section|date=January 2025}}
produces:
Article |
| ||
---|---|---|---|
Category |
| ||
Template |
|
This template will add mainspace articles to Category:Wikipedia articles in need of updating (this category is not populated by pages in other namespaces).
For factual inaccuracies, stronger wording is used and mainspace articles will be added to Category:Articles with obsolete information.
{{Update|inaccurate=yes|date=January 2025}}
This article's factual accuracy may be compromised due to out-of-date information. |
TemplateData
[edit]TemplateData for Update
Use this tag to alert readers that the article is out of date and may need updating.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Type (section) | part 1 | Part that needs updating (e.g. to replace the word "article", often "section")
| String | suggested |
Month and year | date | Provides the month and year of the update request; e.g., 'January 2018', but not 'jan18'
| String | suggested |
Last updated | updated 2 | Date of last significant update | Date | optional |
Inaccurate? | inaccurate | Use 'yes' if the article has inaccuracies due to being out of date.
| Boolean | optional |
Talk page section | talksection discuss talk | Section name on talk page where the discussion takes place | String | optional |
Reason | reason | Explanation why the article is out of date | Content | suggested |
Demospace | demospace | no description | String | optional |
Cat | cat | Only required if a specific maintenance category is needed. | String | optional |
Type | type | Type of page, overriding [[:mw:Help:Magic words#Namespaces|SUBJECTSPACE]]
| String | optional |
Alternatives
[edit]- {{Update after}} is an alternative for individual statements that will be out-of-date at a specifiable future date. It is a more recent and preferred alternative to Wikipedia:As of. It also adds articles to Category:Wikipedia articles in need of updating.
- See Wikipedia:Template messages/Cleanup#Time-sensitive for alternatives unrelated to out-of-date information.
See also
[edit]- {{Update section}}
- {{As of}}
- {{Current}}
- {{Missing information}}
- {{Recentism}}
- {{Show by date}}/{{subst:Show by}}
- {{Time-context}}
- {{Update inline}}
- {{Updated}}
- {{When}}