Template:SMU/doc
 | This is a documentation subpage for Template:SMU. 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 Imperial German Navy or Austro-Hungarian Navy submarine articles named in the format "SM U-28 (Germany)". Since Ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[w:SM U-28 (Germany)|SM ''U-28'' (Germany)]]. This template shortens that to {{SMU|U-28|Germany}}.
This template uses Template:SMS, which in turn uses Template:Ship, so changes to either of those templates may affect the output of this template
Formal Usage
{{SMU|Ship Name}}{{SMU|Ship Name|disambig}}, wheredisambigis usually either Germany, or Austria-Hungary
Examples
| Template usage | Equivalent wikicode | Final result |
|---|---|---|
{{SMU|U-28|Germany}}
|
[[w:SM U-28 (Germany)|SM ''U-28'' (Germany)]]
|
SMU U-28 (Germany) |
{{SMU|U-103}}
|
[[w:SM U-103|SM ''U-103'']]
|
SMU U-103 |
The last example could be used to link to a 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 SMS, 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 | {{SMU|U-28|Germany}}
|
[[w:SM U-28 (Germany) |SM ''U-28'' (Germany)]]
|
SMU U-28 (Germany) |
| 1 | 3rd | {{SMU|U-28|Germany|1}}
|
[[w:SM U-28 (Germany) |Germany]]
|
SMU U-28 (Germany) |
| 2 | 2nd | {{SMU|U-28|Germany|2}}
|
[[w:SM U-28 (Germany) |''U-28'']]
|
SMU U-28 (Germany) |
| 3 | 2nd, 3rd | {{SMU|U-28|Germany|3}}
|
[[w:SM U-28 (Germany) |''U-28'' (Germany)]]
|
SMU U-28 (Germany) |
| 4 | invalid result | {{SMU|U-28|Germany|4}}
|
[[w:SM U-28 (Germany) |Invalid Optional Parameter]]
|
SMU U-28 (Germany) |
| 5 | 1st, 3rd | {{SMU|U-28|Germany|5}}
|
[[w:SM U-28 (Germany) |SM (Germany)]]
|
SMU U-28 (Germany) |
| 6 | 1st, 2nd | {{SMU|U-28|Germany|6}}
|
[[w:SM U-28 (Germany) |SM ''U-28'']]
|
SMU U-28 (Germany) |
| 2nd (no 3rd) |
{{SMU|U-103|3=2}} Alternate usage: {{SMU|U-103||2}}
|
[[w:SM U-103 |''U-103'']]
|
SMU U-103 |
These are the same optional parameters in use in the other ship shortcut templates. Some of the options above are silly in the case of World War I era U-boats, but are included for compatibility with other shortcut templates.
N.B.: Be careful with the third parameter if not using the second parameter. In the U-103 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 {{ship}} to create the same link and text, but usually saving some characters while editing.
{{SMU|U-28|Germany|6}}yields the same results as{{ship|SM|U-28|Germany}}
TemplateData
TemplateData
|
|---|
|
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:SMU in articles based on its TemplateData.
TemplateData for SMU <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
