TemplateDoc:Acronym/Comic

This is a template documentation page!

You cannot edit the associated template from here. To do so, please see Template:Acronym/Comic instead!

Usage

This template is used to sanitise Halopedia comic and graphic 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, HEsc will have been replaced with he. 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 NoPassthrough parameter, the template can be made to output nothing if the acronym does not exist.

Parameters

Field Name	Field Aliases	Optional or Required?	Description	Example
1 (Unnamed field)	-	Required	The acronym to sanitise.	FoR
NoPassthrough	-	Optional	Determines whether or not to pass the original argument through if no acronym match was found. If this flag is set - to anything at all - passthrough will be disabled. Otherwise, passthrough is enabled by default.	yes
Strict	-	Optional	Determines whether or not the test should strictly adhere to the standard acronym defined on 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 comics. IMPORTANT: Non-standard acronyms are permitted to clash with acronyms in other categories! For instance, with the strict flag disabled, this template treats TFoR and HTFoR as valid acronyms for Halo: Fall of Reach (comic), even though they're assigned to the novel Halo: The Fall of Reach according to the standard acronyms. Always set strict to enabled if your template deals with other types of media as well as comics.	yes

Error states

This template has no error states.

Examples

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

Wiki markup	Result
*Strict w/ passthrough: "{{Acronym/Comic|FoR|Strict=yes}}" *Not strict w/ passthrough: "{{Acronym/Comic|FoR}}" *Strict w/o passthrough: "{{Acronym/Comic|FoR|Strict=yes|NoPassthrough=yes}}" *Not strict w/o passthrough: "{{Acronym/Comic|FoR|NoPassthrough=yes}}"	Strict w/ passthrough: "for" Not strict w/ passthrough: "for" Strict w/o passthrough: "for" Not strict w/o passthrough: "for"
*Strict w/ passthrough: "{{Acronym/Comic|HFoR|Strict=yes}}" *Not strict w/ passthrough: "{{Acronym/Comic|HFoR}}" *Strict w/o passthrough: "{{Acronym/Comic|HFoR|Strict=yes|NoPassthrough=yes}}" *Not strict w/o passthrough: "{{Acronym/Comic|HFoR|NoPassthrough=yes}}"	Strict w/ passthrough: "for" Not strict w/ passthrough: "for" Strict w/o passthrough: "for" Not strict w/o passthrough: "for"
*Strict w/ passthrough: "{{Acronym/Comic|TFoR|Strict=yes}}" *Not strict w/ passthrough: "{{Acronym/Comic|TFoR}}" *Strict w/o passthrough: "{{Acronym/Comic|TFoR|Strict=yes|NoPassthrough=yes}}" *Not strict w/o passthrough: "{{Acronym/Comic|TFoR|NoPassthrough=yes}}"	Strict w/ passthrough: "tfor" Not strict w/ passthrough: "for" Strict w/o passthrough: "" Not strict w/o passthrough: "for"
*Strict w/ passthrough: "{{Acronym/Comic|banana|Strict=yes}}" *Not strict w/ passthrough: "{{Acronym/Comic|banana}}" *Strict w/o passthrough: "{{Acronym/Comic|banana|Strict=yes|NoPassthrough=yes}}" *Not strict w/o passthrough: "{{Acronym/Comic|banana|NoPassthrough=yes}}"	Strict w/ passthrough: "banana" Not strict w/ passthrough: "banana" Strict w/o passthrough: "" Not strict w/o passthrough: ""