Kurt: 1 revision imported

2023-01-08T23:01:40Z

1 revision imported

← Older revision	Revision as of 18:01, 8 January 2023
(No difference)

en>Dhtwiki: correcting typo

2021-05-27T23:18:40Z

correcting typo

New page

{{Documentation subpage}}

== Usage ==
Template {{tl|Ship}} creates a wikilink to its article ''and'' formats the visible name correctly. That is, it handles both parts of <code><nowiki>[[targetpage|label]]</nowiki></code>. 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: <code><nowiki>[[HMCS Kootenay (H75)]]</nowiki></code> → [[HMCS Kootenay (H75)]]. The three parts are called: prefix, name, ID (ID is [[WP:DAB|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: <code><nowiki>[[HMCS Kootenay (H75)|HMCS ''Kootenay'']]</nowiki></code> → [[HMCS Kootenay (H75)|HMCS ''Kootenay'']] (note the ''italics'', and the omission of the hull number – linked to the same article).

=== Basic usage ===
:<nowiki>{{ship|1-prefix|2-name|3-ID}}</nowiki> → <code><nowiki>[[1-prefix 2-name (3-ID)|1-prefix ''2-name'' (3-ID)]]</nowiki></code> → {{ship|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:DAB|WP:Disambiguation term]] in article titles.

All parameters are optional. You only need to enter the parts that build the article title.

;Examples
{|class=wikitable width="100%"
|-
! Template usage
! Resulting wikicode
! Link showing
|-
| <nowiki>{{ship|ARA|General Belgrano}}</nowiki>
| <nowiki>[[ARA General Belgrano|ARA ''General Belgrano'']]</nowiki>
| {{ship|ARA|General Belgrano}}
|-
| <nowiki>{{ship|HMCS|Kootenay|H75}}</nowiki>
| <nowiki>[[HMCS Kootenay (H75)|HMCS ''Kootenay'' (H75)]]</nowiki>
| {{ship|HMCS|Kootenay|H75}}
|}

=== Format options parameter ===
A fourth, unnamed parameter {{para|4}} allows setting which pieces of text are displayed in the wikilink. It sets the ''label'' in the link: <code><nowiki>[[targetpage|label]]</nowiki></code>

For example, the ship's article is entered as <code><nowiki>{{ship|HMCS|Kootenay|H75}}</nowiki></code>, by default showing as {{ship|HMCS|Kootenay|H75}}.

But in your article, the hull number (disambiguator) may not be needed to show. In that case, add {{para|4|2}}, and the result is:
:<code><nowiki>{{ship</nowiki>|HMCS|Kootenay|H75|2}} <code><nowiki>[[HMCS Kootenay (H75)|''Kootenay'']]</nowiki></code> </code> → {{ship|HMCS|Kootenay|H75|2}}

The options are:
{|class=wikitable width=100%
! Value
! Parameter(s) displayed
! colspan=2 | Example
! Equivalent wikicode
! Final result
|-same as default
! None
| style="text-align:center;" | prefix, name, ID
| colspan=2 | <nowiki>{{ship|HMCS|Kootenay|H75}}</nowiki>
| <nowiki>[[HMCS Kootenay (H75)|HMCS ''Kootenay'' (H75)]]</nowiki>
| {{ship|HMCS|Kootenay|H75}}
|-
! 1
| style="text-align:center;" | ID
| colspan=2 | <nowiki>{{ship|HMCS|Kootenay|H75|1}}</nowiki>
| <nowiki>[[HMCS Kootenay (H75)|H75]]</nowiki>
| {{ship|HMCS|Kootenay|H75|1}}
|-
! 2
| style="text-align:center;" | name
| colspan=2 | <nowiki>{{ship|HMCS|Kootenay|H75|2}}</nowiki>
| <nowiki>[[HMCS Kootenay (H75)|''Kootenay'']]</nowiki>
| {{ship|HMCS|Kootenay|H75|2}}
|-
! 3
| style="text-align:center;" | name, ID
| colspan=2 | <nowiki>{{ship|HMCS|Kootenay|H75|3}}</nowiki>
| <nowiki>[[HMCS Kootenay (H75)|''Kootenay'' (H75)]]</nowiki>
| {{ship|HMCS|Kootenay|H75|3}}
|-
! 4
| style="text-align:center;" | ''same as default''
| colspan=2 | <nowiki>{{ship|HMCS|Kootenay|H75|4}}</nowiki>
| <nowiki>[[HMCS Kootenay (H75)|HMCS ''Kootenay'' (H75)]]</nowiki>
| {{ship|HMCS|Kootenay|H75|4}}
|-
! 5
| style="text-align:center;" | prefix, ID
| colspan=2 | <nowiki>{{ship|HMCS|Kootenay|H75|5}}</nowiki>
| <nowiki>[[HMCS Kootenay (H75)|HMCS ''H75'']]</nowiki>
| {{ship|HMCS|Kootenay|H75|5}}
|-
! 6
| style="text-align:center;" | prefix, name
| colspan=2 | <nowiki>{{ship|HMCS|Kootenay|H75|6}}</nowiki>
| <nowiki>[[HMCS Kootenay (H75)|HMCS ''Kootenay'']]</nowiki>
| {{ship|HMCS|Kootenay|H75|6}}
|}

===Same format, no wikilink===
By setting {{para|wl|no}}, the same formatting is made but the ship's name is not linked:
:{{ship|HMCS|Kootenay|H75|4}} (regular, <code><nowiki>{{ship|HMCS|Kootenay|H75|4}}</nowiki></code>)
:{{ship|HMCS|Kootenay|H75|4|wl=no}} (no wikilink, setting <code><nowiki>{{ship|HMCS|Kootenay|H75|4</nowiki>|wl=no}}</code>)

=== Prefix in/out option ===
Parameter {{para|up|yes}} (for '''u'''nlinked '''p'''refix) can be used to have an ''unlinked prefix'':. When set to "yes", the template will display the prefix before (outside of) the wikilink.

;Examples:

* <code><nowiki>{{ship|Japanese battleship|Yamato|up=yes}}</nowiki></code> → {{ship|Japanese battleship|Yamato|up=yes}}

Using a format option:
* <code><nowiki>{{ship|Japanese battleship|Yamato||2|up=yes}}</nowiki></code> → {{ship|Japanese battleship|Yamato||2|up=yes}}

==TemplateData==
{{TemplateData header}}
<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==
* {{clc|WPSHIPS: Template Ship parameter errors}}
* {{clc|Pages using Ship with unknown parameters}}

== See also ==
{{WPSHIPS shortcut templates}}

<includeonly>{{sandbox other||

[[Category:Ship templates|Ship]]
[[Category:Ship prefix templates| ]]
[[Category:Templates that add a tracking category]]
}}</includeonly>

Template:Ship/doc - Revision history

Kurt: 1 revision imported

en>Dhtwiki: correcting typo