View source for TemplateDoc:Rank/HR

{{Notice/TemplateDoc}}

==Description==
This template is used as a shorthand to insert a reference to a ''Halo: Reach'' [[Rank (Halo: Reach)|multiplayer rank]]. Doing so will automatically generate the rank icon and, if prompted, a link to the rank page and the rank name.

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

===Parameters===
This template accepts four parameters, though only the first one is required. The first is a shortened version of the rank, shown below.
<pre><nowiki>
recruit=Recruit
pvt=Private
cpl=Corporal
sgt=Sergeant
wo=WarrantOfficer
capt=Captain
majr=Major
ltcol=Lieutenant Colonel
cmdr=Commander
col=Colonel
brig=Brigadier
gen=General
fm=Field Marshall
hero=Hero
legend=Legend
mythic=Mythic
noble=Noble
eclipse=Eclipse
nova=Nova
forerunner=Forerunner
reclaimer=Reclaimer
inheritor=Inheritor
</nowiki></pre>

The second is a number, used for dictating which grade the rank is levelled at (if relevant). Accepted inputs include;
<pre><nowiki>
1
2
3
4
</nowiki></pre>

If no rank grade is required, this input is not needed. The third input consists of the following, and should only be used if you intend to have the template display the rank name alongside the icon. This input is binary, and as long as there is an input, it will use the same rank as defined in the first input.
<pre><nowiki>
|link=yes
</nowiki></pre>

The fourth input only needs to be used if the rank in question is a specific grade. Once again, this is binary and will use the grade defined earlier.
<pre><nowiki>
|grade=yes
</nowiki></pre>

===Error states===
This template uses the user input to generate the filename based off the ones found [[:Category:Halo: Reach rank insignia|here]]. As such, inputting rank/grade combinations that do not exist will result in the template not displaying properly.

===Example===
Here is an example of what the template will output, when used:
{| class="wikitable"
!Wiki markup
!Result
|-
|<pre><nowiki>The armour can be unlocked at {{Rank/HR|gen}}</nowiki></pre>
|The armour can be unlocked at {{Rank/HR|gen|link}}
|-
|<pre><nowiki>The armour can be unlocked at {{Rank/HR|gen}}</nowiki></pre>
|The armour can be unlocked at {{Rank/HR|gen|link}}
|-
|<pre><nowiki>The armour can be unlocked at {{Rank/HR|gen|3}}</nowiki></pre>
|The armour can be unlocked at {{Rank/HR|gen|3}}
|-
|<pre><nowiki>The armour can be unlocked at {{Rank/HR|gen|3|link=yes|grade=yes}}</nowiki></pre>
|The armour can be unlocked at {{Rank/HR|gen|3|link=yes|grade=yes}}
|}

==Dependencies==
===Template dependencies===
This template depends on the following templates. It does depend on the images found at [[:Category:Halo: Reach rank insignia]].
*[[Template:Rank/HR/Ranks]]

===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>