Template:Acronym

v • d • e

Template Documentation

Acronym templates

Generating titles and names

Long title ({{Acronym/LongTitle}})
Short (standard) title ({{Acronym/ShortName}})
Shortest possible title ({{Acronym/ShortestName}})
Associated page/article name (for links) ({{Acronym/PageName}})

Links

Standard link ({{Acronym/Link}})
Long link ({{Acronym/LongLink}})
Short link ({{Acronym/ShortLink}})
Shortest possible link ({{Acronym/ShortestLink}})

Sanitising specific acronym types

Official acronyms ({{Acronym/Official}})
Game acronyms ({{Acronym/Game}})
Novel, novella and anthology acronyms ({{Acronym/Novel}})
Comic and graphic novel acronyms ({{Acronym/Comic}})
Other miscellaneous print acronyms ({{Acronym/MiscBook}})
Film and TV acronyms ({{Acronym/Film}})
Marketing and ARG acronyms ({{Acronym/Marketing}})

Checking acronym existence

All acronym types ({{Acronym/Exists}})
Official acronyms ({{Acronym/Official/Exists}})
Game acronyms ({{Acronym/Game/Exists}})
Novel, novella and anthology acronyms ({{Acronym/Novel/Exists}})
Comic and graphic novel acronyms ({{Acronym/Comic/Exists}})
Other miscellaneous print acronyms ({{Acronym/MiscBook/Exists}})
Film and TV acronyms ({{Acronym/Film/Exists}})
Marketing and ARG acronyms ({{Acronym/Marketing/Exists}})

Description

This template is used to sanitise Halopedia 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, HTFoR will have been replaced with tfor. 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 flag, the template can be made to output nothing if the acronym does not exist.

Usage

Syntax

To insert this template onto a page, place the following wikitext onto the article.

Simplified Version	Full Version
{{Acronym \| }}	{{Acronym \|NoPassthrough= \| }}

Parameters

Field Name	Field Aliases	Optional or Required?	Description	Example
1 (Unnamed field)	-	Required	The acronym to sanitise.	`TFoR`
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.	`no`

Error states

This template has no error states.

Examples

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

Wiki markup	Result
`"{{Acronym\|CE}}"`	"ce"
`"{{Acronym\|H1X}}"`	"ce"
`"{{Acronym\|banana}}"`	"banana"
`"{{Acronym\|CE\|NoPassthrough=yes}}"`	"ce"
`"{{Acronym\|H1X\|NoPassthrough=yes}}"`	"ce"
`"{{Acronym\|banana\|NoPassthrough=yes}}"`	""

Dependencies

Template dependencies

This template depends upon the following templates:

Extension dependencies

This template requires the following extensions:

Variables - used to optimise the number of template calls made, by caching previous call results

Dependent templates

The following templates depend upon this one. If you are making changes to this template, please ensure that they will not break any of them!