Template:Cleanup/doc: Difference between revisions
m 1 revision imported |
No edit summary |
||
| Line 2: | Line 2: | ||
{{Substitution| |only if you want to automatically add the "date{{=}}" parameter}} | {{Substitution| |only if you want to automatically add the "date{{=}}" parameter}} | ||
{{high-use|19,001+}} | {{high-use|19,001+}} | ||
{{Lua|Module:Unsubst}} | {{Lua|Module:Unsubst}} | ||
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> | ||
Revision as of 20:05, 16 July 2018
 | This is a documentation subpage for Template:Cleanup. It contains usage information, categories and other content that is not part of the original template page. |
 | This template should be substituted only if you want to automatically add the "date=" parameter. |
 | This template is used on approximately 19,000 pages, so changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Please consider discussing changes on the talk page before implementing them. |
 | This template uses Lua: |
Post Articles on WP:CLEAN
If you feel that your article needs a significant amount of cleanup, you can post articles on WP:CLEAN (Project Cleanup) to have them cleaned by users. It is more effective than tagging as there is a backlog for the tags. Editors will give your submitted article a cleanup and fix any problems associated with it. Please submit at WP:CLEAN.
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. December 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 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 WP:BETTER.
Articles that violate policy need more direct action. Other templates, such as , 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=December 2024}} would display as:
 | This article may require cleanup to meet BadWolfMC's quality standards. The specific problem is: the article is full of incorrect capitalization. (December 2024) |
| 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
- – For AfD discussions that closed as "keep", but require cleanup
- – For images that need cleanup
- – For articles that need a reorganization in addition to cleanup
- – For "See also" sections
- Wikipedia:Clarify the cleanup
- Wikipedia:Cleanup process
- Wikipedia:Template messages/Cleanup
- List of cleanup templates