Template:HMS/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 Royal Navy ship articles named in the format "HMS Gloucester (D96)". 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 [[HMS Gloucester (D96)|HMS ''Gloucester'']]. This template halves that to {{HMS|Gloucester|D96|6}}.

Basic usage

{{HMS|Ship Name}}
{{HMS|Ship Name|ID}}: the optional ID can be the hull number, pennant number or launch year as specified in the article title: [[HMA Ship Name (ID)]].
{{HMS|Ship Name|ID|6}}: the last code (e.g., "6") sets the formatting of the blue link label.
Examples
Template usage Equivalent wikicode Final result
{{HMS|Illustrious|R06}} [[HMS Illustrious (R06)|HMS ''Illustrious'' (R06)]] HMS Illustrious (R06)
{{HMS|Raisonnable|1768}} [[HMS Raisonnable (1768)|HMS ''Raisonnable'' (1768)]] HMS Raisonnable (1768)
{{HMS|Victory}} [[HMS Victory|HMS ''Victory'']] HMS Victory

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

Format options parameter

A third, unnamed parameter |3= allows setting which pieces of text are displayed in the wikilink. It sets the label in the link: [[targetpage|label]]

For example, the ship's article is entered as {{HMS|Illustrious|R06}}, by default showing as HMS Illustrious (R06).

But in your article, the hull number (disambiguator) may not be needed to show. In that case, add |4=2, and the result is:

{{HMS|Illustrious|R06|2}} [[HMS Illustrious (R06)|''Illustrious'']] HMS Illustrious (R06)

The options are:

Value Displayed Example Wikicode Showing
None prefix, name, ID {{HMS|Illustrious|R06}} [[HMS Illustrious (R06)|HMS ''Illustrious'' (R06)]] HMS Illustrious (R06)
1 ID {{HMS|Illustrious|R06|1}} [[HMS Illustrious (R06)|R06]] HMS Illustrious (R06)
2 name {{HMS|Illustrious|R06|2}} [[HMS Illustrious (R06)|''Illustrious'']] HMS Illustrious (R06)
3 name, ID {{HMS|Illustrious|R06|3}} [[HMS Illustrious (R06)|''Illustrious'' (R06)]] HMS Illustrious (R06)
4 same as default {{HMS|Illustrious|R06|4}} [[HMS Illustrious (R06)|HMS ''Illustrious'' (R06)]] HMS Illustrious (R06)
5 prefix, ID {{HMS|Illustrious|R06|5}} [[HMS Illustrious (R06)|HMS ''R06'']] HMS Illustrious (R06)
6 prefix, name {{HMS|Illustrious|R06|6}} [[HMS Illustrious (R06)|HMS ''Illustrious'']] HMS Illustrious (R06)

TemplataData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:HMS in articles based on its TemplateData.

TemplateData for HMS

<templatedata>{

 "description": "This is a typing short cut for linking to Royal Navy ship articles named in the format 'HMS Gloucester (D96)' (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 HMS Gloucester.  This template halves that to HMS Gloucester (D96).  Note that this template cannot be used for ships which are not part of the Royal Navy.",
 "params": {
   "1": {
     "label": "Ship Name",
     "description": "This parameter gives the name of this ship.",
     "type": "string",
     "default": "",
     "required": true,
     "example": "Gloucester"

},

    "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":"1774"
   },

"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 HMS and without the ship's name; if given as 2, it will give just the ship's name, in italics, without the HMS prefix nor the ID number; if given as 3, it will give the ship's name and its ID number, but not the HMS prefix; 4 is not a valid entry; if given as 5, it will give the HMS prefix and the ID number, but will drop the ship's name; if given as 6, it will give the prefix HMS and the ship's name but will drop the ID number.  If left blank, the ship will be displayed as HMS 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)