Template:Ref/File
From Halopedia, the Halo wiki
Description
This template should be used when citing internal files of the Halo games and modding toolkits. Specialised templates exist for citing more specific game elements such as general game attributes, 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 additional parameters seen below such as a quote or particular detail you want to highlight.
{{Ref/File|Id=Ref ID|Game name or acronym|File path and file name of the file in question|Relevant quote or excerpt from the file}}
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
|
| 2 (unnamed field) | File | Required | The full file path and filename of the file you are citing in question. | data\ui\unlockdb.xml
|
| 3 (unnamed field) | Excerpt | Recommended if needing to quote specific text from a large file | This field allows you to quote text from the file. | S10 H2A WEAPON SKINS
|
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 parameter is given multiple values in the template call.
Examples
Here are some examples of what the template will output when used:
Standard usage
{{Ref/File|Id=Unlock|HTMCC|data\ui\unlockdb.xml|S10 H2A WEAPON SKINS}}[1]
- ^ Halo: The Master Chief Collection, game file
data\ui\unlockdb.xml, excerptS10 H2A WEAPON SKINS
{{Ref/File|Id=Unlock2|HTMCC|File=data\ui\unlockdb.xml|Excerpt=S10 H2A WEAPON SKINS}}[1]
- ^ Halo: The Master Chief Collection, game file
data\ui\unlockdb.xml, excerptS10 H2A WEAPON SKINS
Dependencies
Template dependencies
This template does not depend on any other templates.
Module dependencies
This template depends on the following Lua module:
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.