Template:M/S/doc

From blackwiki
< Template:M‎ | S
Revision as of 01:20, 17 March 2018 by imported>DePiep (→‎Usage)
Jump to navigation Jump to search

Usage

This template links to an unslashed target page [[Template:NnbspMS Antenor (1957)Template:Nnbsp]] and shows the slash: Template:Ship/special

  • When the target pagename has a "/" slash, use {{Ship}}:
Target: [[Template:NnbspS/Y ManitouTemplate:Nnbsp]]
Use: {{ship|S/Y|Manitou}}S/Y Manitou

Formal Usage

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

Label format options

By default, the wikilink is build like this:

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

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'']]
Template:Ship/special

The options are:

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

Template data

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for M/S

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

Template parameters

ParameterDescriptionTypeStatus
Prefix1

Fleet identifier

Example
HMS, Japanese battleship
Stringoptional
Name2

Ship's name

Example
Bismarck, Belgrano
Stringoptional
ID3

Hull number, launch year, or pennanr number

Example
H75, 1975,
Stringoptional
Format4

Formats label (parts showing)

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

yes=puts Fleet ID outside of Wikilink

Default
no
Example
up=yes
Booleanoptional

See also

Template:WPSHIPS shortcut templates