Template:Infobox avionics/doc

From Wikipedia, the free encyclopedia
Jump to navigation Jump to search
{{{name}}}
{{{type}}}
[[File:{{{image}}}|350px|alt={{{alt}}}]] {{{caption}}}
Project name{{{PROJECT}}}
Status{{{status}}}
Manufacturing Info
Designer(s){{{designer}}}
Manufacturer(s){{{manufacturer}}}
Inventor(s){{{inventor}}}
Introduced{{{introdate}}}
Production period{{{years-produced}}}
No. produced{{{number}}}
Developed from{{{developed-from}}}
Specifications
Frequency Range{{{frequency-range}}}
Height{{{height}}}
Width{{{width}}}
Length{{{length}}}
Diameter{{{diameter}}}
Weight{{{weight}}}
Operating temperature{{{operating-temp}}}
Input voltage{{{input-voltage}}}
Input current{{{input-current}}}
Usage
Used by country{{{used-by-country}}}
Used by military{{{used-by-military}}}
Platform(s){{{used-by-aircraft}}}
Variants{{{variants}}}

{{Infobox avionics}} standardizes an infobox presentation of attributes, called parameters, pertaining to a large variety of avionics equipment employed in/on aircraft worldwide.

Intended for all types of avionics equipment, this template is agnostic of the aircraft, purpose, use, or national origin of any given device. It is only meant to describe a single avionic device, but offers the ability to list other versions/models of the same device. It may be used to display general characteristics and features of the item, along with manufacturing details and history as appropriate.

Some parameters are only intended for specific classes of topic and are not recommended for use with the other kinds. For instance height/length/width dimensions might not be appropriate for a spherical device and so, should not be entered into the template.

Infobox avionics should NOT be used if another more specific infobox template would better serve the purpose.

Full syntax

[edit source]

Copy the list of parameters below into your avionics article (before the lead and after any article hatnotes), and fill in the appropriate parameters. To determine parameter usage and other details, please see the Parameters and Template Data sections below.

{{Infobox avionics
<!-- General Info -->
 | name             = <!-- REQUIRED -->
 | image            = <!-- Suggested -->
 | caption          = <!-- Suggested -->
 | alt              = <!-- Suggested -->
 | project          = 
 | type             = <!-- REQUIRED -->
<!-- Manufacture Info -->
 | manufacturer     = 
 | designer         = 
 | inventor         = 
 | status           = 
 | introdate        = 
 | years-produced   = 
 | number           = 
 | developed-from   = 
<!-- Specifications -->
 | height           = 
 | width            = 
 | length           = 
 | diameter         = 
 | weight           = 
 | operating-temp   = 
 | input-voltage    = 
 | input-current    = 
 | frequency-range  = 
<!-- Usage -->
 | used-by-aircraft = <!-- Suggested -->
 | used-by-country  = <!-- Suggested -->
 | used-by-military = 
 | variants         = 
}}

Parameters

[edit source]

Almost all parameters are optional and will accept Wikitext and/or imbedded templates like {{Plainlist}} or {{Convert}}. The name= and type= parameters are required. The image= parameter relies on the name of the image file, which cannot contain Wikitext or imbedded templates.

General information parameters

[edit source]
  • name: REQUIRED. Name or nomenclature of the equipment.
    • Note: If the name of the device matches the name of the wiki-article, it is possible to use {{PAGENAME}}. This method allows the name= parameter to automatically update in the case of an article move (renaming the article).
  • image: It is strongly recommended that an image of the device be added to the infobox if one exists. Image file name of the device in the format filename.xxx without 'File:' tag. Captions will appeared centered left-to-right within the infobox.
    • Note: The photo / image file may reside on either Wikipedia or on Commons, and simply using the filename will access the picture.
  • caption: Caption text appearing under the image. A short (one- or two-line) statement. If it isn't descriptive, then please skip it.
  • alt: Alternate text for the caption used for accessibility by visually impaired readers or other readers who cannot see the image. Please see WP:ALT for details.
    • Example: Picture of an IFF control unit in the cockpit instrument panel of a Boeing B-52 Stratofortress aircraft
  • project: The name of any "Project" related to the development or current use of this device (eg. Have Quick, or Pave Paws). Or, it might contain any alternative names for the particular device based on a "program name". Formatting will automatically CAPITALIZE the project name. But it is possible to add italic formatting, if desired.
    • Examples: SINCGARS, Pathfinder, Star SAFIRE, Big Eye, etc.
  • type: REQUIRED. Describes the general type of the device. Answers whether it is a radar, UHF radio, instrumentation, electronic countermeasures, terrain-following radar, altimeter, etc. It is recommended to use Wikitext when possible for this parameter, and it is possible to list multiple types if it is multi-functional.

