Template:HTMS/doc
 | This is a documentation subpage for Template:HTMS. It may contain usage information, categories and other content that is not part of the original template page. |
Usage
This is a typing short cut for linking to Royal Thai Navy ship articles named in the format "HTMS Chakri Naruebet (CV 911)". Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[HTMS Chakri Naruebet (CV 911)|HTMS ''Chakri Naruebet'' (CV 911)]]. This template halves that to {{HTMS|Chakri Naruebet|CV 911}}.
Formal Usage
{{HTMS|Ship Name}}{{HTMS|Ship Name|ID}}, where ID can be the hull number, launch year, or pennant number, as specified in the article title.
Examples
| Template usage | Equivalent wikicode | Final result |
|---|---|---|
{{HTMS|Chakri Naruebet|CV 911}}
|
[[HTMS Chakri Naruebet (CV 911)|HTMS ''Chakri Naruebet'' (CV 911)]]
|
HTMS Chakri Naruebet (CV 911) |
{{HTMS|Chakri Naruebet|1996}}
|
[[HTMS Chakri Naruebet (1996)|HTMS ''Chakri Naruebet'' (1996)]]
|
HTMS Chakri Naruebet (1996) |
{{HTMS|Chakri Naruebet}}
|
[[HTMS Chakri Naruebet|HTMS ''Chakri Naruebet'']]
|
HTMS Chakri Naruebet |
Last example could be used to link to ship index (disambiguation) page
Optional display control parameter
There is an optional third parameter that controls which pieces of text are displayed in the article. Its value is treated as a binary number and will display the corresponding "bits". So setting the 4's bit will display HTMS, setting the 2's bit will display the ship name, and setting the 1's bit will display the ID. If binary math isn't your thing, refer to these examples:
| Value | Parameter(s) displayed |
Example | Equivalent wikicode | Final result |
|---|---|---|---|---|
| None | all | {{HTMS|Chakri Naruebet|CV 911}}
|
[[HTMS Chakri Naruebet (CV 911)|HTMS ''Chakri Naruebet'' (CV 911)]]
|
HTMS Chakri Naruebet (CV 911) |
| 1 | 3rd | {{HTMS|Chakri Naruebet|CV911|1}}
|
[[HTMS Chakri Naruebet (CV 911)|CV 911]]
|
HTMS Chakri Naruebet (CV 911) |
| 2 | 2nd | {{HTMS|Chakri Naruebet|CV 911|2}}
|
[[HTMS Chakri Naruebet (CV 911)|''Chakri Naruebet'']]
|
HTMS Chakri Naruebet (CV 911) |
| 3 | 2nd, 3rd | {{HTMS|Chakri Naruebet|CV 911|3}}
|
[[HTMS Chakri Naruebet (CV 911)|''Chakri Naruebet'' (CV 911)]]
|
HTMS Chakri Naruebet (CV 911) |
| 4 | invalid result | {{HTMS|Chakri Naruebet|CV 911|4}}
|
[[HTMS Chakri Naruebet CV 911|Invalid Optional Parameter]]
|
HTMS Chakri Naruebet (CV 911) |
| 5 | 1st, 3rd | {{HTMS|Chakri Naruebet|CV 911|5}}
|
[[HTMS Chakri Naruebet (CV 911)|HTMS ''Chakri Naruebet'']]
|
HTMS Chakri Naruebet (CV 911) |
| 6 | 1st, 2nd | {{HTMS|Chakri Naruebet|CV 911|6}}
|
[[HTMS Chakri Naruebet (CV 911)|HTMS ''Chakri Naruebet'']]
|
HTMS Chakri Naruebet (CV 911) |
| 2nd (no 3rd) |
{{HTMS|Chakri Naruebet|3=2}} Alternate usage: >{{HTMS|Chakri Naruebet||2}}
|
[[HTMS Chakri Naruebet|''Chakri Naruebet'']]
|
HTMS Chakri Naruebet |
N.B.: Be careful with the third parameter if not using the second parameter. In the last Chakri Naruebet example above, the "|3=2" means set the third parameter to a value of two, while the alternate syntax shows using a pair of pipes, "||2", to position the value two in the third parameter position.
Using an optional display control parameter value of 6 yields the same results as using {{warship}} to create the same link and text, but saving, coincidentally, 6 characters while editing.
{{HTMS|Chakri Naruebet|CV 911|6}}yields the same results as{{warship|HTMS|Chakri Naruebet|CV 911}}
TemplateData
TemplateData
|
|---|
|
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:HTMS in articles based on its TemplateData.
TemplateData for HTMS <templatedata> { "params": { "1": { "label": "Name", "description": "Ship's name", "example": "Bismarck, Belgrano", "type": "string" }, "2": { "label": "ID", "description": "Hull number, launch year, or pennant number", "example": "H75, 1975", "type": "string" }, "3": { "label": "Format", "description": "Formats the label (which name parts will show)", "example": "1, 2, 3, 5, 6", "type": "number", "default": "blank" }, "up": { "label": "unlink prefix", "description": "up=yes puts prefix before (outside of) the wikilink", "example": "up=yes", "default": "no", "type": "boolean" } }, "description": "This template provides a wikilink to a ship's page, with label options", "paramOrder": [ "1", "2", "3", "up" ] } </templatedata> |
See also
