View source for Template:Cleanup rewrite/doc

{{Documentation subpage}}
{{tsh|clre}}
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->
{{High-use}}
{{Never substitute}}
This template should be used on articles which need so much cleanup that rewriting them completely may be necessary to comply with Wikipedia's guidelines on style and content.  It is strongly encouraged that the editor adding the tag discuss the issue on the article's talk page, especially if the writing appears superficially acceptable.

== Usage ==

To provide a reason for the needed rewrite, use:

{{tnull|Cleanup rewrite|Reason for rewrite|article or section|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
{{Cleanup rewrite|Reason for rewrite|article or section}}


To mark a section for rewrite without a reason, use:

{{tnull|Cleanup rewrite|2{{=}}section|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
{{Cleanup rewrite|2=section}}


To mark an article for rewrite without a reason, use:

{{tnull|Cleanup rewrite|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
{{Cleanup rewrite}}


This template adds tagged articles to [[:Category:Wikipedia articles needing rewrite]].<br />
It should not be [[Wikipedia:Subst|subst]]'d.

== Tracking categories ==
* {{clc|All articles needing rewrite}}

== Aliases ==
* [[Template:Section rewrite]]
* <span class="plainlinks">[{{fullurl:Special:WhatLinksHere/Template:Cleanup_rewrite|hidetrans=1&hidelinks=1&limit=500}} Also known as...]</span> (list of all redirects to this template that may also be used)

== See also ==
{{Div col}}
* [[Template:Citation style]]
* [[Template:Cleanup list]]
* [[Template:Confusing]]
* [[Template:Context]]
* [[Template:Copy edit]]
* [[Template:Fiction]]
* [[Template:Globalize]]
* [[Template:Notability]]
* [[Template:Primary sources]]
* [[Template:Rewriting]]
* [[Template:Self-contradictory]]
* [[Template:Technical]]
* [[Template:Tone]]
* [[Template:Uncategorized]]
* [[Template:Underlinked]]
* [[Template:Unreferenced]]
{{Div col end}}
* [[Wikipedia:Template index/Cleanup]]

== TemplateData ==
{{TemplateData header}}
<templatedata>
{
	"description": "Use this cleanup template to indicate that an article may need to be rewritten to comply with Wikipedia's quality standards.",
	"format": "inline",
	"params": {
		"date": {
			"label": "Month and year",
			"description": "The month and year that the template was placed (in full). \"{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}\" inserts the current month and year automatically.",
			"type": "line",
			"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}",
			"example": "January 2013",
			"suggested": true
		},
		"1": {
			"label": "Reason",
			"description": "The reason why the article may need to be rewritten",
			"type": "string",
			"example": "it is mostly incomprehensible"
		},
		"section": {
			"label": "Section?",
			"description": "Enter \"yes\" here to replace the word \"article\" with \"section\".",
			"type": "line",
			"autovalue": "yes",
			"example": "yes"
		},
		"2": {
			"label": "Affected area",
			"description": "Custom text to replace the word \"article\" in the template",
			"type": "line",
			"example": "section"
		},
		"small": {
			"label": "Make template small",
			"description": "Enter \"left\" here to make the template box small and aligned to the left.",
			"type": "line",
			"autovalue": "left",
			"example": "left"
		}
	},
	"paramOrder": [
		"date",
		"1",
		"section",
		"2",
		"small"
	]
}
</templatedata>

<includeonly>{{Sandbox other||
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
[[Category:Cleanup templates|{{PAGENAME}}]]

}}</includeonly>