Manufacturing parameters

[edit source]
  • manufacturer: Name of the manufacturer of this device. It may be multiple manufacturers, in which case use of {{Plainlist}} template is recommended.
    • Note: Sometimes, the manufacturing company is the same as the company that invented, designed or developed the device. In those cases, it is not recommended to also use the designer= or inventor= parameters. However, if others have also manufactured it after it was designed/invented by one company or person, it would then be perfectly acceptable to use those other parameters.
    • Example: Northrop Grumman
  • designer: Name of the person, company, division, agency, etc. that designed or engineered the device or led its design.
  • inventor: List all documented inventors here including person(s), company, division, agency, etc..
    • Note: If it is the same as designer= or manufacturer=, leave this field blank. But if Marie Curie was on a team of designers (see above example), and she was the sole inventor of the device, it is expected that her name should appear again here. Again, if it was a team of inventors, it is acceptable to list them here.
  • status: Many devices go through stages of development like proof of concept, flight testing, or pre-production. Once fielded, they may be in use, in service, retired, or obsolete, etc. Normally, a device does not have many statuses at once, so this parameter expects only one. This is a free-form unrestricted parameter, so just about any status type is acceptable.
    • Note: Do not list multiple statuses that include other models/versions of the device such as AN/ALR-20 in use, AN/ALR-20A flight testing, AN/ALR-20(V)1 proof of concept. This parameter is used in regard to the device which is the main focus of the article. However, if the ALR-20 and ALR-20A are both retired, and the ALR-20(V)1 is in service and that is mentioned in the article, it is acceptable to use In Service here, and maybe include an explanatory {{efn}} footnote.
  • introdate: Date this device was first introduced into service. Even if only the year is known, using {{Start date and age}} recommended.
    • Example: 1993; 33 years ago (1993)
  • years-produced: Range of years manufactured.
    • Example 1: 1972{{endash}}1989 produces 1972–1989
    • Example 2: Creatively using {{Age}} after the range might result in: 1972–1989 (17 years)
  • number: Number of complete units produced. Either total or list of units by period
    • Examples: 1,000 in 2024 or using {{Plainlist}} to list multiple production numbers like AN/ALR-20: 1,000 in 1972; AN/ALR-20A: 4,000 in 1975, AN/ALR-20(V)1: 3,000 in 2020, etc.
  • developed-from: Previous device that led to development of this device. Typically, this will only be one device.
    • Example: AN/ALR-32

Specification parameters

[edit source]

The definition for most of these values is self evident. Many of them work great with {{Convert}} or {{Cvt}}.

  • height: Describes the measure of height for this device.
  • width: Describes the measure of width for this device.
  • length: Describes the measure of length for this device.
  • diameter: Describes the measure of diameter for this device.
    • Examples: For each of the above measured units, an example might be:
      • 30 feet (9.1 m) or 30 ft (9.1 m)
      • 22 centimetres (8.7 in) or 22 cm (8.7 in)
  • weight: Describes the weight (aka. mass) for this device, usually expressed in pounds or kilograms.
    • 250 pounds (110 kg) or 110 kilograms (250 lb)
  • operating-temp: Operating temperature range. Use the {{Convert}} or {{Cvt}} template to describe the measure of operating temperature for this device.
    • Examples: −5 to 128 °F (−21 to 53 °C) or −5 to 128 °C (23 to 262 °F).
  • input-voltage: Answers what the input voltage, or electrical power, is required for this device to operate properly. Input voltage is not normally a multiple value, unless the device requires both DC and AC voltages, in which case using {{Plainlist}} is recommended for better readability.
    • Examples: 48 VDC, or 120 VAC, or 18 ±2 VDC.
    • Note: In special cases when the combined plus/minus (±) sign is needed, it is best to either use a cut-n-paste of the character from a good source or use ± to get the correct UNICODE character.
  • input-current: Input current required for proper operation of the device expressed in Amperes (A, mA, µA, etc).
    • Examples: 5 A or 1 mA
  • frequency-range: Operating frequency range for transmitters and/or receivers, or it may be expressed as a frequency band. It may be a single center operating frequency as many systems operate, or it may be a range of frequencies.
    • Examples:
      • Single frequency: 300 megahertz (1.00 m) or 300 MHz (1.00 m)
      • Range of frequencies: 2–20 GHz (15.0–1.5 cm) or 30 metres (10.0 MHz)
      • Frequency band designation: VHF, UHF, X-band, Ku-band, etc.

Device usage parameters

[edit source]

All of these parameters should make use of the {{Plainlist}} or {{Unbulleted list}} templates when multiple items exist. Using something like {{Flatlist}} usually leads to poor readability within infoboxes.

