View source for Template:Cleanup/doc

{{Documentation subpage|defaultsort = τ}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{Twinkle standard installation}}

===Usage===
{{Tlx|Cleanup}} can be used on its own, or with the following two optional parameters:
* <tt>reason</tt>: 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.
* <tt>date</tt>: the month and year (e.g. {{CURRENTMONTHNAME}} {{CURRENTYEAR}}) when the Cleanup template was added to the article; this helps to figure out how long an article has been flagged <!-- find a better synonym for "flagged" -->for cleanup.

For example, {{Tlx|Cleanup|<nowiki>reason=the article is full of incorrect capitalisation</nowiki>|<nowiki>date=January 2011</nowiki>}} would display as:
{{Cleanup|article|reason=the article is full of incorrect capitalisation|date=January 2011|demospace=main}}

The template should be placed at the top of the article requiring a cleanup. If practicable, please use a [[MediaWiki:Template messages/Cleanup|more specific cleanup template]]. Because {{Tlx|Cleanup}} is general <!-- find a better term for "general" -->, specific problems should be identified in the <tt>reason</tt> field; a more detailed explanation of what needs to be done can be provided on the article's talk page. An article's {{Tlx|Cleanup}} template may be removed without the problem(s) being fixed if it is not possible to identify what needs to be cleaned-up.

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

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

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.

This [[MediaWiki:Template|template]] is a [[MediaWiki:Avoid self-references|self-reference]].

Do not [[MediaWiki:Subst|substitute]] this template.

Use this tag when the article needs improvement per [[WP:BETTER]]. Articles that violate policy need more direct action.

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

==== 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.

=== See also ===
* {{Tl|Multiple issues}}
* {{Tl|Spacing}}
* {{Tl|Cleanup image}} – For images that need clean-up.
* {{Tl|Cleanup afd}} - For AfD discussions that closed as "keep," but require cleanup.
* {{Tl|Cleanup section}}

* [[MediaWiki:Cleanup process]]
* [[MediaWiki:Template messages/Cleanup]]
* [[MediaWiki:Clarify the cleanup]]

<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Cleanup templates|Cleanup]]
</includeonly>