Template:HMNZS/doc
| File:Edit-copy green.svg | This is a documentation subpage for Template:HMNZS. 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 New Zealand Navy ship articles named in the format "HMNZS Endeavour (A11)". Since Ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[HMNZS Endeavour (A11)|HMNZS ''Endeavour'' (A11)]]. This template halves that to {{HMNZS|Endeavour|A11}}.
Formal usage
- {{HMNZS|Ship Name}}
- {{HMNZS|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 |
|---|---|---|
| {{HMNZS|Endeavour|A11}} | [[HMNZS Endeavour (A11)|HMNZS ''Endeavour'' (A11)]] | HMNZS Endeavour (A11) |
| {{HMNZS|Hawea|1975}} | [[HMNZS Hawea (1975)|HMNZS ''Hawea'' (1975)]] | HMNZS Hawea (1975) |
| {{HMNZS|Charles Upham}} | [[HMNZS Charles Upham|HMNZS ''Charles Upham'']] | HMNZS Charles Upham |
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 "HMNZS", 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 | |
|---|---|---|---|---|---|
| 1 | 3rd | {{HMNZS|Endeavour|I91|1}} | [[HMNZS Endeavour (I91)|I91]] | I91 | |
| 2 | 2nd | {{HMNZS|Endeavour|I91|2}} | [[HMNZS Endeavour (I91)|''Endeavour'']] | Endeavour | |
| 3 | 2nd, 3rd | {{HMNZS|Endeavour|I91|3}} | [[HMNZS Endeavour (I91)|''Endeavour'' I91]] | Endeavour (I91) | |
| 4 | invalid result | {{HMNZS|Endeavour|I91|4}} | — | Error: {{HMNZS}} invalid control parameter: 4 (help) | |
| 5 | 1st, 3rd | {{HMNZS|Endeavour|I91|5}} | [[HMNZS Endeavour (I91)|HMS I91]] | HMNZS I91 | |
| 6 | 1st, 2nd | {{HMNZS|Endeavour|I91|6}} | [[HMNZS Endeavour (I91)|HMS ''Endeavour'']] | HMNZS Endeavour | |
| 2nd (no 3rd) |
{{HMNZS|Charles Uphamr|3=2}} | Alternate usage: {{HMNZS|Charles Upham||2}} | [[HMNZS Charles Upham|''Charles Upham'']] | Charles Upham | |
N.B.: Be careful with the third parameter if not using the second parameter. In the Charles Upham 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.
TemplateData
TemplateData
| |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:HMNZS in articles based on its TemplateData.
TemplateData for HMNZS This template provides a wikilink to a ship's page, with label options
| |||||||||||||||||||||||||
.svg){kind=link}
.svg){kind=link}
