Template:S/S/doc

From MOASSpedia
< Template:S‎ | S
Jump to navigation Jump to search

This template links to an unslashed target page [[ SS City of Los Angeles (1922) ]], but it shows the slash: "S/S": S/S City of Los Angeles  (1922)

Usage

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

Usage

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

Formal Usage

  • {{S/S|Ship Name}}
  • {{S/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
{{S/S|City of Los Angeles|1922}} [[SS City of Los Angeles (1922)|S/S ''City of Los Angeles'' (1922)]] S/S City of Los Angeles  (1922)
{{S/S|Queen Victoria|ship}} [[SS Queen Victoria (ship)|S/S ''Queen Victoria'' (ship)]] S/S Queen Victoria  (ship)
{{S/S|Princess of Norway}} [[SS Princess of Norway|S/S ''Princess of Norway'']] S/S Princess of Norway

Label format options

By default, the wikilink is build like this:

  • {{S/S|City of Los Angeles|1922}}, the targetpage is
[[SS City of Los Angeles (1922)]].
Then the template by default adds the formatted label:
[[targetpage|label]]
[[SS City of Los Angeles (1922)|S/S ''City of Los Angeles'' (1922)]], showing as:
S/S City of Los Angeles  (1922).

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:

  • {{SS|City of Los Angeles|1922|2}}
[[SS City of Los Angeles (1922)|''City of Los Angeles'']]
City of Los Angeles

The options are:

Value Will show Example Wikilink [[targetpage|label]] Shows
(default) PREFIX name (ID) {{S/S|City of Los Angeles|1922}} [[SS City of Los Angeles (1922)|S/S ''City of Los Angeles'' (1922)]] S/S City of Los Angeles  (1922)
1 ID {{S/S|City of Los Angeles|1922|1}} [[SS City of Los Angeles (1922)|''1922'']] 1922
2 name {{S/S|City of Los Angeles|1922|2}} [[SS City of Los Angeles (1922)|''City of Los Angeles'']] City of Los Angeles
3 name (ID) {{S/S|City of Los Angeles|1922|3}} [[SS City of Los Angeles (1922)|''City of Los Angeles'' (1922)]] City of Los Angeles  (1922)
4 (dflt) PREFIX name (ID) {{S/S|City of Los Angeles|1922|4}} [[SS City of Los Angeles (1922)|S/S ''City of Los Angeles'' (1922)]] S/S City of Los Angeles  (1922)
5 PREFIX ID {{S/S|City of Los Angeles|1922|5}} [[SS City of Los Angeles (1922)|S/S ''1922'']] S/S 1922
6 PREFIX name {{S/S|City of Los Angeles|1922|6}} [[SS City of Los Angeles (1922)|S/S ''City of Los Angeles'']] S/S City of Los Angeles
Note: options default (=blank), 2 and 6 are most often used.

Template data

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 S/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