Template:AI/doc

From Homecoming Wiki
< Template:AI
Revision as of 07:20, 19 December 2011 by imported>Sekoia (historical) (→‎Usage)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
This is a documentation subpage for Template:AI (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.

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 CreateSymbol Hero.png)
  • loy, loyalist (for Loyalist CreateSymbol Praetorian.png)
  • pra, prae, praetorian (for Praetorian CreateSymbol Praetorian.png)
  • res, resistance (for Resistance CreateSymbol Resistance.png)
  • rog, rogue (for Rogue CreateSymbol Rogue.png)
  • vig, vigilante (for Vigilante CreateSymbol Vigilante.png)
  • vil, vill, villain (for Villain CreateSymbol Villain.png)
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

CreateSymbol Hero.png {{ai|hero|huge}}

CreateSymbol Resistance.png {{ai|res|large}}

CreateSymbol Praetorian.png {{ai|loy|med}}

CreateSymbol Rogue.png {{ai|rog|small}}

CreateSymbol Villain.png {{ai|villain|tiny}}

CreateSymbol Vigilante.png {{ai|vig|40}}

See also