Template:Cleanup: Difference between revisions

Latest revision as of 22:23, 16 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: @@
-<div class="nomobile">{{Ambox
+<includeonly>{{notice
-| image = [[Image:Cleanup.svg]]
+|align = center
-| type = '''This article may need cleanup to meet quality standards.'''
+|class = nomobile
-| border = yellow
+|color = yellow
-| info = Please help Piratesoftware Wiki if you can.  The <includeonly>[[{{TALKPAGENAME}}|</includeonly><span class="pagetab">Discussion page</span><includeonly>]]</includeonly> may contain suggestions.<br />{{ #if: {{{1|}}} | <br />Reason: "''{{{1}}}''" }}
+|colorBack = yellow
-}}<br /></div>
+|file = Cleanup.svg
-{{#ifeq: {{NAMESPACE}} | Template | |<includeonly>[[category:Cleanup]]</includeonly>}}<noinclude>
+|filesize = 48px
-{{doc}}
+|width = 50%
+|header = '''This page may need cleanup to meet quality standards.'''
-[[Category:Notice templates|{{PAGENAME}}]]</noinclude>
+|content = Please help {{SITENAME}} if you can. The {{#ifeq: {{ROOTPAGENAME}}|Cleanup|'''Discussion page'''|[[{{TALKPAGENAME}}|<span class="pagetab">Discussion page</span>]]}} may contain suggestions.<br><!--
+-->The given reason is: ''{{{1|No reason has been provided}}}''
+}}{{#if: {{{noCategories|}}}| |[[category:Pages marked for cleanup|{{FULLPAGENAME}}]]}}</includeonly><noinclude>
+[[Category:Notice templates|{{PAGENAME}}]]
+{{/doc}}
+</noinclude>