Template:CatWeightInfo/doc: Difference between revisions

From AniDB
Jump to navigation Jump to search
mNo edit summary
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{TOCright}}
{{TOCright}}
==Documentation for this template==
This template creates six different info boxes explaining how the weights for the current category or the current category section should be interpreted.
This template creates six different info boxes explaining how the weights for the current category or the current category section should be interpreted.
{{eyecatch|1|New|Choose between the six <nowiki><type></nowiki>s, and optionally <nowiki><align></nowiki> them.}}
{{eyecatch|1|New|Choose between the six <nowiki><type></nowiki>s, and optionally <nowiki><align></nowiki> them.}}
Line 7: Line 5:
==Alternative names==
==Alternative names==
* <tt><nowiki>{{catWeightInfo|<type>}}</nowiki></tt>  
* <tt><nowiki>{{catWeightInfo|<type>}}</nowiki></tt>  
* <tt><nowiki>{{CatWeightInfo|<type>}}</nowiki></tt> - alternate spelling of template
* <tt><nowiki>{{cwi|<type>}}</nowiki></tt> - alternate template name
* <tt><nowiki>{{catWeightInfo|<type>|<align>}}</nowiki></tt>  
* <tt><nowiki>{{catWeightInfo|<type>|<align>}}</nowiki></tt>  
* <tt><nowiki>{{CatWeightInfo|<type>|<align>}}</nowiki></tt> - alternate spelling of template
* <tt><nowiki>{{cwi|<type>|<align>}}</nowiki></tt> - alternate template name
 


==Syntax==
==Syntax==
The template can have '''1''' or '''2 parameters''':
The template can have '''1''' or '''2 parameters''':
#'''<tt><nowiki>{{catWeightInfo|<type>}}</nowiki></tt>''' - Default mode, no alignment!
#{{m|catWeightInfo|<type>}} - Default mode, no alignment!
#'''<tt><nowiki>{{catWeightInfo|<type>|<align>}}</nowiki></tt>''' - Define alignment via <align> parameter.
#{{m|catWeightInfo|<type>|<align>}} - Define alignment via <align> parameter.
     '''<type>''' =  Define the type of weight info box you require:
     '''<type>''' =  Define the type of weight info box you require:
               '''onoff'''        = The category weight is simply used as an on/off switch
               '''onoff'''        = The category weight is simply used as an on/off switch
Line 25: Line 22:
   
   
     '''<align>''' =  Should the info box be aligned? By default it is not a "float".
     '''<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.
               '''left'''         = Aligns the info box to the left of the text.
               '''right'''     = Aligns the info box to the right 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.
              '''1''' to '''6'''      = No alignment, instead defines level of indentation!
               '''none'''         = No entry, or any other entry will *not* align the info box.
{{eyecatch|1|Note|Any '''<type>''' entry other than "onoff", "onoffSec", "worstcase", "worstcaseSec", or "amountSec" defaults to '''"amount"'''!<br>Any '''<align>''' entry other than "left" or "right" defaults to '''no''' alignment!}}
{{eyecatch|1|Note|Any '''<type>''' entry other than "onoff", "onoffSec", "worstcase", "worstcaseSec", or "amountSec" defaults to '''"amount"'''!<br>Any '''<align>''' entry other than "left" or "right" defaults to '''no''' alignment!}}


==Example Category Weight Info Boxes==
==Example Category Weight Info Boxes==
===The six <type>s of info boxes===
===The six <type>s of info boxes===
  <nowiki>{{CatWeightInfo|onoffSec}}</nowiki>
  <nowiki>{{CatWeightInfo|onoffSec}}</nowiki>
Line 51: Line 48:
{{CatWeightInfo|worstcase}}
{{CatWeightInfo|worstcase}}


===The <align> used for indentation===
<nowiki>{{CatWeightInfo|amount|1}}</nowiki> (indent level 1)
{{CatWeightInfo|amount|1}}


===The <align>ment of the info boxes===
===The <align>ment of the info boxes===
Line 61: Line 61:
{{CatWeightInfo|amount|left}}
{{CatWeightInfo|amount|left}}
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...
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...
===The <align>ment used for indentation===
<nowiki>{{CatWeightInfo|amount|1}}</nowiki> (indent level 1)
{{CatWeightInfo|amount|1}}

Latest revision as of 23:01, 6 May 2009

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

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

Alternative names

  • {{catWeightInfo|<type>}}
  • {{cwi|<type>}} - alternate template name
  • {{catWeightInfo|<type>|<align>}}
  • {{cwi|<type>|<align>}} - alternate template name

Syntax

The template can have 1 or 2 parameters:

  1. {{catWeightInfo|<type>}} - Default mode, no alignment!
  2. {{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.
              1 to 6       = No alignment, instead defines level of indentation!
              none         = No entry, or any other entry will *not* align the info box.
Note Any <type> entry other than "onoff", "onoffSec", "worstcase", "worstcaseSec", or "amountSec" defaults to "amount"!
Any <align> entry other than "left" or "right" defaults to no alignment!

Example Category Weight Info Boxes

The six <type>s of info boxes

{{CatWeightInfo|onoffSec}}
Category Weight - or ***
If one or more categories in this section are applicable they should be weighted with *** (on). Otherwise do not set them! 
{{CatWeightInfo|onoff}}
Category Weight - or ***
If applicable, this category should be weighted with *** (on). Otherwise do not set it at all! 
{{CatWeightInfo|amountSec}}  (this is the default)
Category Weight + to ***
For all the categories in this section choose (if applicable) a weight between + (seldom) to *** (abundant) denoting how often the specific category occurs in the anime. 
{{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|worstcaseSec}} (default align is NONE!)
Category Weight + to ***
For all the categories in this section choose (if applicable) a weight between + (slight) to *** (excessive) describing the worst case of specific category occurrence 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> used for indentation

{{CatWeightInfo|amount|1}} (indent level 1)
Category Weight + to ***
If applicable, choose a weight between + (seldom) to *** (abundant) denoting how often the category occurs 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.

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...

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