Template:CatWeightInfo/doc: Difference between revisions

Revision as of 08:39, 2 May 2009

Documentation for this template

This template creates three different info boxes explaining how the weights for the current category should be interpreted.

New	Choose between the three <type>s, and optionally <align> them.

Alternative names

{{catWeightInfo|<type>}}
{{CatWeightInfo|<type>}} - alternate spelling of template
{{catWeightInfo|<type>|<align>}}
{{CatWeightInfo|<type>|<align>}} - alternate spelling of template

Syntax

The template can have 1 or 2 parameters:

{{catWeightInfo|<type>}} - Default mode, no alignment!
{{catWeightInfo|<type>|<align>}} - Define alignment via <align> parameter.

    <type> =  Define the type of weight info box you require:
              onoff        = The category weight is simply used as an on/off switch
              onoffSec     =   Same as onoff, but referring to the complete page/section.
              worstcase    = The worst case of category occurrence defines weight.
              worstcaseSec =   Same as worstcase, but referring to the complete page/section.
              amount       = The category weight is defined by the occurrence amount (default).
              amountSec    =   Same as amount, but referring to the complete page/section.

   <align> =  Should the info box be aligned? By default it is not a "float".
              left      = Aligns the info box to the left of the text.
              right     = Aligns the info box to the right of the text.
              none /    = No entry, or any other entry will *not* align the info box.

Note	Any <type> entry other than "onoff" or "worstcase" defaults to "amount"! Any <align> entry other than "left" or "right" defaults to no alignment!

Example Category Weight Info Boxes

The three <type>s of info boxes

{{CatWeightInfo|onoff}}

Category Weight	`- or ***`
If applicable, this category should be weighted with `` (on). Otherwise do not set it at all!*

{{CatWeightInfo|amount}}  (this is the default)

Category Weight	`+ to ***`
If applicable, choose a weight between `+`* (seldom) to ``* (abundant) denoting how often the category occurs in the anime.*

{{CatWeightInfo|worstcase}} (default align is NONE!)

Category Weight	`+ to ***`
If applicable, choose a weight between `+`* (slight) to ``* (excessive) describing the worst case of category occurrence in the anime.*

The <align>ment of the info boxes

{{CatWeightInfo|onoff|right}}

Category Weight	`- or ***`
If applicable, this category should be weighted with `` (on). Otherwise do not set it at all!*

blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah...

{{CatWeightInfo|amount|left}}

Category Weight	`+ to ***`
If applicable, choose a weight between `+`* (seldom) to ``* (abundant) denoting how often the category occurs in the anime.*