Template:Aircraft specifications/doc

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

Usage

{{aircraft specifications
<!-- If you do not understand how to use this template, please ask at [[Wikipedia talk:WikiProject Aircraft]]. -->
| plane or copter? = <!-- options: plane/copter -->
| jet or prop? = <!-- options: jet/prop/both/neither -->
<!-- Now, fill out the specs.  Please include units where appropriate (main comes first, alt in parentheses). If an item does not apply, like capacity, leave it blank. 
-->
| ref = 
<!--  General characteristics  -->
| crew         = 
| capacity     = 
| payload main = 
| payload alt  = 
| payload more = 
| length main  = 
| length alt   = 
| span main    = 
| span alt     = 
| height main  = 
| height alt   = 
| area main    = 
| area alt     = 
| airfoil      = 
| aspect ratio = 
| empty weight main  = 
| empty weight alt   = 
| useful load main   = 
| useful load alt    = 
| loaded weight main = 
| loaded weight alt  = 
| max takeoff weight main = 
| max takeoff weight alt  = 
| more general            = 
<!--  Powerplant, jet engine(s)  -->
| engine (jet)    = 
| type of jet     = 
| number of jets  = 
| thrust main     = 
| thrust alt      = 
| thrust original = 
| afterburning thrust main = 
| afterburning thrust alt  = 
<!--  Powerplant, prop(s)  -->
| engine (prop)   = 
| type of prop    = 
| number of props = 
| power main      = 
| power alt       = 
| power original  = 
<!--  Powerplant, propellor/rotor details  -->
| propeller or rotor?     = <!-- options: propeller/rotor -->
| propellers              = 
| number of propellers per engine = 
| propeller diameter main = 
| propeller diameter alt  = 

| more general powerplant =
<!-- Performance  -->
| max speed main    = 
| max speed alt     = 
| max speed more    = 
| cruise speed main = 
| cruise speed alt  = 
| cruise speed more = 
| stall speed main  = 
| stall speed alt   = 
| stall speed more  = 
| never exceed speed main = 
| never exceed speed alt  = 
| range main        = 
| range alt         = 
| range more        = 
| combat radius main= 
| combat radius alt = 
| combat radius more= 
| ferry range main  = 
| ferry range alt   = 
| ferry range more  = 
| endurance         = 
| ceiling main      = 
| ceiling alt       = 
| ceiling more      = 
| climb rate main   = 
| climb rate alt    = 
| climb rate more   = 
| sink rate main    = 
| sink rate alt     = 
| sink rate more    = 
| loading main      = 
| loading alt       = 
| thrust/weight     = 
| power/mass main   = 
| power/mass alt    = 
| more performance  = 
<!--  Armament  -->
| armament = <!-- If you want to use the following specific parameters, do not use this line at all -->
| guns     = 
| bombs    = 
| rockets  = 
| missiles = 
 
| hardpoints = 
| hardpoint capacity = 
| hardpoint rockets  = 
| hardpoint missiles = 
| hardpoint bombs    = 
| hardpoint other    = 

| avionics = 

}}

Aircraft specifications

Editors beware: formatting of code to make it "look nice" is very likely to inadvertently introduce leading and trailing blank lines into the template output.

This template has provisions for four sections: General characteristics, performance, armament, and avionics. What follows is list of the parameters that appear in each section, and specialised instructions for their use where necessary.

