View source for Template:Aircraft specs/doc

{{Documentation subpage}}
{{Intricate template}}
{{High-use}}

'''Template:Aircraft specs''' displays aircraft specifications, automatically formatted and converted for either metric or imperial units.

==Usage==
A "note" parameter is available for every parameters for qualifying the entry. Its name is always the same as the parameter you are amending, without units, and "note" attached to the end. For example {{para|range miles|420}} and {{para|range note|with maximum wing fuel, VTOL, and 10% reserve}}. Some parameters (i.e. {{para|crew}}) will display any text entered and do not require the use of notes.

==Syntax==
{{Aircraft specs/doc/examples}}

This template was designed so that the data supported by it should be largely self-explanatory. A detailed description of the various fields, with examples, follows:

* {{para|ref}} – allows for the data in this section to be specifically sourced. 
* {{para|prime units?}} ('''MANDATORY''') {{anchor|prime-units}} – switches the template from displaying SI (metric) units first (by entering '''met''') or English (Imperial) units first (by entering '''imp''' for mph first or '''kts''' for kts or nautical miles first). There is a long-standing convention within WikiProject:Aircraft that specifications for US, Canadian and UK aircraft (for the UK periods differ - e.g. RAF aircraft until post war used mph, FAA aircraft operated in knots) should be given as English units first, and all others as SI units first.  
:[[Image:Ambox warning pn.svg|left|16px|alt=|link=]] you ''must'' include '''imp''', '''kts''', or '''met'''  in this field or the template won't display at all!

* {{para|genhide}} – allows the "General characteristics" heading to be manually turned off in the rare case that none of the data in this section is available. Enter <code>|genhide=Y</code> to do this. If using this parameter, please leave a hidden note so that other editors will know to remove this line to turn the heading back on again. 
** Example: {{para|genhide|Y}} <!-- please remove this line if data on general characteristics becomes available -->
* {{para|crew}} the number of people typically required to operate the aircraft, and their positions (if known). For commercial aircraft, this may include cabin crew. If specific positions are not known, this field might just contain a number. If the number is "One", however, it's safe to assume that this person's job might be "pilot"! Drones and UAVs should have "None" in this field. {{paragraph}}Examples:
** Four
** One pilot
** None
** Three: Pilot, co-pilot, and navigator/radio operator
** Two: Pilot and tail-gunner
** Five: Two pilots, flight engineer, two cabin crew
* {{para|capacity}} – the passenger and/or cargo carrying capacity of the aircraft. Typically, this may include some alternatives when a transport aircraft is typically configurable for a variety of cargo types. In these cases, the alternatives should be separated by ''or'' (in italics) {{paragraph}}Examples
** 32 passengers
** 2,000 kg (4,400 lb) of cargo
** 320 US gal (1,200 L) of chemicals
** Eight 463L cargo pallets
** Six passengers ''or'' two litters with attendants
* {{para|length}} – the overall length of the airframe. For rotary-wing aircraft, this is the fuselage length, not counting areas swept by turning rotors.
* {{para|span}} – the overall wingspan for fixed-wing aircraft. This does not count areas swept by turning propellers, but does include the width of tip-tanks, finlets, and non-removable wingtip weapons stations.
* One or more of {{para|upper span  m=}}, {{para|mid span m=}}, {{para|lower span m=}} and/or
* One or more of these pairs for bi- and tri-planes, a separate measurement for each wing can be entered. For bi-planes use "upper" and "lower". For tri-planes use "upper", "mid", and "lower". If the spans are equal, use {{para|span=}} instead.{{Why?|date=May 2019|reason=If it has two wings, it should be documented, even if they are the same size.}}: 
** {{para|upper span ft}} and {{para|upper span in}}
** {{para|mid span ft}} and {{para|mid span in}}
** {{para|lower span ft}} and {{para|lower span in}}
* {{para|swept m}} and/or
* {{para|swept f}} and {{para|swept in}} – the swept wingspan on variable-geometry fixed-wing aircraft
* {{para|dia}} – the diameter of an aircraft where this is the best way to describe it. This will most often be used for describing airships and balloons, but will also make sense for disc-shaped (Example: [[VZ-1 Pawnee]], [[Avro Avrocar]]) or cylindrical (Example: [[SNECMA Coléoptère]]) heavier-than-air aircraft. Please do not use this to express a fuselage diameter of a conventional heavier-than-air aircraft – mention that in the article text if it's relevant.
* {{para|width}} – the width of an aircraft in the few very rare cases where this is the best way to describe it (example: [[Rolls-Royce Thrust Measuring Rig]], [[LLRV]])
* {{para|height}} – the overall height of an aircraft, landing gear extended
* {{para|wing area}} – the area of the mainplanes of a fixed-wing aircraft. This excludes the area of horizontal stabiliser or canards. For biplanes, triplanes, and multiplanes, this is the sum of all mainplane areas. For variable-geometry aircraft, this is the unswept area 
* {{para|swept area}} – for variable-geometry aircraft where the mainplane area differs depending on whether the wings are swept or not.
* {{para|volume}} – the envelope volume of a lighter-than-air or hybrid aircraft. Please do not use this to express the volume of a cargo space – put that under "capacity" if it's relevant.
* {{para|aspect ratio}} – the ratio of the length of a wing to its chord. While measurable in any fixed-wing aircraft, please only provide this specification when describing sailplanes or for aircraft where this is an important parameter. This can also be used for ''root'', ''tip'', and ''mid'' point information.
* {{para|airfoil}} – For fixed wing aircraft, the type of airfoil the wing uses, e.g. see [[NACA airfoil]] for information on airfoil types.
* {{para|empty weight}} – the unloaded, unfuelled, unoccupied weight of the aircraft. In most cases, this will be the Basic Aircraft Empty Weight. For lighter-than-air or hybrid aircraft, this will be the structural weight of the aircraft. 
* {{para|gross weight}} – the fully-loaded weight of the aircraft. In most cases, this will be the Maximum Take Off Weight.
* {{para|max takeoff weight}} – the maximum takeoff weight of the aircraft, when different from the above gross weight.
* {{para|fuel capacity}} – description of fuel capacity.
* {{para|lift}} – the static lift of a lighter-than-air or hybrid aircraft. Please do not use this to describe dynamic lift.
* {{para|more general}} – A place to put anything relevant not included already under the general parameters e.g. "Fuel Capacity: 500 gallons"

