Template:MS/doc

From MOASSpedia
Jump to navigation Jump to search

This template links to an unslashed prefix: "MS": MS Antenor (1957)

Usage

This is a typing short cut for linking to steamship articles named in the format "MS Shipname (Year)". Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[MS Shipname (ID)|MS ''Shipname'' (ID)]]. This template halves that to {{MS|Shipname|ID}}.

Formal Usage

  • {{MS|Ship Name}}
  • {{MS|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
{{MS|Antenor|1957}} [[MS Antenor (1957)|MS ''Antenor'' (1957)]] MS Antenor (1957)
{{MS|Queen Victoria|ship}} [[MS Queen Victoria (ship)|MS ''Queen Victoria'' (ship)]] MS Queen Victoria (ship)
{{MS|Princess of Norway}} [[MS Princess of Norway|MS ''Princess of Norway'']] MS Princess of Norway

Label format options

By default, the wikilink is build like this:

  • {{MS|Antenor|1957}}, the targetpage is
[[MS Antenor (1957)]].
Then the template by default adds the formatted label:
[[targetpage|label]]
[[MS Antenor (1957)|MS ''Antenor'' (1957)]], showing as:
MS Antenor (1957).

The default label can be changed with a simple parameter. The extra third position, unnamed parameter allows setting which elements of the ship's full name are shown in the wikilink. It sets the label in the link: For example, in your article, the hull number (disambiguator) may not be needed to show. In that case, add option |2, and the result is:

  • {{MS|Antenor|1957|2}}
[[MS Antenor (1957)|''Antenor'']]
Antenor

The options are:

Value Will show Example Wikilink [[targetpage|label]] Shows
(default) PREFIX name (ID) {{MS|Antenor|1957}} [[MS Antenor (1957)|MS ''Antenor'' (1957)]] MS Antenor (1957)
1 ID {{MS|Antenor|1957|1}} [[MS Antenor (1957)|1957]] 1957
2 name {{MS|Antenor|1957|2}} [[MS Antenor (1957)|''Antenor'']] Antenor
3 name (ID) {{MS|Antenor|1957|3}} [[MS Antenor (1957)|''Antenor'' (1957)]] Antenor (1957)
4 (dflt) PREFIX name (ID) {{MS|Antenor|1957|4}} [[MS Antenor (1957)|MS ''Antenor'' (1957)]] MS Antenor (1957)
5 PREFIX ID {{MS|Antenor|1957|5}} [[MS Antenor (1957)|MS ''1957'']] MS 1957
6 PREFIX name {{MS|Antenor|1957|6}} [[MS Antenor (1957)|MS ''Antenor'']] MS Antenor
Note: usually, options default (=blank), 2 and 6 are used.

TemplateData

This section:
TemplateData
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for MS

This template provides a wikilink to a ship's page, with label options

Template parameters

ParameterDescriptionTypeStatus
Name1

Ship's name

Example
Bismarck, Belgrano
Stringoptional
ID2

Hull number, launch year, or pennant number

Example
H75, 1975
Stringoptional
Format3

Formats the label (which name parts will show)

Default
blank
Example
1, 2, 3, 5, 6
Numberoptional
unlink prefixup

up=yes puts prefix before (outside of) the wikilink

Default
no
Example
up=yes
Booleanoptional

See also

Template:WPSHIPS shortcut templates