![]() | 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. |
Template {{Ship}} creates a wikilink to its article and formats the visible name correctly. That is, it formats both parts of [[targetpage|labeltext]]
.
The ship's article may be titled: [[HMCS Kootenay (H75)]]
→ HMCS Kootenay (H75). The three parts are called: prefix, name, disambiguator (for WP:Disambiguation, or hull number, pennant number, launch year: to identify the ship when multiple ships have that name).
However, in the label the name could be formatted otherwise, like: [[HMCS Kootenay (H75)|HMCS ''Kootenay'']]
→ HMCS Kootenay (note the italics, and the omission of the hull number).
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) |
A fourth, unnamed parameter |4=
allows setting which pieces of text are displayed in the wikilink. It sets the label in the link: [[targetpage|label]]
For example, the ship's article is entered as {{ship|HMCS|Kootenay|H75}}
, by default showing as HMCS Kootenay (H75).
But in your article, the hull number (disambiguator) may not be needed to show. In that case, add |4=2
, and the result is:
{{ship|HMCS|Kootenay|H75|2}}
→ KootenayThe options are:
Value | Parameter(s) displayed |
Example | Equivalent wikicode | Final result | |
---|---|---|---|---|---|
None | prefix, name, ID | {{ship|HMCS|Kootenay|H75}} | [[HMCS Kootenay (H75)|HMCS ''Kootenay'' (H75)]] | HMCS Kootenay (H75) | |
1 | ID | {{ship|HMCS|Kootenay|H75|1}} | [[HMCS Kootenay (H75)|H75]] | H75 | |
2 | name | {{ship|HMCS|Kootenay|H75|2}} | [[HMCS Kootenay (H75)|''Kootenay'']] | Kootenay | |
3 | name, ID | {{ship|HMCS|Kootenay|H75|3}} | [[HMCS Kootenay (H75)|''Kootenay'' (H75)]] | Kootenay (H75) | |
4 | same as default | {{ship|HMCS|Kootenay|H75|4}} | [[HMCS Kootenay (H75)|HMCS ''Kootenay'' (H75)]] | Error: {{Ship}} invalid control parameter: 4 (help) | |
5 | prefix, ID | {{ship|HMCS|Kootenay|H75|5}} | [[HMCS Kootenay (H75)|HMCS (H75)]] | HMCS H75 | |
6 | prefix, name | {{ship|HMCS|Kootenay|H75|6}} | [[HMCS Kootenay (H75)|HMCS ''Kootenay'']] | HMCS Kootenay |
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 |