Template:Cleanup/doc
This is a documentation subpage for Template:Cleanup. It contains usage information, categories, interlanguage links and other content that is not part of the original template page. |
This template should not be substituted. |
This template is used on 30,000+ pages, and changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in a user subpage, and consider discussing changes at the talk page before implementing them. |
This template is used by the standard installation of Twinkle. If you are planning to make major changes to this template or nominate it for deletion, please notify Twinkle's user base and maintainers at Wikipedia talk:Twinkle as a courtesy. |
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. The first character of the reason (immediately after the equals sign) should be lowercase, in order to preserve the sentence flow when rendered.
- date: the month and year (e.g. November 2024) 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 problem(s) being fixed if it is not possible to identify what needs to be cleaned-up.
Do not substitute this template.
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.
Articles that violate policy need more direct action. Other templates, such as {{POV}}, are better suited to content disputes.
Examples
For example, {{Cleanup|reason=the article is full of incorrect capitalization|date=November 2024}}
would display as:
This article needs to be cleaned up. Reason: the article is full of incorrect capitalization. |
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.
For tracking purposes it also categorises the page according to whether a reason code has been given.
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.
See also
- {{Cleanup AfD}} - For AfD discussions that closed as "keep", but require cleanup
- {{Cleanup image}} – For images that need clean-up
- {{Multiple issues}}
- {{Spacing}}
- Wikipedia:Clarify the cleanup
- Wikipedia:Cleanup process
- Wikipedia:Template messages/Cleanup
Redirects
- Template:Attention
- Template:Attention (on talk page)
- Template:Attention see talk
- Template:Attn
- Template:CU
- Template:Clean
- Template:Clean up
- Template:Clean-up
- Template:Cleancat
- Template:Cleanup-article
- Template:Cleanup-because
- Template:Cleanup-date
- Template:Cleanup-quality
- Template:Cleanup-reason
- Template:Cleanup-since
- Template:Clu
- Template:Cu
- Template:Improve
- Template:Index-cleanup
- Template:Quality
- Template:Tidy