Most numerical quantities are divided into 'main' and 'alt'. For example, the quantity 'empty weight' is specified by the parameters {{{empty weight main}}} and {{{empty weight alt}}}. The choice of which is the given first will depend on origin and period. A U.S. aircraft would have U.S. System of customary units given first (in the example of weight 'main' would be given in pounds (lb), and the value for 'alt' in kilograms (kg). Other aircraft are measured using the metric system, so they will have kg for 'main' and lb for 'alt'. Prior to the adoption of metric units, British aircraft used Imperial units, and RAF aircraft used mph until after WWII while Fleet Air Arm aircraft used knots.

Because of the ParserFunctions this template uses, all values will automatically appear in the article once they have been specified. For example, if I specify |area main=1,000 ft<sup>2</sup>|area alt=93 m<sup>2</sup>, the text

Wing area: 1,000 ft² (93 m²)

will automatically appear in the article.

In the following instructions, parameters are referred to thus: {{{parameter name}}}. When indicating which values should be entered for each parameter, the notation |parameter name=vale will be used.

Non-specifications parameters

The template uses three parameters that are not directly related to the specs: {{{plane or copter?}}}, {{{jet or prop?}}}, and {{{ref}}}. The first two control template output; the last one provides citation information.

{{{plane or copter?}}}: If the aircraft is a rotorcraft (including helicopters, gyrodynes, tiltrotors, etc.), the value for this parameter should be |plane or copter?=copter. If it is a fixed wing aircraft, the value should be specified as |plane or copter?=plane.
{{{jet or prop?}}}: For planes that are powered by jet engines or rockets, specify |jet or prop?=jet. For those powered by propellers, specify |jet or prop?=prop. Occasionally, aircraft have both jet engines and propellers; for these, specify |jet or prop?=both. Unpowered aircraft such as gliders should be denoted by |jet or prop?=neither.
{{{ref}}}: Used to cite the sources for the specifications section. Example: |ref=The Encyclopedia of World Aircraft<ref>{{cite encyclopedia|last=Donald|first=David|year=1997|title=Boeing Model 299 (B-17 Flying Fortress|encyclopedia=The Encyclopedia of World Aircraft: 1|location=Etobicoke, Ontario, Canada|publisher=Prospero Books| ISBN =1-85605-375-X|pages=pages 154-155}}</ref>. See Wikipedia:Citation templates for information on the citation templates available and how to use them.

General characteristics

{{{crew}}}: The number of people required to operate the aircraft. If you wish to specify the roles played by each crew member, do so in something similar to the following format: |crew=3 (pilot, copilot, flight engineer)
{{{capacity}}}: The number of passengers the aircraft can carry if the plane is commercial. For general aviation aircraft, this should usually be specified x number of passengers: |capacity=88 passengers and can include crew. Most military transports can be used for patients. In this case, something similar to the system used for the C-130 Hercules may be in order:

|capacity=<br/>
** 92 passengers ''or''
** 64 airborne troops ''or''
** 74 litter patients with 2 medical personnel

{{{payload main}}}, {{{payload alt}}}, {{{payload more}}}: Specifies the amount of cargo that can be carried by an aircraft. For 'main' and 'alt', specify the weight of the payload. If applicable, use to specify the type of payload usually carried, such as fertiliser for agricultural aircraft or mail for mailplanes.
{{{length main}}}, {{{length alt}}}: The length of the aircraft from nose to tail. For helicopters, this means the length of the fuselage without taking the rotor into consideration.
{{{span main}}}, {{{span alt}}}: The wingspan of fixed wing aircraft, or the main rotor diameter for rotorcraft.
{{{height main}}}, {{{height alt}}}
{{{area main}}}, {{{area alt}}}: The area of the wing of a fixed wing aircraft, or the total area of all main rotors for rotorcraft (does not include maneuvering rotors).
{{{airfoil}}}: For fixed wing aircraft, the type of airfoil the wing uses. Eg, see NACA airfoil for information on airfoil types.
aspect ratio: for fixed wing aircraft, the aspect ratio of the wing - a parameter generally of interest in gliders (sailplanes)
{{{empty weight main}}}, {{{empty weight alt}}}: The weight of the aircraft when unloaded—no crew, passengers, cargo, or fuel.
{{{loaded weight main}}}, {{{loaded weight alt}}}: The weight of the aircraft when loaded for a 'typical' mission. This statistic is cited for almost any aircraft, but it is relatively arbitrary, so only use statistics given in sources.
{{{useful load main}}}, {{{useful load alt}}}: The difference between the aircraft's maximum weight and empty weight.
{{{max takeoff weight main}}}, {{{max takeoff weight alt}}}, {{{max takeoff weight more}}}: The heaviest the aircraft can be and still get off the ground.
{{{more general}}}: A place to put anything relevant not included already under the general parameters e.g. "Fuel Capacity: 500 gallons"

Engines

If there is any information that needs to be added after the engine specs, it should be added using the parameter {{{more general powerplant}}}. eg |more general powerplant=engines coupled through gearbox.

Propeller driven aircraft

{{{number of props}}}: The number of engines that drive the propellers. For fixed wing aircraft, this is usually—but not always—the same as the number of propellers.
{{{engine (prop)}}}: The model of engine the aircraft uses. Example: |engine (prop)=[[Pratt & Whitney R-4360]]-53 "Wasp Major".
{{{type of prop}}}: The configuration of the engine. Examples: |type of prop=liquid-cooled [[V12 engine]], |type of prop=[[turboprop]], |type of prop=[[radial engine]].
{{{power main}}}, ({{{power alt}}}): The power output of the engine.
{{{power original}}}: For some engines the power output may have been originally measured in an unconventional unit. For example, older German engines originally had their power measured in Pferdestärke (PS). Sample usage of this parameter: |power original=<ref>Originally measured as 15,000 [[Pferdestärke|PS]].
{{{power more}}}: More information on the power rating, such as the rpm of the engine.

Jet aircraft

{{{number of jets}}}: The number of jet engines or rockets the aircraft has.
{{{engine (jet)}}}: The model of jet or rocket used by the aircraft
{{{type of jet}}}: The configuration of jet, such as turbojet, turbofan, motorjet, rocket, etc.
{{{afterburning thrust main}}}, {{{afterburning thrust alt}}}: Thrust of the engine with afterburner, if applicable.
{{{thrust main}}}, {{{thrust alt}}}: The thrust of the engine; if the engine has afterburners, this parameter denotes dry thrust.
{{{afterburning thrust original}}}, {{{thrust original}}}: Some engines had their original measurements taken in unconventional units. For example, many Russian and Soviet engines were originally rated using kilogram-force.

Propeller model and configuration

{{{propeller or rotor?}}}: If it is a propeller on a fixed wing aircraft, specify |propeller or rotor?=propeller. If it is a rotor on a helicopter or other rotary wing aircraft, specify |propeller or rotor=rotor.
{{{propellers}}}: The model and configuration of the propellers. Example: |propellers=Three-bladed [[Hamilton Standard]].
{{{number of propellers per engine}}}: With some aircraft, multiple propellers will be driven off one engine. Use this parameter to specify the number per engine.
{{{propeller diameter main}}}, {{{propeller diameter alt}}}: Used to indicate the diameter of the propellers. For helicopters, the rotor diameter was already specified using the {{{span}}} parameter.

Performance

The available parameter fields are: Their use is fairly obvious.

| never exceed speed main =
| never exceed speed alt =
| never exceed speed more =

| max speed main =
| max speed alt =
| max speed more = (displays only when there is a value for max speed alt )

| cruise speed main =
| cruise speed alt =
| cruise speed more =

| stall speed main =
| stall speed alt =
| stall speed more =

| lift to drag =

| minimum control speed main =
| minimum control speed alt =
| minimum control speed more =

| range main =
| range alt =
| range more =

| combat radius main =
| combat radius alt =
| combat radius more =

| ferry range main =
| ferry range alt =
| ferry range more =

| endurance = (patrol aircraft and older aircraft may have this instead of range)

| ceiling main =
| ceiling alt =
| ceiling more =

| climb rate main =
| climb rate alt =
| climb rate more =

| sink rate main =
| sink rate alt =
| sink rate more =

| fuel consumption =

| performance more =

Armament

You can use |armament= followed by a bulletted list of the armaments, or omit that line entirely and use the following specific parameters. If you include the line |armament= at all—even with an empty value—then none of the following parameters will have any effect.

to specify the types of hardpoint weapons

Avionics

Will be added later