![]() | This is a documentation subpage for Template:Ship. It may contain usage information, categories and other content that is not part of the original template page. |
This is a typing short cut for linking to ship 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 {{ship|Russian battleship|Petropavlovsk|1914}}.
Template usage | Equivalent wikicode | Final result |
---|---|---|
{{ship|ARA|General Belgrano}} | [[ARA General Belgrano|ARA ''General Belgrano'']] | ARA General Belgrano |
{{ship|HMCS|Kootenay|H75}} | [[HMCS Kootenay (H75)|HMCS ''Kootenay'' (H75)]] | HMCS Kootenay (H75) |
There is an optional parameter that controls which pieces of text are displayed in the wikilink.
Value | Parameter(s) displayed |
Example | Equivalent wikicode | Final result | |
---|---|---|---|---|---|
None | all | {{ship|HMCS|Kootenay|H75}} | [[HMCS Kootenay (H75)|HMCS ''Kootenay'' (H75)]] | HMCS Kootenay (H75) | |
1 | 3rd | {{ship|HMCS|Kootenay|H75|1}} | [[HMCS Kootenay (H75)|H75]] | H75 | |
2 | 2nd | {{ship|HMCS|Kootenay|H75|2}} | [[HMCS Kootenay (H75)|''Kootenay'']] | Kootenay | |
3 | 2nd, 3rd | {{ship|HMCS|Kootenay|H75|3}} | [[HMCS Kootenay (H75)|''Kootenay'' (H75)]] | Kootenay (H75) | |
4 | invalid result | {{ship|HMCS|Kootenay|H75|4}} | [[HMCS Kootenay (H75)|Invalid Optional Parameter]] | Error: {{Ship}} invalid control parameter: 4 (help) | |
5 | 1st, 3rd | {{ship|HMCS|Kootenay|H75|5}} | [[HMCS Kootenay (H75)|HMCS (H75)]] | HMCS H75 | |
6 | 1st, 2nd | {{ship|HMCS|Kootenay|H75|6}} | [[HMCS Kootenay (H75)|HMCS ''Kootenay'']] | HMCS Kootenay | |
2nd (no 3rd) |
{{ship|Japanese battleship|Yamato|4=2}} | Alternate usage: {{ship|Japanese battleship|Yamato||2}} | [[Japanese battleship Yamato|''Yamato'']] | Yamato |
The parameter up
(for unlinked prefix) can be used to have an unlinked prefix. When set to "yes", the template will display the prefix before the wikilink. This should be used with one of the optional display parameters above. (If not, it will result in a doubling of the prefix.)
{{ship|Japanese battleship|Yamato||2|up=yes}}
displays as:
Using without one of the optional display parameters:
{{ship|Japanese battleship|Yamato|up=yes}}
gives this:
TemplateData for Ship
This template provides a wikilink to a ship's page, with label options
Parameter | Description | Type | Status | |
---|---|---|---|---|
Prefix | 1 | Fleet identifier
| String | optional |
Name | 2 | Ship's name
| String | optional |
ID | 3 | Hull number, launch year, or pennanr number
| String | optional |
Format | 4 | Formats label (parts showing)
| Number | optional |
unlink prefix | up | yes=puts Fleet ID outside of Wikilink
| Boolean | optional |