MikeB: Created page with "== Description == This template contains the predefined rarity texts to be used within creature or equipment pages and takes the corresponding tags ({{ListFormat|{{Rarity|TagL..."

2022-03-19T12:34:28Z

Created page with "== Description == This template contains the predefined rarity texts to be used within creature or equipment pages and takes the corresponding tags ({{ListFormat|{{Rarity|TagL..."

New page

== Description ==
This template contains the predefined rarity texts to be used within creature or equipment pages and takes the corresponding tags ({{ListFormat|{{Rarity|TagList}}|Bullets}}) as input. The output is the description to be displayed on the Wiki page.

== Usage ==
<pre>
{{Rarity|<tag>}}
</pre>
For generating a semicolon-separated list of all available tags (intended for documentation purposes) use
<pre>
{{Rarity|TagList}}
</pre>

== Tag options ==
<table class="wikitable">
<tr><th>Tag</th><th>Output</th></tr>
<tr><td>Unique</td><td>{{Rarity|Unique}}</td></tr>
<tr><td>Limited</td><td>{{Rarity|Limited}}</td></tr>
<tr><td>Rare</td><td>{{Rarity|Rare}}</td></tr>
<tr><td>Common</td><td>{{Rarity|Common}}</td></tr>
<tr><td>Unknown</td><td>{{Rarity|Unknown}}</td></tr>
</table>

== How to add new rarity texts ==
In order to add a new rarity text, you have to insert a new case in the template's <nowiki>#switch</nowiki> structure (only parts indicated by <...> may be edited):
<pre>
|<NewTag> = <output text>
</pre>
Also, add the new tag to the existing ''TagList'' case so it will appear in any documentation:
<pre>
|TagList = ...; <NewTag>; ...
</pre>

Template:Rarity/doc - Revision history

MikeB: Created page with "== Description == This template contains the predefined rarity texts to be used within creature or equipment pages and takes the corresponding tags ({{ListFormat|{{Rarity|TagL..."