Template:AI/doc: Difference between revisions
Jump to navigation
Jump to search
imported>Sekoia (historical) (Created page with "{{Documentation subpage}} <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. --> ==Usage== === Examples === {{ai|hero|huge}} <nowiki>{{ai|hero|huge}}</nowiki...") |
imported>Sekoia (historical) (→Usage) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 3: | Line 3: | ||
==Usage== | ==Usage== | ||
This template displays the icon for an alignment. (Thus, "AI" stands for "Alignment Icon".) | |||
The template accepts two parameters as thus: | |||
<nowiki>{{</nowiki>ai|''alignment''|''size''<nowiki>}}</nowiki> | |||
; alignment | |||
: This parameter should be the alignment whose icon should be displayed. Valid options for this parameter are: | |||
:* her, hero (for Hero {{ai|hero|tiny}}) | |||
:* loy, loyalist (for Loyalist {{ai|loy|tiny}}) | |||
:* pra, prae, praetorian (for Praetorian {{ai|prae|tiny}}) | |||
:* res, resistance (for Resistance {{ai|res|tiny}}) | |||
:* rog, rogue (for Rogue {{ai|rog|tiny}}) | |||
:* vig, vigilante (for Vigilante {{ai|vig|tiny}}) | |||
:* vil, vill, villain (for Villain {{ai|vil|tiny}}) | |||
: If invalid input is provided, the Hero icon will be used. | |||
; size | |||
: This parameter specifies how big to make the icon. It can be a keyword or a size. Valid keywords are: | |||
:* huge (64 pixels) | |||
:* lrg, large (42 pixels) | |||
:* med, medium (28 pixels) | |||
:* sm, small (22 pixels) | |||
:* tiny (14 pixels) | |||
: If a size is passed, it should just be a number. Do not include "px". If you pass something other than a keyword or number, you'll receive an error. If you omit the parameter, it will default to huge (64 pixels). | |||
This template is entirely case insensitive. That is, all of the following are equivalent and perfectly valid: | |||
<nowiki>{{ai|hero|huge}}</nowiki> | |||
<nowiki>{{AI|HERO|HUGE}}</nowiki> | |||
<nowiki>{{Ai|Hero|Huge}}</nowiki> | |||
<nowiki>{{aI|hErO|hUgE}}</nowiki> | |||
For consistency and sanity's sake, please call the template as either "ai" or "AI" (all lower or all upper) and please call parameters either as all lowercase or as title case. | |||
== Examples == | |||
{{ai|hero|huge}} <nowiki>{{ai|hero|huge}}</nowiki> | {{ai|hero|huge}} <nowiki>{{ai|hero|huge}}</nowiki> | ||
| Line 18: | Line 51: | ||
==See also== | ==See also== | ||
* [[Template:AlignmentIcon]] | |||
* [[:Category:Creation Icon Templates]] | |||
<includeonly><!-- | <includeonly><!-- | ||
++++ PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, THANK YOU. --> | ++++ PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, THANK YOU. --> | ||
</includeonly> | </includeonly> | ||
Latest revision as of 07:20, 19 December 2011
Usage
This template displays the icon for an alignment. (Thus, "AI" stands for "Alignment Icon".)
The template accepts two parameters as thus:
{{ai|alignment|size}}
- alignment
- This parameter should be the alignment whose icon should be displayed. Valid options for this parameter are:
- her, hero (for Hero
) - loy, loyalist (for Loyalist
) - pra, prae, praetorian (for Praetorian )
- res, resistance (for Resistance
) - rog, rogue (for Rogue
) - vig, vigilante (for Vigilante
) - vil, vill, villain (for Villain
)
- her, hero (for Hero
- If invalid input is provided, the Hero icon will be used.
- size
- This parameter specifies how big to make the icon. It can be a keyword or a size. Valid keywords are:
- huge (64 pixels)
- lrg, large (42 pixels)
- med, medium (28 pixels)
- sm, small (22 pixels)
- tiny (14 pixels)
- If a size is passed, it should just be a number. Do not include "px". If you pass something other than a keyword or number, you'll receive an error. If you omit the parameter, it will default to huge (64 pixels).
This template is entirely case insensitive. That is, all of the following are equivalent and perfectly valid:
{{ai|hero|huge}}
{{AI|HERO|HUGE}}
{{Ai|Hero|Huge}}
{{aI|hErO|hUgE}}
For consistency and sanity's sake, please call the template as either "ai" or "AI" (all lower or all upper) and please call parameters either as all lowercase or as title case.
Examples
{{ai|hero|huge}}
{{ai|res|large}}
{{ai|loy|med}}
{{ai|rog|small}}
{{ai|villain|tiny}}
{{ai|vig|40}}
See also