View source for Template:Cleanup/doc

{{Documentation subpage}}
{{Substitution| |only if you want to automatically add the "date{{=}}" parameter}}
{{high-use|12993}}
{{Twinkle standard installation}}
{{Lua|Module:Unsubst}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

==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 {{tl|POV}}, are better suited to content disputes.

=== Alternatives ===
If the problem is correctable with the skills you already possess, consider being [[WP:bold|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 [[Wikipedia:Cleanup|WikiProject Cleanup]]. It is more effective than using {{ tlc |{{ ROOTPAGENAME }}}} 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 ==
{{Tlc|{{ROOTPAGENAME}}}} should be used with the following two parameters:
* {{para|date}}: 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.
* {{para|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:
* {{para|talk}} or {{para|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.
* {{para|1}} (or an empty parameter): changes the default descriptor (i.e., "article"). For example, {{tlx|Cleanup|section}} changes it to "section".
* {{para|small}}: enter 'left' here to turn the template into a small box on the left side of the screen.
* {{para|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 [[Wikipedia:Template messages/Cleanup|more specific cleanup template]]. Because {{Tlc|{{ROOTPAGENAME}}}} is vague, specific problems should be identified in the <code>reason</code> field; a more detailed explanation of what needs to be done can be provided on the article's talk page. An article's {{Tlc|{{ROOTPAGENAME}}}} 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 [[Wikipedia:Subst|substituted]], the end result consists of an unsubstituted form including an automatically filled <code>date=</code> parameter with the current date.

== Examples ==
For example, {{Tlc|{{ROOTPAGENAME}}|reason{{=}}the article is full of incorrect capitalization.|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} would display as:
{{Cleanup|article|reason=the article is full of incorrect capitalization.|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|demospace=main|nocat=true}}

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

== TemplateData ==
{{TemplateData header}}
<templatedata>
{
	"description": "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.",
	"format": "inline",
	"params": {
		"date": {
			"label": "Month and year",
			"description": "Month and year the template was added to the page",
			"type": "string",
			"autovalue": "{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}",
			"example": "January 2018",
			"required": true
		},
		"reason": {
			"aliases": [
				"2"
			],
			"label": "Reason",
			"description": "Reason for requesting cleanup",
			"type": "string",
			"example": "The article is full of incorrect capitalization.",
			"required": true
		},
		"talk": {
			"aliases": [
				"talksection"
			],
			"label": "Talk page section",
			"description": "The section of the talk page explaining what needs to be done",
			"type": "string"
		},
		"small": {
			"label": "Small",
			"description": "Enter 'left' here to turn the template into a small box on the left side of the screen.",
			"type": "string",
			"autovalue": "left",
			"example": "left"
		},
		"1": {
			"label": "Type (e.g., section)",
			"description": "Text to replace the word \"article\", usually \"section\"",
			"type": "string",
			"autovalue": "section",
			"example": "section"
		},
		"nocat": {
			"label": "No category",
			"description": "Suppress categorization",
			"type": "string",
			"autovalue": "true",
			"example": "true"
		}
	},
	"paramOrder": [
		"date",
		"reason",
		"talk",
		"small",
		"1",
		"nocat"
	]
}
</templatedata>

== 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 ===
* {{clc|All pages needing cleanup}}

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

== See also ==
* {{Tl|Cleanup AfD}} – For AfD discussions that closed as "keep", but require cleanup
* {{Tl|Cleanup image}} – For images that need cleanup
* {{Tl|Cleanup reorganize}} – For articles that need a reorganization in addition to cleanup
* {{Tl|Cleanup see also}} – For "See also" sections
* {{Tl|Cleanup merge}} – After mergers.
* {{Tl|Multiple issues}}
* {{Tl|Spacing}}
* [[Wikipedia:Clarify the cleanup]]
* [[Wikipedia:Cleanup process]]
* [[Wikipedia:Template messages/Cleanup]]
* ''[[Template:Cleanup template documentation see also section generic list|List of cleanup templates]]''

== Redirects ==
{{Columns-list|colwidth=15em|
* {{Tl|Attention}}
* {{Tl|Attention (on talk page)}}
* {{Tl|Attention see talk}}
* {{Tl|Attn}}
* {{Tl|CU}}
* {{Tl|Clean}}
* {{Tl|Clean up}}
* {{Tl|Clean-up}}
* {{Tl|Cleancat}}
* {{Tl|Cleanup-article}}
* {{Tl|Cleanup-because}}
* {{Tl|Cleanup-date}}
* {{Tl|Cleanup-quality}}
* {{Tl|Cleanup-reason}}
* {{Tl|Cleanup-since}}
* {{Tl|Clu}}
* {{Tl|Cu}}
* {{Tl|Improve}}
* {{Tl|Index-cleanup}}
* {{Tl|Quality}}
* {{Tl|Tidy}}
}}

== Wrappers ==
* {{Tl|Cleanup section}}
** {{Tl|Cleanup-section}}
** {{Tl|Clean-up section}}

<includeonly>{{sandbox other||
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Cleanup templates|Cleanup]]
[[Category:Exclude in print|Τ Cleanup]]
[[az:Şablon:Təmizləmə]]
[[Category:Templates_that_are_not_mobile_friendly]]
}}</includeonly>