Template:ArmorType/doc: Difference between revisions
From Archaelund Wiki
(Created page with "== Description == This template contains the predefined armor types to be used within Template:Armor and takes the corresponding tags ({{ListFormat|{{ArmorType|TagList}}|B...") |
No edit summary |
||
| Line 1: | Line 1: | ||
== Description == | == Description == | ||
This template contains the predefined | This template contains the predefined consumable types to be used within [[Template:Consumable]] and takes the corresponding tags ({{ListFormat|{{ConsumableType|TagList}}|Bullets}}) as input. The output is the description to be displayed on the Wiki page. | ||
== Usage == | == Usage == | ||
<pre> | <pre> | ||
{{ | {{ConsumableType|<tag>}} | ||
</pre> | </pre> | ||
For generating a semicolon-separated list of all available tags (intended for documentation purposes) use | For generating a semicolon-separated list of all available tags (intended for documentation purposes) use | ||
<pre> | <pre> | ||
{{ | {{ConsumableType|TagList}} | ||
</pre> | </pre> | ||
| Line 14: | Line 14: | ||
<table class="wikitable"> | <table class="wikitable"> | ||
<tr><th>Tag</th><th>Output</th></tr> | <tr><th>Tag</th><th>Output</th></tr> | ||
<tr><td> | <tr><td>Potion</td><td>{{ConsumableType|Potion}}</td></tr> | ||
<tr><td> | <tr><td>Scroll</td><td>{{ConsumableType|Scroll}}</td></tr> | ||
</table> | </table> | ||
== How to add new | == How to add new consumable types == | ||
In order to add a new type, you have to insert a new case in the template's <nowiki>#switch</nowiki> structure (only parts indicated by <...> may be edited): | In order to add a new type, you have to insert a new case in the template's <nowiki>#switch</nowiki> structure (only parts indicated by <...> may be edited): | ||
<pre> | <pre> | ||
Revision as of 11:43, 28 May 2022
Description
This template contains the predefined consumable types to be used within Template:Consumable and takes the corresponding tags (Food • Potion • Scroll) as input. The output is the description to be displayed on the Wiki page.
Usage
{{ConsumableType|<tag>}}
For generating a semicolon-separated list of all available tags (intended for documentation purposes) use
{{ConsumableType|TagList}}
Tag options
| Tag | Output |
|---|---|
| Potion | Potion |
| Scroll | Scroll |
How to add new consumable types
In order to add a new type, you have to insert a new case in the template's #switch structure (only parts indicated by <...> may be edited):
|<NewTag> = <output text>
Also, add the new tag to the existing TagList case so it will appear in any documentation:
|TagList = ...; <NewTag>; ...
