TemplateDoc:Ref/Game: Difference between revisions

From Halopedia, the Halo wiki
(minor spelling polishes)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Notice/TemplateDoc}}
{{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==
==Usage==
This template should be used when citing games. For other citation templates, see [[Template:Ref]]. For more reference templates, see [[Template:Ref]].
===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 additional parameters seen [[#Parameters|below]] such as a quote or particular detail you want to highlight.


===Full layout===
====Citing a general description====
While not every field is '''Required'''. Here is where every field should go if needed.
<pre><nowiki>{{Ref/Game|Id=Ref ID|Game name or acronym|Description of what you are citing}}</nowiki></pre>
<pre><nowiki>
{{Ref/Site
|Id=
|Game=
|GameLinkText=
|Section=
|SectionLinkText=
|Detail=
|Quote=
|Quotee=
|QuoteeLinkText=
}}</nowiki></pre>


===Fields===
====Citing a page about a game element====
<pre><nowiki>{{Ref/Game|Id=Ref ID|Game name or acronym|Page name|Description of what you are citing}}</nowiki></pre>
 
===Parameters===
{| width=100% class=wikitable
{| width=100% class=wikitable
!Field Name
!Field Name
!Aliases
!Optional or Required?
!Optional or Required?
!Description
!Description
Line 29: Line 25:
|-
|-
|'''Id'''
|'''Id'''
|''Recommended''
| -
|An ID for the reference, so it can be reused. Make it tied to the source so it does not conflict with other IDs. Always put this at the start. While not '''Required''' it is recommended to give every source a unique <code>Id</code> for future use.
|'''Recommended'''
|HRJFOHelmet
|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>
|-
|-
|'''Game'''
|'''1''' {{C|unnamed field}}
|Game, GameLink
|'''Required'''
|'''Required'''
|The name of the game being cited. Alternatively the following [[Halopedia:Acronyms#Video_games|Acronyms]] can be used. If the page name includes a [[Halopedia:Suffixes|suffix]] please include a <code>GameLinkText</code>.
|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.
|<nowiki>Halo: Reach</nowiki>
|<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>
|-
|-
|'''GameLinkText'''
|'''3''' {{C|unnamed field}}
|''Required only if Game includes a Suffix''
|WhatText, WhatLinkText {{C|Deprecated}}
|This is to put what the <code>Game</code> field reads in the citation if it includes a [[Halopedia:Suffixes|suffix]].
|''Required only if 2 is a page name and includes a suffix''
|<nowiki>Halo: Reach</nowiki>
|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>
|-
|-
|'''Section'''
|'''Part'''
|''Recommended''
|PartLink, Expansion, DLC, Edition
|The section of the game being cited. While not '''Required''' it is recommended to try and be as exact in where you are citing. Please include the page name as exact as possible. If the page name includes a [[Halopedia:Suffixes|suffix]] please include a <code>SectionLinkText</code>.
|''Optional''
|Armory
|A specific part or section of the game that's being cited, including DLC expansions or specific limited editions of the game. This field 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>
|-
|-
|'''SectionLinkText'''
|'''PartText'''
|''Required only if Section includes a Suffix''
|ExpansionText, DLCText, EditionText, PartLinkText {{C|Deprecated}}
|This is to put what the <code>Section</code> field reads in the citation if it includes a [[Halopedia:Suffixes|suffix]].
|''Required only if Part is a page name and includes a suffix''
|Armory
|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'''
|'''Detail'''
| -
|''Optional''
|''Optional''
|Used to describe the item in question.
|Any additional details you wish to specifically highlight about the cited game element.
|JFO is used by Soldiers in Halo: Reach.
|<code>JFO is a player customisation item</code>
|-
|-
|'''Quote'''
|'''Quote'''
| -
|''Optional''
|''Optional''
|When citing a particular quote from the game, this should be used. However, it '''cannot''' be used if the <code>Details</code> field is used.
|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.
|<code>Designed and tested at Beweglichrüstungsysteme this helmet is fully compatible with all armor systems.</code>
|-
|-
|'''Quotee'''
|'''Quotee'''
|QuoteeLink
|''Optional''
|''Optional''
|This is to put who or what said a "quote". Please put in the page name exactly. If the page name includes a [[Halopedia:Suffixes|suffix]] please include a <code>QuoteeLinkText</code>.
|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>.
|Armory
|<code>Official description</code>
|-
|-
|'''QuoteeLinkText'''
|'''QuoteeText'''
|''Required only if Quotee includes a Suffix''
|QuoteeLinkText {{C|Deprecated}}
|This is to put what the <code>Quotee</code> field reads in the citation if it includes a [[Halopedia:Suffixes|suffix]].
|''Required only if Quotee is a page name and includes a suffix''
|Armory
|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 parameter is given multiple values in the template call.


===Examples===
===Examples===
*Recommended normal use: {{Ref/Game|Id=HRJFOHelmet|Game=HR|Section=Armor permutations (Halo: Reach)|SectionLinkText=Armory|Detail=JFO - Helmet Description}}<pre>{{Ref/Game|Id=HRJFOHelmet|Game=HR|Section=Armor permutations (Halo: Reach)|SectionLinkText=Armory|Detail=JFO - Helmet Description}}</pre>
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}}
{{Ref/Sources}}


*Details example: {{Ref/Game|Id=HRJFOHelmet|Game=Halo: Reach|Section=Armor permutations (Halo: Reach)|SectionLinkText=Armory|Detail=JFO - Helmet Description}}<pre>{{Ref/Game|Id=HRJFOHelmet|Game=Halo: Reach|Section=Armor permutations (Halo: Reach)|SectionLinkText=Armory|Detail=JFO - Helmet Description}}</pre>
====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}}
{{Ref/Sources}}


*Quote example: {{Ref/Game|Id=HRJFOHelmet|Game=Halo: Reach|Section=Armory|Quote=Designed and tested at Beweglichrüstungsysteme this helmet is fully compatible with all armor systems.|Quotee=Armory}}<pre>{{Ref/Game|Id=HRJFOHelmet|Game=Halo: Reach|Section=Armor permutations (Halo: Reach)|SectionLinkText=Armory|Quote=Designed and tested at Beweglichrüstungsysteme this helmet is fully compatible with all armor systems.|Quotee=Armory}}</pre>
====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}}
{{Ref/Sources}}


*Acronym example: {{Ref/Game|Id=HRMenu|Game=HR|Section=Main Menu}} <pre>{{Ref/Game|Id=HRMenu|Game=HR|Section=Main Menu}}</pre>
==Dependencies==
{{Ref/Sources}}
===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:


==Quick citation==
*[[mw:Extension:Scribunto|Extension:Scribunto]]
For quick references you can avoid using fields. By simply using the following. It however is not recommended as the above goes into more detail, but for fast sourcing it helps.
*[[Halopedia:Acronyms|Extension:Acronym]] {{C|In-house extension}}
*[[Halopedia:UniqueLink|Extension:UniqueLink]] {{C|In-house extension}}


The first field is the "Game" field and [[Halopedia:Acronyms#Video_games|Acronyms]] can be used. The second field is the link itself. The third field is the text shown if the link has a [[Halopedia:Suffixes|suffix]] on the end.
===Dependent templates===
*Example: {{Ref/Game|HR|Cart|Carty}} <pre>{{Ref/Game|HR|Cart|Carty}}</pre>
No other templates are known to depend on this one.
{{Ref/Sources}}


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

Latest revision as of 22:24, September 15, 2022

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

Description[edit]

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[edit]

Syntax[edit]

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 additional parameters seen below such as a quote or particular detail you want to highlight.

Citing a general description[edit]

{{Ref/Game|Id=Ref ID|Game name or acronym|Description of what you are citing}}

Citing a page about a game element[edit]

{{Ref/Game|Id=Ref ID|Game name or acronym|Page name|Description of what you are citing}}

Parameters[edit]

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 field 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[edit]

Warnings[edit]

This template can emit the following warnings:

Errors[edit]

This template can throw the following errors:

Examples[edit]

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

Standard usage[edit]

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

[1]

  1. ^ Halo: Reach, Armory

Detail field usage[edit]

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

[1]

  1. ^ Halo: Reach, Armory: JFO helmet

Quote field usage[edit]

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

[1]

  1. ^ Halo: Reach, Armory: "Designed and tested at Beweglichrüstungsysteme, this helmet is fully compatible with all armor systems." - Official description

Dependencies[edit]

Template dependencies[edit]

This template does not depend on any other templates.

Module dependencies[edit]

This template depends on the following Lua module:

Extension dependencies[edit]

This template requires the following extensions:

Dependent templates[edit]

No other templates are known to depend on this one.

Retrieved from "https://www.halopedia.org/index.php?title=TemplateDoc:Ref/Game&oldid=1552676"