Template:Cleanup reorganize/doc: Difference between revisions

Content deleted Content added

Inline

Latest revision as of 18:35, 26 December 2023

This is a documentation subpage for Template:Cleanup reorganize.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used on approximately 2,500 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.

If you plan to make breaking changes to this template, move it, or nominate it for deletion, please notify Twinkle's users and maintainers at Wikipedia talk:Twinkle as a courtesy, as the standard installation of Twinkle adds and removes this template. Thank you!

Usage

Place the following at the top of the article:

basic usage:
{{Cleanup reorganize|date=November 2024}}
with all parameters:
{{Cleanup reorganize|1=affected area|reason=|date=November 2024}}

This template is intended for articles that need more than small-scale copy editing but can be improved without research beyond the current article contents; editors are encouraged to be bold and make large-scale changes.

Articles tagged are categorized in Category:Wikipedia articles needing reorganization, or a dated subcategory thereof.

Redirects

{{Layout}}
{{Organize}}
{{Reorg}}
{{Reorganize}}
{{Structure}}

TemplateData

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

TemplateData for Cleanup reorganize

Use this cleanup template to indicate that an article may be in need of reorganization to comply with Wikipedia's layout guidelines.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Month and year	`date`	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}}`	Line	suggested
Reason	`reason` `2`	The reason why the article may be in need of reorganization Example it is not chronological	String	optional
Affected area	`1`	Text to replace the word "article", usually "section" Example section Auto value `section`	Line	optional

@@ Line 1: / Line 1: @@
 {{Documentation subpage}}
+{{High-use}}
 <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+{{twinkle standard installation}}
-=== Usage ===
+== Usage ==
+Place the following at the top of the article:
-This template is intended for articles which need more than small-scale copy editing, but can be improved without research beyond the current article contents; editors are encouraged to [[Wikipedia:Be bold|be bold]] and make large-scale changes.
+* basic usage:<br>{{Tlc|{{ROOTPAGENAME}}|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
+* with all parameters:<br><code><nowiki>{{Cleanup reorganize|1=affected area|reason=|date=</nowiki>{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}</code>
+This template is intended for articles that need more than small-scale copy editing but can be improved without research beyond the current article contents; editors are encouraged to [[Wikipedia:Be bold|be bold]] and make large-scale changes.
-Users of this template are listed in [[:Category:Wikipedia articles needing reorganization]]
+Articles tagged are categorized in [[:Category:Wikipedia articles needing reorganization]], or a dated subcategory thereof.
-=== See also ===
+== Redirects ==
-<includeonly>
+* {{Tl|Layout}}
+* {{Tl|Organize}}
+* {{Tl|Reorg}}
+* {{Tl|Reorganize}}
+* {{Tl|Structure}}
+== TemplateData ==
+{{TemplateData header}}
+<templatedata>
+{
+    "description": "Use this cleanup template to indicate that an article may be in need of reorganization to comply with Wikipedia's layout guidelines.",
+	"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
+		},
+		"reason": {
+			"aliases": [
+				"2"
+			],
+			"label": "Reason",
+			"description": "The reason why the article may be in need of reorganization",
+			"type": "string",
+			"example": "it is not chronological"
+		},
+		"1": {
+			"label": "Affected area",
+			"description": "Text to replace the word \"article\", usually \"section\"",
+			"type": "line",
+			"autovalue": "section",
+			"example": "section"
+		}
+	},
+	"paramOrder": [
+		"date",
+		"reason",
+		"1"
+	]
+}
+</templatedata>
+== See also ==
+* {{Tl|Cleanup}}
+* {{Tl|Organize section}}
+* {{Tl|Section too long}}
+* {{Tl|Sections}}
+<includeonly>{{Sandbox other||
 <!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
-[[Category:Cleanup templates|{{PAGENAME}}]]
+[[Category:Cleanup templates]]
-</includeonly>
+}}</includeonly>