Misplaced Pages

Template:Cleanup

Article snapshot taken from[REDACTED] with creative commons attribution-sharealike license. Give it a read and then ask your questions in the chat. We can research this topic together.

This is the current revision of this page, as edited by SWinxy (talk | contribs) at 00:16, 15 March 2024 (Use Special:EditPage). The present address (URL) is a permanent link to this version.

Revision as of 00:16, 15 March 2024 by SWinxy (talk | contribs) (Use Special:EditPage)(diff) ← Previous revision | Latest revision (diff) | Newer revision → (diff)
This article may require cleanup to meet Misplaced Pages's quality standards. Relevant discussion may be found on the talk page. No cleanup reason has been specified. Please help improve this template if you can. (January 2025) (Learn how and when to remove this message)
Template documentation[view] [edit] [history] [purge]
This template should be substituted only if you want to automatically add the "date=" parameter.
WarningThis template is used on approximately 9,300 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.
Logo of Twinkle; Police ManAny breaking changes to this template, including moving it or nominating it for deletion, must be communicated in advance to Twinkle's users and maintainers at Misplaced Pages talk:Twinkle. The standard installation of Twinkle relies on this template. Thank you.
This template uses Lua:

When to use

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.

Articles that violate policy need more direct action. Other templates, such as {{POV}}, are better suited to content disputes.

Alternatives

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.

If you feel that an article needs a significant amount of cleanup, you can post it to WikiProject Cleanup. It is more effective than using {{Cleanup}} as there is a backlog for the tags. Editors will give your submitted article a cleanup and fix any problems associated with it.

How to use

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

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

Optional parameters include:

  • |talk= or |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. This parameter's value is not used when {{Cleanup}} appears inside {{Multiple issues}}.
  • |1= (or an empty parameter): changes the default descriptor (i.e., "article"). For example, {{Cleanup|section}} changes it to "section".
  • |small=: enter 'left' here to turn the template into a small box on the left side of the screen.
  • |nocat=: enter 'true' here to prevent the template from adding cleanup categories to the article.

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.

Examples

For example, {{Cleanup|reason=The article is full of incorrect capitalization.|date=January 2025}} would display as:

This article may require cleanup to meet Misplaced Pages's quality standards. The specific problem is: The article is full of incorrect capitalization. Relevant discussion may be found on the talk page. Please help improve this article if you can. (January 2025) (Learn how and when to remove this message)
(although {{copyedit}} would be the more appropriate tag to use in that specific case)
The template detects which namespace it is used in and changes accordingly:
Article
This article may require cleanup to meet Misplaced Pages's quality standards. The specific problem is: lorem ipsum dolor sit amet. Relevant discussion may be found on the talk page. Please help improve this article if you can. (January 2025) (Learn how and when to remove this message)
Category
This category may require cleanup to meet Misplaced Pages's quality standards. The specific problem is: lorem ipsum dolor sit amet! Please help improve this category if you can; the talk page may contain suggestions.
Template
This template may require cleanup to meet Misplaced Pages's quality standards. The specific problem is: lorem ipsum dolor sit amet? Please help improve this template if you can; the talk page may contain suggestions.

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

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Cleanup in articles based on its TemplateData.

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
Month and yeardate

The month and year that the template was placed (in full). "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}" inserts the current month and year automatically.

Example
January 2013
Auto value
{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}
Linesuggested
Reasonreason

Reason for requesting cleanup

Example
The article is full of incorrect capitalization.
Stringrequired
Talk page sectiontalk talksection

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

Stringoptional
Make template smallsmall

Enter "left" here to make the template box small and aligned to the left.

Example
left
Auto value
left
Lineoptional
Affected area1

Text to replace the word "article", usually "section"

Example
section
Auto value
section
Lineoptional
No categorynocat

Suppress categorization

Example
true
Auto value
true
Stringoptional

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.

Tracking categories

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

See also

Redirects

Wrappers

The above documentation is transcluded from Template:Cleanup/doc. (edit | history)
Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages.
Add categories to the /doc subpage. Subpages of this template. Categories:
Template:Cleanup Add topic