===Engines===
At present, the template allows for up to three different types of engines on an aircraft. Typically, this will be used for mixed-power aircraft with piston-engines and jets, or jets and rockets, but occasionally an aircraft will be fitted with more than one type of piston engine. Please do not use this for APUs, or for alternative engine fits. 

* {{para|eng number}} – the number of this type of engine, expressed with a digit
* {{para|eng name}} – the manufacturer and model of the engine. You need to specify something here otherwise nothing will be shown. Please make sure to wikilink this to the engine article. Please do not simply link to the engine manufacturer to avoid a redlink here. Redlinks are good! They help us grow! Example: {{para|eng1 name|[[Pratt & Whitney R-4360]]-53 "Wasp Major"}}.
* {{para|eng type}} – Examples: {{para|eng1 type|liquid-cooled [[V12 engine]]}}, {{para|eng2 type|[[turboprop]]}}, {{para|eng3 type|[[radial engine]]}}.
* {{para|eng kw}}, {{para|eng hp}} and {{para|eng shp}} – the rated power of a propeller engine (whether piston or turbine-driven)
* {{para|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: {{para|power original|Originally measured as 15,000 [[Pferdestärke|PS]].}}
* {{para|eng kn}} and {{para|eng lbf}} – the rated dry thrust of a jet or rocket engine
* {{para|thrust original}}{{Snd}} Some jet or rocket engines had their original measurements taken in unconventional units.  For example, many Russian and Soviet engines were originally rated using [[kilogram-force]].
* {{para|eng kn-ab}} and {{para|eng lbf-ab}} – the afterburning thrust of a jet engine so equipped.
* {{para|eng note}} – a note that appears after the thrust value. Use this for when data does not fit in the other parameters e.g. expressing a range of power value.
* {{para|prop blade number}} – the number of propellers on a propeller aircraft. 
* {{para|prop name}} – description of the propellers. 
* {{para|prop dia m}}, {{para|prop dia ft}}, and {{para|prop dia in}} – the diameter of the propeller(s)
* {{para|prop dia note}} – a note that appears after the propeller value. Use this for when data does not fit in the other parameters e.g. expressing a range of values.
* {{para|rot number}} – the number of main (lifting) rotors on a rotary-wing aircraft. This will only be displayed if the number is greater than 1
* {{para|rot dia}} – the diameter of the main (lifting) rotor(s) on a rotary-wing aircraft
* {{para|rot area}} – the area of the main (lifting) rotor(s) of a rotary-wing aircraft. For multi-rotor aircraft, this is the sum of all rotor areas.
* {{para|more power}} – A place to put anything relevant not included already under the engine parameters

===Performance===
* {{para|perfhide}} – allows the "Performance" heading to be manually turned off in the rare case that none of the data in this section is available. Enter <code>|perfhide=Y</code> to do this. If using this parameter, please leave a hidden note so that other editors will know to remove this line to turn the heading back on again. 
** Example: {{para|perfhide|Y}} <!-- please remove this line if performance data becomes available -->
* {{para|max speed}} – the maximum speed of the aircraft
* {{para|cruise speed}} – the maximum cruising speed of the aircraft (usually only specified where the maximum speed is unknown)
* {{para|stall speed}} – the stall speed of the aircraft
* {{para|never exceed speed}} – never exceed speed ([[Vne]]) of the aircraft
* {{para|minimum control speed kmh}} – minimum control speed ([[V speeds#VMC|VMC]]) of the aircraft
* {{para|range}} – the maximum unrefuelled range of the aircraft
* {{para|combat range}} – the maximum range of the aircraft loaded for combat
* {{para|ferry range}} – the maximum range of the aircraft with ferry fuel
* {{para|endurance}} – the maximum flight endurance of the aircraft, where the range is unknown (this is particularly common in specifications of early aircraft).
* {{para|ceiling}} – the service ceiling of the aircraft
* {{para|glide ratio}} – the maximum glide ratio of an aircraft. Please only include this specification when describing gliders and sailplanes.
* {{para|climb rate}} – the maximum rate of climb for a powered aircraft
* {{para|time to altitude}} – ''referenced'' time to climb to altitude, usually in "minutes to x thousand feet"
* {{para|sink rate}} – the minimum rate of sink for an aircraft. Please only include this specification when describing gliders and sailplanes.
* {{para|lift to drag}} – the [[lift-to-drag ratio]]. A unitless number.
* {{para|wing loading}} – the loaded weight of the aircraft divided by the area of the wing.
* {{para|disk loading}} – the loaded weight of the aircraft divided by the area of the rotor.
* {{para|fuel consumption}} – fuel burn (kg/km or lb/mi).
* {{para|avionics}} – a place to put any specific avionics used.
* {{para|power/mass}} – the power to weight ratio
* {{para|thrust/weight}} – the thrust to weight ratio - dimensionless

Note: calculating these from other values is considered OR, these should therefore quoted from a source

* {{para|more performance}} – A place to put anything relevant not included already under the performance parameters

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

* {{para|guns}}
* {{para|bombs}}
* {{para|rockets}}
* {{para|missiles}}
* {{para|hardpoints}} – to specify the number of hardpoints
* {{para|hardpoint capacity}} – to specify the capacity of hardpoints (e.g. as total payload), and the following to specify the types of hardpoint weapons:
** {{para|hardpoint rockets}}
** {{para|hardpoint missiles}}
** {{para|hardpoint bombs}}
** {{para|hardpoint other}}
* {{para|other armament}} – for other armament

=== Rounding and significant figures ===
By default, the template will round the result of any measurement unit conversions.  The default precision is such that the converted (output) value has approximately the same number of significant figures as the unconverted (input) value.  To override the significant figures, use {{para|measurement sigfig}} where <code>measurement</code> is the measurement being converted.  For example, for {{para|length m}} or {{para|length ft}}, {{para|length sigfig|3}} would set the significant figures to three.  This only applies to converted values, and has no effect if the measurement is given in both units (typically not recommended).

==Troubleshooting==
===Missing entries===
Make sure you have used [[#prime-units|{{para|prime units?}}]] parameter. See also {{oldid2|1078427256#Missing_fields|this discussion}}.

==Tracking categories==
* {{Category link with count|Pages using aircraft specs with unknown parameters}}
* {{Category link with count|Aircraft specs templates hiding gen section}}
* {{Category link with count|Aircraft specs templates hiding performance section}}
* {{Category link with count|Aircraft specs templates using afterburner without dry parameter}}
* {{Category link with count|Aircraft specs templates using improper note parameter}}
* {{Category link with count|Aircraft specs templates using more general parameter}}
* {{Category link with count|Aircraft specs templates using more performance parameter}}
* {{Category link with count|Aircraft specs templates using more power parameter}}
<noinclude>[[Category:WikiProject Aviation template instructions|Infobox Aircraft]]</noinclude>
<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Aircraft specs templates| ]]
[[Category:Aircraft templates]]
[[Category:Templates that add a tracking category]]
}} }}</includeonly>
<templatedata>
{
	"params": {
		"ref": {},
		"genhide": {},
		"crew": {},
		"crew note": {},
		"capacity": {},
		"capacity note": {},
		"prime units?": {},
		"length m": {},
		"length ft": {},
		"length in": {},
		"length note": {},
		"length sigfig": {},
		"span m": {},
		"span ft": {},
		"span in": {},
		"span note": {},
		"span sigfig": {},
		"upper span m": {},
		"upper span ft": {},
		"upper span in": {},
		"upper span note": {},
		"upper span sigfig": {},
		"mid span m": {},
		"mid span ft": {},
		"mid span in": {},
		"mid span note": {},
		"mid span sigfig": {},
		"lower span m": {},
		"lower span ft": {},
		"lower span in": {},
		"lower span note": {},
		"lower span sigfig": {},
		"swept m": {},
		"swept ft": {},
		"swept in": {},
		"swept note": {},
		"swept sigfig": {},
		"dia m": {},
		"dia ft": {},
		"dia in": {},
		"dia note": {},
		"dia sigfig": {},
		"width m": {},
		"width ft": {},
		"width in": {},
		"width note": {},
		"width sigfig": {},
		"height m": {},
		"height ft": {},
		"height in": {},
		"height note": {},
		"height sigfig": {},
		"wing area sqm": {},
		"wing area sqft": {},
		"wing area note": {},
		"wing area sigfig": {},
		"swept area sqm": {},
		"swept area sqft": {},
		"swept area note": {},
		"swept area sigfig": {},
		"volume m3": {},
		"volume ft3": {},
		"volume note": {},
		"volume sigfig": {},
		"aspect ratio": {},
		"aspect ratio note": {},
		"airfoil": {},
		"airfoil note": {},
		"empty weight kg": {},
		"empty weight lb": {},
		"empty weight note": {},
		"empty weight sigfig": {},
		"gross weight kg": {},
		"gross weight lb": {},
		"gross weight note": {},
		"gross weight sigfig": {},
		"max takeoff weight kg": {},
		"max takeoff weight lb": {},
		"max takeoff weight note": {},
		"max takeoff weight sigfig": {},
		"fuel capacity": {},
		"fuel capacity note": {},
		"lift kg": {},
		"lift lb": {},
		"lift note": {},
		"lift sigfig": {},
		"more general": {},
		"eng1 number": {},
		"eng1 name": {},
		"eng1 type": {},
		"eng1 hp": {},
		"eng1 lbf": {},
		"eng1 kw": {},
		"eng1 kn": {},
		"eng1 shp": {},
		"eng1 lbf-ab": {},
		"eng1 kn-ab": {},
		"power original": {},
		"thrust original": {},
		"eng1 note": {},
		"eng1 sigfig": {},
		"eng2 number": {},
		"eng2 name": {},
		"eng2 type": {},
		"eng2 hp": {},
		"eng2 lbf": {},
		"eng2 kw": {},
		"eng2 kn": {},
		"eng2 shp": {},
		"eng2 lbf-ab": {},
		"eng2 kn-ab": {},
		"eng2 note": {},
		"eng2 sigfig": {},
		"eng3 number": {},
		"eng3 name": {},
		"eng3 type": {},
		"eng3 hp": {},
		"eng3 lbf": {},
		"eng3 kw": {},
		"eng3 kn": {},
		"eng3 shp": {},
		"eng3 lbf-ab": {},
		"eng3 kn-ab": {},
		"eng3 note": {},
		"eng3 sigfig": {},
		"rot number": {},
		"rot dia m": {},
		"rot dia ft": {},
		"rot dia in": {},
		"rot dia note": {},
		"rot dia sigfig": {},
		"rot area sqm": {},
		"rot area sqft": {},
		"rot area note": {},
		"rot area sigfig": {},
		"prop blade number": {},
		"prop name": {},
		"prop dia m": {},
		"prop dia ft": {},
		"prop dia in": {},
		"prop dia note": {},
		"prop dia sigfig": {},
		"more power": {},
		"perfhide": {},
		"max speed kmh": {},
		"max speed mph": {},
		"max speed kts": {},
		"max speed note": {},
		"max speed sigfig": {},
		"max speed mach": {},
		"max speed mach note": {},
		"cruise speed kmh": {},
		"cruise speed mph": {},
		"cruise speed kts": {},
		"cruise speed note": {},
		"cruise speed sigfig": {},
		"stall speed kmh": {},
		"stall speed mph": {},
		"stall speed kts": {},
		"stall speed note": {},
		"stall speed sigfig": {},
		"never exceed speed kmh": {},
		"never exceed speed mph": {},
		"never exceed speed kts": {},
		"never exceed speed note": {},
		"never exceed speed sigfig": {},
		"minimum control speed kmh": {},
		"minimum control speed mph": {},
		"minimum control speed kts": {},
		"minimum control speed note": {},
		"minimum control speed sigfig": {},
		"range km": {},
		"range mi": {},
		"range miles": {},
		"range nmi": {},
		"range note": {},
		"range sigfig": {},
		"combat range km": {},
		"combat range miles": {},
		"combat range mi": {},
		"combat range nmi": {},
		"combat range note": {},
		"combat range sigfig": {},
		"ferry range km": {},
		"ferry range mi": {},
		"ferry range miles": {},
		"ferry range nmi": {},
		"ferry range note": {},
		"ferry range sigfig": {},
		"endurance": {},
		"endurance note": {},
		"ceiling m": {},
		"ceiling ft": {},
		"ceiling note": {},
		"ceiling sigfig": {},
		"g limits": {},
		"g limits note": {},
		"roll rate": {},
		"roll rate note": {},
		"glide ratio": {},
		"glide ratio note": {},
		"climb rate ms": {},
		"climb rate ftmin": {},
		"climb rate note": {},
		"climb rate sigfig": {},
		"time to altitude": {},
		"time to altitude note": {},
		"sink rate ms": {},
		"sink rate ftmin": {},
		"sink rate note": {},
		"sink rate sigfig": {},
		"lift to drag": {},
		"lift to drag note": {},
		"wing loading kg/m2": {},
		"wing loading lb/sqft": {},
		"wing loading note": {},
		"wing loading sigfig": {},
		"disk loading kg/m2": {},
		"disk loading lb/sqft": {},
		"disk loading note": {},
		"disk loading sigfig": {},
		"fuel consumption kg/km": {},
		"fuel consumption lb/mi": {},
		"fuel consumption note": {},
		"fuel consumption sigfig": {},
		"power/mass": {},
		"power/mass note": {},
		"thrust/weight": {},
		"thrust/weight note": {},
		"more performance": {},
		"armament": {},
		"guns": {},
		"bombs": {},
		"missiles": {},
		"rockets": {},
		"hardpoints": {},
		"armament header": {},
		"hardpoint capacity": {},
		"hardpoint rockets": {},
		"hardpoint missiles": {},
		"hardpoint bombs": {},
		"hardpoint other": {},
		"other armament": {},
		"avionics": {},
		"avionics header": {}
	}
}
</templatedata>