Template:HMS/doc

This is a documentation subpage for Template:HMS.
It may contain usage information, categories and other content that is not part of the original template page.

Usage

This is a typing short cut for linking to US Navy ship articles named in the format "HMS Deep Six (AWOL-99)". Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[HMS Deep Six (AWOL-99)|HMS ''Deep Six'' (AWOL-99)]]. This template halves that to {{HMS|Deep Six|AWOL-99}}.

Formal usage

{{HMS|Ship Name}}
{{HMS|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
`{{HMS\|Enterprise\|CVN-65}}`	`[[HMS Enterprise (CVN-65)\|HMS ''Enterprise'' (CVN-65)]]`	HMS Enterprise (CVN-65)
`{{HMS\|Constellation\|1797}}`	`[[HMS Constellation (1797)\|HMS ''Constellation'' (1797)]]`	HMS Constellation (1797)
`{{HMS\|Constitution}}`	`[[HMS Constitution\|HMS ''Constitution'']]`	HMS Constitution

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 HMS, 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	`{{HMS\|Enterprise\|CVN-65}}`	`[[HMS Enterprise (CVN-65) \|HMS ''Enterprise'' (CVN-65)]]`	HMS Enterprise (CVN-65)
1	3rd	`{{HMS\|Enterprise\|CVN-65\|1}}`	`[[HMS Enterprise (CVN-65) \|CVN-65]]`	CVN-65
2	2nd	`{{HMS\|Enterprise\|CVN-65\|2}}`	`[[HMS Enterprise (CVN-65) \|''Enterprise'']]`	Enterprise
3	2nd, 3rd	`{{HMS\|Enterprise\|CVN-65\|3}}`	`[[HMS Enterprise (CVN-65) \|''Enterprise'' (CVN-65)]]`	(CVN-65)
4	invalid result	`{{HMS\|Enterprise\|CVN-65\|4}}`	`[[HMS Enterprise (CVN-65) \|Invalid Optional Parameter]]`	HMS Enterprise (CVN-65)
5	1st, 3rd	`{{HMS\|Enterprise\|CVN-65\|5}}`	`[[HMS Enterprise (CVN-65) \|HMS (CVN-65)]]`	HMS CVN-65
6	1st, 2nd	`{{HMS\|Enterprise\|CVN-65\|6}}`	`[[HMS Enterprise (CVN-65) \|HMS ''Enterprise'']]`	HMS Enterprise
	2nd (no 3rd)	`{{HMS\|Constitution\|3=2}}` Alternate usage: `{{HMS\|Constitution\|\|2}}`	`[[HMS Constitution \|''Constitution'']]`	Constitution

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