Templat:HMAS/doc

Usage

This is a typing short cut for linking to Royal Australian Navy ship articles named in the format "HMAS Bataan (I91)". Since Ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[HMAS Bataan (I91)|HMAS ''Bataan'' (I91)]]. This template halves that to {{HMAS|Bataan|I91}}.

Formal usage

 {{HMAS|Ship Name}}
 {{HMAS|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
{{HMAS|Bataan|I91}}	[[HMAS Bataan (I91)|HMAS ''Bataan'' (I91)]]	HMAS Bataan (I91)
{{HMAS|Anzac|1917}}	[[HMAS Anzac (1917)|HMAS ''Anzac'' (1917)]]	HMAS Anzac (1917)
{{HMAS|Encounter}}	[[HMAS Encounter|HMAS ''Encounter'']]	HMAS Encounter

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

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

 {{HMAS|Bataan|I91|6}} yields the same results as {{warship|HMS|Illustrious|I91}}