Template:RMS/doc

Usage

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

Formal usage

• {{RMS|Ship Name}}
• {{RMS|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
{{RMS|Adriatic|1907}}	[[RMS Adriatic (1907)|RMS ''Adriatic'' (1907)]]	RMS Adriatic (1907)
{{RMS|Titanic}}	[[RMS Titanic|RMS ''Titanic'']]	RMS Titanic

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. Its value is treated as a binary number and will display the corresponding "bits". So setting the 4's bit will display RMS, 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	{{RMS|Adriatic|1907}}	[[RMS Adriatic (1907) |RMS ''Adriatic'' (1907)]]	RMS Adriatic (1907)
1	3rd	{{RMS|Adriatic|1907|1}}	[[RMS Adriatic (1907) |1907]]	1907
2	2nd	{{RMS|Adriatic|1907|2}}	[[RMS Adriatic (1907) |''Adriatic'']]	Adriatic
3	2nd, 3rd	{{RMS|Adriatic|1907|3}}	[[RMS Adriatic (1907) |''Adriatic'' (1907)]]	Adriatic (1907)
4	invalid result	{{RMS|Adriatic|1907|4}}	[[RMS Adriatic (1907) |Invalid Optional Parameter]]	RMS Adriatic (1907)
5	1st, 3rd	{{RMS|Adriatic|1907|5}}	[[RMS Adriatic (1907) |RMS (1907)]]	RMS 1907
6	1st, 2nd	{{RMS|Adriatic|1907|6}}	[[RMS Adriatic (1907) |RMS ''Adriatic'']]	RMS Adriatic
	2nd (no 3rd)	{{RMS|Titanic|3=2}} Alternate usage: {{RMS|Titanic||2}}	[[RMS Titanic|''Titanic'']]	Titanic

N.B.: Be careful with the third parameter if not using the second parameter. In the Titanic 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.

 {{RMS|Adriatic|1907|6}} yields the same results as {{warship|RMS|Adriatic|1907}}

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 RMS This template provides a wikilink to a ship's page, with label options Template parameters Parameter Description Type Status Name 1 Ship's name Example Bismarck, Belgrano String optional ID 2 Hull number, launch year, or pennant number Example H75, 1975 String optional Format 3 Formats the label (which name parts will show) Default blank Example 1, 2, 3, 5, 6 Number optional unlink prefix up up=yes puts prefix before (outside of) the wikilink Default no Example up=yes Boolean optional