Template:MS/doc

From 'City of Adelaide' History and Genealogy Site
Jump to navigation Jump to search

{{#invoke:Message box|mbox}}

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

Last example could be used to link to ship index (disambiguation) page

Optional display control parameter

There is an optional third parameter that controls which pieces of text are displayed in the article. It's value is treated as a binary number and will display the corresponding "bits". So setting the 8's bit will add a slash ("/") in the prefix, the 4's bit will display MS, setting the 2's bit will display the ship name, and setting the 1's bit will display the ID. If binary math isn't your thing, refer to these examples:

Value Parameter(s)
displayed
Example Equivalent wikicode Final result
None all {{MS|Antenor|1957}} [[MS Antenor (1957) |MS ''Antenor'' (1957)]] MS Antenor (1957)
1 3rd {{MS|Antenor|1957|1}} [[MS Antenor (1957) |1957]] 1957
2 2nd {{MS|Antenor|1957|2}} [[MS Antenor (1957) |''Antenor'']] Antenor
3 2nd, 3rd {{MS|Antenor|1957|3}} [[MS Antenor (1957) |''Antenor'' (1957)]] Antenor (1957)
4 invalid result {{MS|Antenor|1957|4}} [[MS Antenor (1957) |Invalid Optional Parameter]] Invalid Optional Parameter
5 1st, 3rd {{MS|Antenor|1957|5}} [[MS Antenor (1957) |MS (1957)]] MS (1957)
6 1st, 2nd {{MS|Antenor|1957|6}} [[MS Antenor (1957) |MS ''Antenor'']] MS Antenor
8 all (with "M/S") {{MS|Antenor|1957|8}} [[MS Antenor (1957)|M/S ''Antenor'' (1957)]] M/S Antenor (1957)
13 1st, 3rd (with "M/S") {{MS|Antenor|1957|13}} [[MS Antenor (1957)|M/S (1957)]] M/S (1957)
14 1st, 2nd (with "M/S") {{MS|Antenor|1957|14}} [[MS Antenor (1957)|M/S ''Antenor'']] M/S Antenor
2nd
(no 3rd)
{{MS|Princess of Norway|3=2}}
Alternate usage: {{MS|Princess of Norway||2}}
[[MS Princess of Norway |''Princess of Norway'']] Princess of Norway

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

Using an optional display control parameter value of 6 yields the same results as using {{warship}} to create the same link and text, but saving, coincidentally, 6 characters while editing.

 {{MS|Antenor|1957}} yields the same results as {{warship|MS|Antenor|1957}}

See also

WP:SHIPS shortcut templates:

Ship class article shortcuts
  • For articles about ship classes named for a member of the class:
    {{sclass}}—article titles that are not hyphenated
    {{sclass-}}—article titles that are hyphenated
  • For articles about ship classes named for a common theme:
    {{sclass2}}—article titles that are not hyphenated
    {{sclass2-}}—article titles that are hyphenated
Ship prefix shortcuts
  • Generic ship prefixes
  • Commonwealth ship prefixes
  • United States ship prefixes
  • Other navies' prefixes
Dictionary of American Naval Fighting Ships (DANFS) templates
Measurement shortcut templates