1,633
edits
Template:CatWeightInfo/doc: Difference between revisions
m
no edit summary
m (Syntax ... update more <type> options added, i.e. special text for the section application.) |
mNo edit summary |
||
| (11 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{TOCright}} | {{TOCright}} | ||
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.}} | |||
This template creates | |||
{{eyecatch|1|New|Choose between the | |||
==Alternative names== | ==Alternative names== | ||
* <tt><nowiki>{{catWeightInfo|<type>}}</nowiki></tt> | * <tt><nowiki>{{catWeightInfo|<type>}}</nowiki></tt> | ||
* <tt><nowiki>{{ | * <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>{{ | * <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''': | ||
# | #{{m|catWeightInfo|<type>}} - Default mode, no alignment! | ||
# | #{{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 26: | 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''' | '''left''' = Aligns the info box to the left of the text. | ||
'''right''' | '''right''' = Aligns the info box to the right of the text. | ||
'''none | '''1''' to '''6''' = No alignment, instead defines level of indentation! | ||
{{eyecatch|1|Note|Any <type> entry other than "onoff" or " | '''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!}} | |||
==Example Category Weight Info Boxes== | ==Example Category Weight Info Boxes== | ||
===The six <type>s of info boxes=== | |||
<nowiki>{{CatWeightInfo|onoffSec}}</nowiki> | |||
{{CatWeightInfo|onoffSec}} | |||
<nowiki>{{CatWeightInfo|onoff}}</nowiki> | <nowiki>{{CatWeightInfo|onoff}}</nowiki> | ||
{{CatWeightInfo|onoff}} | {{CatWeightInfo|onoff}} | ||
<nowiki>{{CatWeightInfo|amountSec}}</nowiki> (this is the default) | |||
{{CatWeightInfo|amountSec}} | |||
<nowiki>{{CatWeightInfo|amount}}</nowiki> (this is the default) | <nowiki>{{CatWeightInfo|amount}}</nowiki> (this is the default) | ||
{{CatWeightInfo|amount}} | {{CatWeightInfo|amount}} | ||
<nowiki>{{CatWeightInfo|worstcaseSec}}</nowiki> (default align is NONE!) | |||
{{CatWeightInfo|worstcaseSec}} | |||
<nowiki>{{CatWeightInfo|worstcase}}</nowiki> (default align is NONE!) | <nowiki>{{CatWeightInfo|worstcase}}</nowiki> (default align is NONE!) | ||
{{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=== | ||