Editing TemplateDoc:Ref/Game

{{Notice/TemplateDoc}}

==Description==
This template should be used when citing miscellaneous elements of the ''Halo'' games, for instance parts of the menu. Specialised templates exist for citing more specific game elements such as [[Template:Ref/Quest|''Halo Infinite'' open-world missions/quests]], [[Template:Ref/Level|campaign levels]], [[Template:Ref/Map|multiplayer maps]], [[Template:Ref/FFMap|firefight maps]], [[Template:Ref/SpOps|Spartan Ops missions]] or [[Template:Ref/Mode|gametypes]].

For other citation templates, see [[Template:Ref]].

==Usage==
===Syntax===
To insert this template onto a page, place one of the following wikitext samples onto the article, and fill in as necessary. You may also add any of additional parameters seen [[#Parameters|below]] if necessary, for instance a quote, or particular detail you want to highlight.

====Citing a general description====
<pre><nowiki>{{Ref/Game|Id=ref_id|game_name_or_initials|description_of_what_you_are_citing}}</nowiki></pre>

====Citing a page about a game element====
<pre><nowiki>{{Ref/Game|Id=ref_id|game_name_or_initials|page_name|description_of_what_you_are_citing}}</nowiki></pre>

===Parameters===
{| width=100% class=wikitable
!Field Name
!Aliases
!Optional or Required?
!Description
!Example
|-
|'''Id'''
| -
|'''Recommended'''
|An ID for the reference, so it can be reused. Make it specific to your particular citation, so that it does not conflict with other IDs, and so other editors can understand it. It should always be put at the start.
|<code>ReachJFO</code>
|-
|'''1''' {{C|unnamed field}}
|Game, GameLink
|'''Required'''
|The name of the game being cited. This field supports the use of [[Halopedia:Acronyms|Halopedia's acronym system]], so <code>CE</code> can be used in place of <code>Halo: Combat Evolved</code>. If the game's page name includes a [[Halopedia:Suffixes|suffix]], please include the <code>GameText</code> field too.
|<code>Halo: Reach</code>
|-
|'''GameText'''
|GameLinkText {{C|Deprecated}}
|''Required only if Game includes a suffix''
|If the <code>Game</code> page includes a suffix, this field should be filled in with what the display text of the link should be - i.e. the page name, but without the suffix.
|<code>Halo: Reach</code>
|-
|'''2''' {{C|unnamed field}}
|What, WhatLink
|'''Recommended'''
|A description of what you are citing, or a page name. If a page name is provided, a link will automatically be created - you can use the third unnamed field (<code>WhatText</code>) to change what the display text of the link will be, if required.
|<code>Armory</code>
|-
|'''3''' {{C|unnamed field}}
|WhatText, WhatLinkText {{C|Deprecated}}
|''Required only if 2 is a page name and includes a suffix''
|If a page name is provided for the second unnamed field, then this will be the display text for the resulting link.
|<code>Armory</code>
|-
|'''Part'''
|PartLink, Expansion, DLC, Edition
|''Optional''
|A specific part or section of the game that's being cited, including DLC expansions or specific limited editions of the game. This fields accepts page names and will automatically create a link if the page exists - use <code>PartText</code> to control the display text for said link.
|<code>Halo Wars 2: Awakening the Nightmare</code>
|-
|'''PartText'''
|ExpansionText, DLCText, EditionText, PartLinkText {{C|Deprecated}}
|''Required only if Part is a page name and includes a suffix''
|If a page name is specified for <code>Part</code>, this field controls the display text for the resulting link.
|<code>Awakening the Nightmare</code>
|-
|'''Detail'''
| -
|''Optional''
|Any additional details you wish to specifically highlight about the cited game element.
|<code>JFO is a player customisation item</code>
|-
|'''Quote'''
| -
|''Optional''
|Used to cite a particular quote from the game that supports your citation.
|<code>Designed and tested at Beweglichrüstungsysteme this helmet is fully compatible with all armor systems.</code>
|-
|'''Quotee'''
|QuoteeLink
|''Optional''
|If <code>Quote</code> is used, this field can be used to specify who or what is being quoted. This field can receive a page name, in which case it will create a link. If the page name includes a [[Halopedia:Suffixes|suffix]] please include the <code>QuoteeText</code>.
|<code>Official description</code>
|-
|'''QuoteeText'''
|QuoteeLinkText {{C|Deprecated}}
|''Required only if Quotee is a page name and includes a suffix''
|If <code>Quotee</code> contains a page name, this field can be used to override the link display text.
|<code>Official description</code>
|}

===Error states===
====Warnings====
This template can emit the following warnings:

*[[Template:Internal/Warning/MissingParam|Missing recommended parameter]] - If a recommended parameter is not passed to the template.
*[[Template:Internal/Warning/DeprecatedParam|Deprecated parameter]] - If a deprecated template parameter is used in a template call.

====Errors====
This template can throw the following errors:

*[[Template:Internal/Error/MissingParam|Missing required parameter]] - If a required parameter is not passed to the template.
*[[Template:Internal/Error/InvalidParam|Invalid parameter]] - If an unrecognised parameter is passed to the template.
*[[Template:Internal/Error/ClobberedParam|Overwritten parameter]] - If the same paramater is given multiple values in the template call.

===Examples===
Here are some examples of what the template will output, when used:

====Standard usage====
<pre>{{Ref/Game|Id=HRJFOHelmet|HR|Armor permutations (Halo: Reach)|Armory}}</pre>{{Ref/Game|Id=HRJFOHelmet|HR|Armor permutations (Halo: Reach)|Armory}}
{{Ref/Sources}}

====Detail field usage====
<pre>{{Ref/Game|Id=HRJFOHelmet|HR|Armor permutations (Halo: Reach)|Armory|Detail=JFO helmet}}</pre>{{Ref/Game|Id=HRJFOHelmet|HR|Armor permutations (Halo: Reach)|Armory|Detail=JFO helmet}}
{{Ref/Sources}}

====Quote field usage====
<pre>{{Ref/Game|Id=HRJFOHelmet|HR|Armor permutations (Halo: Reach)|Armory|Quote=Designed and tested at Beweglichrüstungsysteme, this helmet is fully compatible with all armor systems.|Quotee=Official description}}</pre>
{{Ref/Game|Id=HRJFOHelmet|HR|Armor permutations (Halo: Reach)|Armory|Quote=Designed and tested at Beweglichrüstungsysteme, this helmet is fully compatible with all armor systems.|Quotee=Official description}}
{{Ref/Sources}}

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

===Module dependencies===
This template depends on the following Lua module:

*[[Module:Ref]]

===Extension dependencies===
This template requires the following extensions:

*[[mw:Extension:Scribunto|Extension:Scribunto]]
*[[Halopedia:Acronyms|Extension:Acronym]] {{C|In-house extension}}
*[[Halopedia:UniqueLink|Extension:UniqueLink]] {{C|In-house extension}}

===Dependent templates===
No other templates are known to depend on this one.

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