Difference between revisions of "Template:Cleanup"

From Nottinghack Wiki
Jump to navigation Jump to search
(try)
((also works using 1st unnamed parameter).)
 
(14 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{Ambox
 
{{Ambox
 +
<!-- | subst    = {{subst:substcheck}} - not used on Nottinghack Wiki? -->
 +
<!-- | demospace = {{{demospace|}}} -  not used on Nottinghack Wiki? -->
 +
<!-- | small    = {{{small|}}}  - not used on Nottinghack Wiki? -->
 +
<!-- | doc      = no  - not used on Nottinghack Wiki? -->
 +
| image    =<!--
 +
-->{{#switch: {{{priority}}}<!--  switch on value of priority -->
 +
  |#default = <!-- default sweeping brush image -->
 +
  |high = [[File:Cleanhigh.svg|40px]]
 +
}}
 
| name      = Cleanup
 
| name      = Cleanup
| subst     = {{subst:substcheck}}
+
| type     =<!--
| demospace = {{{demospace|}}}
+
-->{{#switch: {{{priority}}}<!--  switch on value of priority -->
| type      = style
+
  |#default = style
 +
  |high = content
 +
}}
 
| class    = ambox-Cleanup
 
| class    = ambox-Cleanup
| small    = {{{small|}}}
+
| text      =<!--
| text      = {{#switch: <!-- switch on value of section -->
+
  -->{{#switch: {{{section}}}<!-- switch on value of section -->
  |section = yes       = This section requires tidying up!
+
      |#default = {{#ifeq: {{{priority}}}|high|This page requires '''urgent''' attention!&nbsp;|This page requires cleaning up!&nbsp;}}
  |#default  = This page requires tidying up!
+
      |yes = {{#ifeq: {{{priority}}}|high|This section requires '''urgent''' attention!&nbsp;|This section requires cleaning up!&nbsp;}}
}}  
+
      }}<!--
{{#if:{{{2|{{{reason|}}}}}}|The specific problem is: '''{{{2|{{{reason|}}}|Please add a "reason" parameter to this template}}}'''.|(Consider using [[Template:Cleanup|More specific cleanup instructions]].)}} Please help improve this page if you can. {{#ifeq:{{SUBJECTSPACE}}|{{NAMESPACE}}|The [[{{TALKPAGENAME}}{{#if:{{{talksection|}}}|&#35;{{{talksection}}}}}|talk page]] may contain suggestions.}} {{#if:{{{date|}}}|<small>''({{{date}}})''</small>}}
+
  -->{{#if:{{{1|{{{reason|}}}}}}<!--
| doc      = no
+
    -->|The specific problem is: '''{{{1|{{{reason|}}}}}}'''<!--
}}<includeonly>[[Category:Pages to clean up]]</includeonly><noinclude>
+
    -->|'''Describe the specific problem using the 'reason' parameter''' (See [[Template:Cleanup|Cleanup template]] for instructions).
 +
      }}<!--
 +
--> Please help improve this page if you can. {{#ifeq:{{SUBJECTSPACE}}|{{NAMESPACE}}|Use the [[{{TALKPAGENAME}}{{#if:{{{talksection|}}}|&#35;{{{talksection}}}}}|talk page]] to discuss suggestions.}} {{#if:{{{date|}}}|<small>''({{{date}}})''</small>}}
 +
}}<includeonly>[[Category:Pages to clean up]]{{#ifeq: {{{priority}}}|high|[[Category:Pages to clean up (high priority)]]}}</includeonly><noinclude><!--
 +
-->
 
==Documentation==
 
==Documentation==
To indicate that a page is messy and needs tidying up, add this text near the top of the page:
+
To indicate that a page is messy and needs tidying up, add this text near the top of the page or section:
  
<pre>
+
'''Note:''' the page will be automatically added to the category [[:Category:Pages to clean up|pages to clean up]]. If priority is set to high it will also be to [[:Category:Pages to clean up (high priority)]].
{{Cleanup}}
 
</pre>
 
  
'''Note:''' the page will be automatically added to the category [[:Category:Pages to clean up|pages to clean up]].
+
===Examples===
 +
Simple.
 +
:<code><nowiki>{{Cleanup}}</nowiki></code>
  
=== How to provide more detail ===
+
To give more specific instructions and a date in the clean up box use the following wikicode.
To give more specific instructions and a date in the clean up box use this wiki markup:
+
:<code><nowiki>{{Cleanup|reason=the article is full of incorrect capitalisation|date=April 2012}}</nowiki></code>
<pre>
+
 
{{Cleanup|reason=the article is full of incorrect capitalisation|date=April 2012}}  
+
===Parameters ===
</pre>
+
;date
 +
:Date of tagging use Month YYYY date format.
 +
 
 +
;reason
 +
:Provide the reason the page requires a cleanup (also works using 1st unnamed parameter).
 +
 
 +
;section
 +
:If tag is used for a section of a page use <code>section=yes</code> to reflect section in text.
 +
 
 +
;priority
 +
:Use <code>priority=high</code> make the message and appearance of the banner more urgent, and the page is added to [[:Category:Pages to clean up (high priority)]].
  
=== Other parameters ===
 
If tag is used for a section of a page use {{cline|section=yes}} to reflect section in text.
 
  
 
[[Category:Page Action Templates]]
 
[[Category:Page Action Templates]]
 
</noinclude>
 
</noinclude>

Latest revision as of 21:20, 15 February 2019

Documentation

To indicate that a page is messy and needs tidying up, add this text near the top of the page or section:

Note: the page will be automatically added to the category pages to clean up. If priority is set to high it will also be to Category:Pages to clean up (high priority).

Examples

Simple.

{{Cleanup}}

To give more specific instructions and a date in the clean up box use the following wikicode.

{{Cleanup|reason=the article is full of incorrect capitalisation|date=April 2012}}

Parameters

date
Date of tagging use Month YYYY date format.
reason
Provide the reason the page requires a cleanup (also works using 1st unnamed parameter).
section
If tag is used for a section of a page use section=yes to reflect section in text.
priority
Use priority=high make the message and appearance of the banner more urgent, and the page is added to Category:Pages to clean up (high priority).