Template:HDMS
Formal usage
- {{HDMS|Ship Name}}
- {{HDMS|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 |
|---|---|---|
| {{HDMS|Lougen|1791}} | [[HDMS Lougen (1791)|HDMS ''Lougen'' (1791)]] | HDMS Lougen (1791) |
| {{HDMS|Lougen|1791}} | [[HDMS Lougen (1791)|HDMS ''Lougen'' (1791)]] | HDMS Lougen (1791) |
| {{HDMS|Lougen}} | [[HDMS Lougen|HDMS ''Lougen'']] | HDMS Lougen |
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 "HDMS", 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 | {{HDMS|Lougen|1791|1}} | [[HDMS Lougen (1791)|1791]] | 1791 | |
| 2 | 2nd | {{HDMS|Lougen|1791|2}} | [[HDMS Lougen (1791)|''Lougen'']] | Lougen | |
| 3 | 2nd, 3rd | {{HDMS|Lougen|1791|3}} | [[HDMS Lougen (1791)|''Lougen'' 1791]] | Lougen (1791) | |
| 4 | invalid result | {{HDMS|Lougen|1791|4}} | — | Error: {{HDMS}} invalid control parameter: 4 (help) | |
| 5 | 1st, 3rd | {{HDMS|Lougen|1791|5}} | [[HDMS Lougen (1791)|HDMS 1791]] | HDMS 1791 | |
| 6 | 1st, 2nd | {{HDMS|Lougen|1791|6}} | [[HDMS Lougen (1791)|HDMS ''Lougen'']] | HDMS Lougen | |
| 2nd (no 3rd) |
{{HDMS|Lougen|3=2}} | Alternate usage: {{HDMS|Lougen||2}} | [[HDMS Lougen|''Lougen'']] | Lougen | |
N.B.: Be careful with the third parameter if not using the second parameter. In the Lougen 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:HDMS in articles based on its TemplateData.
TemplateData for HDMS This template provides a wikilink to a ship's page, with label options
| |||||||||||||||||||||||||
