Template:Ship/doc

Usage

This is a typing short cut for linking to ship articles named in the format "Russian battleship Petropavlovsk (1914)". Since Ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[Russian battleship Petropavlovsk (1914)|Russian battleship ''Petropavlovsk'']]. This template approximately halves that to {{ship|Russian battleship|Petropavlovsk|1914}}.

Formal usage

{{ship|Ship Name}}

{{ship|Ship Name|ID}}, where ID can be the hull number, launch year, or pennant number, as specified in the article title.

Examples

Template usage	Equivalent wikicode	Final result
{{ship|ARA|General Belgrano}}	[[ARA General Belgrano|ARA ''General Belgrano'']]
{{ship|HMCS|Kootenay|H75}}	[[HMCS Kootenay (H75)|HMCS ''Kootenay'' (H75)]]

Optional display control parameter

There is an optional third parameter that controls which pieces of text are displayed in the article. Its value is treated as a binary number and will display the corresponding "bits". So setting the 4's bit will display USS, setting the 2's bit will display the ship name, and setting the 1's bit will display the ID. If you are unfamiliar with binary math, refer to these examples:

Value	Parameter(s) displayed	Example		Equivalent wikicode	Final result
None	all	{{ship|HMCS|Kootenay|H75}}		[[HMCS Kootenay (H75)|HMCS ''Kootenay'' (H75)]]
1	3rd	{{ship|HMCS|Kootenay|H75|1}}		[[HMCS Kootenay (H75)|H75]]
2	2nd	{{ship|HMCS|Kootenay|H75|2}}}		[[HMCS Kootenay (H75)|''Kootenay'']]
3	2nd, 3rd	{{ship|HMCS|Kootenay|H75|3}}}		[[HMCS Kootenay (H75)|''Kootenay'' (H75)]]
4	invalid result	{{ship|HMCS|Kootenay|H75|4}}}		[[HMCS Kootenay (H75)|Invalid Optional Parameter]]
5	1st, 3rd	{{ship|HMCS|Kootenay|H75|5}}}		[[HMCS Kootenay (H75)|HMCS (H75)]]
6	1st, 2nd	{{ship|HMCS|Kootenay|H75|6}}}		[[HMCS Kootenay (H75)|HMCS ''Kootenay'']]
	2nd (no 3rd)	{{ship|Japanese battleship|Yamato|4=2}}	Alternate usage: {{ship|Japanese battleship|Yamato||2}}	[[Japanese battleship Yamato|''Yamato'']]

N.B.: Be careful with the third parameter if not using the second parameter. In the Yamato example above, the "|4=2" means set the fourth parameter to a value of two, while the alternate syntax shows using a pair of pipes, "||2", to position the value two in the fourth parameter position.

Optional prefix parameter

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.)

Examples

• {{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: