This is a documentation subpage for Template:Infobox ship begin. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 41,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.
Preview message: Transclusion count updated automatically (see documentation). |
This template should italicize the article title automatically. If this is not required, add |display title=none to the list of parameters. |
This template uses Lua: |
|display title=none
is specified. For details see: the infobox usage guide § Title styling.This ship infobox supports a very large number of fields, including some specialty fields that will rarely be used. Some fields simply don't make sense in some cases. Some different sets of code have been prepared using only the most common fields. Select the most appropriate set below and copy and paste the entire code to the top of a ship article, then fill in as many fields as possible. Empty fields should generally be kept so that a future editor can fill them in unless they make no sense for the ship in question.
The "Full" code contains every field the template supports. If you want, you can copy one of the simplified sets of code and add a few fields from the "Full" code.
If you have ideas for improvements or would like to add brand new fields to these templates, please post on Template talk:Infobox ship begin to discuss the changes and how they should be implemented.
For infoboxes of individual ships, please copy the appropriate example for the type of ship:
Warships (except submarines). Select show to expand.
|
---|
{|{{Infobox ship begin <!-- warships except submarines -->
|infobox caption= <!-- keywords: yes, nodab; or caption text -->
|display title= <!-- keywords: none, ital; or article title with markup -->
}}
{{Infobox ship image
|Ship image=
|Ship image size=
|Ship caption=
|image alt=
}}
{{Infobox ship career
|Hide header=
|Ship country=
|Ship flag=
|Ship name=
|Ship owner=
|Ship namesake=
|Ship ordered=
|Ship builder=
|Ship laid down=
|Ship launched=
|Ship acquired=
|Ship commissioned=
|Ship decommissioned=
|Ship in service=
|Ship out of service=
|Ship stricken=
|Ship reinstated=
|Ship honours=
|Ship honors=
|Ship fate=
|Ship status=
|Ship notes=
}}
{{Infobox ship characteristics
|Hide header=
|Header caption=
|Ship class=
|Ship displacement=
|Ship length=
|Ship beam=
|Ship draught=
|Ship draft=
|Ship propulsion=
|Ship speed=
|Ship range=
|Ship complement=
|Ship sensors=
|Ship EW=
|Ship armament=
|Ship armour=
|Ship armor=
|Ship aircraft=
|Ship aircraft facilities=
|Ship notes=
}}
|}
|
Submarines. Select show to expand.
|
---|
{|{{Infobox ship begin <!-- submarines -->
|infobox caption= <!-- keywords: yes, nodab; or caption text -->
|display title= <!-- keywords: none, ital; or article title with markup -->
}}
{{Infobox ship image
|Ship image=
|Ship image size=
|Ship caption=
|image alt=
}}
{{Infobox ship career
|Hide header=
|Ship country=
|Ship flag=
|Ship name=
|Ship namesake=
|Ship ordered=
|Ship builder=
|Ship laid down=
|Ship launched=
|Ship acquired=
|Ship commissioned=
|Ship decommissioned=
|Ship in service=
|Ship out of service=
|Ship stricken=
|Ship reinstated=
|Ship fate=
|Ship status=
}}
{{Infobox ship characteristics
|Hide header=
|Header caption=
|Ship class=
|Ship displacement=
|Ship length=
|Ship beam=
|Ship draught=
|Ship draft=
|Ship propulsion=
|Ship speed=
|Ship range=
|Ship endurance=
|Ship test depth=
|Ship complement=
|Ship sensors=
|Ship EW=
|Ship armament=
|Ship notes=
}}
|}
|
Age of sail. Select show to expand.
|
---|
{|{{Infobox ship begin <!-- age of sail -->
|infobox caption= <!-- keywords: yes, nodab; or caption text -->
|display title= <!-- keywords: none, ital; or article title with markup -->
}}
{{Infobox ship image
|Ship image=
|Ship image size=
|Ship caption=
|image alt=
}}
{{Infobox ship career
|Hide header=
|Ship country=
|Ship flag=
|Ship name=
|Ship owner=
|Ship ordered=
|Ship builder=
|Ship original cost=
|Ship laid down=
|Ship launched=
|Ship acquired=
|Ship commissioned=
|Ship decommissioned=
|Ship in service=
|Ship out of service=
|Ship renamed=
|Ship stricken=
|Ship reinstated=
|Ship honours=
|Ship honors=
|Ship captured=
|Ship fate=
|Ship status=
|Ship notes=
}}
{{Infobox ship characteristics
|Hide header=
|Header caption=
|Ship class=
|Ship tons burthen=
|Ship length=
|Ship beam=
|Ship draught=
|Ship draft=
|Ship hold depth=
|Ship propulsion=
|Ship sail plan=
|Ship complement=
|Ship armament=
|Ship notes=
}}
|}
|
Commercial vessels. Select show to expand.
|
---|
{|{{Infobox ship begin <!-- commercial vessels -->
|infobox caption= <!-- keywords: yes, nodab; or caption text -->
|display title= <!-- keywords: none, ital; or article title with markup -->
}}
{{Infobox ship image
|Ship image=
|Ship image size=
|Ship caption=
|image alt=
}}
{{Infobox ship career
|Hide header=
|Ship name=
|Ship owner=
|Ship operator=
|Ship registry=
|Ship route=
|Ship ordered=
|Ship builder=
|Ship original cost=
|Ship yard number=
|Ship way number=
|Ship laid down=
|Ship launched=
|Ship completed=
|Ship christened=
|Ship acquired=
|Ship maiden voyage=
|Ship in service=
|Ship out of service=
|Ship identification=
|Ship fate=
|Ship status=
|Ship notes=
}}
{{Infobox ship characteristics
|Hide header=
|Header caption=
|Ship class=
|Ship type=
|Ship tonnage=
|Ship displacement=
|Ship length=
|Ship beam=
|Ship height=
|Ship draught=
|Ship draft=
|Ship depth=
|Ship decks=
|Ship deck clearance=
|Ship ramps=
|Ship ice class=
|Ship sail plan=
|Ship power=
|Ship propulsion=
|Ship speed=
|Ship capacity=
|Ship crew=
|Ship notes=
}}
|}
|
If none of the above fit, you may use this full setup:
Full code for individual ships. Select show to expand.
|
---|
{|{{Infobox ship begin <!-- full code -->
|infobox caption= <!-- keywords: yes, nodab; or caption text -->
|display title= <!-- keywords: none, ital; or article title with markup -->
}}
{{Infobox ship image
|Ship image=
|Ship image size=
|Ship caption=
|image alt=
}}
{{Infobox ship career
|Hide header=
|Ship country=
|Ship flag=
|Ship name=
|Ship namesake=
|Ship owner=
|Ship operator=
|Ship registry=
|Ship route=
|Ship ordered=
|Ship awarded=
|Ship builder=
|Ship original cost=
|Ship yard number=
|Ship way number=
|Ship laid down=
|Ship launched=
|Ship sponsor=
|Ship christened=
|Ship completed=
|Ship acquired=
|Ship commissioned=
|Ship recommissioned=
|Ship decommissioned=
|Ship maiden voyage=
|Ship in service=
|Ship out of service=
|Ship renamed=
|Ship reclassified=
|Ship refit=
|Ship stricken=
|Ship reinstated=
|Ship homeport=
|Ship identification=
|Ship motto=
|Ship nickname=
|Ship honours=
|Ship honors=
|Ship captured=
|Ship fate=
|Ship status=
|Ship notes=
|Ship badge=
}}
{{Infobox ship characteristics
|Hide header=
|Header caption=
|Ship class=
|Ship type=
|Ship tonnage=
|Ship displacement=
|Ship tons burthen=
|Ship length=
|Ship beam=
|Ship height=
|Ship draught=
|Ship draft=
|Ship depth=
|Ship hold depth=
|Ship decks=
|Ship deck clearance=
|Ship ramps=
|Ship ice class=
|Ship power=
|Ship propulsion=
|Ship sail plan=
|Ship speed=
|Ship range=
|Ship endurance=
|Ship test depth=
|Ship boats=
|Ship capacity=
|Ship troops=
|Ship complement=
|Ship crew=
|Ship time to activate=
|Ship sensors=
|Ship EW=
|Ship armament=
|Ship armour=
|Ship armor=
|Ship aircraft=
|Ship aircraft facilities=
|Ship notes=
}}
|}
|
For infoboxes of ship classes, please copy the appropriate example for the type of ship class:
Warship classes (except submarines). Select show to expand.
|
---|
{|{{Infobox ship begin <!-- warship classes -->
|infobox caption= <!-- keywords: yes, nodab; or caption text -->
|display title= <!-- keywords: none, ital; or article title with markup -->
|sclass= <!-- keyword: 2 -->
}}
{{Infobox ship image
|Ship image=
|Ship image size=
|Ship caption=
|image alt=
}}
{{Infobox ship class overview
|Builders=
|Operators=
|Class before=
|Class after=
|Subclasses=
|Built range=
|In commission range=
|Total ships planned=
|Total ships on order=
|Total ships building=
|Total ships completed=
|Total ships cancelled=
|Total ships active=
|Total ships laid up=
|Total ships lost=
|Total ships retired=
|Total ships scrapped=
|Total ships preserved=
}}
{{Infobox ship characteristics
|Hide header=
|Header caption=
|Ship type=
|Ship displacement=
|Ship length=
|Ship beam=
|Ship draught=
|Ship draft=
|Ship propulsion=
|Ship speed=
|Ship range=
|Ship complement=
|Ship sensors=
|Ship EW=
|Ship armament=
|Ship armour=
|Ship armor=
|Ship aircraft=
|Ship aircraft facilities=
|Ship notes=
}}
|}
|
Submarine classes. Select show to expand.
|
---|
{|{{Infobox ship begin <!-- submarine classes -->
|infobox caption= <!-- keywords: yes, nodab; or caption text -->
|display title= <!-- keywords: none, ital; or article title with markup -->
|sclass= <!-- keyword: 2 -->
}}
{{Infobox ship image
|Ship image=
|Ship image size=
|Ship caption=
|image alt=
}}
{{Infobox ship class overview
|Builders=
|Operators=
|Class before=
|Class after=
|Subclasses=
|Built range=
|In commission range=
|Total ships planned=
|Total ships on order=
|Total ships building=
|Total ships completed=
|Total ships cancelled=
|Total ships active=
|Total ships laid up=
|Total ships lost=
|Total ships retired=
|Total ships scrapped=
|Total ships preserved=
}}
{{Infobox ship characteristics
|Hide header=
|Header caption=
|Ship type=
|Ship displacement=
|Ship length=
|Ship beam=
|Ship draught=
|Ship draft=
|Ship propulsion=
|Ship speed=
|Ship range=
|Ship endurance=
|Ship test depth=
|Ship complement=
|Ship sensors=
|Ship EW=
|Ship armament=
|Ship notes=
}}
|}
|
Age of sail classes. Select show to expand.
|
---|
{|{{Infobox ship begin <!-- age of sail classes -->
|infobox caption= <!-- keywords: yes, nodab; or caption text -->
|display title= <!-- keywords: none, ital; or article title with markup -->
|sclass= <!-- keyword: 2 -->
}}
{{Infobox ship image
|Ship image=
|Ship image size=
|Ship caption=
|image alt=
}}
{{Infobox ship class overview
|Builders=
|Operators=
|Class before=
|Class after=
|Subclasses=
|Built range=
|In commission range=
|Total ships planned=
|Total ships on order=
|Total ships building=
|Total ships completed=
|Total ships cancelled=
|Total ships active=
|Total ships laid up=
|Total ships lost=
|Total ships retired=
|Total ships scrapped=
|Total ships preserved=
}}
{{Infobox ship characteristics
|Hide header=
|Header caption=
|Ship type=
|Ship tons burthen=
|Ship length=
|Ship beam=
|Ship draught=
|Ship draft=
|Ship hold depth=
|Ship propulsion=
|Ship sail plan=
|Ship complement=
|Ship armament=
|Ship notes=
}}
|}
|
Commercial vessel classes. Select show to expand.
|
---|
{|{{Infobox ship begin <!-- commercial vessel classes -->
|infobox caption= <!-- keywords: yes, nodab; or caption text -->
|display title= <!-- keywords: none, ital; or article title with markup -->
|sclass= <!-- keyword: 2 -->
}}
{{Infobox ship image
|Ship image=
|Ship image size=
|Ship caption=
|image alt=
}}
{{Infobox ship class overview
|Builders=
|Operators=
|Class before=
|Class after=
|Subclasses=
|Built range=
|In service range=
|Total ships planned=
|Total ships on order=
|Total ships building=
|Total ships completed=
|Total ships cancelled=
|Total ships active=
|Total ships laid up=
|Total ships lost=
|Total ships retired=
|Total ships scrapped=
|Total ships preserved=
}}
{{Infobox ship characteristics
|Hide header=
|Header caption=
|Ship type=
|Ship tonnage=
|Ship displacement=
|Ship length=
|Ship beam=
|Ship height=
|Ship draught=
|Ship draft=
|Ship depth=
|Ship decks=
|Ship deck clearance=
|Ship ramps=
|Ship ice class=
|Ship sail plan=
|Ship power=
|Ship propulsion=
|Ship speed=
|Ship capacity=
|Ship crew=
|Ship notes=
}}
|}
|
If none of the above fit, you may use this full setup:
Full code for ship classes. Select show to expand.
|
---|
{|{{Infobox ship begin <!-- full code -->
|infobox caption= <!-- keywords: yes, nodab; or caption text -->
|display title= <!-- keywords: none, ital; or article title with markup -->
|sclass= <!-- keyword: 2 -->
}}
{{Infobox ship image
|Ship image=
|Ship image size=
|Ship caption=
|image alt=
}}
{{Infobox ship class overview
|Name=
|Builders=
|Operators=
|Class before=
|Class after=
|Subclasses=
|Cost=
|Built range=
|In service range=
|In commission range=
|Total ships planned=
|Total ships on order=
|Total ships building=
|Total ships completed=
|Total ships cancelled=
|Total ships active=
|Total ships laid up=
|Total ships lost=
|Total ships retired=
|Total ships scrapped=
|Total ships preserved=
}}
{{Infobox ship characteristics
|Hide header=
|Header caption=
|Ship class=
|Ship type=
|Ship tonnage=
|Ship displacement=
|Ship tons burthen=
|Ship length=
|Ship beam=
|Ship height=
|Ship draught=
|Ship draft=
|Ship depth=
|Ship hold depth=
|Ship decks=
|Ship deck clearance=
|Ship ramps=
|Ship ice class=
|Ship power=
|Ship propulsion=
|Ship sail plan=
|Ship speed=
|Ship range=
|Ship endurance=
|Ship test depth=
|Ship boats=
|Ship capacity=
|Ship troops=
|Ship complement=
|Ship crew=
|Ship time to activate=
|Ship sensors=
|Ship EW=
|Ship armament=
|Ship armour=
|Ship armor=
|Ship aircraft=
|Ship aircraft facilities=
|Ship notes=
}}
|}
|
Most fields are self-explanatory, but here are some tips (see the usage guide for a complete explanation of all parameter fields):
Some fields provide alternative spellings and should never both be filled in:
It's generally a good idea not to remove fields, because another editor might be able to provide the information later. However, in the case of mutually exclusive fields, like "Ship armor" and "Ship armour", the unused field can be removed if desired. Also, if a section is repeated (to show multiple periods in commission, for example), fields that are inappropriate to duplicate can be removed if desired. Keep in mind that a ship from the Age of Sail would not need the fields for aircraft or electronic warfare instruments and conversely an aircraft carrier would not need the fields for a sail plan. A surface ship would not require fields for submarines etc.
This infobox allows you to repeat sections. To repeat, just make a copy of the section to be repeated. You can repeat the Image, Career, or Characteristics sections. Here is an example, with extra fields removed for clarity:
{|{{Infobox ship begin |infobox caption=}}
{{Infobox ship image
| Ship image=Uss bang.jpg
| Ship caption=
}}
{{Infobox ship career
| Ship country=US
| Ship flag={{USN flag|1972}}
| Ship name=USS ''Bang'' (SS-385)
| Ship laid down=30 April 1943
| Ship launched=30 August 1943
| Ship commissioned=4 December 1943
| Ship decommissioned=1 October 1972
| Ship struck=18 November 1974
| Ship fate=Transferred to Spain, 1 October 1972
}}
{{Infobox ship career
| Ship country=Spain
| Ship flag={{shipboxflag|Spain}}
| Ship name=SPS ''Cosme Garcia'' (S34)
| Ship acquired=1 October 1972
| Ship fate=scrapped 1983
}}
{{Infobox ship characteristics
| Header caption=
| Ship displacement=*1,526 tons surfaced
*2,391 tons
| Ship length=311 ft 8 in (95 m)
| Ship beam=27 ft 3 in (8.3 m)
| Ship complement=66
}}
|}
It is possible to hide the headers for the Career and General Characteristics sections, in order to repeat fields. For example, a ship might have been commissioned, decommissioned, recommissioned, and decommissioned again. To have the second commission and decommission dates, use additional a second Infobox ship career template with its header hidden, like this:
USS Wisconsin at sea, circa 1990
| |
History | |
---|---|
Laid down | 25 January 1941 |
Launched | 7 December 1943 |
Commissioned | 16 April 1944 |
Decommissioned | 1 July 1948 |
Recommissioned | 3 March 1951 |
Decommissioned | 8 March 1958 |
Recommissioned | 1 August 1986 |
Decommissioned | 30 September 1991 |
Stricken | 17 March 2006 |
Fate | Museum ship |
General characteristics (1943) | |
Displacement | 45,000 tons |
Length | 887.2 ft (270 m) |
Beam | 108.2 ft (33 m) |
Draft | 28.9 ft (8.8 m) |
Speed | 33 knots (61 km/h) |
Complement | 1,921 officers and men |
Armament | big guns |
{|{{Infobox ship begin |infobox caption=}}
{{Infobox ship image
| Ship image=USS Wisconsin (BB-64) underway at sea, circa 1988-1991 (NH 97206-KN).jpg
| Ship caption=USS ''Wisconsin'' at sea, circa 1990
| image alt=USS ''Wisconsin'' at sea, circa 1990
}}
{{Infobox ship career
| Hide header=
| Ship caption=(US)
| Ship flag={{USN flag|1992}}
| Ship laid down=25 January 1941
| Ship launched=7 December 1943
| Ship commissioned=16 April 1944
| Ship decommissioned=1 July 1948
}}
{{Infobox ship career
| Hide header=yes
| Ship recommissioned=3 March 1951
| Ship decommissioned=8 March 1958
}}
{{Infobox ship career
| Hide header=yes
| Ship recommissioned=1 August 1986
| Ship decommissioned=30 September 1991
| Ship struck=17 March 2006
| Ship fate=[[Museum ship]]
}}
{{Infobox ship characteristics
| Hide header=
| Header caption=(1943)
| Ship displacement=45,000 tons
| Ship length=887.2 ft (270 m)
| Ship beam=108.2 ft (33 m)
| Ship draft=28.9 ft (8.8 m)
| Ship speed=33 knots (61 km/h)
| Ship complement=1,921 officers and men
| Ship armament=big guns
}}
|}
The General Characteristics section can be given a caption using the Header caption field. See the USS Wisconsin example above, which has a header caption of (1943) to indicate that the characteristics provided are as of 1943.
It is possible to add custom fields to the infobox using standard Wiki table syntax. This is not encouraged, because infoboxes are intended to standardize the appearance of ship articles, but it can be done if needed. See the below example, where "Sunk:" and "Raised:" fields are added to the ship's career:
{|{{Infobox ship begin |infobox caption=}}
{{Infobox ship image
|Ship image=Uss west virginia bb.jpg
|Ship caption=''West Virginia'' in San Francisco Bay, circa 1934.
|image alt=''West Virginia'' in San Francisco Bay, circa 1934.
}}
{{Infobox ship career
| Hide header=
| Ship caption=US
| Ship flag={{USN flag|1947}}
| Ship ordered=5 December 1916
| Ship laid down=12 April 1920
| Ship launched=17 November 1921
| Ship commissioned=1 December 1923
}}
|-
| Sunk:
|7 December 1941
|-
|Raised:
|17 May 1942
{{Infobox ship career
| Hide header=yes
| Ship decommissioned=9 January 1947
| Ship fate=sold for scrap
| Ship struck=1 March 1959
| Ship nickname="Wee Vee"
}}
{{Infobox ship characteristics
| Hide header=
| Ship displacement=33,590 tons
| Ship length=624 ft (190 m)
| Ship beam=97.3 ft (29.6 m)
| Ship draft=30.5 ft (9.3 m)
| Ship speed=21.0 knots (39 km/h)
| Ship complement=1,407 officers and men
| Ship armament=big guns
}}
|}