Template:Infobox ship/doc

This is a documentation subpage for Template:Infobox ship.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used on approximately 43,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.

This template uses Lua:

Module:Infobox ship (sandbox)

This template accepts these named parameters. Positional parameters are not accepted. The positional parameters are:

|sectionn= – the value assigned to these enumerated parameters is a child infobox, typically one of:
- {{infobox ship/image}}
- {{infobox ship/career}}
- {{infobox ship/characteristics}}
- {{infobox ship/class_overview}}
- {{infobox ship/service record}}
- other infoboxen that can be configured as child infoboxen; {{Infobox NRHP}} with |embed=yes
see each template's documentation for parameters supported by those templates
|labeln= – the values assigned to these enumerated parameters are labels for custom infobox entries; n for |labeln= and |datan= must match
|datan= – the values assigned to these enumerated parameters are the data for custom infobox entries; n for |datan= and |labeln= must match
|display_title= – controls display styling of the article title
- none – does no article-title styling
- ital – uses {{italic title}} to style the article title
- <article title with markup> – uses {{DISPLAYTITLE:<article title with markup>}} to style the article title
- when empty or omitted, attempts to automatically style the article title
|infobox_caption= – controls the infobox caption
- yes – uses the article title as the infobox caption. The ship's name will be auto-italicized when the article title has a recognized ship prefix (USS, MV, etc) or has a parenthetical disambiguator (year, hull number, etc) or is in the form <nationality> <ship type> <name> (with or without parenthetical disambiguator); this setting overridden by |sclass=2
- nodab – formats the infobox caption in the same way as the disambiguated article title except that disambiguator(s) are not displayed; for article titles with a parenthetical disambiguator, the disambiguator is omitted from the caption; for article titles in the form <nationality> <ship type> <name> (with or without parenthetical disambiguator), setting |infobox_caption=nodab will display only <name>; this setting overridden by |sclass=2
- <other text> – when the assigned value is other than the keywords yes or nodab, that value is used as the infobox caption. Infobox caption text formatting is the responsibility of the editor.
- when omitted or present-but-empty: the infobox does not have a caption
|sclass= – when set to 2, forces unstyled title and also unstyled infobox caption (if enabled by |infobox_caption=yes or |infobox_caption=nodab); the name is taken from {{sclass2}} which creates links to theme-named-class_articles
|showerrs= – for use when auto-styling fails, may give a clue why it failed; requires |infobox_caption=yes or |infobox_caption=nodab; the article should probably not be saved with |showerrs=yes

Usage

Code for individual ships

For infoboxes of individual ships, please copy the appropriate example for the type of ship:

Warships (except submarines). Select show to expand.

{{Infobox ship    <!-- warships except submarines -->
|infobox_caption= <!-- keywords: yes, nodab; or caption text -->
|display_title=   <!-- keywords: none, ital; or article title with markup -->

|section1={{Infobox ship/image
 |image= 
 |image_size= 
 |image_caption=
 |image_alt=
 }}

|section2={{Infobox ship/career
 |hide_header= 
 |country= 
 |flag= 
 |name=
 |owner= 
 |namesake= 
 |ordered= 
 |builder= 
 |laid_down= 
 |launched= 
 |acquired= 
 |commissioned= 
 |decommissioned= 
 |in_service= 
 |out_of_service= 
 |stricken= 
 |reinstated= 
 |honours=
 |honors=
 |fate=
 |status= 
 |notes= 
 }}

|section3={{Infobox ship/characteristics
 |hide_header= 
 |header_caption= 
 |class= 
 |displacement= 
 |length= 
 |beam= 
 |draught= 
 |draft= 
 |propulsion= 
 |speed= 
 |range= 
 |complement= 
 |sensors= 
 |EW= 
 |armament= 
 |armour= 
 |armor= 
 |aircraft= 
 |aircraft_facilities=
 |notes= 
 }}
}}

Submarines. Select show to expand.

{{Infobox ship    <!-- submarines -->
|infobox_caption= <!-- keywords: yes, nodab; or caption text -->
|display_title=   <!-- keywords: none, ital; or article title with markup -->

|section1={{Infobox ship/image
 |image= 
 |image_size= 
 |image_caption=
 |image_alt=
 }}

|section2={{Infobox ship/career
 |hide_header=
 |country=
 |flag=
 |name=
 |namesake=
 |ordered=
 |builder=
 |laid_down=
 |launched=
 |acquired=
 |commissioned=
 |decommissioned=
 |in_service=
 |out_of_service=
 |stricken=
 |reinstated=
 |fate=
 |status=
 }}

|section3={{Infobox ship/characteristics
 |hide_header=
 |header_caption=
 |class=
 |displacement=
 |length=
 |beam=
 |draught=
 |draft=
 |propulsion=
 |speed=
 |range=
 |endurance=
 |test_depth=
 |complement=
 |sensors=
 |EW=
 |armament=
 |notes=
 }}
}}

Age of sail. Select show to expand.

