View source for Template:Cleanup/doc

{{Documentation subpage|defaultsort = τ}}
<includeonly>{{high-use|28,000+}}</includeonly>
{{Twinkle standard installation}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

=== 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 tagged for cleanup.

For example, {{Tlx|Cleanup|reason{{=}}the article is full of incorrect capitalisation|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} would display as:
{{Cleanup|article|reason=the article is full of incorrect capitalisation|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|demospace=main|nocat=true}}

The template should be placed at the top of the article requiring a cleanup. If practicable, please use a [[Wikipedia: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 [[Wikipedia:Namespace|namespace]] it is used in and changes accordingly:
! Article
| {{Cleanup|article|reason=Lorem ipsum dolor sit amet|demospace=main|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|nocat=true}}
|-
! Category
| {{Cleanup|category|reason=Lorem ipsum dolor sit amet|demospace=category|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|nocat=true}}
|-
! Template
| {{Cleanup|template|reason=Lorem ipsum dolor sit amet|demospace=other|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|nocat=true}}
|}

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.

Do not [[Wikipedia: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 [[:Category:Articles needing cleanup]] 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|Cleanup AfD}} - For AfD discussions that closed as "keep," but require cleanup
* {{Tl|Cleanup image}} – For images that need clean-up
* {{Tl|Multiple issues}}
* {{Tl|Spacing}}
* [[Wikipedia:Clarify the cleanup]]
* [[Wikipedia:Cleanup process]]
* [[Wikipedia:Template messages/Cleanup]]

=== Redirects ===
* {{Tl|Cleanup-article}}

<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Cleanup templates|Cleanup]]
[[Category:Exclude in print|Τ Cleanup]]
{{DEFAULTSORT:Τ Cleanup}}

[[ar:قالب:إعادة كتابة]]
[[as:Template:Cleanup]]
[[az:Şablon:Təmizləmə]]
[[ca:Plantilla:Millorar]]
[[cs:Šablona:Upravit]]
[[de:Vorlage:Überarbeiten]]
[[el:Πρότυπο:Επιμέλεια]]
[[eo:Ŝablono:Polurinda]]
[[fa:الگو:تمیزکاری]]
[[fr:Modèle:À recycler]]
[[he:תבנית:לשכתב]]
[[ia:Patrono:Polimento]]
[[id:Templat:Rapikan]]
[[ja:Template:Cleanup]]
[[ka:თარგი:გასაწმენდი]]
[[ko:틀:정리 필요]]
[[mk:Шаблон:Внимание]]
[[ms:Templat:Cleanup]]
[[nl:Sjabloon:Wiu]]
[[no:Mal:Opprydning]]
[[pl:Szablon:Dopracować]]
[[pt:Predefinição:Reciclagem]]
[[ro:Format:Curăţenie]]
[[ru:Template:Cleanup]]
[[simple:Template:Cleanup]]
[[sl:Predloga:Popravi]]
[[ckb:داڕێژە:خاوێنکردن]]
[[sv:Mall:Städa]]
[[th:แม่แบบ:ช่วยดูหน่อย]]
[[uk:Template:Cleanup]]
[[vi:Tiêu bản:Cần sửa lại]]
[[wuu:Template:清理]]
[[zh-yue:Template:清理]]
[[zh:Template:Cleanup]]
</includeonly>