TemplateDoc:Ref/Audio: Difference between revisions

From Halopedia, the Halo wiki

(Created page with "{{Notice/TemplateDoc}} ==Description== This template should be used when citing ''Halo'' audio media, such as audio dramas. For other citation templates, see [[Template:Ref]...")
 
(minor word swappin)
Line 2: Line 2:


==Description==
==Description==
This template should be used when citing ''Halo'' audio media, such as audio dramas.
This template should be used when citing ''Halo'' audio media, such as audio dramas. For other citation templates, see [[Template:Ref]].
 
For other citation templates, see [[Template:Ref]].


==Usage==
==Usage==
===Syntax===
===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.
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 standalone audio piece====
====Citing a standalone audio piece====
<pre><nowiki>
<pre><nowiki>
{{Ref/Audio|Id=ref_id|audio_series_name_or_acronym|time_code}}
{{Ref/Audio|Id=Ref ID|Audio series name or acronym|Time code}}
</nowiki></pre>
</nowiki></pre>


====Citing an episode in a larger audio series====
====Citing an episode in a larger audio series====
<pre><nowiki>
<pre><nowiki>
{{Ref/Audio|Id=ref_id|audio_series_name_or_acronym|Ep=episode|time_code}}
{{Ref/Audio|Id=Ref ID|Audio series name or acronym|Ep=Episode|Time code}}
</nowiki></pre>
</nowiki></pre>


Line 49: Line 47:
|Episode
|Episode
|''Optional''
|''Optional''
|The particualar episode being cited, if the media is a series.
|The particular episode being cited, if the media is a series.
|<code>Episode 00: Primer</code>
|<code>Episode 00: Primer</code>
|-
|-
|'''2''' {{C|unnamed field}}
|'''2''' {{C|unnamed field}}
|Time, Tiemstamp
|Time, Timestamp
|'''Recommended'''
|'''Recommended'''
|The timestamp that the cited audio takes place at.
|The timestamp that the cited audio takes place at.
Line 95: Line 93:
*[[Template:Internal/Error/MissingParam|Missing required parameter]] - If a required parameter is not passed to the template.
*[[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/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.
*[[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:
Here are some examples of what the template will output when used:


====Standard usage====
====Standard usage====

Revision as of 21:14, September 15, 2022

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

Description

This template should be used when citing Halo audio media, such as audio dramas. 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.

Citing a standalone audio piece

{{Ref/Audio|Id=Ref ID|Audio series name or acronym|Time code}}

Citing an episode in a larger audio series

{{Ref/Audio|Id=Ref ID|Audio series name or acronym|Ep=Episode|Time code}}

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) Audio Required The name of the piece of audio media. 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 AudioText field too. Hunt the Truth
AudioText AudioLinkText (Deprecated) Required only if Audio includes a suffix If the Audio 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. Hunt the Truth
Ep (unnamed field) Episode Optional The particular episode being cited, if the media is a series. Episode 00: Primer
2 (unnamed field) Time, Timestamp Recommended The timestamp that the cited audio takes place at. 03:40
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:

Errors

This template can throw the following errors:

Examples

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

Standard usage

{{Ref/Audio|Id=Rebirth|Rebirth|5:60}}

[1]

  1. ^ Rebirth, episode 05:60

Episode field usage

{{Ref/Audio|Id=HtT|HtT|Ep=00: Primer|2:50}}

[1]

  1. ^ HUNTtheTRUTH, episode 2:50

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:

Dependent templates

No other templates are known to depend on this one.

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