TemplateDoc:Acronym

Acronym templates
{| width=100%
 * style="vertical-align:top;" width=50%|

Generating titles and names

 * Long title
 * Short (standard) title
 * Shortest possible title
 * Associated page/article name (for links)
 * style="vertical-align:top;" width=50%|

Links
{| width=100%
 * Standard link
 * Long link
 * Short link
 * Shortest possible link
 * }
 * style="vertical-align:top;" width=50%|

Sanitising specific acronym types

 * Official acronyms
 * Game acronyms
 * Novel, novella and anthology acronyms
 * Comic and graphic novel acronyms
 * Other miscellaneous print acronyms
 * Film and TV acronyms
 * Marketing and ARG acronyms
 * style="vertical-align:top;" width=50%|

Checking acronym existence

 * All acronym types
 * Official acronyms
 * Game acronyms
 * Novel, novella and anthology acronyms
 * Comic and graphic novel acronyms
 * Other miscellaneous print acronyms
 * Film and TV acronyms
 * Marketing and ARG acronyms
 * }

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

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

Error states
This template has no error states.

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

Template dependencies
This template depends upon the following templates:


 * Template:Acronym/Official
 * Template:Acronym/Game
 * Template:Acronym/Novel
 * Template:Acronym/Comic
 * Template:Acronym/MiscBook
 * Template:Acronym/Film
 * Template:Acronym/Marketing

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!


 * Template:Acronym/Exists
 * Template:Acronym/LongName
 * Template:Acronym/ShortName
 * Template:Acronym/ShortestName
 * Template:Acronym/PageName
 * Template:Acronym/LongLink
 * Template:Acronym/ShortLink
 * Template:Acronym/ShortestLink
 * Template:Acronym/Link