Template:Cleanup/doc: Difference between revisions

Latest revision as of 09:36, 17 June 2025

Documentation

This template is used for maintenance purposes to signal that a page needs some tender, loving care, or maybe brutal pruning. Marked pages will automatically be added to Category:Pages marked for cleanup.

This template uses {{Notice}} to create the box and it's not visible on mobile devices (added class nomobile).

Usage

To use, put {{Cleanup|reason}} at the start of the page.

Parameters

Parameter^{[note 1]}		Data Type	Status	Default Value	Description
Position or name	Placeholder	Data Type	Status	Default Value	Description
`1`	`reason`	String	Optional	No reason has been provided	Reason why the article needs cleanup.
`noCategories`	-	Boolean	Optional	-	If given any value, the page will not be auto-categorized.

Notes

↑ Placeholders refer to the names used in the syntax above. For documentation purposes positioned parameters often have a pseudo name instead of their number to improve readabilty, e.g. reason instead of 1.
Placeholder - indicates parameters that are not used by default and need to be added by hand, e.g. |noCategories = 1.

Example

{{Cleanup|content is outdated}} produces:

This page may need cleanup to meet quality standards.

Please help Ferret Software Wiki if you can. The Discussion page may contain suggestions.
The given reason is: content is outdated

References

[1] Placeholders refer to the names used in the syntax above. For documentation purposes positioned parameters often have a pseudo name instead of their number to improve readabilty, e.g. reason instead of 1.
Placeholder - indicates parameters that are not used by default and need to be added by hand, e.g. |noCategories = 1.

[note 1]

@@ Line 1: / Line 1: @@
 {{doc/start}}
-This template is used for maintenance purposes to signal that a page needs some tender, loving care, or maybe brutal pruning.
+This template is used for maintenance purposes to signal that a page needs some tender, loving care, or maybe brutal pruning. Marked pages will automatically be added to [[:Category:Pages marked for cleanup]].
-This template will add tagged pages to [[:Category:Cleanup]].
+This template uses {{tl|Notice}} to create the box and it's not visible on mobile devices (added class <code>nomobile</code>).
-==Usage==
+== Usage ==
-{{tlx|cleanup|Reason}}
+To use, put {{tlx|Cleanup|reason}} at the start of the page.
+=== Parameters ===
+{| class="wikitable"
+! colspan=2 | Parameter<ref group="note">Placeholders refer to the names used in the syntax above. For documentation purposes positioned parameters often have a pseudo name instead of their number to improve readabilty, e.g. <code>reason</code> instead of <code>1</code>.<br> Placeholder <code>-</code> indicates parameters that are not used by default and need to be added by hand, e.g. <code>{{!}}noCategories = 1</code>.</ref>
+! rowspan=2 | Data Type
+! rowspan=2 | Status
+! rowspan=2 | Default Value
+! rowspan=2 | Description
+|-
+! Position or name
+! Placeholder
+|-
+| <code>1</code>
+| <code>reason</code>
+| String
+| Optional
+| No reason has been provided
+| Reason why the article needs cleanup.
+|-
+| <code>noCategories</code>
+| style="text-align: center"| -
+| Boolean
+| Optional
+| style="text-align: center"| -
+| If given any value, the page will not be auto-categorized.
+|}
+==== Notes ====
+<references group="note"/>
+== Example ==
+{{tlx|Cleanup|content is outdated}} produces:
+{{Cleanup|content is outdated|noCategories=1}}
+== See also ==
+{{#dpl:
+|namespace = Template
+|category = Notice templates
+|uses = Template:Notice
+|nottitlematch = %{{ROOTPAGENAME}}%
+|ordermethod = title
+|order = ascending
+}}
+== References ==
+<references/>
 {{doc/end}}