Template:Eyecatch3/doc: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| 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.}} | |||
== | ==Alternative names== | ||
< | * <tt><nowiki>{{eyecatch3|<type>}}</nowiki></tt> | ||
* <tt><nowiki>{{cwi|<type>}}</nowiki></tt> - alternate template name | |||
* <tt><nowiki>{{eyecatch3|<type>|<align>}}</nowiki></tt> | |||
* <tt><nowiki>{{cwi|<type>|<align>}}</nowiki></tt> - alternate template name | |||
==Syntax== | |||
The template can have '''1''' or '''2 parameters''': | |||
#{{m|eyecatch3|<type>}} - Default mode, no alignment! | |||
#{{m|eyecatch3|<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. | |||
{{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!}} | |||
{{eyecatch3| | ==Example Category Weight Info Boxes== | ||
===The six <type>s of info boxes=== | |||
<nowiki>{{eyecatch3|onoffSec}}</nowiki> | |||
{{eyecatch3|onoffSec}} | |||
<nowiki>{{eyecatch3|onoff}}</nowiki> | |||
{{eyecatch3|onoff}} | |||
< | <nowiki>{{eyecatch3|amountSec}}</nowiki> (this is the default) | ||
{{eyecatch3|amountSec}} | |||
<nowiki>{{eyecatch3|amount}}</nowiki> (this is the default) | |||
{{eyecatch3|amount}} | |||
{{eyecatch3| | <nowiki>{{eyecatch3|worstcaseSec}}</nowiki> (default align is NONE!) | ||
{{eyecatch3|worstcaseSec}} | |||
<nowiki>{{eyecatch3|worstcase}}</nowiki> (default align is NONE!) | |||
{{eyecatch3|worstcase}} | |||
< | ===The <align> used for indentation=== | ||
<nowiki>{{eyecatch3|amount|1}}</nowiki> (indent level 1) | |||
{{eyecatch3|amount|1}} | |||
===The <align>ment of the info boxes=== | |||
<nowiki>{{eyecatch3|onoff|right}}</nowiki> | |||
{{eyecatch3|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... | |||
<nowiki>{{eyecatch3|amount|left}}</nowiki> | |||
< | {{eyecatch3|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... | |||
{{eyecatch3| | |||
Revision as of 11:46, 15 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
- {{eyecatch3|<type>}}
- {{cwi|<type>}} - alternate template name
- {{eyecatch3|<type>|<align>}}
- {{cwi|<type>|<align>}} - alternate template name
Syntax
The template can have 1 or 2 parameters:
- {{eyecatch3|<type>}} - Default mode, no alignment!
- {{eyecatch3|<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
{{eyecatch3|onoffSec}}
|
{{eyecatch3|onoff}}
|
{{eyecatch3|amountSec}} (this is the default)
|
{{eyecatch3|amount}} (this is the default)
|
{{eyecatch3|worstcaseSec}} (default align is NONE!)
|
{{eyecatch3|worstcase}} (default align is NONE!)
|
The <align> used for indentation
{{eyecatch3|amount|1}} (indent level 1)
|
The <align>ment of the info boxes
{{eyecatch3|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...
{{eyecatch3|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...