Lihimi Tɛmplet:Ship/doc ni yi shɛli na

{{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> &rarr; [[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> &rarr; [[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> &rarr; <code><nowiki>[[1-prefix 2-name (3-ID)|1-prefix ''2-name'' (3-ID)]]</nowiki></code> &rarr; {{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<span style="background:yellow;">|2</span>}} <code><nowiki>[[HMCS Kootenay (H75)|''Kootenay'']]</nowiki></code>  </code> &rarr; {{ship|HMCS|Kootenay|H75|2}}

The options are:
{|class=wikitable width=100%
! Value
! Parameter(s)<br>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><span style="background:yellow">|wl=no</span>}}</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:
<!-- Better examples needed: show the effect of prefix in/out article title. DePiep, 2018-03-10 -->
* <code><nowiki>{{ship|Japanese battleship|Yamato|up=yes}}</nowiki></code> &rarr; {{ship|Japanese battleship|Yamato|up=yes}}

Using a format option:
* <code><nowiki>{{ship|Japanese battleship|Yamato||2|up=yes}}</nowiki></code> &rarr; {{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||
<!-- Categories to be added below this line: -->
[[Category:Ship templates|Ship]]
[[Category:Ship prefix templates| ]]
[[Category:Templates that add a tracking category]]
}}</includeonly>