{{Infobox ship    <!-- age of sail -->
|infobox_caption= <!-- keywords: yes, nodab; or caption text -->
|display_title=   <!-- keywords: none, ital; or article title with markup -->

|section1={{Infobox ship/image
 |image=
 |image_size= 
 |image_caption=
 |image_alt=
 }}

|section2={{Infobox ship/career
 |hide_header=
 |country=
 |flag=
 |name=
 |owner=
 |ordered=
 |builder=
 |original_cost=
 |laid_down=
 |launched=
 |acquired=
 |commissioned=
 |decommissioned=
 |in_service=
 |out_of_service=
 |renamed=
 |stricken=
 |reinstated=
 |honours=
 |honors=
 |captured=
 |fate=
 |status=
 |notes=
 }}

|section3={{Infobox ship/characteristics
 |hide_header=
 |header_caption=
 |class=
 |tons burthen=
 |length=
 |beam=
 |draught=
 |draft=
 |hold_depth=
 |propulsion=
 |sail_plan=
 |complement=
 |armament=
 |notes=
 }}
}}

Commercial vessels. Select show to expand.

{{Infobox ship    <!-- commercial vessels -->
|infobox_caption= <!-- keywords: yes, nodab; or caption text -->
|display_title=   <!-- keywords: none, ital; or article title with markup -->

|section1={{Infobox ship/image
 |image=
 |image_size= 
 |image_caption=
 |image_alt=
 }}

|section2={{Infobox ship/career
 |hide_header=
 |name=
 |owner=
 |operator=
 |registry=
 |route=
 |ordered=
 |builder=
 |original_cost=
 |yard_number=
 |way_number=
 |laid_down=
 |launched=
 |completed=
 |christened=
 |acquired=
 |maiden_voyage=
 |in_service=
 |out_of_service=
 |identification=
 |fate=
 |status=
 |notes=
 }}

|section3={{Infobox ship/characteristics
 |hide_header=
 |header_caption=
 |class=
 |type=
 |tonnage=
 |displacement=
 |length=
 |beam=
 |height=
 |draught=
 |draft=
 |depth=
 |decks=
 |deck_clearance=
 |ramps=
 |ice_class=
 |sail_plan=
 |power=
 |propulsion=
 |speed=
 |capacity=
 |crew=
 |notes=
 }}
}}

If none of the above fit, you may use this full setup:

Full code for individual ships. Select show to expand.

{{Infobox ship    <!-- full code -->
|infobox_caption= <!-- keywords: yes, nodab; or caption text -->
|display_title=   <!-- keywords: none, ital; or article title with markup -->

|section1={{Infobox ship/image
 |image=
 |image_size= 
 |image_caption=
 |image_alt=
 }}

|section2={{Infobox ship/career
 |hide_header=
 |country=
 |flag=
 |name=
 |namesake=
 |owner=
 |operator=
 |registry=
 |route=
 |ordered=
 |awarded=
 |builder=
 |original_cost=
 |yard_number=
 |way_number=
 |laid_down=
 |launched=
 |sponsor=
 |christened=
 |completed=
 |acquired=
 |commissioned=
 |recommissioned=
 |decommissioned=
 |maiden_voyage=
 |in_service=
 |out_of_service=
 |renamed=
 |reclassified=
 |refit=
 |stricken=
 |reinstated=
 |homeport=
 |identification=
 |motto=
 |nickname=
 |honours=
 |honors=
 |captured=
 |fate=
 |status=
 |notes=
 |badge=
 }}

|section3={{Infobox ship/characteristics
 |hide_header=
 |header_caption=
 |class=
 |type=
 |tonnage=
 |displacement=
 |tons burthen=
 |length=
 |beam=
 |height=
 |draught=
 |draft=
 |depth=
 |hold_depth=
 |decks=
 |deck_clearance=
 |ramps=
 |ice_class=
 |power=
 |propulsion=
 |sail_plan=
 |speed=
 |range=
 |endurance=
 |test_depth=
 |boats=
 |capacity=
 |troops=
 |complement=
 |crew=
 |time_to_activate=
 |sensors=
 |EW=
 |armament=
 |armour=
 |armor=
 |aircraft=
 |aircraft_facilities=
 |notes=
 }}
}}

Code for ship classes

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    <!-- warship classes -->
|infobox_caption= <!-- keywords: yes, nodab; or caption text -->
|display_title=   <!-- keywords: none, ital; or article title with markup -->
|sclass=          <!-- keyword: 2 -->

|section1={{Infobox ship/image
 |image=
 |image_size= 
 |image_caption=
 |image_alt=
 }}

|section2={{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=
 }}

|section3={{Infobox ship/characteristics
 |hide_header=
 |header_caption=
 |type=
 |displacement=
 |length=
 |beam=
 |draught=
 |draft=
 |propulsion=
 |speed=
 |range=
 |complement=
 |sensors=
 |EW=
 |armament=
 |armour=
 |armor= 
 |aircraft=
 |aircraft_facilities=
 |notes=
 }}
}}

