Template:Twin-screw steamer
Usage
This is a typing short cut for linking to steamship articles named in the format "TSS Shipname (Year)". Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[TSS Shipname (Year)|TSS ''Shipname'' (Year)]]. This template halves that to {{TSS|Shipname|Year}}.
Formal Usage
{{TSS|Ship Name}}{{TSS|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 |
|---|---|---|
{{TSS|Princess Maud|1934}} |
[[TSS Princess Maud (1934)|TSS ''Princess Maud'' (1934)]] |
TSS Princess Maud (1934) |
{{TSS|Caledonian Princess}} |
[[TSS Caledonian Princess|TSS ''Caledonian Princess'']] |
TSS Caledonian Princess |
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 TSS, 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 | {{TSS|Princess Maud|1934}} |
[[TSS Princess Maud (1934) |TSS ''Princess Maud'' (1934)]] |
TSS Princess Maud (1934) |
| 1 | 3rd | {{TSS|Princess Maud|1934|1}} |
[[TSS Princess Maud (1934) |1934]] |
1934 |
| 2 | 2nd | {{TSS|Princess Maud|1934|2}} |
[[TSS Princess Maud (1934) |''Princess Maud'']] |
Princess Maud |
| 3 | 2nd, 3rd | {{TSS|Princess Maud|1934|3}} |
[[TSS Princess Maud (1934) |''Princess Maud'' (1934)]] |
Princess Maud (1934) |
| 4 | invalid result | {{TSS|Princess Maud|1934|4}} |
— | Error: {{TSS}} invalid control parameter: 4 (help) |
| 5 | 1st, 3rd | {{TSS|Princess Maud|1934|5}} |
[[TSS Princess Maud (1934) |TSS (1934)]] |
TSS 1934 |
| 6 | 1st, 2nd | {{TSS|Princess Maud|1934|6}} |
[[TSS Princess Maud (1934) |TSS ''Princess Maud'']] |
TSS Princess Maud |
| 2nd (no 3rd) |
{{TSS|Caledonian Princess|3=2}} Alternate usage: {{TSS|Caledonian Princess||2}} |
[[TSS Caledonian Princess|''Caledonian Princess'']] |
Caledonian Princess |
N.B.: Be careful with the third parameter if not using the second parameter. In the Caledonian Princess 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:Twin-screw steamer in articles based on its TemplateData.
TemplateData for Twin-screw steamer This template provides a wikilink to a ship's page, with label options
| |||||||||||||||||||||||||
