Template:CatWeight/doc: Difference between revisions

From AniDB
Jump to navigation Jump to search
mNo edit summary
 
(48 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{todo}}
{{TOCright}}
{{TOCright}}
 
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.
==Documentation for this template==
{{eyecatch|1|Features|Indentation of up to 6 levels, colours, and weight ranges.}}
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.
{{eyecatch|1|New|Subtle one-pixel border added, padding improved, <info> is not word-wrapped.}}
 
==Alternative names==
* <tt><nowiki>{{catWeight|<info>|<text>}}</nowiki></tt>
* <tt><nowiki>{{CatWeight|<info>|<text>}}</nowiki></tt>  - alternate spelling of template
* <tt><nowiki>{{catWeight|<#>|<info>|<text>}}</nowiki></tt> 
* <tt><nowiki>{{CatWeight|<#>|<info>|<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|<info>|<text>}}</nowiki></tt>''' - Default mode, no indentation.
#{{m|catWeight|<colour>|<weight>|<text>}} - Default mode, no indentation.
#'''<tt><nowiki>{{catWeight|<#>|<info>|<text>}}</nowiki></tt>''' - Define indentation via <#> parameter.
#{{m|catWeight|<#>|<colour>|<weight>|<text>}} - Define indentation via <#> parameter.
         '''<#>''' =  Number '''0''' (min) to '''6''' (max), defines indentation level.
         '''<#>''' =  Number '''0''' (min) to '''6''' (max), defines indentation level.
     '''<info>''' =  The info to highlight (not word-wrapped), i.e. ''Note'' or ''Important''.
     '''<text>''' =  The descriptive text for the info.
  '''<colour>''' =  Define the colour type of the info box:
{{catWeight|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>{{catWeight|info|text}}</nowiki></tt>!}}
                  '''onoff'''     = yellow-ish... use to match <nowiki>{{catWeightInfo|onoff}}</nowiki>
{{catWeight|1|Note|The '''<info>''' parameter is intended for short message headers. To improve readability the '''word-wrapping''' is turned '''off'''!}}
                  '''worstcase'''  = red-ish... use to match <nowiki>{{catWeightInfo|worstcase}}</nowiki>
                  '''amount'''    = green-ish... use to match <nowiki>{{catWeightInfo|amount}}</nowiki>
                  '''misc'''      = purple-ish... (fun, testing), the '''default''' colour!
              For the most current list of available <colour>s, see [[Template:CatWcolBackground|CatWcolBackground]]
              or [[Template:CatWcolFrame|CatWcolFrame]] template. 
  '''<weight>''' =  The category weight denominator (not word-wrapped), range:
                  '''1''' for "+"  to  '''6''' for "***"
                  '''1-5''' for "+ to **+"
                  '''1-6''' for "+ to ***"
              For a complete list of available <weight>s (and ranges), see the '''[[Template:CatWweight|CatWweight]]''' template.
     '''<text>''' =  The descriptive text for that weight level.
  '''<weight>''' =  The category weight denominator (not word-wrapped), range:
    '''<w>'''         '''1''' for "+"  to '''6''' for "***"
                '''1-5''' for "+ to **+"
                '''1-6''' for "+ to ***"
 
==Examples==
===The Weights===
{{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>.}}
{{catWeight|onoff|3|Weight <tt>*+ </tt> for <tt><nowiki><color> = onoff, <weight> = 3</nowiki></tt>.}}
{{catWeight|blue|4|Weight <tt>** </tt> for <tt><nowiki><color> = blue, <weight> = 4</nowiki></tt>.}}
{{catWeight|misc|5|Weight <tt>**+</tt> for <tt><nowiki><color> = misc, <weight> = 5</nowiki></tt>.}}
{{catWeight|misc|6|Weight <tt>***</tt> for <tt><nowiki><weight> = 6</nowiki></tt>.}}
{{catWeight|misc|1-5|Weight <tt>+ to **+</tt> for <tt><nowiki><weight> = 1-5</nowiki></tt>.}}
{{catWeight|misc|1-6|Weight <tt>+ to ***</tt> for <tt><nowiki><weight> = 1-6</nowiki></tt>.}}


===Indentation===
<nowiki>{{catWeight|0|onoff|0|'''No''' indentation or weight.}}</nowiki>
{{catWeight|0|onoff|0|'''No''' indentation or weight.}}


==Examples==
  <nowiki>{{catWeight|1|worstcase|1|'''One''' indentation and weight.}}</nowiki>  
  <nowiki>{{catWeight|0|Note|'''No''' indentation, just like the normal <tt>catWeight</tt>.}}</nowiki>
{{catWeight|1|worstcase|1|'''One''' indentation and weight.}}
<nowiki>{{catWeight|abc|Note|'''No''' indentation, just like the normal <tt>catWeight</tt>.}}</nowiki>  
<nowiki>{{catWeight||Note|'''No''' indentation, just like the normal <tt>catWeight</tt>.}}</nowiki>
{{catWeight|0|Note|'''No''' indentation, just like the normal <tt>catWeight</tt>.}}


  <nowiki>{{catWeight|1|Another note|'''One''' indentation, just like <tt>catWeight2</tt>.}}</nowiki>  
  <nowiki>{{catWeight|2|amount|2|Level '''two''' indentation and weight!}}</nowiki>  
{{catWeight|1|Another note|'''One''' indentation, just like <tt>catWeight2</tt>.}}
{{catWeight|2|amount|2|Level '''two''' indentation and weight!}}


  <nowiki>{{catWeight|2|Important|Level '''two''' indentation!}}</nowiki>  
  <nowiki>{{catWeight|6|misc|6|Maximum indentation level of '''six''', same weight!}}</nowiki>  
{{catWeight|2|Important|Level '''two''' indentation!}}
{{catWeight|6|misc|6|Maximum indentation level of '''six''', same weight!}}


<nowiki>{{catWeight|6|Very important|Maximum indentation level of '''six'''! "Very important" is ...}}</nowiki>
==Test the Code==
{{catWeight|6|Very important|Maximum indentation level of '''six'''! "Very important" is '''not''' word-wrapped.}}
Should more code testing be required see the [[Template:CatWeight/Test Code]] page.

Latest revision as of 23:02, 6 May 2009

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 Indentation of up to 6 levels, colours, and weight ranges.

Syntax

The template can have 3 or 4 parameters:

  1. {{catWeight|<colour>|<weight>|<text>}} - Default mode, no indentation.
  2. {{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      = yellow-ish... use to match {{catWeightInfo|onoff}}
                 worstcase  = red-ish... use to match {{catWeightInfo|worstcase}}
                 amount     = green-ish... use to match {{catWeightInfo|amount}}
                 misc       = purple-ish... (fun, testing), the default colour!
              For the most current list of available <colour>s, see CatWcolBackground 
              or CatWcolFrame template.  

  <weight> =  The category weight denominator (not word-wrapped), range:
                 1 for "+"  to  6 for "***"
                 1-5 for "+ to **+"
                 1-6 for "+ to ***"
              For a complete list of available <weight>s (and ranges), see the CatWweight template.

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

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

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 <color> = blue, <weight> = 4.
Category Weight **+ Weight **+ for <color> = misc, <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.

Retrieved from "https://wiki.anidb.net/index.php?title=Template:CatWeight/doc&oldid=13382"