Editing TemplateDoc:Ref/Audio

{{Notice/TemplateDoc}}

==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 of additional parameters seen [[#Parameters|below]] if necessary, for instance a quote, or particular detail you want to highlight.

====Citing a standalone audio piece====
<pre><nowiki>
{{Ref/Audio|Id=ref_id|audio_series_name_or_acronym|time_code}}
</nowiki></pre>

====Citing an episode in a larger audio series====
<pre><nowiki>
{{Ref/Audio|Id=ref_id|audio_series_name_or_acronym|Ep=episode|time_code}}
</nowiki></pre>

===Parameters===
{| width=100% class=wikitable
!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.
|<code>ReachJFO</code>
|-
|'''1''' {{C|unnamed field}}
|Audio
|'''Required'''
|The name of the piece of audio media. 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>AudioText</code> field too.
|<code>Hunt the Truth</code>
|-
|'''AudioText'''
|AudioLinkText {{C|Deprecated}}
|''Required only if Audio includes a suffix''
|If the <code>Audio</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>Hunt the Truth</code>
|-
|'''Ep''' {{C|unnamed field}}
|Episode
|''Optional''
|The particualar episode being cited, if the media is a series.
|<code>Episode 00: Primer</code>
|-
|'''2''' {{C|unnamed field}}
|Time, Tiemstamp
|'''Recommended'''
|The timestamp that the cited audio takes place at.
|<code>03:40</code>
|-
|'''Detail'''
| -
|''Optional''
|Any additional details you wish to specifically highlight about the cited game element.
|<code>JFO is a player customisation item</code>
|-
|'''Quote'''
| -
|''Optional''
|Used to cite a particular quote from the game that supports your citation.
|<code>Designed and tested at Beweglichrüstungsysteme this helmet is fully compatible with all armor systems.</code>
|-
|'''Quotee'''
|QuoteeLink
|''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>.
|<code>Official description</code>
|-
|'''QuoteeText'''
|QuoteeLinkText {{C|Deprecated}}
|''Required only if Quotee is a page name and includes a suffix''
|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 paramater is given multiple values in the template call.

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

====Standard usage====
<pre>{{Ref/Audio|Id=Rebirth|Rebirth|5:60}}</pre>{{Ref/Audio|Id=Rebirth|Rebirth|05:60}}
{{Ref/Sources}}

====Episode field usage====
<pre>{{Ref/Audio|Id=HtT|HtT|Ep=00: Primer|2:50}}</pre>{{Ref/Audio|Id=HtT|HtT|Ep=00: Primer|2:50}}
{{Ref/Sources}}

==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:

*[[mw:Extension:Scribunto|Extension:Scribunto]]
*[[Halopedia:Acronyms|Extension:Acronym]] {{C|In-house extension}}
*[[Halopedia:UniqueLink|Extension:UniqueLink]] {{C|In-house extension}}

===Dependent templates===
No other templates are known to depend on this one.

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