Difference between revisions of "Template:Cleanup-reason/doc"

From blackwiki
Jump to navigation Jump to search
imported>Rich Farmbrough
(Created page with '{{Documentation subpage}} <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> == Usage == Use: {{Tlx|cleanup-reason|reason=<reason>}} * This...')
 
imported>Debresser
m (m)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
 
 
  
 
== Usage ==
 
== Usage ==
Use: {{Tlx|cleanup-reason|reason=<reason>}}
+
Use: {{Tlx|Cleanup-reason|reason=<reason>}}
 
* This [[Wikipedia:Template|template]] is a [[Wikipedia:Avoid self-references|self-reference]].
 
* This [[Wikipedia:Template|template]] is a [[Wikipedia:Avoid self-references|self-reference]].
 
* Please do not [[Wikipedia:Subst|subst:]] this template.  
 
* Please do not [[Wikipedia:Subst|subst:]] this template.  
Line 12: Line 10:
 
== Parameter options ==
 
== Parameter options ==
 
There are three optional named control parameters, '''section=''', '''date=''' and (your) '''reason='''(ing), two of which may be specified by either [[meta:Help:Template#Parameters|name or numeric order]].  
 
There are three optional named control parameters, '''section=''', '''date=''' and (your) '''reason='''(ing), two of which may be specified by either [[meta:Help:Template#Parameters|name or numeric order]].  
* The "date" must be in the format MMMMMM YYYY, where MMMMMM represents the full month name (April, November, etc.) followed by YYYY, representing the year in four digits (2007) separated by a space. That format is necessary to auto-categorize the page to the proper clean-up-by-date tagged category. If you leave it off it will be added by a [[WP:BOT]]
+
* The "date" must be in the format MMMMMM YYYY, where MMMMMM represents the full month name (April, November, etc.) followed by YYYY, representing the year in four digits (2007) separated by a space. That format is necessary to auto-categorize the page to the proper clean-up-by-date tagged category. If you leave it off it will be added by a [[WP:BOT|bot]]
 
* Your '''reason''' for tagging the page can be any brief sensible text that will help any editors who come along later to understand what you see as shortcomings. If section= is not defined, the reason will double as a link to the talk page section where the clean-up needs should be explained.  
 
* Your '''reason''' for tagging the page can be any brief sensible text that will help any editors who come along later to understand what you see as shortcomings. If section= is not defined, the reason will double as a link to the talk page section where the clean-up needs should be explained.  
 
* Alternatively, define '''section=''' which supersedes <nowiki>{{{reason}}}</nowiki>.
 
* Alternatively, define '''section=''' which supersedes <nowiki>{{{reason}}}</nowiki>.

Revision as of 23:37, 31 August 2009

Usage

Use: {{Cleanup-reason}}

  • This template is a self-reference.
  • Please do not subst: this template.
  • Please give a clear reason to future editors which may be specified by:

Parameter options

There are three optional named control parameters, section=, date= and (your) reason=(ing), two of which may be specified by either name or numeric order.

  • The "date" must be in the format MMMMMM YYYY, where MMMMMM represents the full month name (April, November, etc.) followed by YYYY, representing the year in four digits (2007) separated by a space. That format is necessary to auto-categorize the page to the proper clean-up-by-date tagged category. If you leave it off it will be added by a bot
  • Your reason for tagging the page can be any brief sensible text that will help any editors who come along later to understand what you see as shortcomings. If section= is not defined, the reason will double as a link to the talk page section where the clean-up needs should be explained.
  • Alternatively, define section= which supersedes {{{reason}}}.
  • Any additional reasoning or lists of deficiencies should be given on the talk page in a separate section that includes the name of the template as part of the section name.

See also