Template:Update/doc

From TSP Encyclopedia
Revision as of 21:08, 30 April 2024 by LordGianni (talk | contribs) (1 revision imported)
Jump to navigation Jump to search

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 |part= or number it |1=): {{Update|part=the later-life and death material and the [[#Legacy|Legacy]] section|date=November 2024}}
  • 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=November 2024}}
  • 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=11 October 2024|date=November 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: {{Update|date=November 2024}}
    You can also do: {{Update|{{subst:DATE}}}}
  • To explain that the article now has inaccuracies (not just missing information) due to being outdated, use |inaccurate=yes: {{Update|inaccurate=yes|date=November 2024}}
  • 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 2024?|date=November 2024}}
  • To display a reason, use |reason=a short comment here, e.g. {{Update|reason=Is missing the November 2024 election results|date=November 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=August 2024|date=November 2024}}

Example

{{Update|documentation|date=November 2024}}

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

Article
Category
Template

{{Update|section|date=November 2024}} 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=November 2024}}

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Update in articles based on its TemplateData.

TemplateData for Update

Use this tag to alert readers that the article is out of date and may need updating.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Type (section)part 1

Part that needs updating (e.g. to replace the word "article", often "section")

Default
article
Example
section
Auto value
Stringsuggested
Month and yeardate

Provides the month and year of the update request; e.g., 'January 2018', but not 'jan18'

Auto value
{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}
Stringsuggested
Last updatedupdated 2

Date of last significant update

Dateoptional
Inaccurate?inaccurate

Use 'yes' if the article has inaccuracies due to being out of date.

Example
yes
Booleanoptional
Talk page sectiontalksection discuss talk

Section name on talk page where the discussion takes place

Stringoptional
Reasonreason

Explanation why the article is out of date

Contentsuggested
Demospacedemospace

Stringoptional
Catcat

Only required if a specific maintenance category is needed.

Stringoptional
Typetype

Type of page, overriding [[:mw:Help:Magic_words#Namespaces|SUBJECTSPACE]]

Example
article
Stringoptional

Alternatives

See also