Template:Ship/doc

Usage
Template Ship creates a wikilink to its article and formats the visible name correctly. That is, it handles both parts of. 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:  &rarr; 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 sae name).

Apart from the article title, in the visible label the name could be formatted. Like:  &rarr; HMCS Kootenay (note the italics, and the omission of the hull number – linked to the same article).

Basic usage

 * 1-PREFIX 2-name &rarr;  &rarr; 1-PREFIX 2-name


 * 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

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:

For example, the ship's article is entered as, by default showing as HMCS Kootenay.

But in your article, the hull number (disambiguator) may not be needed to show. In that case, add 2, and the result is:
 * &rarr; HMCS Kootenay

The options are:

Same format, no wikilink
By setting no, the same formatting is made but the ship's name is not linked:
 * HMCS Kootenay (regular, )
 * HMCS Kootenay (no wikilink, setting  )

Prefix in/out option
Parameter 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:


 * &rarr; JAPANESE BATTLESHIP Yamato

Using a format option:
 * &rarr; JAPANESE BATTLESHIP Yamato

Template data
{	"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 pennanr 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" ] }