Template:Ship/doc
| This is a documentation subpage for Template:Ship. It contains usage information, categories and other content that is not part of the original template page. |
Contents
Usage
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
- {{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
- 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
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}}→ Kootenay[[HMCS Kootenay (H75)|''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 | same as default | {{ship|HMCS|Kootenay|H75|4}} | [[HMCS Kootenay (H75)|HMCS ''Kootenay'' (H75)]] | HMCS Kootenay (H75) | |
| 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 | |
Same format, no wikilink
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|4}}) - HMCS Kootenay (H75) (no wikilink, setting
{{ship|HMCS|Kootenay|H75|4|wl=no}})
Prefix in/out option
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}}→ Japanese battleship Yamato
TemplateData
TemplateData for Ship
This template provides a wikilink to a ship's page, with label options
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Prefix | 1 | Fleet identifier
| String | optional |
| Name | 2 | Ship's name
| String | optional |
| ID | 3 | Hull number, launch year, or pennant number
| String | optional |
| Format | 4 | Formats label (parts showing)
| Number | optional |
| unlink prefix | up | yes=puts Fleet ID outside of Wikilink
| Boolean | optional |
Tracking categories
- Category:WPSHIPS: Template Ship parameter errors (0)
- Category:Pages using Ship with unknown parameters (0)
See also
| Ship classes | |||
|---|---|---|---|
| Group | Template | Ref article | Example |
| after member ship | Script error: No such module "Template link general". | article hyphenated | Valiant-class harbor tug |
| after theme | Script error: No such module "Template link general". | article hyphenated | Flower-class corvette |
| General ship prefixes | |||
| Group | Template | Ref article | Example |
| generic | Script error: No such module "Template link general". | any prefix | Brigante Musolino or Charles de Gaulle (R91) |
| civil | Script error: No such module "Template link general". | Gas turbine ships | GTS Infinity (2001) |
| civil | Script error: No such module "Template link general". | High-speed crafts | HSC Tarifa Jet (1997) |
| civil | Script error: No such module "Template link general". or Script error: No such module "Template link general". | Motor ships | MS Antenor (1957) or M/S Antenor (1957) |
| civil | Script error: No such module "Template link general". or Script error: No such module "Template link general". | Motor vessels | MV Aurora (2000) or M/V Aurora (2000) |
| civil | Script error: No such module "Template link general". or Script error: No such module "Template link general". | Motor yachts | MY Monte Carlo or M/Y Monte Carlo |
| civil | Script error: No such module "Template link general". | Paddle steamers | PS Commonwealth (1854) |
| civil | Script error: No such module "Template link general". | Royal Mail Ships | RMS Adriatic (1907) |
| civil | Script error: No such module "Template link general". or Script error: No such module "Template link general". | Research vessels | RV Vityaz (1939) or R/V Vityaz (1939) |
| civil | Script error: No such module "Template link general". | Sailing barges | SB Cambria |
| civil | Script error: No such module "Template link general". or Script error: No such module "Template link general". | Steamships | SS Aeolus (1899) or S/S Aeolus (1899) |
| civil | Script error: No such module "Template link general". or Script error: No such module "Template link general". | Sailing vessels | SV Argo (1841) or S/V Argo (1841) |
| civil | Script error: No such module "Template link general". or Script error: No such module "Template link general". | Sailing vessels | SY Raven (1889) or S/Y Raven (1889) |
| civil | Script error: No such module "Template link general". | Twin-screw steamers | TSS Princess Maud (1934) |
| International navy ship prefixes | |||
| Group | Template | Ref article | Example |
| Script error: No such module "Template link general". | Algerian National Navy ships | ANS Kalaat Béni Abbès (474) | |
| Script error: No such module "Template link general". | Royal Australian Navy ships | HMAS Anzac (G90) | |
| Script error: No such module "Template link general". | Royal Bahamas Defence Force ships | HMBS Nassau (P-61) | |
| Script error: No such module "Template link general". | Bangladesh Navy ships | BNS Surma (2013) | |
| Script error: No such module "Template link general". | Royal Canadian Navy ships | HMCS Bonaventure (CVL 22) | |
| Script error: No such module "Template link general". | Canadian Coast Guard ships | CCGS Simcoe (1909) | |
| Script error: No such module "Template link general". | Colombian Navy ships | ARC 7 de Agosto (D-06) | |
| Script error: No such module "Template link general". | Royal Danish Navy ships | HDMS Lougen (1791) | |
| Script error: No such module "Template link general". | Ecuadorian Navy ships | BAE Guayas (BE-21) | |
| Script error: No such module "Template link general". | Egyptian Navy ships | ENS Gamal Abdel Nasser (L1010) | |
| Script error: No such module "Template link general". | Estonian Navy ships | EML Wambola (A433) | |
| Script error: No such module "Template link general". | Republic of Fiji Naval Service ships | RFNS Kiro (203) | |
| Script error: No such module "Template link general". | Finnish Navy ships | FNS Turunmaa (1918) | |
| Script error: No such module "Template link general". | Hellenic Navy ships | HS Georgios Averof (1910) | |
| Script error: No such module "Template link general". | Imperial German Navy and Austro-Hungarian Navy ships | SMS Novara (1912) | |
| Script error: No such module "Template link general". | Imperial German Navy and Austro-Hungarian Navy U-boats | SM U-28 (Germany) | |
| Script error: No such module "Template link general". | German World War II and later U-boats | German submarine U-39 (1938) | |
| Script error: No such module "Template link general". | Icelandic Coast Guard ships | ICGV Óðinn | |
| Script error: No such module "Template link general". | Indian Navy ships | INS Vikrant (R11) | |
| Script error: No such module "Template link general". | Indonesian Navy ships | KRI Fatahillah (361) | |
| Script error: No such module "Template link general". | Irish Navy ships | LÉ Emer (P21) | |
| Script error: No such module "Template link general". | Imperial Japanese Navy submarines | Japanese submarine I-15 | |
| Script error: No such module "Template link general". | Older Japan Maritime Self-Defense Force ships | JDS Wakaba (DE-261) | |
| Script error: No such module "Template link general". | Newer Japan Maritime Self-Defense Force ships | JDS Ashigara (DDG-178) | |
| Script error: No such module "Template link general". | Royal Netherlands Navy ships | HNLMS De Ruyter (F804) | |
| Script error: No such module "Template link general". | Royal New Zealand Navy ships | HMNZS Endeavour (A11) | |
| Script error: No such module "Template link general". | Nigerian Navy ships | NNS Aradu (F89) | |
| Script error: No such module "Template link general". | Royal Norwegian Navy ships | HNoMS Svenner (G03) | |
| Script error: No such module "Template link general". | Papua New Guinean Navy ships | HMPNGS Rabaul (P01) | |
| Script error: No such module "Template link general". | Peruvian Navy ships | BAP Montero (FM-53) | |
| Script error: No such module "Template link general". | Older Philippine Navy ships | RPS Rajah Soliman (D-66) | |
| Script error: No such module "Template link general". | Newer Philippine Navy ships | BRP Rajah Soliman (D-66) | |
| Script error: No such module "Template link general". | Polish Navy ships | ORP Orzeł (1938) | |
| Script error: No such module "Template link general". | Portuguese Navy ships | NRP Sagres (1937) | |
| Script error: No such module "Template link general". | Romanian Navy ships | NMS Smeul (1888) | |
| Script error: No such module "Template link general". | Republic of Singapore Navy ships | RSS Formidable (68) | |
| Script error: No such module "Template link general". | South African Navy ships after 31 May 1961 | SAS Mendi (F148) | |
| Script error: No such module "Template link general". | Union of South Africa Navy (before 30 May 1961) | HMSAS Protea (K51) | |
| Script error: No such module "Template link general". | Republic of Korea Navy ships | ROKS Dokdo (LPH-6111) | |
| Script error: No such module "Template link general". | Swedish Navy ships | HSwMS Sjölejonet (1936) | |
| Script error: No such module "Template link general". | Royal Thai Navy ships | HTMS Chakri Naruebet (CV 911) | |
| Script error: No such module "Template link general". | Turkish Naval Forces ships | TCG Gediz (F 495) | |
| Script error: No such module "Template link general". | Royal Navy ships | HMS Illustrious (R06) | |
| Script error: No such module "Template link general". | Royal Navy trawlers | HMT Elk (1902) | |
| Script error: No such module "Template link general". | Royal Fleet Auxiliary ships | RFA Fort Austin (A386) | |
| Script error: No such module "Template link general". | US Army transport ships | USAT Havana (1917) | |
| Script error: No such module "Template link general". | US Coast Guard Cutter | USCGC Healy (WAGB-20) | |
| Script error: No such module "Template link general". | US Naval Ship | USNS Mercy (T-AH-19) | |
| Script error: No such module "Template link general". | US Revenue Cutter Service | USRC Harriet Lane (1857) | |
| Script error: No such module "Template link general". | US Navy ship | USS Enterprise (CVN-65) | |
| Script error: No such module "Template link general". | US Army Vessel | USAV Spearhead (TSV-X1) | |