Template:Update/doc: Difference between revisions

Latest revision as of 13:01, 25 June 2022

This is a documentation subpage for Template:Update.
It contains usage information, categories and other content that is not part of the original Template page.

[[Category:Template documentation pages{{#translation:}}]]

This template is used on approximately 28,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.

If you plan to make breaking changes to this template, move it, or nominate it for deletion, please notify Twinkle's users and maintainers at Wikipedia talk:Twinkle as a courtesy, as this template is used in the standard installation of Twinkle. Thank you!

This template uses Lua:

Module:Unsubst

Usage

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 <templatestyles src="Template:Nowrap/styles.css"/>|part= or number it <templatestyles src="Template:Nowrap/styles.css"/>|1=): <templatestyles src="Template:Nowrap/styles.css"/>{{Update|part=the later-life and death material and the [[#Legacy|Legacy]] section|date=December 2024}}
To use the template in one specific section, and change its wording to refer to the section instead of the page, use <templatestyles src="Template:Nowrap/styles.css"/>|section and insert the template at the top of the section: <templatestyles src="Template:Nowrap/styles.css"/>{{Update|section|date=December 2024}}
To display the date (in whatever format) of the last significant update to the page, use the second unnamed parameter (or name it <templatestyles src="Template:Nowrap/styles.css"/>|updated= or number it <templatestyles src="Template:Nowrap/styles.css"/>|2=): <templatestyles src="Template:Nowrap/styles.css"/>{{Update|updated=25 November 2024|date=December 2024}}
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: <templatestyles src="Template:Nowrap/styles.css"/>{{Update|date=December 2024}}
You can also do: <templatestyles src="Template:Nowrap/styles.css"/>{{Update|{{subst :DATE}}}}
To explain that the article now has inaccuracies (not just missing information) due to being outdated, use <templatestyles src="Template:Nowrap/styles.css"/>|inaccurate=yes: <templatestyles src="Template:Nowrap/styles.css"/>{{Update|inaccurate=yes|date=December 2024}}
To link to a particular section of the talk page where the update is being discussed, use <templatestyles src="Template:Nowrap/styles.css"/>|talk=Section title (<templatestyles src="Template:Nowrap/styles.css"/>|talksection= and <templatestyles src="Template:Nowrap/styles.css"/>|discuss= are equivalent to <templatestyles src="Template:Nowrap/styles.css"/>|talk=): <templatestyles src="Template:Nowrap/styles.css"/>{{Update|talk=Shall we update this for 2024?|date=December 2024}}
To display a reason, use <templatestyles src="Template:Nowrap/styles.css"/>|reason=a short comment here, e.g. <templatestyles src="Template:Nowrap/styles.css"/>{{Update|reason=Is missing the December 2024 election results|date=December 2024}}
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=September 2024|date=December 2024}}

Example

<templatestyles src="Template:Nowrap/styles.css"/>{{Update|documentation|date=December 2024}}

[[Category:Outdated pages{{#translation:}}]]

The template detects which namespace it is used in and changes accordingly:

Article

[[Category:Outdated pages{{#translation:}}]]

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Update

[[Category:TemplateData documentation{{#translation:}}]]

<templatedata> { "description": "Use this tag to alert readers that the article is out of date and may need updating.", "params": { "date": { "label": "Month and year", "description": "Provides the month and year of the update request; e.g., 'January 2018', but not 'jan18'", "type": "string", "required": false, "autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}", "suggested": true }, "updated": { "aliases": [ "2" ], "label": "Last updated", "description": "Date of last significant update", "type": "date" }, "inaccurate": { "label": "Inaccurate?", "description": "Use 'yes' if the article has inaccuracies due to being out of date.", "example": "yes", "type": "boolean" }, "talksection": { "aliases": [ "discuss", "talk" ], "label": "Talk page section", "description": "Section name on talk page where the discussion takes place", "type": "string" }, "reason": { "label": "Reason", "description": "Explanation why the article is out of date", "type": "content", "suggested": true }, "part": { "aliases": [ "1" ], "label": "Type (section)", "description": "Part that needs updating (e.g. to replace the word \"article\", often \"section\")", "example": "section", "type": "string", "default": "article", "autovalue": "", "suggested": true }, "type": { "label": "Type", "description": "Type of page, overriding SUBJECTSPACE", "type": "string", "example": "article", "suggested": false }, "demospace": { "label": "Demospace", "description": "", "type": "string", "required": false }, "cat": { "label": "Cat", "description": "Only required if a specific maintenance category is needed.", "type": "string", "required": false } }, "format": "inline", "paramOrder": [ "part", "date", "updated", "inaccurate", "talksection", "reason", "demospace", "cat", "type" ] } </templatedata>

Alternatives

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