Jump to content

Template:Cleanup/doc: Difference between revisions

From BadWolfMC Wiki
Line 18: Line 18:


===When to use===
===When to use===
This tag is intended to identify pages that need wikification or the correction of spelling, grammar, typographical errors, tone, and other similar, non-content-focused changes. Use this tag when the article needs improvement per [[WP:BETTER]].  
This tag is intended to identify pages that need wikification or the correction of spelling, grammar, typographical errors, tone, and other similar, non-content-focused changes. Use this tag when the article needs improvement per [[Wikipedia:Writing_better_articles]].  


Articles that violate policy need more direct action. Other templates, such as {{tl|POV}}, are better suited to content disputes.
Articles that violate policy need more direct action. Other templates, such as {{tl|POV}}, are better suited to content disputes.


==== Alternative ====
==== Alternative ====
If the problem is correctable with the skills you already possess, consider being [[WP:SOFIXIT|bold]] and fixing it yourself, rather than applying this template and leaving it for someone else to clean up.
If the problem is correctable with the skills you already possess, consider being [[Wikipedia:Be_bold|bold]] and fixing it yourself, rather than applying this template and leaving it for someone else to clean up.


=== Examples ===
=== Examples ===
Line 87: Line 87:
* {{Tl|Tidy}}
* {{Tl|Tidy}}
}}
}}
<templatedata>
{
"params": {
"1": {},
"2": {},
"": {},
"reason": {},
"nocat": {
"type": "wiki-template-name"
},
"small": {},
"talk": {},
"talksection": {
"type": "unknown"
},
"demospace": {}
}
}
</templatedata>
===== Heading text =====
===== Heading text =====


Line 112: Line 93:
** {{Tl|Cleanup-section}}
** {{Tl|Cleanup-section}}
** {{Tl|Clean-up section}}
** {{Tl|Clean-up section}}
<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Cleanup templates|Cleanup]]
[[Category:Exclude in print|Τ Cleanup]]
[[az:Şablon:Təmizləmə]]
</includeonly>
<templatedata>
{
"params": {
"1": {},
"2": {},
"": {},
"date": {},
"reason": {},
"nocat": {},
"small": {},
"talk": {},
"talksection": {},
"demospace": {}
},
"description": "This tag is intended to identify pages that need wikification or the correction of spelling, grammar, typographical errors, tone, and other similar, non-content-focused changes. Use this tag when the article needs improvement per WP:BETTER."
}
</templatedata>

Revision as of 07:36, 6 May 2025

Usage

{{Cleanup}} should be used with the following two parameters:

  • |reason=: the reason for requesting cleanup. This is useful for editors in case the reason for requesting a cleanup is not immediately obvious.
  • |date=: the month and year (e.g. May 2026) when the Cleanup template was added to the article; this helps to figure out how long an article has been tagged for cleanup.

Optional parameters include:

  • |talksection=: the section of the talk page explaining what needs to be done. Add a new section to the talk page explaining the type and extent of clean-up required so editors will know what to address, and when to remove this template.

The template should be placed at the top of the article requiring a cleanup. If practicable, please use a more specific cleanup template. Because {{Cleanup}} is vague, specific problems should be identified in the reason field; a more detailed explanation of what needs to be done can be provided on the article's talk page. An article's {{Cleanup}} template may be removed without the problems being fixed if it is not possible to identify what needs to be cleaned up.

If this template is substituted, the end result consists of an unsubstituted form including an automatically filled date= parameter with the current date.

When to use

This tag is intended to identify pages that need wikification or the correction of spelling, grammar, typographical errors, tone, and other similar, non-content-focused changes. Use this tag when the article needs improvement per Wikipedia:Writing_better_articles.

Articles that violate policy need more direct action. Other templates, such as {{POV}}, are better suited to content disputes.

Alternative

If the problem is correctable with the skills you already possess, consider being bold and fixing it yourself, rather than applying this template and leaving it for someone else to clean up.

Examples

For example, {{Cleanup|reason=the article is full of incorrect capitalization.|date=May 2026}} would display as:

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

The descriptor (on the preceding example "template") can be changed from its default using the first parameter, for instance {{Cleanup|section}} or {{Cleanup|disambiguation page}}.

Categorization

This template will add pages on which it is used to a specific category Category:Articles needing cleanup containing pages needing cleanup or a dated subcategory thereof.

Tracking categories

For tracking purposes it also categorises the page according to whether a reason code has been given.

See also

Redirects

Heading text

Wrappers