Template:Cleanup/doc: Difference between revisions

VisualWikitext

Latest revision as of 01:52, 18 November 2025

Description: These articles should be reformatted or otherwise improved for grammar, typographical errors, organization, readability, and other non-content related changes.; Putting this template on a page also adds it to the Candidates for cleanup category.

Dependencies

Uses:

{{Banner}}

Syntax

reason (optional) - Reason why the page need cleanup, If omitted defaults to unspecified.

date (optional) - Month when the banner is placed

Sample output: {{Cleanup}} gives...

This article should be cleaned up or improved

{{Cleanup|Overly verbose with multiple redundancies}} gives...

This article should be cleaned up or improved.
The reason is: Overly verbose with multiple redundancies

{{Cleanup|Overly verbose with multiple redundancies|date= February 2017}} gives...

This article should be cleaned up or improved, as of February 2017.
The reason is: Overly verbose with multiple redundancies

{{Cleanup||date= February 2017}} gives...

This article should be cleaned up or improved, as of February 2017.
The reason is: unspecified

See also

{{Update}}, for pages which need facts checked, numbers updated, or entire sections altered, to reflect game changes.

Template data

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Banner to mark an article for reformatting, improve for grammar, typographical errors, organization, readability, and other non-content related changes. Putting this template on a page also adds it to the Candidates for cleanup category.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Reason	`1`	Reason why the article is in need of clean up or improvement Example Lots of spelling errors.	Content	suggested
Date	`date`	Date the banner is added or updated. In month year format. Shows Semantic MediaWiki code in preview, got fixed on save. Example June 2025 Auto value `{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}`	Date	suggested

@@ Line 1: / Line 1: @@
-;Description
+; Description
-:This template is used to indicate that the current page should be tidied up or improved. Pages may be marked for cleanup if they are outdated or poorly formatted, but still generally useful as an active page.
+: These articles should be reformatted or otherwise improved for grammar, typographical errors, organization, readability, and other non-content related changes.
+: Putting this template on a page also adds it to the [[:Category:Candidates for cleanup|Candidates for cleanup]] category.
+; Dependencies
+: Uses:
+:: {{Tl|Banner}}
 ;Syntax
-:Type <code>{{t|Cleanup}}</code> at the top of the page.
+: {{T|Cleanup|reason|3=date= month year}}
-;Sample output
+:: reason (optional) - Reason why the page need cleanup, If omitted defaults to ''unspecified''.
-:<code><nowiki>{{Cleanup}}</nowiki></code> produces this banner:
+:: date (optional) - Month when the banner is placed
-:{{Cleanup}}
-;Optional descriptor
+; Sample output <!-- Not using the actual template to avoid the automatic category assigning -->
-:Type <code>{{t|Cleanup|Example reason given}}</code> at the top of the page.
+: <code><nowiki>{{Cleanup}}</nowiki></code> gives...
-;Sample output
+{{Banner|color= #153E7E|border= #153E7E|text= white
-:<code><nowiki>{{Cleanup|Major changes in Kronos expansion.}}</nowiki></code> produces this banner:
+|'''This article should be cleaned up or improved}}
-:{{Cleanup|Major changes in Kronos expansion.}}
+: <nowiki>{{Cleanup|Overly verbose with multiple redundancies}}</nowiki> gives...
+{{Banner|color= #153E7E|border= #153E7E|text= white
+|'''This article should be cleaned up or improved{{#if: {{{date|}}}|, as of {{{date}}}|}}.'''<br>The reason is: ''Overly verbose with multiple redundancies''}}
+: <nowiki>{{Cleanup|Overly verbose with multiple redundancies|date= February 2017}}</nowiki> gives...
+{{Banner|color= #153E7E|border= #153E7E|text= white
+| '''This article should be cleaned up or improved, as of February 2017.''' <br>The reason is: ''Overly verbose with multiple redundancies''}}
+: <nowiki>{{Cleanup||date= February 2017}}</nowiki> gives...
+{{Banner|color= #153E7E|border= #153E7E|text= white
+|'''This article should be cleaned up or improved, as of February 2017.'''<br> The reason is: ''unspecified''}}
+; See also
+* {{Tl|Update}}, for pages which need facts checked, numbers updated, or entire sections altered, to reflect game changes.
-Putting this template on a page also adds it to the [[:Category:Candidates for Cleanup|Candidates for Cleanup]] category.
+; Template data
+: This is the [[mediawikiwiki:Help:TemplateData|TemplateData]] documentation for this template used by [[mediawikiwiki:VisualEditor|VisualEditor]] and other tools.
+:: <templatedata>
+{
+	"params": {
+		"1": {
+			"label": "Reason",
+			"description": "Reason why the article is in need of clean up or improvement",
+			"example": "Lots of spelling errors.",
+			"type": "content",
+			"suggested": true
+		},
+		"date": {
+			"label": "Date",
+			"description": "Date the banner is added or updated. In month year format. Shows Semantic MediaWiki code in preview, got fixed on save.",
+			"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}",
+			"suggested": true,
+			"example": "June 2025",
+			"type": "date"
+		}
+	},
+	"description": " Banner to mark an article for  reformatting, improve for grammar, typographical errors, organization, readability, and other non-content related changes.  Putting this template on a page also adds it to the Candidates for cleanup category.",
+	"format": "inline"
+}
+</templatedata>
-<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
+<includeonly>[[Category:Maintenance templates]]</includeonly>
+<noinclude>[[Category:Template documentation]]</noinclude>