View source for Template:Monthly clean-up category/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->

==Usage==
The simplest usage is just {{Tl|Monthly clean-up category}}
In this case a default message page for that group of categories will need to exist. See [[Template:Monthly clean-up category/Messages]] for a list of existing message pages and to understand the naming convention. 

Also the category will need to follow the naming convention "Blah blah '''from''' {{CURRENTMONTHNAME}} {{CURRENTYEAR}}". (See [[#Limitations]] for more information.)

A missing message page will give a red-link to the page where the message should be written. That page will look something like [[Template:Monthly clean-up category/Messages/CategoryName]]. {{Tl|Null}} can be used for an intentionally blank item.

If a red lined counter category is shown, simply populate it with {{Tl|Counter category}}.

===Parameter toc===
* toc = focus  - gives a focus letter
* toc = toc - give a category style table of contents
* toc = none - 

===Parameter hidden===
* hidden = n  - The category will not be hidden<!--, but possibly not in talk namespaces ??? -->.

==Examples==
===Focus===
<pre><nowiki>
{{Monthly clean-up category
 | type    = silly articles
 | message = silly articles should be deleted
 | toc     = focus
 | cat     = test stubs
}}
</nowiki></pre>
{{Monthly clean-up category
 | type    = silly articles
 | message = silly articles should be deleted
 | toc     = focus
 | cat     = test stubs
 | monthno = {{CURRENTMONTH}}
 | month name = {{CURRENTMONTHNAME}}
 | year    = {{CURRENTYEAR}}
}}

===Toc===
<pre><nowiki>
{{Monthly clean-up category
 | type    = silly articles
 | message = silly articles should be made sensible
 | toc     = toc
 | cat     = test stubs
}}
</nowiki></pre>

{{Monthly clean-up category
 | type    = silly articles
 | message = silly articles should be made sensible
 | toc     = toc
 | cat     = test stubs
 | monthno = {{CURRENTMONTH}}
 | month name = {{CURRENTMONTHNAME}}
 | year    = {{CURRENTYEAR}}
}}

===No TOC===
<pre><nowiki>
{{Monthly clean-up category
 | type    = silly articles
 | message = silly articles should be rewritten
 | toc     = none
 | cat     = test stubs
}}
</nowiki></pre>

{{Monthly clean-up category
 | type    = silly articles
 | message = silly articles should be rewritten
 | toc     = none
 | cat     = test stubs
 | monthno = {{CURRENTMONTH}}
 | month name = {{CURRENTMONTHNAME}}
 | year    = {{CURRENTYEAR}}
}}

===Another example===
<pre><nowiki>
{{Monthly clean-up category
 | type    = silly articles
 | message = silly articles should be revised
 | cat     = test stubs
 | hidden  = n
}}
</nowiki></pre>

{{Monthly clean-up category
 | type    = silly articles
 | message = silly articles should be revised
 | cat     = test stubs
 | hidden  = n
 | monthno = {{CURRENTMONTH}}
 | month name = {{CURRENTMONTHNAME}}
 | year    = {{CURRENTYEAR}}
}}

==Nearly empty copy==
<code><pre>
<nowiki>{{</nowiki>Monthly clean-up category
&nbsp;| type    = 
&nbsp;| toc     = toc
&nbsp;| cat     = 
&nbsp;| hidden  = y
&nbsp;| message = 
}}
</pre></code>

==Limitations==
If category names are over 100 chars or contain special characters, the template may need to have "year" "month name" and "monthno" supplied.

Similarly if the category name does not follow the convention "Blah blah '''from''' {{CURRENTMONTHNAME}} {{CURRENTYEAR}}".

===Example===
...
 | monthno = {{CURRENTMONTH}}
 | month name = {{CURRENTMONTHNAME}}
 | year    = {{CURRENTYEAR}}
...

==See also==
* {{Tl|Monthly maintenance category}}
* {{Tl|Parent monthly clean up category}}