Template:Ship
Template documentationUsage
Template {{Ship}} creates a wikilink to its article and formats the visible name correctly. That is, it handles both parts of [[w:targetpage|label]]. Now it is up to the editor (you) to get this right: a bluelink to the article, and well-formatted ship's full name.
The ship's article may be titled: [[w:HMCS Kootenay (H75)|HMCS Kootenay (H75)]] → HMCS Kootenay (H75). The three parts are called: prefix, name, ID (ID is WP:Disambiguation, or hull number, pennant number, launch year: to identify the ship when multiple ships have the same name).
Apart from the article title, in the visible label the name could be formatted. Like: [[w:HMCS Kootenay (H75)|HMCS ''Kootenay'']] → HMCS Kootenay (note the italics, and the omission of the hull number – linked to the same article).
Basic usage
- {{ship|1-prefix|2-name|3-ID}} →
[[w:1-prefix 2-name (3-ID)|1-prefix ''2-name'' (3-ID)]]→ 1-prefix 2-name (3-ID)
- 1 prefix
- like HMS, USS
- 2 name
- ship's name
- 3 ID
- Specifier like hull number, pennant number, or launch year. Also serves as the WP:Disambiguation term in article titles.
All parameters are optional. You only need to enter the parts that build the article title.
- Examples
| Template usage | Resulting wikicode | Link showing |
|---|---|---|
| {{ship|ARA|General Belgrano}} | [[w:ARA General Belgrano|ARA ''General Belgrano'']] | ARA General Belgrano |
| {{ship|HMCS|Kootenay|H75}} | [[w:HMCS Kootenay (H75)|HMCS ''Kootenay'' (H75)]] | HMCS Kootenay (H75) |
Format options parameter
A fourth, unnamed parameter |4= allows setting which pieces of text are displayed in the wikilink. It sets the label in the link: [[w: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}}→ Kootenay[[w:HMCS Kootenay (H75)|''Kootenay'']]
The options are:
| Value | Parameter(s) displayed |
Example | Equivalent wikicode | Final result | |
|---|---|---|---|---|---|
| None | prefix, name, ID | {{ship|HMCS|Kootenay|H75}} | [[w:HMCS Kootenay (H75)|HMCS ''Kootenay'' (H75)]] | HMCS Kootenay (H75) | |
| 1 | ID | {{ship|HMCS|Kootenay|H75|1}} | [[w:HMCS Kootenay (H75)|H75]] | H75 | |
| 2 | name | {{ship|HMCS|Kootenay|H75|2}} | [[w:HMCS Kootenay (H75)|''Kootenay'']] | Kootenay | |
| 3 | name, ID | {{ship|HMCS|Kootenay|H75|3}} | [[w:HMCS Kootenay (H75)|''Kootenay'' (H75)]] | Kootenay (H75) | |
| 4 | same as default | {{ship|HMCS|Kootenay|H75|4}} | [[w:HMCS Kootenay (H75)|HMCS ''Kootenay'' (H75)]] | HMCS Kootenay (H75) | |
| 5 | prefix, ID | {{ship|HMCS|Kootenay|H75|5}} | [[w:HMCS Kootenay (H75)|HMCS ''H75'']] | HMCS H75 | |
| 6 | prefix, name | {{ship|HMCS|Kootenay|H75|6}} | [[w:HMCS Kootenay (H75)|HMCS ''Kootenay'']] | HMCS Kootenay | |
Same format, no wikilink
By setting |wl=no, the same formatting is made but the ship's name is not linked:
- HMCS Kootenay (H75) (regular,
{{ship|HMCS|Kootenay|H75|4}}) - HMCS Kootenay (H75) (no wikilink, setting
{{ship|HMCS|Kootenay|H75|4|wl=no}})
Prefix in/out option
Parameter |up=yes (for unlinked prefix) can be used to have an unlinked prefix:. When set to "yes", the template will display the prefix before (outside of) the wikilink.
- Examples
{{ship|Japanese battleship|Yamato|up=yes}}→ Japanese battleship Yamato
Using a format option:
{{ship|Japanese battleship|Yamato||2|up=yes}}→ Japanese battleship Yamato
TemplateData
TemplateData for Ship
<templatedata> { "params": { "1": { "label": "Prefix", "description": "Fleet identifier", "example": "HMS, Japanese battleship", "type": "string" }, "2": { "label": "Name", "description": "Ship's name", "example": "Bismarck, Belgrano", "type": "string" }, "3": { "label": "ID", "description": "Hull number, launch year, or pennant number", "example": "H75, 1975, ", "type": "string" }, "4": { "label": "Format", "description": "Formats label (parts showing)", "example": "1, 2, 3, 5, 6", "default": "blank", "type": "number" }, "up": { "label": "unlink prefix", "description": "yes=puts Fleet ID outside of 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", "4", "up" ] } </templatedata>
Tracking categories
- Category:WPSHIPS: Template Ship parameter errors (0)
- Category:Pages using Ship with unknown parameters (0)
