Template:Aircraft specs/doc

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

Usage

Please test any changes in the template's /sandbox or /testcases subpages, or in a user subpage, and consider discussing changes on the appropriate pages before implementing them. 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 employs intricate features of template syntax.

You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages.
Remember that you can conduct experiments, and should test all improvements, in either the general Template sandbox or your user space before changing anything here.

Aircraft specs

This template displays aircraft specifications, automatically formatted and converted for either metric or imperial units.

Due to the use of the {{convert}} template, entries must not include commas. For example |empty weight=11280 not |empty weight=11,280!

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 |range miles=420 and |range note=with max wing fuel, VTOL, & 10% reserves. Some parameters (i.e. |crew=) will display any text entered and do not require the use of notes.

Syntax

Template: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:

|ref= allows for the data in this section to be specifically sourced.

|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.

you must include imp, kts, or met in this field or the template won't display at all!

|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 |genhide=Y 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

|genhide=Y

|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.

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

|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)

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

|length= – the overall length of the airframe. For rotary-wing aircraft, this is the fuselage length, not counting areas swept by turning rotors.

|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:
|upper span m=, |mid span m=, |lower span m= and/or
One or more of these pairs:
|upper span ft= and |upper span in=,
|mid span ft= and |mid span in=,
|lower span ft= and |lower span in= –
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 |span= instead.^[why?]

|swept m= and/or
|swept ft= and |swept in= –
the swept wingspan on variable-geometry fixed-wing aircraft

|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.

|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)

|height= – the overall height of an aircraft, landing gear extended

|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

|swept area= – for variable-geometry aircraft where the mainplane area differs depending on whether the wings are swept or not.

|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.

|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.

|airfoil= - For fixed wing aircraft, the type of airfoil the wing uses. E.g., see NACA airfoil for information on airfoil types.

|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.

|gross weight= - the fully-loaded weight of the aircraft. In most cases, this will be the Maximum Take Off Weight.

|max takeoff weight= - the max takeoff weight of the aircraft, when different from the above gross weight.

|fuel capacity= - description of fuel capacity.

|lift= - the static lift of a lighter-than-air or hybrid aircraft. Please do not use this to describe dynamic lift.

|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.

|eng number= – the number of this type of engine, expressed with a digit

|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: |eng1 name=[[Pratt & Whitney R-4360]]-53 "Wasp Major".

|eng type= – Examples: |eng1 type=liquid-cooled [[V12 engine]], |eng2 type=[[turboprop]], |eng3 type=[[radial engine]].

|eng kw=, |eng hp= and |eng shp= – the rated power of a propeller engine (whether piston or turbine-driven)

|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]].

|eng kn= and |eng lbf= – the rated dry thrust of a jet or rocket engine

|thrust original= – 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.

|eng kn-ab= and |eng lbf-ab= – the afterburning thrust of a jet engine so equipped.

|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.

|prop blade number= – the number of propellers on a propeller aircraft.

|prop name= – description of the propellers.

|prop dia m=, |prop dia ft=, and |prop dia in= – the diameter of the propeller(s)

|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.

|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

|rot dia= – the diameter of the main (lifting) rotor(s) on a rotary-wing aircraft

|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.

|more power= – A place to put anything relevant not included already under the engine parameters

Performance

|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 |perfhide=Y 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

|perfhide=Y

|max speed= – the maximum speed of the aircraft

|cruise speed= – the maximum cruising speed of the aircraft (usually only specified where the maximum speed is unknown)

|stall speed= – the stall speed of the aircraft

|never exceed speed= – never exceed speed (Vne) of the aircraft

|minimum control speed kmh= – minimum control speed (VMC) of the aircraft

|range= – the maximum unrefuelled range of the aircraft

|combat range= – the maximum range of the aircraft loaded for combat

|ferry range= – the maximum range of the aircraft with ferry fuel

|endurance= – the maximum flight endurance of the aircraft, where the range is unknown (this is particularly common in specifications of early aircraft).

|ceiling= – the service ceiling of the aircraft

|glide ratio= – the maximum glide ratio of an aircraft. Please only include this specification when describing gliders and sailplanes.

|climb rate= – the maximum rate of climb for a powered aircraft

|time to altitude= - referenced time to climb to altitude, usually in "minutes to x thousand feet"

|sink rate= – the minimum rate of sink for an aircraft. Please only include this specification when describing gliders and sailplanes.

|lift to drag= – the Lift-to-drag ratio. A unitless number.

|wing loading= – the loaded weight of the aircraft divided by the area of the wing.

|disk loading= – the loaded weight of the aircraft divided by the area of the rotor.

|fuel consumption= – fuel burn (kg/km or lb/mi).

|avionics= – a place to put any specific avionics used.

|power/mass= - the power to weight ratio

|thrust/weight= - the thrust to weight ratio - dimensionless

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

|more performance= – A place to put anything relevant not included already under the performance parameters

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.

|hardpoint rockets=

|hardpoint missiles=

|hardpoint bombs=

|hardpoint other=

to specify the types of hardpoint weapons

|other armament= for other armament

Tracking categories

Category:Aircraft spec cleanup