1,633
edits
Template:CatWeightInfo/doc: Difference between revisions
m
Finalized the documentation for the CatWeightInfo template.
m (Finalized the documentation for the CatWeightInfo template.) |
|||
| Line 1: | Line 1: | ||
{{TOCright}} | {{TOCright}} | ||
==Documentation for this template== | |||
This template creates three different info boxes explaining how the weights for the current category should be interpreted. | |||
{{eyecatch|1|New|Choose between the three <nowiki><type></nowiki>s, and optionally <nowiki><align></nowiki> them.}} | |||
==Alternative names== | |||
* <tt><nowiki>{{catWeightInfo|<type>}}</nowiki></tt> | |||
* <tt><nowiki>{{CatWeightInfo|<type>}}</nowiki></tt> - alternate spelling of template | |||
* <tt><nowiki>{{catWeightInfo|<type>|<align>}}</nowiki></tt> | |||
* <tt><nowiki>{{CatWeightInfo|<type>|<align>}}</nowiki></tt> - alternate spelling of template | |||
==Syntax== | |||
The template can have '''1''' or '''2 parameters''': | |||
#'''<tt><nowiki>{{catWeightInfo|<type>}}</nowiki></tt>''' - Default mode, no alignment! | |||
#'''<tt><nowiki>{{catWeightInfo|<type>|<align>}}</nowiki></tt>''' - 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 | |||
'''worstcase''' = The worst case of category occurrence defines weight. | |||
'''amount''' = The category weight is defined by the occurrence amount (default). | |||
'''<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. | |||
{{eyecatch|1|Note|Any <type> entry other than "onoff" or "worstcase" 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 three <type>s of info boxes=== | ||
<nowiki>{{CatWeightInfo|onoff}}</nowiki> | <nowiki>{{CatWeightInfo|onoff}}</nowiki> | ||
{{CatWeightInfo|onoff}} | {{CatWeightInfo|onoff}} | ||
| Line 13: | Line 41: | ||
{{CatWeightInfo|worstcase}} | {{CatWeightInfo|worstcase}} | ||
=== | |||
<nowiki>{{CatWeightInfo|onoff|right}}</nowiki> | ===The <align>ment of the info boxes=== | ||
<nowiki>{{CatWeightInfo|onoff|right}}</nowiki> | |||
{{CatWeightInfo|onoff|right}} | {{CatWeightInfo|onoff|right}} | ||
blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah... | blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah... | ||
<nowiki>{{CatWeightInfo|amount|left}}</nowiki> | <nowiki>{{CatWeightInfo|amount|left}}</nowiki> | ||
{{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... | ||