Template:Cleanup/doc

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.

[[Category:Template documentation pages{{#translation:}}]]

This is the {{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:

This page needs to be cleaned up or reorganized.

While on talk pages it looks like this:

This page needs to be cleaned up or reorganized.

Usage

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

You may use the optional date parameter, e.g. {{Cleanup|date=November 2024}}. 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 {{Cleanup| {{subst:DATE}} }} at the top of the article or talk page, or use {{subst:Cleanup-now}}.

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 being bold and fixing it yourself, rather than applying this tag and leaving it for someone else to clean up.

Notes

For section cleanup, use {{Cleanup-section }}.
This template will add tagged articles to Category:All pages needing cleanup and, if date is not specified, Category:Wikipedia cleanup (from which the bot will move them to appropriate subcategory of Category:Cleanup by month).
This template is a self-reference.
Please do not subst: this template.
Use this tag when the article needs improvement per WP:BETTER. Articles that violate policy need more direct action.

Redirects

Several names redirect redirect here and can be used as alternative names for this template. Although using this template's real name is probably the least confusing.

Transclusions

{{Cleanup-now }} – Automatically adds the current month and year. Note: Always "subst:" that template.