Template:ArmorType/doc: Difference between revisions

From Archaelund Wiki
No edit summary
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Description ==
== Description ==
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.
This template contains the predefined armor types to be used within [[Template:Armor]] and takes the corresponding tags ({{ListFormat|{{ArmorType|TagList}}|Bullets}}) as input. The output is the description to be displayed on the Wiki page.


== Usage ==
== Usage ==
<pre>
<pre>
{{ConsumableType|<tag>}}
{{ArmorType|<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}}
{{ArmorType|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>Potion</td><td>{{ConsumableType|Potion}}</td></tr>
<tr><td>Garment</td><td>{{ArmorType|Garment}}</td></tr>
<tr><td>Scroll</td><td>{{ConsumableType|Scroll}}</td></tr>
<tr><td>Jewelry</td><td>{{ArmorType|Jewelry}}</td></tr>
<tr><td>Shield</td><td>{{ArmorType|Shield}}</td></tr>
</table>
</table>


== How to add new consumable types ==
== How to add new armor 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>

Latest revision as of 20:10, 13 January 2025

Description

This template contains the predefined armor types to be used within Template:Armor and takes the corresponding tags (Garment • Jewelry • Shield) as input. The output is the description to be displayed on the Wiki page.

Usage

{{ArmorType|<tag>}}

For generating a semicolon-separated list of all available tags (intended for documentation purposes) use

{{ArmorType|TagList}}

Tag options

TagOutput
GarmentGarment
JewelryJewelry
ShieldShield

How to add new armor 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>; ...