Template:HMVS/doc
 | This is a documentation subpage for Template:HMVS. It may contain usage information, categories and other content that is not part of the original template page. |
Usage
[edit]This is a typing short cut for linking to Victorian Naval Forces ship articles named in the format "HMVS Victoria (1855)". Since Ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[HMVS Victoria (1855)|HMVS ''Victoria'' (1855)]]. This template halves that to {{HMVS|Victoria|1855}}.
Formal usage
[edit]- {{HMVS|Ship Name}}
- {{HMVS|Ship Name|ID}}, where ID can be the hull number, launch year, or pennant number, as specified in the article title.
Examples
[edit]| Template usage | Equivalent wikicode | Final result |
|---|---|---|
| {{HMVS|Victoria|1855}} | [[HMVS Victoria (1855)|HMVS ''Victoria'' (1855)]] | HMVS Victoria (1855) |
| {{HMVS|Gordon}} | [[HMVS Gordon|HMVS ''Gordon'']] | HMVS Gordon |
Last example could be used to link to ship index (disambiguation) page
Optional display control parameter
[edit]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 "HMVS", 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 | {{HMVS|Victoria|1855|1}} | [[HMVS Victoria (1855)|1855]] | 1855 | |
| 2 | 2nd | {{HMVS|Victoria|1855|2}} | [[HMVS Victoria (1855)|''Victoria'']] | Victoria | |
| 3 | 2nd, 3rd | {{HMVS|Victoria|1855|3}} | [[HMVS Victoria (1855)|''Victoria'' 1855]] | Victoria (1855) | |
| 4 | invalid result | {{HMVS|Victoria|1855|4}} | — | Error: {{HMVS}} invalid control parameter: 4 (help) | |
| 5 | 1st, 3rd | {{HMVS|Victoria|1855|5}} | [[HMVS Victoria (1855)|HMVS 1855]] | HMVS 1855 | |
| 6 | 1st, 2nd | {{HMVS|Victoria|1855|6}} | [[HMVS Victoria (1855)|HMVS ''Victoria'']] | HMVS Victoria | |
| 2nd (no 3rd) |
{{HMVS|Gordon|3=2}} | Alternate usage: {{HMVS|Gordon||2}} | [[HMVS Gordon|''Gordon'']] | Gordon | |
N.B.: Be careful with the third parameter if not using the second parameter. In the Gordon 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
[edit]TemplateData
| |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:HMVS in articles based on its TemplateData.
TemplateData for HMVS This template provides a wikilink to a ship's page, with label options
| |||||||||||||||||||||||||
See also
[edit]
