Template:Infobox ship characteristics: Difference between revisions
old>Questers |
m (Changed protection level for "Template:Infobox ship characteristics": high-risk template with 4000+ transclusions ([Edit=Require template editor access] (indefinite) [Move=Require template editor access] (indefinite))) |
||
Line 6: | Line 6: | ||
| #default = <tr> | | #default = <tr> | ||
<th colspan="2" height="30" {{WPMILHIST Infobox style|header_bar}}>General characteristics {{{Header caption|}}}</th></tr> | <th colspan="2" height="30" {{WPMILHIST Infobox style|header_bar}}>General characteristics {{{Header caption|}}}</th></tr> | ||
}}{{ | }}{{#if:{{{Ship class|}}}|<tr style="vertical-align:top;"><td>Class and type:</td><td> | ||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship class|}}}}}</td></tr> | |||
}}{{ | }}{{#if:{{{Ship type|}}}|<tr style="vertical-align:top;"><td>Type:</td><td> | ||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship type|}}}}}</td></tr> | |||
}} | }}{{#if:{{{Ship tonnage|}}}|<tr style="vertical-align:top;"><td>Tonnage:</td><td> | ||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship tonnage|}}}}}</td></tr> | |||
}}{{ | }}{{#if:{{{Ship displacement|}}}|<tr style="vertical-align:top;"><td>Displacement:</td><td> | ||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship displacement|}}}}}</td></tr> | |||
}}{{ | }}{{#if:{{{Ship tons burthen|}}}|<tr style="vertical-align:top;"><td>Tons burthen:</td><td> | ||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship tons burthen|}}}}}</td></tr> | |||
}}{{ | }}{{#if:{{{Ship length|}}}|<tr style="vertical-align:top;"><td>Length:</td><td> | ||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship length|}}}}}</td></tr> | |||
}} | }}{{#if:{{{Ship beam|}}}|<tr style="vertical-align:top;"><td>Beam:</td><td> | ||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship beam|}}}}}</td></tr> | |||
}} | }}{{#if:{{{Ship height|}}}|<tr style="vertical-align:top;"><td>Height:</td><td> | ||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship height|}}}}}</td></tr> | |||
}}{{ | }}{{#if:{{{Ship draught|}}}|<tr style="vertical-align:top;"><td>Draught:</td><td> | ||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship draught|}}}}}</td></tr> | |||
}}{{ | }}{{#if:{{{Ship draft|}}}|<tr style="vertical-align:top;"><td>Draft:</td><td> | ||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship draft|}}}}}</td></tr> | |||
}}{ | }}{{#if:{{{Ship depth|}}}|<tr style="vertical-align:top;"><td>Depth:</td><td> | ||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship depth|}}}}}</td></tr> | |||
}} | }}{{#if:{{{Ship hold depth|}}}|<tr style="vertical-align:top;"><td>Depth of hold:</td><td> | ||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship hold depth|}}}}}</td></tr> | |||
}}{ | }}{{#if:{{{Ship decks|}}}|<tr style="vertical-align:top;"><td>Decks:</td><td> | ||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship decks|}}}}}</td></tr> | |||
}} | }}{{#if:{{{Ship deck clearance|}}}|<tr style="vertical-align:top;"><td>Deck clearance:</td><td> | ||
}}{{ | {{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship deck clearance|}}}}}</td></tr> | ||
}}{{#if:{{{Ship ramps|}}}|<tr style="vertical-align:top;"><td>Ramps:</td><td> | |||
}} | {{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship ramps|}}}}}</td></tr> | ||
}}{{#if:{{{Ship ice class|}}}|<tr style="vertical-align:top;"><td>Ice class:</td><td> | |||
}}{{ | {{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship ice class|}}}}}</td></tr> | ||
}}{{#if:{{{Ship power|}}}|<tr style="vertical-align:top;"><td>Installed power:</td><td> | |||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship power|}}}}}</td></tr> | |||
}}{{ | }}{{#if:{{{Ship propulsion|}}}|<tr style="vertical-align:top;"><td>Propulsion:</td><td> | ||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship propulsion|}}}}}</td></tr> | |||
}} | }}{{#if:{{{Ship sail plan|}}}|<tr style="vertical-align:top;"><td>Sail plan:</td><td> | ||
}}{{ | {{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship sail plan|}}}}}</td></tr> | ||
}}{{#if:{{{Ship speed|}}}|<tr style="vertical-align:top;"><td>Speed:</td><td> | |||
}}{ | {{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship speed|}}}}}</td></tr> | ||
}}{{#if:{{{Ship range|}}}|<tr style="vertical-align:top;"><td>Range:</td><td> | |||
}} | {{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship range|}}}}}</td></tr> | ||
}}{{#if:{{{Ship endurance|}}}|<tr style="vertical-align:top;"><td>Endurance:</td><td> | |||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship endurance|}}}}}</td></tr> | |||
}}{{#if:{{{Ship test depth|}}}|<tr style="vertical-align:top;"><td>Test depth:</td><td> | |||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship test depth|}}}}}</td></tr> | |||
}}{{#if:{{{Ship boats|}}}|<tr style="vertical-align:top;"><td>Boats & landing <br /> craft carried:</td><td> | |||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship boats|}}}}}</td></tr> | |||
}}{{#if:{{{Ship capacity|}}}|<tr style="vertical-align:top;"><td>Capacity:</td><td> | |||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship capacity|}}}}}</td></tr> | |||
}}{{#if:{{{Ship troops|}}}|<tr style="vertical-align:top;"><td>Troops:</td><td> | |||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship troops|}}}}}</td></tr> | |||
}}{{#if:{{{Ship complement|}}}|<tr style="vertical-align:top;"><td>Complement:</td><td> | |||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship complement|}}}}}</td></tr> | |||
}}{{#if:{{{Ship crew|}}}|<tr style="vertical-align:top;"><td>Crew:</td><td> | |||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship crew|}}}}}</td></tr> | |||
}}{{#if:{{{Ship time to activate|}}}|<tr style="vertical-align:top;"><td>Time to activate:</td><td> | |||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship time to activate|}}}}}</td></tr> | |||
}}{{#if:{{{Ship sensors|}}}|<tr style="vertical-align:top;"><td>Sensors and <br /> processing systems:</td><td> | |||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship sensors|}}}}}</td></tr> | |||
}}{{#if:{{{Ship EW|}}}|<tr style="vertical-align:top;"><td>Electronic warfare <br /> & decoys:</td><td> | |||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship EW|}}}}}</td></tr> | |||
}}{{#if:{{{Ship armament|}}}|<tr style="vertical-align:top;"><td>Armament:</td><td> | |||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship armament|}}}}}</td></tr> | |||
}}{{#if:{{{Ship armour|}}}|<tr style="vertical-align:top;"><td>Armour:</td><td> | |||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship armour|}}}}}{{#if:{{{Ship armor|}}}|[[Category:Pages using infobox ship with both armor and amour]]}}</td></tr> | |||
|{{#if:{{{Ship armor|}}}|<tr style="vertical-align:top;"><td>Armor:</td><td> | |||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship armor|}}}}}</td></tr> | |||
}}}}{{#if:{{{Ship aircraft|}}}|<tr style="vertical-align:top;"><td>Aircraft carried:</td><td> | |||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship aircraft|}}}}}</td></tr> | |||
}}{{#if:{{{Ship aircraft facilities|}}}|<tr style="vertical-align:top;"><td>Aviation facilities:</td><td> | |||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship aircraft facilities|}}}}}</td></tr> | |||
}}{{#if:{{{Ship notes|}}}|<tr style="vertical-align:top;"><td>Notes:</td><td> | |||
{{#invoke:WPSHIPS utilities|unbulleted_list|{{{Ship notes|}}}}}</td></tr> | |||
}}</includeonly><noinclude> | }}</includeonly><noinclude> | ||
{{Documentation}} | {{Documentation}} | ||
</noinclude> | </noinclude> |
Revision as of 16:30, 23 February 2018
This template is part of the WikiProject Ships ship infobox. It adds a Characteristics section to the infobox. Each section, except Infobox Ship Begin, can be repeated as necessary to support multiple careers, multiple sets of characteristics, etc. The header of the Characteristics box can be hidden by setting its "Hide header=yes". This allows you to repeat certain fields by adding a second Characteristics box with a hidden header. Also, additional text can be added to the Characteristics box with "Header caption=".
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.
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.
|
---|
|
Submarines. Select show to expand.
|
---|
|
Age of sail. Select show to expand.
|
---|
|
Commercial vessels. Select show to expand.
|
---|
|
If none of the above fit, you may use this full setup:
Full code for individual ships. Select show to expand.
|
---|
|
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.
|
---|
|
Submarine classes. Select show to expand.
|
---|
|
Age of sail classes. Select show to expand.
|
---|
|
Commercial vessel classes. Select show to expand.
|
---|
|
If none of the above fit, you may use this full setup:
Full code for ship classes. Select show to expand.
|
---|
|
Parameters
Most fields are self-explanatory, but here are some tips (see the usage guide for a complete explanation of all parameter fields):
- Ship image If your article does not have an image in this field, the ship will automatically be listed at the hidden category Category:Ship infoboxes without an image. Editors can use the category to easily see a list of infoboxes where no image is attached and work to find pictures.
- Ship caption, the caption for the ship's picture, should be left blank if no extra information about the picture is available; don't just fill in the ship's name.
- Ship country is necessary when a ship served under multiple countries, but not really necessary otherwise.
- Ship class should include both the class and the type of ship. For example, Balao-class diesel-electric submarine provides complete information. It can be replaced with Ship type, which displays as "Type:", for ships that aren't members of a class.
- Ship name is necessary when a ship served under multiple names, but not really necessary otherwise.
- Ship fate and Ship status generally shouldn't both be filled in. Whichever one sounds most appropriate for the situation should be filled in. Use Ship fate when the ship sank or was scrapped, and use Ship status when the ship is active, kept in reserve, or currently a museum.
- Ship displacement and Ship tonnage are not the same thing. Displacement is the mass of a ship in a particular condition, like when it's fully loaded for battle. It is generally used for military vessels. Tonnage is a measurement of the cargo capacity of a vessel and isn't exactly correlated with weight: a ship of a particular tonnage will have a different mass depending on whether it's full of grain or iron. Entries in either parameter need to specifically identify the units in which they are being measured, such as long tons, metric tons or tonnes (unacceptable in articles using American English, use metric tons) or gross register tons or whatever. If possible, use templates such as {{GT}}, {{NetT}} and {{DWT}}.
Alternate spellings
Some fields provide alternate spellings and should never both be filled in:
- "Ship honors" and "Ship honours"
- "Ship draft" and "Ship draught"
- "Ship armor" and "Ship armour"
Parameter value import from Wikidata
Infobox ship can import parameter values from Wikidata (WD). A Wikidata property is roughly equivalent to an infobox parameter. When there is a page at Wikidata that matches the page at Wikipedia, and the Wikidata page has a property that matches the infobox parameter, then the infobox parameter can take its value from the Wikidata property.
These parameters, if left empty or omitted from the template, may be filled from Wikidata:
- Ship class, supplied by WD property d:ship class
When the infobox is rendered in an article, those parameters that use Wikidata property values will display an icon () linked to the Wikidata source page. Articles using Wikidata properties are listed in Category:Ship infoboxes importing Wikidata.
If an imported value is inappropriate or wrong, the corresponding Wikidata item should be corrected. The template code will only display a parameter's label and value if the parameter has an assigned value, whether provided locally or provided by Wikidata. If display of a Wikidata property value is not appropriate or desired, use the reserved value none
as the parameter value to block Wikdata import. Articles blocking Wikdata property import are listed in Category:Ship infoboxes blocking Wikidata import.
Removing extra fields
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 in opposite an aircraft carrier would not need the fields for a sail plan. A surface ship would not require fields for submarines etc.
Special capabilities
Repeating sections
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 }} |}
Hiding section headers
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 |
Struck: | 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 }} {{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.
Custom fields
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. }} {{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 }} |}
TemplateData
TemplateData for Infobox ship characteristics
Ship characteristics, to be used with {{Infobox ship begin}}
Parameter | Description | Type | Status | |
---|---|---|---|---|
Hide header | Hide header | no description | String | optional |
Header caption | Header caption | no description | String | optional |
Ship class | Ship class | no description | String | optional |
Ship type | Ship type | no description | String | optional |
Ship tonnage | Ship tonnage | no description | String | optional |
Ship displacement | Ship displacement | no description | String | optional |
Ship tons burthen | Ship tons burthen | no description | String | optional |
Ship length | Ship length | no description | String | optional |
Ship beam | Ship beam | no description | String | optional |
Ship height | Ship height | no description | String | optional |
Ship draught | Ship draught | no description | String | optional |
Ship draft | Ship draft | no description | String | optional |
Ship depth | Ship depth | no description | String | optional |
Ship hold depth | Ship hold depth | no description | String | optional |
Ship decks | Ship decks | no description | String | optional |
Ship deck clearance | Ship deck clearance | no description | String | optional |
Ship ramps | Ship ramps | no description | String | optional |
Ship ice class | Ship ice class | no description | String | optional |
Ship power | Ship power | no description | String | optional |
Ship propulsion | Ship propulsion | no description | String | optional |
Ship sail plan | Ship sail plan | no description | String | optional |
Ship speed | Ship speed | no description | String | optional |
Ship range | Ship range | no description | String | optional |
Ship endurance | Ship endurance | no description | String | optional |
Ship test depth | Ship test depth | no description | String | optional |
Ship boats | Ship boats | no description | String | optional |
Ship capacity | Ship capacity | no description | String | optional |
Ship troops | Ship troops | no description | String | optional |
Ship complement | Ship complement | no description | String | optional |
Ship crew | Ship crew | no description | String | optional |
Ship time to activate | Ship time to activate | no description | String | optional |
Ship sensors | Ship sensors | no description | String | optional |
Ship EW | Ship EW | no description | String | optional |
Ship armament | Ship armament | no description | String | optional |
Ship armour | Ship armour | no description | String | optional |
Ship armor | Ship armor | no description | String | optional |
Ship aircraft | Ship aircraft | no description | String | optional |
Ship aircraft facilities | Ship aircraft facilities | no description | String | optional |
Ship motto | Ship motto | no description | String | optional |
Ship nickname | Ship nickname | no description | String | optional |
Ship honours | Ship honours | no description | String | optional |
Ship honors | Ship honors | no description | String | optional |
Ship notes | Ship notes | no description | String | optional |
Ship badge | Ship badge | no description | String | optional |