View source for Template:SpellAttributes/doc

== Description ==
This template contains the predefined spell attributes to be used within [[Template:Spell]] and takes a list of the corresponding tags ({{ListFormat|{{SpellAttributes|Tag}}|Bullets}}) as input. The output is a list of the description (either as text or image) to be displayed on the Wiki page.

Note that the order of the output list produced by this template is fixed, irrespective of the order of the input list. Unknown or duplicate tags are ignored.

== Usage ==
<pre>
{{SpellAttributes|<format>|<semicolon-separated list of tags>}}
</pre>

== Format options ==
<table class="wikitable">
<tr><th>Format</th><th>Description</th><th>Example output</th></tr>
<tr><td>Text</td><td>Outputs a semicolon-separated list of the attribute descriptions (plain text).</td><td>{{SpellAttributes|Text|{{SpellAttributes|Tag}}}}</td></tr>
<tr><td>Image</td><td>Outputs a semicolon-separated list of the attribute icons, with the respective attribute description shown as a tooltip.</td><td>{{SpellAttributes|Image|{{SpellAttributes|Tag}}}}</td></tr>
<tr><td>Tag</td><td>Outputs a semicolon-separated list of all available attribute tags. This is intended for documentation purposes only.</td><td>{{SpellAttributes|Tag}}</td></tr>
</table>
The semicolon-separated output lists may further be processed by using [[Template:ListFormat]].

== How to add new spell attributes ==
In order to add a new attribute, you have to insert the following line in the template's code (only parts indicated by <...> may be edited):
<pre>
-->{{Attribute|{{{1|}}}|{{{2|}}}|Tag=<new tag>|Text=<output text>|Image=<output icon>}}<!--
</pre>
Note that the order of the attribute lines directly determines the order of the output list, so choose the position of the inserted code accordingly.