Template:Sclass/doc

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

Ship class articles have titles that are hyphenated. A typical ship-class article name has the form:

<class name>-class <ship type>

When a ship class is named for a member of the class, the class name is italicized. For these classes use {{sclass}}. Classes not named for a member of the class are not italicized, in which case use {{sclass2}}.

Usage

sclass is an editor's shortcut for creating properly formatted links to ship-class articles with hyphenated titles: class name-class ship type.

The basic form:

{{sclass | class name | ship type}}

replaces:

[[class name-class ship type | class name-class]] [[ship type]]

This form assumes that ship type is its own separate article so produces a link to the class article, followed by a link to the ship type article. The text in the first link is properly formatted with the class name displayed in italics followed by "-class". Note that if referring to the ship class as a noun, the hyphen may be removed with the formatting options below, even though is part of the article title.

Optional unnamed format control parameter

An optional third parameter allows you to control the format and use the template if ship type is not an article:

{{sclass|class name|ship type|format}}

The values and results for format are:

0: suppresses ship type display entirely. Adjectival form.
1: displays ship type as part of a single link to the class article.
2: displays unlinked ship type.
3: displays ship type as a separate link. Ship type must be the name of an article.
4: suppresses ship type display entirely. Noun form.
5: class name only, suitable for tables

To avoid the dreaded red link, one of the first three options must be used if Ship type is not already an article. Note that option 3 is the default, so may be omitted. Other values of format will let you know the error of your ways.

Optional parameter: "ship-type disambiguation"

An optional fourth parameter allows you to disambiguate the ship type if it would ordinarily link to a disambiguation page :

{{sclass | class name | ship type  | format | disambiguation }}

This would only be needed with either the default or with the "format" parameter set to 3. Note: to use the disambiguation parameter, you must specify a "format" parameter, or use "||" (double pipe) between the "ship type" and "disambiguation" parameters.

Optional parameter: "class-name disambiguation"

When there are separate ship classes that share the same name and that use parenthetical disambiguation, for example Königsberg-class cruiser, use the optional fifth parameter to disambiguate the class-name:

{{sclass|Königsberg|cruiser|||1905}} produces Königsberg-class cruiser which is the same as:
[[Königsberg-class cruiser (1905)|''Königsberg''-class]] [[cruiser]]

The class-name disambiguator is never displayed.

Template data

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

TemplateData for Sclass

<templatedata> { "params": { "1": { "label": "class name", "type": "string" }, "2": { "label": "ship type" }, "3": { "label": "format", "description": "Format options 1, 2, 3, 4, 5", "type": "number" }, "4": { "label": "ship type disambiguation",

           "description": "disambiguation for ship type",
           "type": "string"

}, "5": { "label": "class name disambiguation", "description": "disambiguation for class name",

           "type": "string"

} }, "description": "Formats ship class name and ship type into article link. Italicises class name." } </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)