Template:Ship/doc
 | 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 template is used on approximately 42,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
 | This template uses Lua: |
Usage
[edit]Template {{Ship}} creates a wikilink to its article and formats the visible name correctly. That is, it handles both parts of [[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: [[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: [[HMCS Kootenay (H75)|HMCS ''Kootenay'']] → HMCS Kootenay (note the italics, and the omission of the hull number – linked to the same article).
Basic usage
[edit]- {{ship|1-prefix|2-name|3-ID}} →
[[1-prefix 2-name (3-ID)|1-prefix ''2-name'' (3-ID)]]→ 1-prefix 2-name (3-ID)
- 1 prefix
- like HMS, USS. Leave the parameter blank if the ship's title has no prefix.
- 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}} | [[ARA General Belgrano|ARA ''General Belgrano'']] | ARA General Belgrano |
| {{ship|HMCS|Kootenay|H75}} | [[HMCS Kootenay (H75)|HMCS ''Kootenay'' (H75)]] | HMCS Kootenay (H75) |
Format options parameter
[edit]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}}→ Kootenay[[HMCS Kootenay (H75)|''Kootenay'']]
The 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 | invalid | {{ship|HMCS|Kootenay|H75|4}} | — | 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 | |
Same format, no wikilink
[edit]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}}) - HMCS Kootenay (H75) (no wikilink, setting
{{ship|HMCS|Kootenay|H75|wl=no}})
Prefix in/out option
[edit]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}}→ Yamato
TemplateData
[edit]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 pennant number
| String | optional |
| Format | 4 | Formats label (parts showing)
| Number | optional |
| unlink prefix | up | yes=puts Fleet ID outside of Wikilink
| Boolean | optional |
