Template:CatWeight/doc: Difference between revisions

Revision as of 13:27, 2 May 2009

Documentation for this template

This template creates an category weight bar that can be indented up to six times via parameter value. It can also be colour coded, a weight can be defined, and you can add a message describing the weight choice.

Features

Intentation up to 6 levels, colours, and weight ranges.

Alternative names

{{catWeight|<colour>|<weight>|<text>}}
{{CatWeight|<colour>|<weight>|<text>}} - alternate spelling of template
{{catWeight|<#>|<colour>|<weight>|<text>}}
{{CatWeight|<#>|<colour>|<weight>|<text>}} - alternate spelling of template

Syntax

The template can have 3 or 4 parameters:

{{catWeight|<colour>|<weight>|<text>}} - Default mode, no indentation.
{{catWeight|<#>|<colour>|<weight>|<text>}} - Define indentation via <#> parameter.

       <#> =  Number 0 (min) to 6 (max), defines indentation level.

  <colour> =  Define the colour type of the info box:
                 onoff      = red-ish... use to match {{catWeightInfo|onoff}}
                 worstcase  = yellow-ish... use to match {{catWeightInfo|worstcase}}
                 amount     = green-ish... use to match {{catWeightInfo|amount}}
                 misc       = purple-ish... (fun, testing), the default colour!

  <weight> =  The category weight denominator (not word-wrapped), range:
                 1 for "+"  to  6 for "***"
                 1-5 for "+ to **+"
                 1-6 for "+ to ***"

    <text> =  The descriptive text for that weight level.

Note	Only the <#>* values 1 to 6 are actually checked, any other values (e.g. 0 or abc) yield no indentation at all, and are treated the same as `{{eyecatch\|info\|text}}`!*

Examples

The Weights

Category Weight Weight "emtpy" for <color> = misc, <weight> = 0.

Category Weight + Weight + for <color> = amount, <weight> = 1.

Category Weight * Weight * for <color> = worstcase, <weight> = 2.

Category Weight *+ Weight *+ for <color> = onoff, <weight> = 3.

Category Weight ** Weight ** for <weight> = 4.

Category Weight **+ Weight **+ for <weight> = 5.

Category Weight *** Weight *** for <weight> = 6.

Category Weight + to **+ Weight + to **+ for <weight> = 1-5.

Category Weight + to *** Weight + to *** for <weight> = 1-6.

Indentation

{{catWeight|0|onoff|0|'''No''' indentation or weight.}}

Category Weight No indentation or weight.

{{catWeight|1|worstcase|1|'''One''' indentation and weight.}}

Category Weight + One indentation and weight.

{{catWeight|2|amount|2|Level '''two''' indentation and weight!}}

Category Weight * Level two indentation and weight!

{{catWeight|6|misc|6|Maximum indentation level of '''six''', same weight!}}

Category Weight *** Maximum indentation level of six, same weight!

Test the Code

Should more code testing be required see the Template:CatWeight/Test Code page.

@@ Line 34: / Line 34: @@
 ==Examples==
 ===The Weights===
-{{catWeight|misc|0|Weight <tt>   </tt> for <tt><nowiki><color> = misc, <weight> = 0</nowiki></tt>.}}
+{{catWeight|misc|0|Weight <tt>"emtpy"</tt> for <tt><nowiki><color> = misc, <weight> = 0</nowiki></tt>.}}
 {{catWeight|amount|1|Weight <tt>+  </tt> for <tt><nowiki><color> = amount, <weight> = 1</nowiki></tt>.}}
 {{catWeight|worstcase|2|Weight <tt>*  </tt> for <tt><nowiki><color> = worstcase, <weight> = 2</nowiki></tt>.}}