View source for TemplateDoc:H5Rarity

{{Notice/TemplateDoc}}

==Description==
This template is used as a shorthand to change the colour of text, when referring to the rarity of a [[List of REQ cards|REQ card]] in ''[[Halo 5: Guardians]]''.

Similar templates, [[Template:HW2Rarity]] and [[Template:HINFRarity]], exist to cover items in ''[[Halo Wars 2]]'' and ''[[Halo Infinite]]''.

==Usage==
===Syntax===
To insert this template onto a page, place the following wikitext onto the article.
<pre><nowiki>{{H5Rarity}}</nowiki></pre>

===Parameters===
This template accepts two parameters. The first is mandatory, and will only accept one of the following inputs, which determine the colour of the text:
* Common
* Uncommon
* Rare
* Ultra Rare
* Legendary
* Mythic

The second input is optional, and can be used to change the displayed text, should it be needed. There is almost no need for this second input to be used, but it is included in case of irregularities.

===Error states===
Entering any first input except the above listed will break the template.

===Example===
Here is an example of what the template will output, when used:
{| class="wikitable"
!Wiki markup
!Result
|-
|<pre><nowiki>{{H5Rarity|Common}}</nowiki></pre>
|{{H5Rarity|Common}}
|-
|<pre><nowiki>{{H5Rarity|Uncommon}}</nowiki></pre>
|{{H5Rarity|Uncommon}}
|-
|<pre><nowiki>{{H5Rarity|Rare}}</nowiki></pre>
|{{H5Rarity|Rare}}
|-
|<pre><nowiki>{{H5Rarity|Ultra Rare}}</nowiki></pre>
|{{H5Rarity|Ultra Rare}}
|-
|<pre><nowiki>{{H5Rarity|Legendary}}</nowiki></pre>
|{{H5Rarity|Legendary}}
|-
|<pre><nowiki>{{H5Rarity|Mythic}}</nowiki></pre>
|{{H5Rarity|Mythic}}
|-
|<pre><nowiki>{{H5Rarity|Legendary|displaytext}}</nowiki></pre>
|{{H5Rarity|Legendary|displaytext}}
|}

==Dependencies==
===Template dependencies===
This template does not depend on any templates.

===Extension dependencies===
This template does not require any extensions.

===Dependent templates===
The following templates depend upon this one. If you are making changes to this template, please ensure that they will not break any of them!


<noinclude>[[Category:Shorthand template documentation]]</noinclude>