Template:Warship
From Wikipedia, the free encyclopedia
This is a shortcut for linking to ship articles.
Template documentation
Contents |
[edit] Usage
This is a typing short cut for linking to warship articles named in the format "Russian battleship Petropavlovsk (1914)". Since Ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[Russian battleship Petropavlovsk (1914)|Russian battleship ''Petropavlovsk'']]. This template approximately halves that to {{warship|Russian battleship|Petropavlovsk|1914}}.
[edit] Formal usage
{{warship|Ship Name}}
{{warship|Ship Name|ID}}, where ID can be the hull number, launch year, or pennant number, as specified in the article title.
[edit] Examples
| Template usage | Equivalent wikicode | Final result |
|---|---|---|
| {{warship|ARA|General Belgrano}} | [[ARA General Belgrano|ARA ''General Belgrano'']] | ARA General Belgrano |
| {{warship|HMCS|Kootenay|H75}} | [[HMCS Kootenay (H75)|HMCS ''Kootenay'' (H75)]] | HMCS Kootenay (H75) |
[edit] Optional display control parameter
There is an optional third parameter that controls which pieces of text are displayed in the article. It's value is treated as a binary number and will display the corresponding "bits". So setting the 4's bit will display USS, 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 | {{warship|HMCS|Kootenay|H75}} | [[HMCS Kootenay (H75)|HMCS ''Kootenay'' (H75)]] | HMCS Kootenay (H75) | |
| 1 | 3rd | {{warship|HMCS|Kootenay|H75|1}} | [[HMCS Kootenay (H75)|H75]] | H75 | |
| 2 | 2nd | {{warship|HMCS|Kootenay|H75|2}}} | [[HMCS Kootenay (H75)|''Kootenay'']] | Kootenay | |
| 3 | 2nd, 3rd | {{warship|HMCS|Kootenay|H75|3}}} | [[HMCS Kootenay (H75)|''Kootenay'' (H75)]] | Kootenay (H75) | |
| 4 | invalid result | {{warship|HMCS|Kootenay|H75|4}}} | [[HMCS Kootenay (H75)|Invalid Optional Parameter]] | Invalid Optional Parameter | |
| 5 | 1st, 3rd | {{warship|HMCS|Kootenay|H75|5}}} | [[HMCS Kootenay (H75)|HMCS (H75)]] | HMCS (H75) | |
| 6 | 1st, 2nd | {{warship|HMCS|Kootenay|H75|6}}} | [[HMCS Kootenay (H75)|HMCS ''Kootenay'']] | HMCS Kootenay | |
| 2nd (no 3rd) |
{{warship|Japanese battleship|Yamato|4=2}} | Alternate usage: {{warship|Japanese battleship|Yamato||2}} | [[Japanese battleship Yamato|''Yamato'']] | Yamato | |
N.B.: Be careful with the third parameter if not using the second parameter. In the Yamato example above, the "|4=2" means set the fourth parameter to a value of two, while the alternate syntax shows using a pair of pipes, "||2", to position the value two in the fourth parameter position.
[edit] See also
WP:SHIPS shortcut templates:
|
|
