Template:CatWeight/doc: Difference between revisions

Revision as of 12:48, 2 May 2009

Documentation for this template

This template creates an eye-catcher bar that can be indented up to 6 times via parameter value, letting the user better customize his "Note"s. The code is backwards compatible, letting the user keep on using the old 2 parameter version as well.

New	Subtle one-pixel border added, padding improved, <weight> is not word-wrapped.

Alternative names

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

Syntax

The template can have 2 or 3 parameters:

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

       <#> =  Number 0 (min) to 6 (max), defines indentation level.
  <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 for <weight> = 0.

Category Weight + Weight + for <weight> = 1.

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

Category Weight *+ Weight *+ for <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|0|'''No''' indentation or weight.}}

Category Weight No indentation or weight.

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

Category Weight + One indentation and weight.

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

Category Weight * Level two indentation and weight!

{{catWeight|6|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 26: / Line 26: @@
 ==Examples==
 ===The Weights===
-{{catWeight|1|1| Weight <tt>+  </tt> means this and that.}}
+{{catWeight|1|0|Weight <tt>   </tt> for <tt><nowiki><weight> = 0</nowiki></tt>.}}
-{{catWeight|1|2| Weight <tt>*  </tt> means this and that.}}
+{{catWeight|1|1|Weight <tt>+  </tt> for <tt><nowiki><weight> = 1</nowiki></tt>.}}
-{{catWeight|1|3| Weight <tt>*+ </tt> means this and that.}}
+{{catWeight|1|2|Weight <tt>*  </tt> for <tt><nowiki><weight> = 2</nowiki></tt>.}}
-{{catWeight|1|4| Weight <tt>** </tt> means this and that.}}
+{{catWeight|1|3|Weight <tt>*+ </tt> for <tt><nowiki><weight> = 3</nowiki></tt>.}}
-{{catWeight|1|5| Weight <tt>**+</tt> means this and that.}}
+{{catWeight|1|4|Weight <tt>** </tt> for <tt><nowiki><weight> = 4</nowiki></tt>.}}
-{{catWeight|1|6| Weight <tt>***</tt> means this and that.}}
+{{catWeight|1|5|Weight <tt>**+</tt> for <tt><nowiki><weight> = 5</nowiki></tt>.}}
-{{catWeight|1|1-5| Weight <tt>+ to **+</tt> means this and that.}}
+{{catWeight|1|6|Weight <tt>***</tt> for <tt><nowiki><weight> = 6</nowiki></tt>.}}
-{{catWeight|1|1-6| Weight <tt>+ to ***</tt> means this and that.}}
+{{catWeight|1|1-5|Weight <tt>+ to **+</tt> for <tt><nowiki><weight> = 1-5</nowiki></tt>.}}
+{{catWeight|1|1-6|Weight <tt>+ to ***</tt> for <tt><nowiki><weight> = 1-6</nowiki></tt>.}}
+}
 ===Indentation===