Template:ROKS

Template documentation[view] [edit] [history] [purge]

Usage

This is a typing short cut for linking to Republic of Korea Navy ship articles named in the format "ROKS Dokdo (LPH-6111)". Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[ROKS Dokdo (LPH-6111)|ROKS ''Dokdo'' (LPH-6111)]]. This template halves that to {{ROKS|Dokdo|LPH-6111}}.

Formal Usage

• {{ROKS|Ship Name}}
• {{ROKS|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
{{ROKS|Dokdo|LPH-6111}}	[[ROKS Dokdo (LPH-6111)|ROKS ''Dokdo'' (LPH-6111)]]	ROKS Dokdo (LPH-6111)
{{ROKS|Dokdo|2005}}	[[ROKS Dokdo (2005)|ROKS ''Dokdo'' (2005)]]	ROKS Dokdo (2005)
{{ROKS|Dokdo}}	[[ROKS Dokdo|ROKS ''Dokdo'']]	ROKS Dokdo

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 ROKS, 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	{{ROKS|Dokdo|LPH-6111}}	[[ROKS Dokdo (LPH-6111)|ROKS ''Dokdo'' (LPH-6111)]]	ROKS Dokdo (LPH-6111)
1	3rd	{{ROKS|Dokdo|LPH-6111|1}}	[[ROKS Dokdo (LPH-6111)|LPH-6111]]	LPH-6111
2	2nd	{{ROKS|Dokdo|LPH-6111|2}}	[[ROKS Dokdo (LPH-6111)|''Dokdo'']]	Dokdo
3	2nd, 3rd	{{ROKS|Dokdo|LPH-6111|3}}	[[ROKS Dokdo (LPH-6111)|''Dokdo'' (LPH-6111)]]	Dokdo (LPH-6111)
4	invalid result	{{ROKS|Dokdo|LPH-6111|4}}	[[ROKS Dokdo (LPH-6111)|Invalid Optional Parameter]]	ROKS Dokdo (LPH-6111)
5	1st, 3rd	{{ROKS|Dokdo|LPH-6111|5}}	[[ROKS Dokdo (LPH-6111)|ROKS (LPH-6111)]]	ROKS LPH-6111
6	1st, 2nd	{{ROKS|Dokdo|LPH-6111|6}}	[[ROKS Dokdo (LPH-6111)|ROKS ''Dokdo'']]	ROKS Dokdo
	2nd (no 3rd)	{{ROKS|Dokdo|3=2}} Alternate usage: >{{ROKS|Dokdo||2}}	[[ROKS Dokdo|''Dokdo'']]	Dokdo

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

 {{ROKS|Dokdo|LPH-6111|6}} yields the same results as {{warship|ROKS|Dokdo|LPH-6111}}

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 ROKS 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 crafts	HSC Tarifa Jet (1997)
civil	{{MS}} or {{M/S}}	Motor ships	MS Antenor (1957) or M/S Antenor  (1957)
civil	{{MV}} or {{M/V}}	Motor vessels	MV Aurora (2000) or M/V Aurora  (2000)
civil	{{MY}} or {{M/Y}}	Motor yachts	MY Monte Carlo or M/Y Monte Carlo
civil	{{PS}}	Paddle steamers	PS Commonwealth (1854)
civil	{{RMS}}	Royal Mail Ships	RMS Adriatic (1907)
civil	{{RV}} or {{R/V}}	Research vessels	RV Vityaz (1939) or R/V Vityaz  (1939)
civil	{{SB}}	Sailing barges	SB Cambria
civil	{{SS}} or {{S/S}}	Steamships	SS Aeolus (1899) or Template:Ship/alt-label-prefix
civil	{{SV}} or {{S/V}}	Sailing vessels	SV Argo (1841) or S/V Argo  (1841)
civil	{{SY}} or {{S/Y}}	Sailing vessels	SY Raven (1889) or S/Y Raven  (1889)
civil	{{TSS}}	Twin-screw steamers	TSS Princess Maud (1934)
International navy ship prefixes
Group	Template	Ref article	Example
Algeria	{{ANS}}	Algerian National Navy ships	ANS Kalaat Béni Abbès (474)
Australia	{{HMAS}}	Royal Australian Navy ships	HMAS Anzac (G90)
Bahamas	{{HMBS}}	Royal Bahamas Defence Force ships	HMBS Nassau (P-61)
Bangladesh	{{BNS}}	Bangladesh Navy ships	BNS Surma (2013)
Canada	{{HMCS}}	Royal Canadian Navy ships	HMCS Bonaventure (CVL 22)
	{{CCGS}}	Canadian Coast Guard ships	CCGS Simcoe (1909)
Colombia	{{ARC}}	Colombian Navy ships	ARC 7 de Agosto (D-06)
Denmark	{{HDMS}}	Royal Danish Navy ships	HDMS Lougen (1791)
Ecuador	{{BAE}}	Ecuadorian Navy ships	BAE Guayas (BE-21)
Egypt	{{ENS}}	Egyptian Navy ships	ENS Gamal Abdel Nasser (L1010)
Estonia	{{EML}}	Estonian Navy ships	EML Wambola (A433)
Fiji	{{RFNS}}	Republic of Fiji Naval Service ships	RFNS Kiro (203)
Finland	{{FNS}}	Finnish Navy ships	FNS Turunmaa (1918)
Greece	{{HS}}	Hellenic Navy ships	HS Georgios Averof (1910)
Germany	{{SMS}}	Imperial German Navy and Austro-Hungarian Navy ships	SMS Novara (1912)
	{{SMU}}	Imperial German Navy and Austro-Hungarian Navy U-boats	SM U-28 (Germany)
	{{GS}}	German World War II and later U-boats	German submarine U-39 (1938)
Iceland	{{ICGV}}	Icelandic Coast Guard ships	ICGV Óðinn
India	{{INS}}	Indian Navy ships	INS Vikrant (1961)
Indonesia	{{KRI}}	Indonesian Navy ships	KRI Fatahillah (361)
Ireland	{{LÉ}}	Irish Navy ships	LÉ Emer (P21)
Japan	{{Jsub}}	Imperial Japanese Navy submarines	Japanese submarine I-15
	{{JDS}}	Older Japan Maritime Self-Defense Force ships	JDS Wakaba (DE-261)
	{{JS}}	Newer Japan Maritime Self-Defense Force ships	JS Ashigara (DDG-178)
Netherlands	{{HNLMS}}	Royal Netherlands Navy ships	HNLMS De Ruyter (F804)
New Zealand	{{HMNZS}}	Royal New Zealand Navy ships	HMNZS Endeavour (A11)
Nigeria	{{NNS}}	Nigerian Navy ships	NNS Aradu (F89)
Norway	{{HNoMS}}	Royal Norwegian Navy ships	HNoMS Svenner (G03)
Papua New Guinea	{{HMPNGS}}	Papua New Guinean Navy ships	HMPNGS Rabaul (P01)
Peru	{{BAP}}	Peruvian Navy ships	BAP Montero (FM-53)
Philippines	{{RPS}}	Older Philippine Navy ships	RPS Rajah Soliman (D-66)
	{{BRP}}	Newer Philippine Navy ships	BRP Rajah Soliman (D-66)
Poland	{{ORP}}	Polish Navy ships	ORP Orzeł (1938)
Portugal	{{NRP}}	Portuguese Navy ships	NRP Sagres (1937)
Romania	{{NMS}}	Romanian Navy ships	NMS Smeul (1888)
Singapore	{{RSS}}	Republic of Singapore Navy ships	RSS Formidable (68)
South Africa	{{SAS}}	South African Navy ships after 31 May 1961	SAS Mendi (F148)
	{{HMSAS}}	Union of South Africa Navy (before 30 May 1961)	HMSAS Protea (K51)
South Korea	{{ROKS}}	Republic of Korea Navy ships	ROKS Dokdo (LPH-6111)
Sweden	{{HSwMS}}	Swedish Navy ships	HSwMS Sjölejonet (1936)
Thailand	{{HTMS}}	Royal Thai Navy ships	HTMS Chakri Naruebet (CV 911)
Turkey	{{TCG}}	Turkish Naval Forces ships	TCG Gediz (F 495)
United Kingdom	{{HMS}}	Royal Navy ships	HMS Illustrious (R06)
	{{HMT}}	Royal Navy trawlers	HMT Elk (1902)
	{{RFAux}}	Royal Fleet Auxiliary ships	RFA Fort Austin (A386)
United States	{{USAT}}	US Army transport ships	USAT Havana (1917)
	{{USCGC}}	US Coast Guard Cutter	USCGC Healy (WAGB-20)
	{{USNS}}	US Naval Ship	USNS Mercy (T-AH-19)
	{{USRC}}	US Revenue Cutter Service	USRC Harriet Lane (1857)
	{{USS}}	US Navy ship	USS Enterprise (CVN-65)
	{{USAV}}	US Army Vessel	USAV Spearhead (TSV-X1)
Category:Ship templates (11) Category:Ship prefix templates (52)

The above documentation is transcluded from Template:ROKS/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Please add categories to the /doc subpage. Subpages of this template.