Difference between revisions of "Template:Cleanup-reason"

From blackwiki
Jump to navigation Jump to search
imported>Rich Farmbrough
(→‎Usage: Peopel can manage cut and paste - don't adisevs them on dates - son't advie to put random tet in default parameters.)
imported>Rich Farmbrough
(→‎Parameter options: Tidy up and remove commented out byzantine advice on which numbered parmeter might ot might not display.)
Line 44: Line 44:
 
== 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]].  
* Date must be given 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 cleanup by date tagged category. The format is guaranteed by substituting {{tl2|DATE}}.
+
* 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}}
* 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 extension to the talk page section where the cleanup 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> and numeric parameters alike.
+
* Alternatively, define '''section=''' which supersedes <nowiki>{{{reason}}}</nowiki>.
* Longer reasoning or a local list of deficiencies can be given as a subsequent (numeric) parameter and should always be documented on the talk page in a separate section that includes the name of this template as part of the section name. HTML elements such as formating to new lines will work within your reasons.
+
* 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.
<!---
 
;parameter rules in detail:
 
 
 
1.) If and when the named parameter''' <nowiki>date=</nowiki>''' is given, the argument '''<nowiki>{{{2}}}</nowiki>'''
 
will have no effect '''and will not display''' at all. This fact
 
applies as well if the argument is given indirectly using the
 
{{tl|DATE}} template, whether or not it is substituted using <nowiki>{{subst:DATE}}</nowiki>.
 
    1.1) In which case it is recommended <nowiki>{{{2}}}</nowiki> be used to list more
 
explicit complaints or suggestions to another editor coming along to the page
 
later, to ensure your judgment is communicated to the next editor
 
considering taking on the issue or issues you raise.
 
    1.2) The field  <nowiki>{{{2}}}</nowiki> can then also be easily
 
copied to a talk page section and amplified therein, as is important
 
always, as others usually will not perceive things with your training,
 
background, and thought processes, so take time to be clear and communicate
 
especially be careful to make a clear notation in the talk on more complex changes
 
you judge are needed and don't have time (or knowledge?) to fix yourself
 
If the matter's simple, you should always do so in preference to asking others
 
to handle the matter.
 
 
 
2.) <nowiki>date= is the same as giving argument {{{1}}}, but {{{1}}} may be given as the reason, if you define the date= parameter</nowiki>
 
<nowiki>reason= is the same as giving argument {{{2}}}, or {{{1}}}, assuming date= is specified.</nowiki>
 
Thus the two argument modes can be mixed, either give
 
{&#123;[[template:cleanup-reason]]{{!}}date=''month year''{{!}}reason=''your text reasoning''}&#125;
 
Or use:
 
{&#123;[[template:cleanup-reason]]{{!}}''month year''{{!}}''your text reasoning''}&#125; --->
 
  
 
== See also ==
 
== See also ==

Revision as of 22:29, 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 Template:WP: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