Editing TemplateDoc:Rank/HW

{{Notice/TemplateDoc}}

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

==Usage==
===Syntax===
To insert this template onto a page, place the following wikitext onto the article.
<pre><nowiki>{{Rank/HW}}</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
|lt=Lieutenant
|capt=Captain
|majr=Major
|cmdr=Commander
|col=Colonel
|brig=Brigadier
|gen=General
</nowiki></pre>

The second input is a number, used for dictating which star-level the rank is levelled at (if relevant). This is only relevant for the General ranks introduced in ''[[Halo Wars: Definitive Edition]]'', so shouldn't be used often. Accepted inputs include;
<pre><nowiki>
|1                (For most cases, you will only ever need to use this parameter)
|2
|3
|4
</nowiki></pre>

If you want to link the rank page and display the rank name, you can use the following parameter for the third input;
<pre><nowiki>
|link = Displays the link as Rank, Grade X (X being then number inputted in step two; or none if 1)
</nowiki></pre>

===Error states===
This template uses the user input to generate the filename based off the ones found [[:Category:Halo 3 rank insignia|here]]. As such, inputting rank/grade combinations that do not exist will result in the template not displaying properly. As this template relies on the ''Halo 3'' rank template info to generate, inputting ''Halo 3'' ranks not found in ''Halo Wars'' will also result in those ranks displaying despite not appearing in ''Halo Wars''.

===Example===
Here is an example of what the template will output, when used:
{| class="wikitable"
!Wiki markup
!Result
|-
|<pre><nowiki>{{Rank/HW|recruit}}</nowiki></pre>
|{{Rank/HW|recruit}}
|-
|<pre><nowiki>{{Rank/HW|recruit|1|link}}</nowiki></pre>
|{{Rank/HW|recruit|1|link}}
|-
|<pre><nowiki>{{Rank/HW|lt|1|link}}</nowiki></pre>
|{{Rank/HW|lt|1|link}}
|-
|<pre><nowiki>{{Rank/HW|gen|1|link}}</nowiki></pre>
|{{Rank/HW|gen|1|link}}
|-
|<pre><nowiki>{{Rank/HW|gen|4|link}}</nowiki></pre>
|{{Rank/HW|gen|4|link}}
|}

==Dependencies==
===Template dependencies===
This template depends on the following templates. It does depend on the images found at [[:Category:Halo 3 rank insignia]].
*[[Template:Rank/H3/Ranks]] - handles turning the input for parameter 1 into a rank full name.
*[[Template:Rank/H3/Icons]] - handles turning the input for parameter 1 into a rank name for image-link generation.

===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!
*[[Template:Documentation]]

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