Template:HMCS/doc

From Wikipedia, the free encyclopedia
Jump to: navigation, search

Usage[edit]

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[edit]

{{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[edit]

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[edit]

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]] Invalid Optional Parameter
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}}

See also[edit]

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
Naval Vessel Register templates
Measurement shortcut templates