Template:CatWeight/doc: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (→Syntax) |
||
| Line 17: | Line 17: | ||
#'''<tt><nowiki>{{catWeight|<#>|<colour>|<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: | '''<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 "***" | ||
'''1-5''' for "+ to **+" | '''1-5''' for "+ to **+" | ||
'''1-6''' for "+ to ***" | '''1-6''' for "+ to ***" | ||
'''<text>''' = The descriptive text for that weight level. | '''<text>''' = The descriptive text for that weight level. | ||
{{eyecatch|1|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 <tt><nowiki>{{eyecatch|info|text}}</nowiki></tt>!}} | {{eyecatch|1|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 <tt><nowiki>{{eyecatch|info|text}}</nowiki></tt>!}} | ||
Revision as of 13:01, 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|<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)
<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.