Template:SMS/doc

From the AARoads Wiki: Read about the road before you go
Jump to navigation Jump to search

Usage

This is a typing short cut for linking to Imperial German Navy or Austro-Hungarian Navy ship articles named in the format "SMS Germania (1899)". Since Ship names are italicized in article text, linking to them in the usual manner means typing everything twice, such as [[w:SMS Germania (1899)|SMS ''Germania'' (1899)]]. This template halves that to {{SMS|Germania|1899}}.

Formal Usage

  • {{SMS|Ship Name}}
  • {{SMS|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
{{SMS|Novara|1912}} [[w:SMS Novara (1912)|SMS ''Novara'' (1912)]] SMS Novara (1912)
{{SMS|Sankt Georg}} [[w:SMS Sankt Georg|SMS ''Sankt Georg'']] SMS Sankt Georg

Last example could be used to link to a 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 SMS, 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 {{SMS|Novara|1912}} [[w:SMS Novara (1912) |SMS ''Novara'' (1912)]] SMS Novara (1912)
1 3rd {{SMS|Novara|1912|1}} [[w:SMS Novara (1912) |1912]] SMS Novara (1912)
2 2nd {{SMS|Novara|1912|2}} [[w:SMS Novara (1912) |''Novara'']] SMS Novara (1912)
3 2nd, 3rd {{SMS|Novara|1912|3}} [[w:SMS Novara (1912) |''Novara'' (1912)]] SMS Novara (1912)
4 invalid result {{SMS|Novara|1912|4}} [[w:SMS Novara (1912) |Invalid Optional Parameter]] SMS Novara (1912)
5 1st, 3rd {{SMS|Novara|1912|5}} [[w:SMS Novara (1912) |SMS (1912)]] SMS Novara (1912)
6 1st, 2nd {{SMS|Novara|1912|6}} [[w:SMS Novara (1912) |SMS ''Novara'']] SMS Novara (1912)
2nd
(no 3rd)
{{SMS|Sankt Georg|3=2}}
Alternate usage: {{SMS|Sankt Georg||2}}
[[w:SMS Sankt Georg |''Sankt Georg'']] SMS Sankt Georg

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

 {{SMS|Novara|1912|6}} yields the same results as {{warship|SMS|Novara|1912}}

Optional submarine prefix parameter

Submarines or U-boats in the German Imperial Navy and the Austro-Hungarian Navy were prefixed with SM rather than SMS. Using an optional sub parameter allows the proper link generation for U-boat articles. The sub parameter also works in conjunction with the optional display parameters listed above.

Template usage Equivalent wikicode Final result
{{SMS|U-90|sub=y}} [[w:SM U-90|SM ''U-90'']] SMS U-90
{{SMS|U-4|Austria-Hungary|sub=y}} [[w:SM U-4 (Austria-Hungary)|SM ''U-4'' (Austria-Hungary)]] SMS U-4 (Austria-Hungary)
{{SMS|U-4|Austria-Hungary|6|sub=y}} [[w:SM U-4 (Austria-Hungary)|SM ''U-4'']] SMS U-4 (Austria-Hungary)

TemplataData section

<templatedata> {

 "description": "This is a typing short cut for linking to Imperial German Navy or Austro-Hungarian Navy (SMS) ship articles named in the format 'SMS Germania (1899)' (that is, the initial letters HMS, the ship's name, and its pennant number). Since ship names are italicized in article text and editors often don't want to include the pennant number, linking to them in the usual manner means typing everything twice, such as SMS Germania.  This template halves that to SMS Germania (1899).  Note that this template cannot be used for ships which were not part of the SMS.",
 "params": {
   "1": {
     "label": "Ship Name",
     "description": "This parameter gives the name of this ship.",
     "type": "string",
     "default": "",
     "required": true,
     "example": "Germania"

},

    "2": {
      "label": "ID",
      "description": "This parameter gives the ship's hull number, pennant number, year of construction, or any other identifying information that will allow the ship to be distinguished from other ships of the same name.",
      "required": false,
      "default": "",
      "type": "string",
      "example":"1899"
   },
   "3": {
      "label": "3",
      "description": "This is an optional parameter which sets out in bits the way the editor would like to display the name of the ship within an article.  If it is set to 1, the ship will be displayed only by its ID number (that is, but the entry given in parameter 2) without the prefix SMS and without the ship's name; if given as 2, it will give just the ship's name, in italics, without the SMS prefix nor the ID number; if given as 3, it will give the ship's name and its ID number, but not the SMS prefix; 4 is not a valid entry; if given as 5, it will give the SMS prefix and the ID number, but will drop the ship's name; if given as 6, it will give the prefix SMS and the ship's name but will drop the ID number.  If left blank, the ship will be displayed as SMS plus the ship's name plus its ID number.",
      "required": false,
      "suggested": false,
      "autovalue": "",
      "default": "",
      "example": "5",
      "type": "number"
   }
 }

} </templatedata>

See also

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}} Motor ships MS Antenor (1957)
civil {{MV}} Motor vessels MV Aurora (2000)
civil {{MY}} Motor yachts MY Monte Carlo
civil {{PS}} Paddle steamers PS Commonwealth (1854)
civil {{RMS}} Royal Mail Ships RMS Adriatic (1907)
civil {{RV}} Research vessels RV Vityaz (1939)
civil {{SB}} Sailing barges SB Cambria
civil {{SS}} Steamships SS Aeolus (1899)
civil {{SV}} Sailing vessels SV Argo (1841)
civil {{SY}} 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)
 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 GS U-39 (1938)
{{SMS}} Imperial German Navy and Austro-Hungarian Navy ships SMS Novara (1912)
{{SMU}} Imperial German Navy and Austro-Hungarian Navy submarines SMU 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 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)