Template:CatWeight/doc: Difference between revisions

Jump to navigation Jump to search
mNo edit summary
Line 6: Line 6:


==Alternative names==
==Alternative names==
* <tt><nowiki>{{catWeight|<weight>|<text>}}</nowiki></tt>  
* <tt><nowiki>{{catWeight|<colour>|<weight>|<text>}}</nowiki></tt>  
* <tt><nowiki>{{CatWeight|<weight>|<text>}}</nowiki></tt>  - alternate spelling of template
* <tt><nowiki>{{CatWeight|<colour>|<weight>|<text>}}</nowiki></tt>  - alternate spelling of template
* <tt><nowiki>{{catWeight|<#>|<weight>|<text>}}</nowiki></tt>   
* <tt><nowiki>{{catWeight|<#>|<colour>|<weight>|<text>}}</nowiki></tt>   
* <tt><nowiki>{{CatWeight|<#>|<weight>|<text>}}</nowiki></tt> - alternate spelling of template
* <tt><nowiki>{{CatWeight|<#>|<colour>|<weight>|<text>}}</nowiki></tt> - alternate spelling of template




==Syntax==
==Syntax==
The template can have '''2''' or '''3 parameters''':
The template can have '''3''' or '''4 parameters''':
#'''<tt><nowiki>{{catWeight|<weight>|<text>}}</nowiki></tt>''' - Default mode, no indentation.
#'''<tt><nowiki>{{catWeight|<colour>|<weight>|<text>}}</nowiki></tt>''' - Default mode, no indentation.
#'''<tt><nowiki>{{catWeight|<#>|<weight>|<text>}}</nowiki></tt>''' - Define indentation via <#> parameter.
#'''<tt><nowiki>{{catWeight|<#>|<colour>|<weight>|<text>}}</nowiki></tt>''' - Define indentation via <#> parameter.
         '''<#>''' =  Number '''0''' (min) to '''6''' (max), defines indentation level.
         '''<#>''' =  Number '''0''' (min) to '''6''' (max), defines indentation level.
  '''<colour>''' =  Define the colour type of the info box:
              '''onoff'''        = red-ish... use to match <nowiki>{{catWeightInfo|onoff}}</nowiki>
              '''worstcase'''    = yellow-ish... use to match <nowiki>{{catWeightInfo|worstcase}}</nowiki>
              '''amount'''      = green-ish... use to match <nowiki>{{catWeightInfo|amount}}</nowiki>
              '''misc'''        = purple-ish... ((fun, testing)
   '''<weight>''' =  The category weight denominator (not word-wrapped), range:
   '''<weight>''' =  The category weight denominator (not word-wrapped), range:
                   '''1''' for "+"  to  '''6''' for "***"
                   '''1''' for "+"  to  '''6''' for "***"