Template:HSwMS
Template documentationUsage
This is a typing short cut for linking to Swedish Navy ship articles named in the format "HSwMS Ulla Fersen (1789)". Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[HSwMS Ulla Fersen (1789)|HSwMS ''Ulla Fersen'' (1789)]]. This template halves that to {{HSwMS|Ulla Fersen|1789}}.
Formal usage
- {{HSwMS|Ship Name}}
- {{HSwMS|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 |
|---|---|---|
| {{HSwMS|Visby|K31}} | [[HSwMS Visby (K31)|HSwMS ''Visby'' (K31)]] | HSwMS Visby (K31) |
| {{HSwMS|Ulla Fersen|1789}} | [[HSwMS Ulla Fersen (1789)|HSwMS ''Ulla Fersen'' (1789)]] | HSwMS Ulla Fersen (1789) |
| {{HSwMS|Dristigheten}} | [[HSwMS Dristigheten|HSwMS ''Dristigheten'']] | HSwMS Dristigheten |
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. The value is treated as a binary number and will display the corresponding "bits". So setting the 4's bit will display "HSwMS", 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 | {{HSwMS|Ulla Fersen|1789|1}} | [[HSWMS Ulla Fersen (1789)|1789]] | HSwMS Ulla Fersen (1789) | |
| 2 | 2nd | {{HSwMS|Ulla Fersen|1789|2}}} | [[HSWMS Ulla Fersen (1789)|''Ulla Fersen'']] | HSwMS Ulla Fersen (1789) | |
| 3 | 2nd, 3rd | {{HSwMS|Ulla Fersen|1789|3}} | [[HSwMS Ulla Fersen (1789)|''Ulla Fersen'' (1789)]] | HSwMS Ulla Fersen (1789) | |
| 4 | invalid result | {{HSwMS|Ulla Fersen|1789|4}} | [[HSwMS Ulla Fersen (1789)|Invalid Optional Parameter]] | HSwMS Ulla Fersen (1789) | |
| 5 | 1st, 3rd | {{HSwMS|Ulla Fersen|1789|5}} | [[HSwMS Ulla Fersen (1789)|HMS (1789)]] | HSwMS Ulla Fersen (1789) | |
| 6 | 1st, 2nd | {{HSwMS|Ulla Fersen|1789|6}} | [[HSwMS Ulla Fersen (1789)|HSwMS ''Ulla Fersen'']] | HSwMS Ulla Fersen (1789) | |
| 2nd (no 3rd) |
{{HSwMS|Dristigheten|3=2}} | Alternate usage: {{HSwMS|Dristigheten||2}} | [[HSwMS Dristigheten|''Dristigheten'']] | HSwMS Dristigheten | |
N.B.: Be careful with the third parameter if not using the second parameter. In the Dristigheten 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.
- {{HSwMS|Ulla Fersen|1789|6}} yields the same results as {{warship|HSwMS|Ulla Fersen|1789}}
TemplateData
TemplateData
|
|---|
|
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:HSwMS in articles based on its TemplateData.
TemplateData for HSwMS <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> |
