Editing TemplateDoc:Acronym/Novel

{{Notice/TemplateDoc}}

==Usage==
This template is used to sanitise Halopedia [[Halopedia:Acronyms|novel acronyms]] before they are used in other templates. It does ''not'' guarantee that an acronym is valid, as the correct response to an invalid acronym will vary between templates that call this one. However, it guarantees that what it returns will be in lower case and that, if it ''was'' a valid acronym, it will have been replaced with the '''primary''' acronym for that topic. For instance, <code>HTFoR</code> will have been replaced with <code>tfor</code>. This allows template pages to only have to consider the primary acronym cases, while still providing support for the secondary acronyms.

Usually, if no acronym match is found, the template will simply return exactly what was passed to it, albeit in lower case. However, by setting the <code>Passthrough</code> parameter to <code>no</code>, the template can be made to output nothing if the acronym does not exist.

===Parameters===
{| width=100% class="wikitable"
!width=12%|''Field Name''
!width=12%|''Field Aliases''
!width=12%|''Optional or Required?''
!width=auto|''Description''
!width=24%|''Example''
|-
|'''1''' {{C|Unnamed field}}
| -
|'''Required'''
|The acronym to sanitise.
|<code>TFoR</code>
|-
|'''Passthrough'''
| -
|''Optional''
|Determines whether or not to pass the original argument through if no acronym match was found. Specify <code>no</code> to disable passthrough, and anything else to enable it. Passthrough is enabled by default.
|<code>no</code>
|-
|'''Strict'''
| -
|''Optional''
|Determines whether or not the test should strictly adhere to the standard acronym defined on [[Halopedia:Acronyms|this page]]. If this is set (to any value whatsoever), it will only check against the standard acronyms. Otherwise, it may check against non-standard acronyms, that are specific to the novels.

'''IMPORTANT:''' Non-standard acronyms are permitted to clash with acronyms in other categories! For instance, with the strict flag disabled, this template treats <code>SS</code> and <code>HSS</code> as valid acronyms for ''[[Halo: Silent Storm]]'', even though they're assigned to the game ''[[Halo: Spartan Strike]]'' according to the standard acronyms. Always set strict to enabled if your template deals with other types of media as well as novels.
|<code>yes</code>
|}

===Error states===
This template has no error states.

===Examples===
Here are some examples of what the template will output, when used:
{| class="wikitable"
!Wiki markup
!Result
|-
|
<pre><nowiki>
*Strict w/ passthrough: "{{Acronym/Novel|TFoR|Strict=yes}}"
*Not strict w/ passthrough: "{{Acronym/Novel|TFoR}}"
*Strict w/o passthrough: "{{Acronym/Novel|TFoR|Strict=yes|Passthrough=no}}"
*Not strict w/o passthrough: "{{Acronym/Novel|TFoR|Passthrough=no}}"
</nowiki></pre>
|
*Strict w/ passthrough: "{{Acronym/Novel|TFoR|Strict=yes}}"
*Not strict w/ passthrough: "{{Acronym/Novel|TFoR}}"
*Strict w/o passthrough: "{{Acronym/Novel|TFoR|Strict=yes|Passthrough=no}}"
*Not strict w/o passthrough: "{{Acronym/Novel|TFoR|Passthrough=no}}"
|-
|
<pre><nowiki>
*Strict w/ passthrough: "{{Acronym/Novel|HTFoR|Strict=yes}}"
*Not strict w/ passthrough: "{{Acronym/Novel|HTFoR}}"
*Strict w/o passthrough: "{{Acronym/Novel|HTFoR|Strict=yes|Passthrough=no}}"
*Not strict w/o passthrough: "{{Acronym/Novel|HTFoR|Passthrough=no}}"
</nowiki></pre>
|
*Strict w/ passthrough: "{{Acronym/Novel|HTFoR|Strict=yes}}"
*Not strict w/ passthrough: "{{Acronym/Novel|HTFoR}}"
*Strict w/o passthrough: "{{Acronym/Novel|HTFoR|Strict=yes|Passthrough=no}}"
*Not strict w/o passthrough: "{{Acronym/Novel|HTFoR|Passthrough=no}}"
|-
|
<pre><nowiki>
*Strict w/ passthrough: "{{Acronym/Novel|FoR|Strict=yes}}"
*Not strict w/ passthrough: "{{Acronym/Novel|FoR}}"
*Strict w/o passthrough: "{{Acronym/Novel|FoR|Strict=yes|Passthrough=no}}"
*Not strict w/o passthrough: "{{Acronym/Novel|FoR|Passthrough=no}}"
</nowiki></pre>
|
*Strict w/ passthrough: "{{Acronym/Novel|FoR|Strict=yes}}"
*Not strict w/ passthrough: "{{Acronym/Novel|FoR}}"
*Strict w/o passthrough: "{{Acronym/Novel|FoR|Strict=yes|Passthrough=no}}"
*Not strict w/o passthrough: "{{Acronym/Novel|FoR|Passthrough=no}}"
|-
|
<pre><nowiki>
*Strict w/ passthrough: "{{Acronym/Novel|banana|Strict=yes}}"
*Not strict w/ passthrough: "{{Acronym/Novel|banana}}"
*Strict w/o passthrough: "{{Acronym/Novel|banana|Strict=yes|Passthrough=no}}"
*Not strict w/o passthrough: "{{Acronym/Novel|banana|Passthrough=no}}"
</nowiki></pre>
|
*Strict w/ passthrough: "{{Acronym/Novel|banana|Strict=yes}}"
*Not strict w/ passthrough: "{{Acronym/Novel|banana}}"
*Strict w/o passthrough: "{{Acronym/Novel|banana|Strict=yes|Passthrough=no}}"
*Not strict w/o passthrough: "{{Acronym/Novel|banana|Passthrough=no}}"
|}

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