Template:HMCS/doc

Usage

This is a typing short cut for linking to Canadian Forces Maritime Command (1968–present) and Royal Canadian Navy (1910–1968) ship articles named in the format "HMCS Toronto (FFH 333)". Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[HMCS Toronto (FFH 333)|HMCS ''Toronto'' (FFH 333)]]. This template halves that to {{HMCS|Toronto|FFH 333}}.

Formal usage

{{HMCS|Ship Name}}

{{HMCS|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
{{HMCS|Bonaventure|CVL 22}}	[[HMCS Bonaventure (CVL 22)|HMCS ''Bonaventure'' (CVL 22)]]	HMCS Bonaventure (CVL 22)
{{HMCS|Rainbow|1910}}	[[HMCS Rainbow (1910)|HMS ''Rainbow'' (1910)]]	HMCS Rainbow (1910)
{{HMCS|Athabaskan}}	[[HMCS Athabaskan|HMCS ''Athabaskan'']]	HMCS Athabaskan

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 "HMCS", 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);br>displayed	Example		Equivalent wikicode	Final result
1	3rd	{{HMCS|Bonaventure|CVL 22|1}}		[[HMCS Bonaventure (CVL 22)|CVL 22]]	CVL 22
2	2nd	{{HMCS|Bonaventure|CVL 22|2}}		[[HMCS Bonaventure (CVL 22)|''Bonaventure'']]	Bonaventure
3	2nd, 3rd	{{HMCS|Bonaventure|CVL 22|3}}		[[HMCS Bonaventure (CVL 22)|''Bonaventure'' CVL 22]]	Bonaventure (CVL 22)
4	invalid result	{{HMCS|Bonaventure|CVL 22|4}}		[[HMCS Bonaventure (CVL 22)|Invalid Optional Parameter]]	HMCS Bonaventure (CVL 22)
5	1st, 3rd	{{HMCS|Bonaventure|CVL 22|5}}		[[HMCS Bonaventure (CVL 22)|HMCS CVL 22]]	HMCS CVL 22
6	1st, 2nd	{{HMCS|Bonaventure|CVL 22|6}}		[[HMCS Bonaventure (CVL 22)|HMCS ''Bonaventure'']]	HMCS Bonaventure
	2nd (no 3rd)	{{HMCS|Athabaskan|3=2}}	Alternate usage: {{HMCS|Athabaskan||2}}	[[HMCS Athabaskan|''Athabaskan'']]	Athabaskan

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

{{HMCS|Bonaventure|CVL 22|6}} yields the same results as {{warship|HMCS|Bonaventure|CVL 22}}

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 HMCS 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