Template:ROKS/doc

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)]]	(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. See a monthly parameter usage report for Template:ROKS in articles based on its 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 class and prefix shortcut templates
type	group	template	ref article	example
Ship class
class	after member ship	{{sclass-}}	article hyphenated	Valiant-class harbor tug
class	after theme	{{sclass2-}}	article hyphenated	Flower-class corvette
Ship prefix
General prefixes (civil, propulsion, utility)
prefix	generic	{{ship}}	any prefix, no prefix	HMCS Kootenay (H75) Brigante Musolino Charles de Gaulle (R91)
prefix	civil	{{GTS}}	Gas turbine ship article	GTS Infinity (2001)
prefix	civil	{{HSC}}	High-speed craft article	HSC Tarifa Jet (1997)
prefix	civil	{{MS}} {{M/S}}	Motor ship article	MS Antenor (1957) M/S Antenor (1957)
prefix	civil	{{MV}} {{M/V}}	Motor vessel article	MV Aurora (2000) M/V Aurora (2000)
prefix	civil	{{MY}} {{M/Y}}	Motor yacht article	MY Jairo Mora Sandoval M/Y Jairo Mora Sandoval
prefix	civil	{{PS}}	Paddle steamer article	PS Commonwealth (1854)
prefix	civil	{{RV}} {{R/V}}	Research vessel article	RV Vityaz (1939) R/V Vityaz (1939)
prefix	civil	{{SB}}	Sailing barge article	SB Cambria
prefix	civil	{{SS}} {{S/S}}	Steamship article	SS City of Los Angeles (1922) S/S City of Los Angeles (1922)
prefix	civil	{{SV}} {{S/V}}	Sailing vessel article	SV Argo (1841) S/V Argo (1841)
prefix	civil	{{SY}} {{S/Y}}	Sailing vessel article	SY Raven (1889) S/Y Raven (1889)
prefix	civil	{{TSS}}	Twin-screw steamer article	TSS Princess Maud (1934)
Commonwealth ship prefixes
prefix	UK	{{HMS}}	Royal Navy ships	HMS Illustrious (R06)
prefix	UK	{{HMT}}	Royal Navy trawlers	HMT Elk (1902)
prefix	UK	{{RMS}}	Royal Mail Ships	RMS Adriatic (1907)
prefix	UK	{{RFAux}}	Royal Fleet Auxiliary ships	RFA Fort Austin (A386) (do not use {{RFA}})
prefix	Australia	{{HMAS}}	Royal Australian Navy ships	HMAS Bataan (I91)
prefix	Australia	{{HMQS}}	Queensland Maritime Defence Force ships	HMQS Gayundah
prefix	Australia	{{HMVS}}	Victorian Naval Forces ships	HMVS Victoria (1855)
prefix	Bahamas	{{HMBS}}	Royal Bahamas Defence Force ships	HMBS Nassau (P-61)
prefix	Bangladesh	{{BNS}}	Bangladesh Navy ships	BNS Surma (2013)
prefix	Canada	{{HMCS}}	Royal Canadian Navy ships	HMCS Bonaventure (CVL 22)
prefix	India	{{INS}}	Indian Navy ships	INS Vikrant (R11)
prefix	New Zealand	{{HMNZS}}	Royal New Zealand Navy ships	HMNZS Endeavour (A11)
prefix	South Africa	{{SAS}}	South African Navy ships	SAS Mendi (F148)
United States ship prefixes
prefix	US	{{USAT}}	United States Army Transport ships	USAT Havana (1917)
prefix	US	{{USCGC}}	United States Coast Guard Cutter	USCGC Healy (WAGB-20)
prefix	US	{{USNS}}	United States Naval Ship	USNS Mercy (T-AH-19)
prefix	US	{{USRC}}	United States Revenue Cutter Service	USRC Harriet Lane (1857)
prefix	US	{{USS}}	United States Navy ship	USS Enterprise (CVN-65)
prefix	US	{{USAV}}	United States Army Vessel	USAV Spearhead (TSV-X1)
Other navies' ship prefixes
prefix	Algeria	{{ANS}}	Algerian National Navy ships	ANS Kalaat Béni Abbès (474)
prefix	Denmark	{{HDMS}}	Royal Danish Navy ships	HDMS Lougen (1791)
prefix	Egypt	{{ENS}}	Egyptian Navy ships	ENS Gamal Abdel Nasser (L1010)
prefix	Finland	{{FNS}}	Finnish Navy ships	FNS Turunmaa (1918)
prefix	Greece	{{HS}}	Hellenic Navy ships	HS Georgios Averof (1910)
prefix	Germany	{{SMS}}	Imperial German Navy and Austro-Hungarian Navy ships	SMS Novara (1912)
prefix	Germany	{{SMU}}	Imperial German Navy and Austro-Hungarian Navy U-boats	SM U-28 (Germany)
prefix	Germany	{{GS}}	German World War II and later U-boats	German submarine U-39 (1938)
prefix	Indonesia	{{KRI}}	Indonesian Navy ships	KRI Fatahillah (361)
prefix	Ireland	{{LÉ}}	Irish Navy ships	LÉ Emer (P21)
prefix	Japan	{{Jsub}}	Imperial Japanese Navy submarines	Japanese submarine I-15
prefix	Japan	{{JDS}}	older Japan Maritime Self-Defense Force ships	JDS Wakaba (DE-261)
prefix	Japan	{{JS}}	newer Japan Maritime Self-Defense Force ships	JDS Ashigara (DDG-178)
prefix	Netherlands	{{HNLMS}}	Royal Netherlands Navy ships	HNLMS De Zeven Provinciën (C802)
prefix	Nigeria	{{NNS}}	Nigerian Navy ships	NNS Aradu (F89)
prefix	Norway	{{HNoMS}}	Royal Norwegian Navy ships	HNoMS Svenner (G03)
prefix	Peru	{{BAP}}	Peruvian Navy ships	BAP Montero (FM-53)
prefix	Philippines	{{RPS}}	older Philippine Navy ships	RPS Rajah Soliman (D-66)
prefix	Philippines	{{BRP}}	newer Philippine Navy ships	BRP Rajah Soliman (D-66)
prefix	Poland	{{ORP}}	Polish Navy ships	ORP Orzeł (1938)
prefix	South Korea	{{ROKS}}	Republic of Korea Navy ships	ROKS Dokdo (LPH-6111)
prefix	Singapore	{{RSS}}	Republic of Singapore Navy ships	RSS Formidable (68)
prefix	Sweden	{{HSwMS}}	Swedish Navy ships	HSwMS Sjölejonet (1936)
prefix	Thailand	{{HTMS}}	Royal Thai Navy ships	HTMS Chakri Naruebet (CV 911)
prefix	Turkey	{{TCG}}	Turkish Naval Forces ships	TCG Gediz (F 495)
Category:Ship templates (17) Category:Ship prefix templates (64)