Open main menu

Template:Cleanup/doc

< Template:Cleanup

Post Articles on WP:CLEANEdit

If you feel that your article needs a significant amount of cleanup, you can post articles on WP:CLEAN (Project Cleanup) to have them cleaned by users. It is more effective than tagging as there is a backlog for the tags. Editors will give your submitted article a cleanup and fix any problems associated with it. Please submit at WP:CLEAN.

UsageEdit

{{Cleanup}} should be used with the following two parameters:

  • |reason=: the reason for requesting cleanup. This is useful for editors in case the reason for requesting a cleanup is not immediately obvious.
  • |date=: the month and year (e.g. November 2018) when the Cleanup template was added to the article; this helps to figure out how long an article has been tagged for cleanup.

Optional parameters include:

  • the first parameter: changes the default descriptor (i.e. "Article"). Example tl|Cleanup|section changes it to "Section". A wrapper is {{Cleanup section}}
  • |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 problems being fixed if it is not possible to identify what needs to be cleaned up.

If this template is substituted, the end result consists of an unsubstituted form including an automatically filled date= parameter with the current date.

When to useEdit

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.

AlternativeEdit

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.

ExamplesEdit

For example, {{Cleanup|reason=the article is full of incorrect capitalization.|date=November 2018}} would display as:

The template detects which namespace it is used in and changes accordingly:
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}}.

CategorizationEdit

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.

Tracking categoriesEdit

For tracking purposes it also categorises the page according to whether a reason code has been given.

See alsoEdit

RedirectsEdit

WrappersEdit

TemplateDataEdit

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly error report for this template.

TemplateData for Cleanup

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.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Datedate

Date the template was added to the page

Example
January 2018
Auto value
{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}
Stringrequired
Reasonreason2

Reason for requesting cleanup

Example
the article is full of incorrect capitalization
Stringrequired
Talk page sectiontalktalksection

the section of the talk page explaining what needs to be done

Stringoptional
Smallsmall

Small format

Example
left
Stringoptional
Type1

Type of page (e.g. article) or section

Stringoptional
No categorynocat

Suppress categorization

Example
true
Stringoptional