Template:Cleanup/doc: Difference between revisions
format -> adapted style to fit the other notice templates |
m added a bit more context to the note |
||
| Line 9: | Line 9: | ||
=== Parameters === | === Parameters === | ||
{| class="wikitable" | {| class="wikitable" | ||
! colspan=2 | Parameter<ref group="note">Placeholders refer to the names used in the syntax above. 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> | ! 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 | Data Type | ||
! rowspan=2 | Status | ! rowspan=2 | Status | ||
Latest revision as of 09:36, 17 June 2025
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 | ||||
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.
reasoninstead of1.
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
The given reason is: content is outdated