TemplateDoc:Ref/Game

This is a template documentation page!

You cannot edit the associated template from here. To do so, please see Template:Ref/Game instead!

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 Halo Infinite open-world missions/quests, campaign levels, multiplayer maps, firefight maps, Spartan Ops missions or 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 below if necessary, for instance a quote, or particular detail you want to highlight.

Citing a general description

{{Ref/Game|Id=ref_id|game_name_or_acronym|description_of_what_you_are_citing}}

Citing a page about a game element

{{Ref/Game|Id=ref_id|game_name_or_acronym|page_name|description_of_what_you_are_citing}}

Parameters

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.	ReachJFO
1 (unnamed field)	Game, GameLink	Required	The name of the game being cited. This field supports the use of Halopedia's acronym system, so CE can be used in place of Halo: Combat Evolved. If the game's page name includes a suffix, please include the GameText field too.	Halo: Reach
GameText	GameLinkText (Deprecated)	Required only if Game includes a suffix	If the Game 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.	Halo: Reach
2 (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 (WhatText) to change what the display text of the link will be, if required.	Armory
3 (unnamed field)	WhatText, WhatLinkText (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.	Armory
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 PartText to control the display text for said link.	Halo Wars 2: Awakening the Nightmare
PartText	ExpansionText, DLCText, EditionText, PartLinkText (Deprecated)	Required only if Part is a page name and includes a suffix	If a page name is specified for Part, this field controls the display text for the resulting link.	Awakening the Nightmare
Detail	-	Optional	Any additional details you wish to specifically highlight about the cited game element.	JFO is a player customisation item
Quote	-	Optional	Used to cite a particular quote from the game that supports your citation.	Designed and tested at Beweglichrüstungsysteme this helmet is fully compatible with all armor systems.
Quotee	QuoteeLink	Optional	If Quote 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 suffix please include the QuoteeText.	Official description
QuoteeText	QuoteeLinkText (Deprecated)	Required only if Quotee is a page name and includes a suffix	If Quotee contains a page name, this field can be used to override the link display text.	Official description

Error states

Warnings

This template can emit the following warnings:

• Missing recommended parameter - If a recommended parameter is not passed to the template.
• Deprecated parameter - If a deprecated template parameter is used in a template call.

Errors

This template can throw the following errors:

• Missing required parameter - If a required parameter is not passed to the template.
• Invalid parameter - If an unrecognised parameter is passed to the template.
• 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

{{Ref/Game|Id=HRJFOHelmet|HR|Armor permutations (Halo: Reach)|Armory}}

Detail field usage

{{Ref/Game|Id=HRJFOHelmet|HR|Armor permutations (Halo: Reach)|Armory|Detail=JFO helmet}}

Quote field usage

{{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}}

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:

• Extension:Scribunto
• Extension:Acronym (In-house extension)
• Extension:UniqueLink (In-house extension)

Dependent templates

No other templates are known to depend on this one.