Jump to content

Template:USAT/doc

From Wikipedia, the free encyclopedia

Usage

[edit]

This is a typing short cut for linking to steamship articles named in the format "USAT Shipname (Year)". Since ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[USAT Shipname (Year)|USAT ''Shipname'' (Year)]]. This template halves that to {{USAT|Shipname|Year}}. The U.S. Army Transport prefix was not applied to the majority of Army vessels and should be applied only to those vessels, large troop or cargo vessels, owned, long term bareboat chartered and some other vessels. Tugs, specialized craft and the coastal transports (FS and such) were simply U.S. Army (#/name).

Formal Usage

[edit]
  • {{USAT|Ship Name}}
  • {{USAT|Ship Name|ID}}, where ID can be the hull number, launch year, or pennant number, as specified in the article title.

Examples

[edit]
Template usage Equivalent wikicode Final result
{{USAT|Havana|1917}} [[USAT Havana (1917)|USAT ''Havana'' (1917)]] USAT Havana (1917)
{{USAT|Meigs}} [[USAT Meigs|USAT ''Meigs'']] USAT Meigs

Last example could be used to link to ship index (disambiguation) page

Optional display control parameter

[edit]

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 USAT, 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 {{USAT|Havana|1917}} [[USAT Havana (1917) |USAT ''Havana'' (1917)]] USAT Havana (1917)
1 3rd {{USAT|Havana|1917|1}} [[USAT Havana (1917) |1917]] 1917
2 2nd {{USAT|Havana|1917|2}} [[USAT Havana (1917) |''Havana'']] Havana
3 2nd, 3rd {{USAT|Havana|1917|3}} [[USAT Havana (1917) |''Havana'' (1917)]] Havana (1917)
4 invalid result {{USAT|Havana|1917|4}} Error: {{USAT}} invalid control parameter: 4 (help)
5 1st, 3rd {{USAT|Havana|1917|5}} [[USAT Havana (1917) |USAT (1917)]] USAT 1917
6 1st, 2nd {{USAT|Havana|1917|6}} [[USAT Havana (1917) |USAT ''Havana'']] USAT Havana
2nd
(no 3rd)
{{USAT|Meigs|3=2}}
Alternate usage: {{USAT|Meigs||2}}
[[USAT Meigs|''Meigs'']] Meigs

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

TemplateData

[edit]
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:USAT in articles based on its TemplateData.

TemplateData for USAT

This template provides a wikilink to a ship's page, with label options

Template parameters

ParameterDescriptionTypeStatus
Name1

Ship's name

Example
Bismarck, Belgrano
Stringoptional
ID2

Hull number, launch year, or pennant number

Example
H75, 1975
Stringoptional
Format3

Formats the label (which name parts will show)

Default
blank
Example
1, 2, 3, 5, 6
Numberoptional
unlink prefixup

up=yes puts prefix before (outside of) the wikilink

Default
no
Example
up=yes
Booleanoptional

See also

[edit]
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 MY Monte Carlo
civil {{PS}} Paddle steamers PS Commonwealth (1854)
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
 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)
 Brunei {{KDB}} Royal Brunei Navy ships KDB Darussalam (06)
 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 {{GS}} German Navy and Kriegsmarine submarines German submarine U-39 (1938)
{{SMS}} Imperial German Navy and Austro-Hungarian Navy ships SMS Novara (1912)
{{SMU}} Imperial German Navy and Austro-Hungarian Navy submarines SM U-28 (Germany)
 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 {{}} Irish Navy ships LÉ Emer (P21)
 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 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 {{BRP}} Philippine Navy ships BRP Rajah Soliman (D-66)
{{RPS}} Philippine Navy ships (older) RPS 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 SAS Mendi (F148)
{{HMSAS}} Union of South Africa Navy 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-Marine and US Revenue Cutter Service USRC Harriet Lane (1857)
{{USS}} US Navy ship USS Enterprise (CVN-65)
{{USAV}} US Army Vessel USAV Spearhead (TSV-X1)