Submarine classes. Select show to expand.

{{Infobox ship    <!-- submarine classes -->
|infobox_caption= <!-- keywords: yes, nodab; or caption text -->
|display_title=   <!-- keywords: none, ital; or article title with markup -->
|sclass=          <!-- keyword: 2 -->

|section1={{Infobox ship/image
 |image=
 |image_size= 
 |image_caption=
 |image_alt=
 }}

|section2={{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=
 }}

|section3={{Infobox ship/characteristics
 |hide_header=
 |header_caption=
 |type=
 |displacement=
 |length=
 |beam=
 |draught=
 |draft=
 |propulsion=
 |speed=
 |range=
 |endurance=
 |test_depth=
 |complement=
 |sensors=
 |EW=
 |armament=
 |notes=
 }}
}}

Age of sail classes. Select show to expand.

{{Infobox ship    <!-- 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 -->

|section1={{Infobox ship/image
 |image=
 |image_size= 
 |image_caption=
 |image_alt=
 }}

|section2={{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=
 }}

|section3={{Infobox ship/characteristics
 |hide_header=
 |header_caption=
 |type=
 |tons burthen=
 |length=
 |beam=
 |draught=
 |draft=
 |hold_depth=
 |propulsion=
 |sail_plan=
 |complement=
 |armament=
 |notes=
 }}
}}

Commercial vessel classes. Select show to expand.

{{Infobox ship    <!-- commercial vessel classes -->
|infobox_caption= <!-- keywords: yes, nodab; or caption text -->
|display_title=   <!-- keywords: none, ital; or article title with markup -->
|sclass=          <!-- keyword: 2 -->

|section1={{Infobox ship/image
 |image=
 |image_size= 
 |image_caption=
 |image_alt=
 }}

|section2={{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=
 }}

|section3={{Infobox ship/characteristics
 |hide_header=
 |header_caption=
 |type=
 |tonnage=
 |displacement=
 |length=
 |beam=
 |height=
 |draught=
 |draft=
 |depth=
 |decks=
 |deck_clearance=
 |ramps=
 |ice_class=
 |sail_plan=
 |power=
 |propulsion=
 |speed=
 |capacity=
 |crew=
 |notes=
 }}
}}

If none of the above fit, you may use this full setup:

Full code for ship classes. Select show to expand.

{{Infobox ship    <!-- full code -->
|infobox_caption= <!-- keywords: yes, nodab; or caption text -->
|display_title=   <!-- keywords: none, ital; or article title with markup -->
|sclass=          <!-- keyword: 2 -->

|section1={{Infobox ship/image
 |image=
 |image_size= 
 |image_caption=
 |image_alt=
 }}

|section2={{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=
 }}

|section3={{Infobox ship/characteristics
 |hide_header=
 |header_caption=
 |class=
 |type=
 |tonnage=
 |displacement=
 |tons burthen=
 |length=
 |beam=
 |height=
 |draught=
 |draft=
 |depth=
 |hold_depth=
 |decks=
 |deck_clearance=
 |ramps=
 |ice_class=
 |power=
 |propulsion=
 |sail_plan=
 |speed=
 |range=
 |endurance=
 |test_depth=
 |boats=
 |capacity=
 |troops=
 |complement=
 |crew=
 |time_to_activate=
 |sensors=
 |EW=
 |armament=
 |armour=
 |armor=
 |aircraft=
 |aircraft_facilities=
 |notes=
 }}
}}

No description.

Template parameters
Parameter		Description	Type	Status
image	`image`	no description	Unknown	optional
image_size	`image_size`	no description	Unknown	optional
image_caption	`image_caption`	no description	Unknown	optional
image_alt	`image_alt`	no description	Unknown	optional
hide_header	`hide_header`	no description	Unknown	optional
country	`country`	no description	Unknown	optional
flag	`flag`	no description	Unknown	optional
name	`name`	no description	Unknown	optional
owner	`owner`	no description	Unknown	optional
namesake	`namesake`	no description	Unknown	optional
ordered	`ordered`	no description	Unknown	optional
builder	`builder`	no description	Unknown	optional
laid_down	`laid_down`	no description	Unknown	optional
launched	`launched`	no description	Unknown	optional
acquired	`acquired`	no description	Unknown	optional
commissioned	`commissioned`	no description	Unknown	optional
decommissioned	`decommissioned`	no description	Unknown	optional
in_service	`in_service`	no description	Unknown	optional
out_of_service	`out_of_service`	no description	Unknown	optional
stricken	`stricken`	no description	Unknown	optional
reinstated	`reinstated`	no description	Unknown	optional
honours	`honours`	no description	Unknown	optional
honors	`honors`	no description	Unknown	optional
fate	`fate`	no description	Unknown	optional
status	`status`	no description	Unknown	optional

A page that knows where it met you.

Usage

Code for individual ships

Code for ship classes