| Latest revision |
Your text |
| 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== |
| ===Syntax===
| | This template should be used when citing games. For other citation templates, see [[Template:Ref]]. For more reference templates, see [[Template:Ref]]. |
| 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.
| |
|
| |
|
| ====Citing a general description==== | | ===Full layout=== |
| <pre><nowiki>{{Ref/Game|Id=Ref ID|Game name or acronym|Description of what you are citing}}</nowiki></pre> | | While not every field is '''Required'''. Here is where every field should go if needed. |
| | <pre><nowiki> |
| | {{Ref/Site |
| | |Id= |
| | |Game= |
| | |GameLinkText= |
| | |Section= |
| | |SectionLinkText= |
| | |Detail= |
| | |Quote= |
| | |Quotee= |
| | |QuoteeLinkText= |
| | }}</nowiki></pre> |
|
| |
|
| ====Citing a page about a game element==== | | ===Fields=== |
| <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 25: |
Line 29: |
| |- | | |- |
| |'''Id''' | | |'''Id''' |
| | - | | |''Recommended'' |
| |'''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. |
| |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. | | |HRJFOHelmet |
| |<code>ReachJFO</code>
| |
| |- | | |- |
| |'''1''' {{C|unnamed field}} | | |'''Game''' |
| |Game, GameLink
| |
| |'''Required''' | | |'''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. | | |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>. |
| |<code>Halo: Reach</code>
| | |<nowiki>Halo: Reach</nowiki> |
| |-
| |
| |'''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}} | | |'''GameLinkText''' |
| |WhatText, WhatLinkText {{C|Deprecated}}
| | |''Required only if Game includes a Suffix'' |
| |''Required only if 2 is a page name and includes a suffix'' | | |This is to put what the <code>Game</code> field reads in the citation if it includes a [[Halopedia:Suffixes|suffix]]. |
| |If a page name is provided for the second unnamed field, then this will be the display text for the resulting link. | | |<nowiki>Halo: Reach</nowiki> |
| |<code>Armory</code> | |
| |- | | |- |
| |'''Part''' | | |'''Section''' |
| |PartLink, Expansion, DLC, Edition
| | |''Recommended'' |
| |''Optional'' | | |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>. |
| |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. | | |Armory |
| |<code>Halo Wars 2: Awakening the Nightmare</code> | |
| |- | | |- |
| |'''PartText''' | | |'''SectionLinkText''' |
| |ExpansionText, DLCText, EditionText, PartLinkText {{C|Deprecated}}
| | |''Required only if Section includes a Suffix'' |
| |''Required only if Part is a page name and includes a suffix'' | | |This is to put what the <code>Section</code> field reads in the citation if it includes a [[Halopedia:Suffixes|suffix]]. |
| |If a page name is specified for <code>Part</code>, this field controls the display text for the resulting link. | | |Armory |
| |<code>Awakening the Nightmare</code> | |
| |- | | |- |
| |'''Detail''' | | |'''Detail''' |
| | -
| |
| |''Optional'' | | |''Optional'' |
| |Any additional details you wish to specifically highlight about the cited game element. | | |Used to describe the item in question. |
| |<code>JFO is a player customisation item</code> | | |JFO is used by Soldiers in Halo: Reach. |
| |- | | |- |
| |'''Quote''' | | |'''Quote''' |
| | -
| |
| |''Optional'' | | |''Optional'' |
| |Used to cite a particular quote from the game that supports your citation. | | |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. |
| |<code>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. |
| |- | | |- |
| |'''Quotee''' | | |'''Quotee''' |
| |QuoteeLink
| |
| |''Optional'' | | |''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>. | | |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>. |
| |<code>Official description</code> | | |Armory |
| |- | | |- |
| |'''QuoteeText''' | | |'''QuoteeLinkText''' |
| |QuoteeLinkText {{C|Deprecated}}
| | |''Required only if Quotee includes a Suffix'' |
| |''Required only if Quotee is a page name and includes a suffix'' | | |This is to put what the <code>Quotee</code> field reads in the citation if it includes a [[Halopedia:Suffixes|suffix]]. |
| |If <code>Quotee</code> contains a page name, this field can be used to override the link display text. | | |Armory |
| |<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=== |
| Here are some examples of what the template will output when used:
| | *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> |
| | {{Ref/Sources}} |
|
| |
|
| ====Standard usage====
| | *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> |
| <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}} |
|
| |
|
| ====Detail field usage====
| | *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> |
| <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 field usage====
| | *Acronym example: {{Ref/Game|Id= HRMenu| Game=HR| Section= Main Menu}} <pre>{{Ref/Game|Id= HRMenu| Game=HR| Section= Main Menu}} </pre> |
| <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}} |
|
| |
|
| ==Dependencies== | | ==Quick citation== |
| ===Template dependencies===
| | 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. |
| 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===
| | 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. |
| No other templates are known to depend on this one.
| | *Example: {{Ref/Game|HR|Cart|Carty}} <pre>{{Ref/Game|HR|Cart|Carty}}</pre> |
| | {{Ref/Sources}} |
|
| |
|
| <noinclude>[[Category:Reference template documentation]]</noinclude>
| | [[Category:Reference template documentation]] |