Template:HMNZS/doc

Usage

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

Formal usage

• {{HMNZS|Ship Name}}
• {{HMNZS|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
{{HMNZS|Endeavour|A11}}	[[HMNZS Endeavour (A11)|HMNZS ''Endeavour'' (A11)]]	HMNZS Endeavour (A11)
{{HMNZS|Hawea|1975}}	[[HMNZS Hawea (1975)|HMNZS ''Hawea'' (1975)]]	HMNZS Hawea (1975)
{{HMNZS|Charles Upham}}	[[HMNZS Charles Upham|HMNZS ''Charles Upham'']]	HMNZS Charles Upham

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 "HMNZS", 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	{{HMNZS|Endeavour|I91|1}}		[[HMNZS Endeavour (I91)|I91]]	I91
2	2nd	{{HMNZS|Endeavour|I91|2}}		[[HMNZS Endeavour (I91)|''Endeavour'']]	Endeavour
3	2nd, 3rd	{{HMNZS|Endeavour|I91|3}}		[[HMNZS Endeavour (I91)|''Endeavour'' I91]]	Endeavour (I91)
4	invalid result	{{HMNZS|Endeavour|I91|4}}		[[HMNZS Endeavour (I91)|Invalid Optional Parameter]]	HMNZS Endeavour (I91)
5	1st, 3rd	{{HMNZS|Endeavour|I91|5}}		[[HMNZS Endeavour (I91)|HMS I91]]	HMNZS I91
6	1st, 2nd	{{HMNZS|Endeavour|I91|6}}		[[HMNZS Endeavour (I91)|HMS ''Endeavour'']]	HMNZS Endeavour
	2nd (no 3rd)	{{HMNZS|Charles Uphamr|3=2}}	Alternate usage: {{HMNZS|Charles Upham||2}}	[[HMNZS Charles Upham|''Charles Upham'']]	Charles Upham

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

• {{HMNZS|Endeavour|I91|6}} yields the same results as {{warship|HMNZS|Endeavour|I91}}

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 in articles based on this TemplateData. TemplateData for HMNZS 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

See also

WP:SHIPS – ship class and ship prefix shortcut templates
Ship classes
Group	Template	Ref article	Example
after member ship	{{sclass}}	article hyphenated	Valiant-class harbor tug
after theme	{{sclass2}}	article hyphenated	Flower-class corvette
General ship prefixes
Group	Template	Ref article	Example
generic	{{ship}}	any prefix	Brigante Musolino or Charles de Gaulle (R91)
civil	{{GTS}}	Gas turbine ships	GTS Infinity (2001)
civil	{{HSC}}	High-speed craft	HSC Tarifa Jet (1997)
civil	{{MS}} ({{M/S}} deprecated)	Motor ships	MS Antenor (1957)
civil	{{MV}} ({{M/V}} deprecated)	Motor vessels	MV Aurora (2000)
civil	{{MY}} ({{M/Y}} deprecated)	Motor yachts	Template:MY
civil	{{PS}}	Paddle steamers	Template:PS
civil	{{RMS}}	Royal Mail Ships	RMS Adriatic (1907)
civil	{{RV}} ({{R/V}} deprecated)	Research vessels	RV Vityaz (1939)
civil	{{SB}}	Sailing barges	SB Cambria
civil	{{SS}} ({{S/S}} deprecated)	Steamships	SS Aeolus (1899)
civil	{{SV}} ({{S/V}} deprecated)	Sailing vessels	SV Argo (1841)
civil	{{SY}} ({{S/Y}} deprecated)	Sailing vessels	SY Raven (1889)
civil	{{TSS}}	Twin-screw steamers	TSS Princess Maud (1934)
International navy and government ship prefixes
Group	Template	Ref article	Example
Template:Country data Algeria	{{ANS}}	Algerian National Navy ships	Template:ANS
Australia	{{HMAS}}	Royal Australian Navy ships	HMAS Anzac (G90)
Template:Country data Bahamas	{{HMBS}}	Royal Bahamas Defence Force ships	Template:HMBS
Bangladesh	{{BNS}}	Bangladesh Navy ships	Template:BNS
Canada	{{HMCS}}	Royal Canadian Navy ships	Template:HMCS
	{{CCGS}}	Canadian Coast Guard ships	CCGS Simcoe (1909)
Colombia	{{ARC}}	Colombian Navy ships	Template:ARC
Denmark	{{HDMS}}	Royal Danish Navy ships	Template:HDMS
Ecuador	{{BAE}}	Ecuadorian Navy ships	Template:BAE
Egypt	{{ENS}}	Egyptian Navy ships	Template:ENS
Estonia	{{EML}}	Estonian Navy ships	Template:EML
Template:Country data Fiji	{{RFNS}}	Republic of Fiji Naval Service ships	Template:RFNS
Finland	{{FNS}}	Finnish Navy ships	Template:FNS
Greece	{{HS}}	Hellenic Navy ships	Template:HS
Germany	{{GS}}	German Navy and Kriegsmarine submarines	Template:GS
	{{SMS}}	Imperial German Navy and Austro-Hungarian Navy ships	SMS Novara (1912)
	{{SMU}}	Imperial German Navy and Austro-Hungarian Navy submarines	Template:SMU
Iceland	{{ICGV}}	Icelandic Coast Guard ships	Template:ICGV
India	{{INS}}	Indian Navy ships	INS Vikrant (1961)
Indonesia	{{KRI}}	Indonesian Navy ships	KRI Fatahillah (361)
Template:Country data Ireland	{{LÉ}}	Irish Navy ships	Template:LÉ
Japan	{{Jsub}}	Imperial Japanese Navy and Imperial Japanese Army submarines	Japanese submarine I-15
	{{JS}}	Japan Maritime Self-Defense Force ships	JS Ashigara (DDG-178)
	{{JDS}}	Japan Maritime Self-Defense Force ships (older)	JDS Wakaba (DE-261)
Netherlands	{{HNLMS}}	Royal Netherlands Navy ships	Template:HNLMS
New Zealand	{{HMNZS}}	Royal New Zealand Navy ships	HMNZS Endeavour (A11)
Template:Country data Nigeria	{{NNS}}	Nigerian Navy ships	Template:NNS
Norway	{{HNoMS}}	Royal Norwegian Navy ships	Template:HNoMS
Template:Country data Papua New Guinea	{{HMPNGS}}	Papua New Guinean Navy ships	Template:HMPNGS
Peru	{{BAP}}	Peruvian Navy ships	Template:BAP
Philippines	{{BRP}}	Philippine Navy ships	BRP Rajah Soliman (D-66)
	{{RPS}}	Philippine Navy ships (older)	Template:RPS
Poland	{{ORP}}	Polish Navy ships	Template:ORP
Portugal	{{NRP}}	Portuguese Navy ships	Template:NRP
Romania	{{NMS}}	Romanian Navy ships	Template:NMS
Singapore	{{RSS}}	Republic of Singapore Navy ships	Template:RSS
South Africa	{{SAS}}	South African Navy	Template:SAS
	{{HMSAS}}	Union of South Africa Navy	Template:HMSAS
South Korea	{{ROKS}}	Republic of Korea Navy ships	Template:ROKS
Sweden	{{HSwMS}}	Swedish Navy ships	HSwMS Sjölejonet (1936)
Thailand	{{HTMS}}	Royal Thai Navy ships	Template:HTMS
Turkey	{{TCG}}	Turkish Naval Forces ships	TCG Gediz (F 495)
United Kingdom	{{HMS}}	Royal Navy ships	HMS Illustrious (R06)
	{{HMT}}	Royal Navy trawlers	Template:HMT
	{{RFAux}}	Royal Fleet Auxiliary ships	Template:RFAux
United States	{{USAT}}	US Army transport ships	Template:USAT
	{{USCGC}}	US Coast Guard Cutter	USCGC Healy (WAGB-20)
	{{USNS}}	US Naval Ship	USNS Mercy (T-AH-19)
	{{USRC}}	US Revenue-Marine and US Revenue Cutter Service	Template:USRC
	{{USS}}	US Navy ship	USS Enterprise (CVN-65)
	{{USAV}}	US Army Vessel	Template:USAV
Category:Ship templates (15) Category:Ship prefix templates (2)