Strong note: Before adding national or military icons within any of the below infobox parameters, please become familiar with the proper use at Wikipedia:Manual of Style/Icons.

  • used-by-aircraft: List of aircraft where this device is or was installed.
  • used-by-country: List of countries that use or require this device. Use of the country flag templates, like {{USA}} are not recommended here, but not prohibited. If there are many items to list, consider using a wikilink to a section in the article called something like Operators.
  • used-by-military: List of militaries that use this device. Again, use of flag presentation templates like {{Navy}} or {{Air force}} are not recommended, but not prohibited. If there are many items to list, consider using a wikilink to a section in the article called something like Users.
  • variants: List variant names or nomenclatures. In the examples used above, this might be a {{Plainlist}} with entries for AN/ALR-20, AN/ALR-20A, AN/ALR-20(V), AN/ALR-20(V)1. If there are many items to list, consider using a wikilink to a section in the article called something like Variants.

Example

[edit source]
AN/APQ-120
Aircraft Fire Control Radar
Image of APQ-120 in the nose of F-4E Phantom II AN/APQ-120 in the nose of F-4E Phantom II
Project nameBIG EYE
StatusObsolete
Manufacturing Info
Designer(s)Bob Smith
Manufacturer(s)Westinghouse Electric
Inventor(s)Nicole Smith
IntroducedJanuary 1, 1971;
55 years ago
 (1971-01-01)
Production period1970–1979 (9 years)
No. produced6,000
Developed fromAN/APQ-117
Specifications
Frequency Range
  • 9.275–9.35 GHz (3.232–3.206 cm)
  • (I-Band)
Height19 in (48 cm)
Width12 in (30 cm)
Length18 in (46 cm)
Diameter12 in (30 cm)
Weight24.6 lb (11.2 kg)
Operating temperature
  • From −40 °F (−40 °C)
  • to 120 °F (49 °C)
Input voltage48 ±2 VDC
Input current5 A
Usage
Used by countryFile:Flag of the United States (23px).png United States
Used by military
Platform(s)
Variants
  • AN/APQ-120(V)
  • AN/APQ-120(V)1
  • AN/APQ-120A
  • AN/APQ-120B

The example {{Infobox avionics}} that appears on the right of this page is the result of the below dataset used:

{{Infobox avionics
| name             = AN/APQ-120
| image            = AN APQ-120 fire control radar in the nose of F-4E Phantom II.jpg
| caption          = AN/APQ-120 in the nose of [[F-4E Phantom II]]
| alt              = Image of APQ-120 in the nose of F-4E Phantom II
| project          = ''Big Eye''
| type             = Aircraft Fire Control Radar
| manufacturer     = [[Westinghouse Electric (1886)|Westinghouse Electric]]
| designer         = Bob Smith
| inventor         = Nicole Smith
| status           = Obsolete
| introdate        = {{Start date and age|1971|01|01|br=y}}
| years-produced   = 1970{{endash}}1979 ({{age|1970|1|1|1979|1|1}} years)
| number           = 6,000
| developed-from   = [[AN/APQ-117]]
| height           = {{cvt|19|in|cm}}
| width            = {{cvt|12|in|cm}}
| length           = {{cvt|18|in|cm}}
| diameter         = {{cvt|12|in|cm}}
| weight           = {{cvt|24.6|lb}}
| operating-temp   = {{Plainlist|
*From {{cvt|-40|F|C}}
*to {{cvt|120|F}}
}}
| input-voltage    = 48 &PlusMinus;2 VDC
| input-current    = 5 A
| frequency-range  = {{Plainlist|
*{{cvt|9.275-9.35|GHz|cm|lk=in}}
*([[I band (NATO)|I-Band]])
}}
| used-by-aircraft = {{Plainlist|
*[[F-4E Phantom II]]
*[[F-16 Fighting Falcon]]
*[[EF-111A Raven]]
}}
| used-by-country  = {{USA}}
| used-by-military = {{Plainlist|
*{{Air force|USA}}
*{{Navy|UK}}
}}
| variants         = {{Plainlist|
*AN/APQ-120(V)
*AN/APQ-120(V)1
*AN/APQ-120A
*AN/APQ-120B}}
}}

Template Data

[edit source]

To see uses and rules for each of the attributes in the {{Infobox avionics}}, expand the show link to the right of this bar.

  • Only "name" and "type" attributes are required. All others are optional.
  • The "image" attribute should contain a pertinent photo of the device without the File: syntax.
  • Almost all attributes may use wikitext or multiple imbedded templates.

Tracking categories

[edit source]

Microformat

[edit source]
[edit source]