Editing TemplateDoc:Acronym

{{Notice/TemplateDoc}}

==Acronym templates==
{| width=100%
|style="vertical-align:top;" width=50%|
===Generating titles and names===
*[[Template:Acronym/LongName|Long title]] (<code><nowiki>{{Acronym/LongTitle}}</nowiki></code>)
*[[Template:Acronym/ShortName|Short (standard) title]] (<code><nowiki>{{Acronym/ShortName}}</nowiki></code>)
*[[Template:Acronym/ShortestName|Shortest possible title]] (<code><nowiki>{{Acronym/ShortestName}}</nowiki></code>)
*[[Template:Acronym/PageName|Associated page/article name (for links)]] (<code><nowiki>{{Acronym/PageName}}</nowiki></code>)
|style="vertical-align:top;" width=50%|
===Links===
*[[Template:Acronym/Link|Standard link]] (<code><nowiki>{{Acronym/Link}}</nowiki></code>)
*[[Template:Acronym/LongLink|Long link]] (<code><nowiki>{{Acronym/LongLink}}</nowiki></code>)
*[[Template:Acronym/ShortLink|Short link]] (<code><nowiki>{{Acronym/ShortLink}}</nowiki></code>)
*[[Template:Acronym/ShortestLink|Shortest possible link]] (<code><nowiki>{{Acronym/ShortestLink}}</nowiki></code>)
|}
{| width=100%
|style="vertical-align:top;" width=50%|
===Sanitising specific acronym types===
*[[Template:Acronym/Official|Official acronyms]] (<code><nowiki>{{Acronym/Official}}</nowiki></code>)
*[[Template:Acronym/Game|Game acronyms]] (<code><nowiki>{{Acronym/Game}}</nowiki></code>)
*[[Template:Acronym/Novel|Novel, novella and anthology acronyms]] (<code><nowiki>{{Acronym/Novel}}</nowiki></code>)
*[[Template:Acronym/Comic|Comic and graphic novel acronyms]] (<code><nowiki>{{Acronym/Comic}}</nowiki></code>)
*[[Template:Acronym/MiscBook|Other miscellaneous print acronyms]] (<code><nowiki>{{Acronym/MiscBook}}</nowiki></code>)
*[[Template:Acronym/Film|Film and TV acronyms]] (<code><nowiki>{{Acronym/Film}}</nowiki></code>)
*[[Template:Acronym/Marketing|Marketing and ARG acronyms]] (<code><nowiki>{{Acronym/Marketing}}</nowiki></code>)
|style="vertical-align:top;" width=50%|
===Checking acronym existence===
*[[Template:Acronym/Exists|All acronym types]] (<code><nowiki>{{Acronym/Exists}}</nowiki></code>)
*[[Template:Acronym/Official/Exists|Official acronyms]] (<code><nowiki>{{Acronym/Official/Exists}}</nowiki></code>)
*[[Template:Acronym/Game/Exists|Game acronyms]] (<code><nowiki>{{Acronym/Game/Exists}}</nowiki></code>)
*[[Template:Acronym/Novel/Exists|Novel, novella and anthology acronyms]] (<code><nowiki>{{Acronym/Novel/Exists}}</nowiki></code>)
*[[Template:Acronym/Comic/Exists|Comic and graphic novel acronyms]] (<code><nowiki>{{Acronym/Comic/Exists}}</nowiki></code>)
*[[Template:Acronym/MiscBook/Exists|Other miscellaneous print acronyms]] (<code><nowiki>{{Acronym/MiscBook/Exists}}</nowiki></code>)
*[[Template:Acronym/Film/Exists|Film and TV acronyms]] (<code><nowiki>{{Acronym/Film/Exists}}</nowiki></code>)
*[[Template:Acronym/Marketing/Exists|Marketing and ARG acronyms]] (<code><nowiki>{{Acronym/Marketing/Exists}}</nowiki></code>)
|}

==Usage==
This template is used to sanitise Halopedia [[Halopedia:Acronyms|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>NoPassthrough</code> flag, 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. If this flag is set - to anything at all - passthrough will be disabled. Otherwise, passthrough is enabled by default.
|<code>no</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
|-
|<code><nowiki>"{{Acronym|CE}}"</nowiki></code>
|"{{Acronym|CE}}"
|-
|<code><nowiki>"{{Acronym|H1X}}"</nowiki></code>
|"{{Acronym|H1X}}"
|-
|<code><nowiki>"{{Acronym|banana}}"</nowiki></code>
|"{{Acronym|banana}}"
|-
|<code><nowiki>"{{Acronym|CE|NoPassthrough=yes}}"</nowiki></code>
|"{{Acronym|CE|NoPassthrough=yes}}"
|-
|<code><nowiki>"{{Acronym|H1X|NoPassthrough=yes}}"</nowiki></code>
|"{{Acronym|H1X|NoPassthrough=yes}}"
|-
|<code><nowiki>"{{Acronym|banana|NoPassthrough=yes}}"</nowiki></code>
|"{{Acronym|banana|NoPassthrough=yes}}"
|}

<noinclude>[[Category:Acronym template documentation]]</noinclude>
@@ Line 38: / Line 38: @@
 |}
-==Description==
+==Usage==
 This template is used to sanitise Halopedia [[Halopedia:Acronyms|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>NoPassthrough</code> 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.
-{|width=100%
-!width=50%|Simplified Version
-!width=50%|Full Version
-|-
-|
-<pre>
-{{Acronym
-|
-}}
-</pre>
-|
-<pre>
-{{Acronym
-|NoPassthrough=
-|
-}}
-</pre>
-|}
 ===Parameters===
@@ Line 81: / Line 57: @@
 |<code>TFoR</code>
 |-
-|'''NoPassthrough'''
+|'''Passthrough'''
 | -
 |''Optional''
@@ Line 115: / Line 91: @@
 |"{{Acronym|banana|NoPassthrough=yes}}"
 |}
-==Dependencies==
-===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:
-*[[mw:Extension:Variables|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]]
-<noinclude>[[Category:Shorthand template documentation]]</noinclude>
 <noinclude>[[Category:Acronym template documentation]]</noinclude>