View source for Template:Cleanup/doc

{{Documentation subpage}}

This is the {{tl|cleanup}} template.

Note: this generic template '''should only be used when a more specific tag is not suitable'''.

=== Placement ===

For articles needing major clean-up, place at the top of the article to alert readers.

For articles needing minor clean-up, place at the top of the talk page to alert editors.

This template automatically detects which namespace it is used in and changes style accordingly. That means that on articles it looks like this:

{{Cleanup| demospace=main | category= }}

While on talk pages it looks like this:

{{Cleanup| demospace=talk | category= }}

=== Usage ===

You can optionally use the first parameter to change the word "article",  for instance {{tl|cleanup|section}} or {{tl|cleanup|disambiguation page}}. (Although for sections we have the {{tl|cleanup-section}}.)

You may use the optional date parameter, e.g. <code><nowiki>{{Cleanup|</nowiki>date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki>}}</nowiki></code>. This helps with the categorisation of articles requiring cleanup.  Articles tagged with this template without this parameter will be given the parameter by a bot.

The simplest way to add this template to an article is to copy and paste<code> <nowiki>{{Cleanup|date=January 2009}}</nowiki></code> at the top of the article or talk page, or use <code><nowiki>{{subst:Cleanup-now}}</nowiki></code>.

Add a new item 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 tag.

=== Alternative ===

If the problem is correctable with the skills you already possess, consider fixing it yourself, rather than applying this tag and leaving it for someone else to clean up.

=== Notes ===

* For section cleanup, use {{tl|cleanup-section}}.
* This template will add tagged articles to [[:Category:All pages needing cleanup]] and, if date is not specified, [[:Category:Lockwiki cleanup]].
* This template is a self-reference.
*Use this tag when the article needs improvement. Articles that violate policy need more direct action.

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