Template:Cleanup/doc: Difference between revisions

Revision as of 10:45, 25 February 2024

This is a documentation subpage for Template:Cleanup.

It contains usage information, categories, and other content that is not part of the original template page.

{{Cleanup}} should be placed on articles or section that you believe require a cleanup. This template adds pages to Category:Pages needing cleanup. You should always specify the reason by including a parameter.

Usage

{{Cleanup|Reason}}

TemplateData

Place on articles or sections you believe require a cleanup. This template adds pages to Category:Pages needing cleanup.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Reason	`1`	Reason why article requires cleanup Example Should be rewritten as prose	String	required

@@ Line 1: / Line 1: @@
-;Description
+{{Documentation}}
-:These articles should be reformatted or otherwise improved for grammar, typographical errors, organization, readability, and other non-content related changes.
+{{t|Cleanup}} should be placed on articles or section that you believe require a cleanup. This template adds pages to [[:Category:Pages needing cleanup]]. You should always specify the reason by including a parameter.
-;Basic Syntax
-:Type <code>{{t|Cleanup}}</code> at the top of the page.
-;Sample output
-:<code><nowiki>{{Cleanup}}</nowiki></code> produces this banner:
-:{| cellpadding="2" style="background-color: #153E7E; color: #FFFFFF; width: 100%; text-align:center;"
-| '''This article should be cleaned up or improved{{#if: {{{date|}}}|, as of {{{date}}}|}}.''' The reason is: ''{{#if: {{{1|}}}|{{{1}}}|unspecified}}''
-|}
-;Optional descriptors
-:Place a reason after the first pipe (the symbol | ), and the parameter <code>date=</code> to indicate the month of the request. Copy this format, replacing with a reason, and it will automatically add the month of the request: <br/>
-:<code><nowiki>{{Cleanup|</nowiki>''<Place your reason here!>''<nowiki>|date={{subst:#time: F Y}} }}</nowiki></code>
-;Sample output
-:<code><nowiki>{{Cleanup|overly verbose with multiple redundancies.|date={{#time: F Y}}</nowiki></code> produces this banner:
-:{| cellpadding="2" style="background-color: #153E7E; color: #FFFFFF; width: 100%; text-align:center;"
-| '''This article should be cleaned up or improved, as of February 2017.''' The reason is: ''overly verbose with multiple redundancies.''
-|}
-Putting this template on a page also adds it to the [[:Category:Candidates for cleanup|Candidates for cleanup]] category.
+== Usage ==
+<code>{{tlx|Cleanup|Reason}}</code>
-== See also ==
+== TemplateData ==
+<templatedata>
+{
+	"params": {
+		"1": {
+			"label": "Reason",
+			"description": "Reason why article requires cleanup",
+			"example": "Should be rewritten as prose",
+			"type": "string",
+			"required": true
+		}
+	},
+	"description": "Place on articles or sections you believe require a cleanup. This template adds pages to Category:Pages needing cleanup.\n\n",
+	"format": "inline"
+}
+</templatedata>
-* {{t|Update}}, for pages which need facts checked, numbers updated, or entire sections altered, to reflect recent game changes.
+<includeonly>[[Category:Maintenance templates]]</includeonly>
-<includeonly>[[Category:Template]]</includeonly>
-<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>