TemplateDoc:Acronym/Official: Difference between revisions
From Halopedia, the Halo wiki
mNo edit summary |
(Inserting TemplateDoc notice) |
||
| Line 1: | Line 1: | ||
{{Notice/TemplateDoc}} | |||
==Usage== | ==Usage== | ||
This template is used to sanitise Halopedia [[Halopedia:Acronyms|official and reserved 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. This allows template pages to only have to consider the primary acronym cases, while still providing support for the secondary acronyms. | This template is used to sanitise Halopedia [[Halopedia:Acronyms|official and reserved 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. This allows template pages to only have to consider the primary acronym cases, while still providing support for the secondary acronyms. | ||
Latest revision as of 19:05, June 4, 2020
Usage[edit]
This template is used to sanitise Halopedia official and reserved 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. 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[edit]
| Field Name | Field Aliases | Optional or Required? | Description | Example |
|---|---|---|---|---|
| 1 (Unnamed field) | - | Required | The acronym to sanitise. | HP
|
| 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 official/reserved category.
IMPORTANT: Non-standard acronyms are permitted to clash with acronyms in other categories! Always set strict to enabled if your template deals with other types of media as well as official/reserved acronyms. |
yes
|
Error states[edit]
This template has no error states.
Examples[edit]
Here are some examples of what the template will output, when used:
| Wiki markup | Result |
|---|---|
*Passthrough: "{{Acronym/Official|HP}}"
*No passthrough: "{{Acronym/Official|HP|NoPassthrough=yes}}"
|
|
*Passthrough: "{{Acronym/Official|banana}}"
*No passthrough: "{{Acronym/Official|banana|NoPassthrough=yes}}"
|
|