Jump to content

Template:Ship/doc

From Wikipedia, the free encyclopedia

Usage

[edit]

Template {{Ship}} creates a wikilink to its article and formats the visible name correctly. That is, it handles both parts of [[targetpage|label]]. Now it is up to the editor (you) to get this right: a bluelink to the article, and well-formatted ship's full name.

The ship's article may be titled: [[HMCS Kootenay (H75)]]HMCS Kootenay (H75). The three parts are called: prefix, name, ID (ID is WP:Disambiguation, or hull number, pennant number, launch year: to identify the ship when multiple ships have the same name).

Apart from the article title, in the visible label the name could be formatted. Like: [[HMCS Kootenay (H75)|HMCS ''Kootenay'']]HMCS Kootenay (note the italics, and the omission of the hull number – linked to the same article).

Basic usage

[edit]
{{ship|1-prefix|2-name|3-ID}} → [[1-prefix 2-name (3-ID)|1-prefix ''2-name'' (3-ID)]]1-prefix 2-name (3-ID)
1 prefix
like HMS, USS. Leave the parameter blank if the ship's title has no prefix.
2 name
ship's name
3 ID
Specifier like hull number, pennant number, or launch year. Also serves as the WP:Disambiguation term in article titles.

All parameters are optional. You only need to enter the parts that build the article title.

Examples
Template usage Resulting wikicode Link showing
{{ship|ARA|General Belgrano}} [[ARA General Belgrano|ARA ''General Belgrano'']] ARA General Belgrano
{{ship|HMCS|Kootenay|H75}} [[HMCS Kootenay (H75)|HMCS ''Kootenay'' (H75)]] HMCS Kootenay (H75)

Format options parameter

[edit]

A fourth, unnamed parameter |4= 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 {{ship|HMCS|Kootenay|H75}}, by default showing as HMCS Kootenay (H75).

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

{{ship|HMCS|Kootenay|H75|2}} [[HMCS Kootenay (H75)|''Kootenay'']] Kootenay

The options are:

Value Parameter(s)
displayed
Example Equivalent wikicode Final result
None prefix, name, ID {{ship|HMCS|Kootenay|H75}} [[HMCS Kootenay (H75)|HMCS ''Kootenay'' (H75)]] HMCS Kootenay (H75)
1 ID {{ship|HMCS|Kootenay|H75|1}} [[HMCS Kootenay (H75)|H75]] H75
2 name {{ship|HMCS|Kootenay|H75|2}} [[HMCS Kootenay (H75)|''Kootenay'']] Kootenay
3 name, ID {{ship|HMCS|Kootenay|H75|3}} [[HMCS Kootenay (H75)|''Kootenay'' (H75)]] Kootenay (H75)
4 invalid {{ship|HMCS|Kootenay|H75|4}} Error: {{Ship}} invalid control parameter: 4 (help)
5 prefix, ID {{ship|HMCS|Kootenay|H75|5}} [[HMCS Kootenay (H75)|HMCS ''H75'']] HMCS H75
6 prefix, name {{ship|HMCS|Kootenay|H75|6}} [[HMCS Kootenay (H75)|HMCS ''Kootenay'']] HMCS Kootenay
[edit]

By setting |wl=no, the same formatting is made but the ship's name is not linked:

HMCS Kootenay (H75) (regular, {{ship|HMCS|Kootenay|H75}})
HMCS Kootenay (H75) (no wikilink, setting {{ship|HMCS|Kootenay|H75|wl=no}})

Prefix in/out option

[edit]

Parameter |up=yes (for unlinked prefix) can be used to have an unlinked prefix:. When set to "yes", the template will display the prefix before (outside of) the wikilink.

Examples
  • {{ship|Japanese battleship|Yamato|up=yes}} → Japanese battleship Yamato

Using a format option:

  • {{ship|Japanese battleship|Yamato||2|up=yes}}Yamato

TemplateData

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

TemplateData for Ship

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

Template parameters

ParameterDescriptionTypeStatus
Prefix1

Fleet identifier

Example
HMS, Japanese battleship
Stringoptional
Name2

Ship's name

Example
Bismarck, Belgrano
Stringoptional
ID3

Hull number, launch year, or pennant number

Example
H75, 1975,
Stringoptional
Format4

Formats label (parts showing)

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

yes=puts Fleet ID outside of Wikilink

Default
no
Example
up=yes
Booleanoptional

Tracking categories

[edit]

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)