Template:Cleanup/doc: Difference between revisions
m Reverted edits by 166.181.3.86 (talk) (HG 3) |
Changing to reflect that the coding requires a reason to be given and that date is optional. Correct me if I am wrong |
||
Line 7: | Line 7: | ||
=== Usage === |
=== Usage === |
||
{{Tlx|Cleanup}} |
{{Tlx|Cleanup}} must be used with the following parameter: |
||
* <tt>reason</tt>: the reason for requesting cleanup. |
* <tt>reason</tt>: the reason for requesting cleanup. You must specify a reason because what needs to be done may not be 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. |
||
⚫ | |||
Optional parameters include: |
Optional parameters include: |
||
⚫ | |||
* <tt>talksection</tt>: 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. |
* <tt>talksection</tt>: 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. |
||
Revision as of 11:32, 5 June 2014
![]() | This is a documentation subpage for Template:Cleanup. It may contain usage information, categories and other content that is not part of the original template page. |
![]() | This template should not be substituted. |
![]() | This template is used on 10,000+ pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
![]() | If you plan to make breaking changes to this template, move it, or nominate it for deletion, please notify Twinkle's users and maintainers at Wikipedia talk:Twinkle as a courtesy, as the standard installation of Twinkle adds and removes this template. Thank you! |
![]() | This template uses Lua: |
Usage
{{Cleanup}}
must be used with the following parameter:
- reason: the reason for requesting cleanup. You must specify a reason because what needs to be done may not be 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.
Optional parameters include:
- date: the month and year (e.g. August 2024) when the Cleanup template was added to the article; this helps to figure out how long an article has been tagged for cleanup.
- 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=August 2024}}
would display as:
![]() | This article may require cleanup to meet Wikipedia's quality standards. The specific problem is: the article is full of incorrect capitalization. (August 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.
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 cleanup
- {{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
Semiredirects