Template:Update/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
meta>Thnidu
Clarified misleading instructions for use in reference to a section
Ookami (talk | contribs)
m 128 revisions imported
 
(18 intermediate revisions by 15 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
{{High-use| 15,000+ }}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
{{High-use| 20176 }}
{{Twinkle standard installation}}
{{Twinkle standard installation}}
{{Lua|Module:Unsubst}}
{{Lua|Module:Unsubst}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
===Usage===
==Usage==
This template can be used to mark articles or sections with old or out-of-date information.
This template can be used to mark articles or sections with old or out-of-date information.


;To specify what parts of the page need updating, use the first unnamed parameter (or name it {{para|part}} or number it {{para|1}}){{colon}}
* To specify what parts of the page need updating, use the first unnamed parameter (or name it {{para|part}} or number it {{para|1}}): {{tlc|{{BASEPAGENAME}}|part{{=}}the later-life and death material and the <nowiki>[[#Legacy|Legacy]]</nowiki> section|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
: {{tnull|Update|'''part{{=}}The later-life and death material and the <nowiki>[[#Legacy|Legacy]]</nowiki> section'''|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
* To use the template in one specific section, and change its wording to refer to the section instead of the page, use {{para||section}} and insert the template at the top of the section: {{tlc|{{BASEPAGENAME}}|section|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
;To use the template in one specific section, and change its wording to refer to the section instead of the page, use {{para||section}} (this is a special case of {{para|1}} a.k.a. {{para|part}}, above). Insert the template at the top of the page{{colon}}
* To display the date (in whatever format) of the last significant update to the page, use the second unnamed parameter (or name it {{para|updated}} or number it {{para|2}}): {{tlc|{{BASEPAGENAME}}|updated{{=}}{{#time:j F Y|-1 month}}|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
: {{tnull|Update|'''section'''|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
*: Note: The parameter name or number must be used if the first numbered/unnamed parameter is not used.
;To display the date (in whatever format) of the last significant update to the page, use the second unnamed parameter (or name it {{para|updated}} or number it {{para|2}}){{colon}}
* To add the date when the tag was added (this is used for cleanup categorization), use: {{tlc|{{BASEPAGENAME}}|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
: {{tnull|Update|'''updated{{=}}{{#time:j F Y|-1 month}}'''|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
*: You can also do: {{tlc|{{BASEPAGENAME}}|{{tls|DATE}}}}
: '''Note:''' The parameter name or number must be used if the first numbered/unnamed parameter is not used.
* To explain that the article now has inaccuracies (not just missing information) due to being outdated, use {{para|inaccurate|yes}}: {{tlc|{{BASEPAGENAME}}|inaccurate{{=}}yes|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
;To add the date when the tag was added (this is used for cleanup categorization), use{{colon}}
* 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}}): {{tlc|{{BASEPAGENAME}}|talk{{=}}Shall we update this for {{CURRENTYEAR}}?|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
: {{tnull|Update|'''date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}'''}}
* To display a reason (after the added phrase "In particular{{colon}}"), use {{para|reason|{{var|a short comment here}}}}, e.g. {{tlc|{{BASEPAGENAME}}|reason{{=}}Is missing the {{CURRENTMONTHNAME}} {{CURRENTYEAR}} election results|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
: You can also do: <code><nowiki>{{Update|{{subst:DATE}}}}</nowiki></code>
* These parameters can be combined, of course: {{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}}}}
;To explain that the article now has inaccuracies (not just missing information) due to being outdated, use {{para|inaccurate|yes}}{{colon}}
: {{tnull|Update|'''inaccurate{{=}}yes'''|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
;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}}){{colon}}
: {{tnull|Update|'''talk{{=}}Shall we update this for {{CURRENTYEAR}}?'''|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
;To display a reason (after the added phrase "In particular{{colon}}"), use {{para|reason|{{var|a short comment here}}}}, e.g.{{colon}}
: {{tnull|Update|'''reason{{=}}Is missing the {{CURRENTMONTHNAME}} {{CURRENTYEAR}} election results'''|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
; These parameters can be combined, of course{{colon}}:
: {{tnull|Update |part{{=}}The <nowiki>[[#Production|Production]]</nowiki> section and follow-on material&nbsp;|reason{{=}}the film is released, so this needs a "Critical reception" section, too&nbsp;|inaccurate{{=}}yes&nbsp;|talk{{=}}Post-release updating&nbsp;|updated{{=}}{{#time:F Y|-3 month}}&nbsp;|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}


===Example===
==Example==
{{tlx|Update|documentation|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
{{tlc|{{BASEPAGENAME}}|documentation|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
{{Update|documentation}}
{{{{BASEPAGENAME}}|documentation}}


The template detects which [[Wikipedia:Namespace|namespace]] it is used in and changes accordingly:
The template detects which [[Wikipedia:Namespace|namespace]] it is used in and changes accordingly:
{| class="wikitable"
{| class="wikitable"
! Article
! Article
| {{Update|type=article|demospace=main|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
| {{{{BASEPAGENAME}}|type=article|demospace=main|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
|-
|-
! Category
! Category
| {{Update|type=category|demospace=category|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
| {{{{BASEPAGENAME}}|type=category|demospace=category|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
|-
|-
! Template
! Template
| {{Update|type=template|demospace=template|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
| {{{{BASEPAGENAME}}|type=template|demospace=template|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
|}
|}


{{tlx|Update|section}} produces:
{{tlc|{{BASEPAGENAME}}|section}} produces:
{| class="wikitable"
{| class="wikitable"
! Article
! Article
| {{Update|section|type=article|demospace=main|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
| {{{{BASEPAGENAME}}|section|type=article|demospace=main|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
|-
|-
! Category
! Category
| {{Update|section|type=category|demospace=category|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
| {{{{BASEPAGENAME}}|section|type=category|demospace=category|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
|-
|-
! Template
! Template
| {{Update|section|type=template|demospace=template|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
| {{{{BASEPAGENAME}}|section|type=template|demospace=template|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
|}
|}


Line 58: Line 51:
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]].


{{tlx|Update|2=inaccurate=yes}}
{{tlc|{{BASEPAGENAME}}|2=inaccurate=yes}}
{{Update|type=article|demospace=main|inaccurate=yes}}
{{{{BASEPAGENAME}}|type=article|demospace=main|inaccurate=yes}}
 
==TemplateData==
{{TemplateDataHeader}}
<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 citation 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
},
"type": {
"aliases": [
"part",
"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
},
"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": [
"type",
"date",
"updated",
"inaccurate",
"talksection",
"reason",
"demospace",
"cat"
]
}
</templatedata>


===Alternatives===
==Alternatives==
* {{tl|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]].
* {{tl|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 [[Wikipedia:Template messages/Cleanup#Time-sensitive]] for alternatives unrelated to out-of-date information.


===See also===
==See also==
* {{tl|As of}}
* {{tl|As of}}
* {{tl|Current}}
* {{tl|Current}}
Line 74: Line 150:
* {{tl|Updated}}
* {{tl|Updated}}
* {{tl|When}}
* {{tl|When}}
* {{tl|Incomplete}}
* {{tl|Missing information}}


<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
<includeonly>{{sandbox other||
| <!-- ADD CATEGORIES BELOW THIS LINE -->
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Cleanup templates]]
[[Category:Cleanup templates]]
[[Category:Dispute templates]]
[[Category:Dispute templates]]

Latest revision as of 13:59, 3 September 2020

Usage

This template can be used to mark articles or sections with old or out-of-date information.

  • 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=27 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 (after the added phrase "In particular:"), 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, of course: {{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}} 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}}

TemplateData

This is the TemplateData for this template, used by TemplateWizard, VisualEditor and other tools.
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)type 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 citation 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

Alternatives

See also