Difference between revisions of "Catalog metadata"

From FlightGear wiki
Jump to: navigation, search
(Update link to catalog tag list)
(Update supported tags with latest catalogTags.py)
Line 56: Line 56:
  
 
=== Aircraft types ===
 
=== Aircraft types ===
 +
 +
* <code>aerobatic</code>
 +
* <code>airship</code>
 +
* <code>balloon</code>
 +
* <code>bizjet</code>
 +
* <code>bomber</code>
 +
* <code>cargo</code>
 +
* <code>carrier</code>
 +
* <code>fighter</code>
 
* <code>ga</code>
 
* <code>ga</code>
 +
* <code>glider</code>
 +
* <code>groundvehicle</code>
 
* <code>helicopter</code>
 
* <code>helicopter</code>
* <code>fighter</code>
 
 
* <code>interceptor</code>
 
* <code>interceptor</code>
* <code>glider</code> - But does this includes the Space Shuttle, Virgin Galactic's SpaceShipeOne, as well?
+
* <code>passenger</code>
 +
* <code>racer</code>
 
* <code>spaceship</code>
 
* <code>spaceship</code>
* <code>bomber</code>
 
 
* <code>tanker</code>
 
* <code>tanker</code>
* <code>cargo</code>
+
* <code>trainer</code>
 
* <code>transport</code>
 
* <code>transport</code>
* <code>bizjet</code> - Not just for jets, but I cant think of a better term
 
* <code>reconnaissance</code>
 
* <code>airship</code>
 
* <code>balloon</code>
 
* <code>trainer</code> - Used in a pilot training role
 
* <code>aerobatic</code>
 
 
* <code>ultralight</code>
 
* <code>ultralight</code>
 +
* <code>unpowered</code>
 +
* <code>uav</code>
 +
* <code>reconnaissance</code>
 +
* <code>seacraft</code>
 +
* <code>crop-duster</code>
 +
* <code>bush-plane</code>
  
 
=== Manufacturers ===
 
=== Manufacturers ===
Line 78: Line 88:
  
 
* <code>airbus</code>
 
* <code>airbus</code>
 +
* <code>antonov</code>
 +
* <code>arado</code>
 +
* <code>atr</code>
 
* <code>avro</code>
 
* <code>avro</code>
 +
* <code>bae</code>
 
* <code>bell</code>
 
* <code>bell</code>
 +
* <code>bleriot</code>
 
* <code>boeing</code>
 
* <code>boeing</code>
 
* <code>bombardier</code>
 
* <code>bombardier</code>
 +
* <code>caudron</code>
 
* <code>cessna</code>
 
* <code>cessna</code>
 +
* <code>consolidated</code>
 
* <code>dassault</code>
 
* <code>dassault</code>
 
* <code>diamond</code>
 
* <code>diamond</code>
 +
* <code>dornier</code>
 
* <code>douglas</code>
 
* <code>douglas</code>
 
* <code>embraer</code>
 
* <code>embraer</code>
Line 90: Line 108:
 
* <code>fairchild</code>
 
* <code>fairchild</code>
 
* <code>fairey</code>
 
* <code>fairey</code>
 +
* <code>focke-wulf</code>
 
* <code>fokker</code>
 
* <code>fokker</code>
 +
* <code>general-dynamics</code>
 +
* <code>gotha</code>
 
* <code>grumman</code>
 
* <code>grumman</code>
 +
* <code>handley-page</code>
 +
* <code>hawker</code>
 +
* <code>heinkel</code>
 +
* <code>ilyushin</code>
 +
* <code>junkers</code>
 +
* <code>kawasaki</code>
 
* <code>lockheed</code>
 
* <code>lockheed</code>
 +
* <code>mc-donnell-douglas</code>
 +
* <code>messerschmitt</code>
 +
* <code>mikoyan-gurevich</code>
 +
* <code>mitsubishi</code>
 +
* <code>north-american</code>
 +
* <code>northrop</code>
 
* <code>pilatus</code>
 
* <code>pilatus</code>
 
* <code>piper</code>
 
* <code>piper</code>
 +
* <code>republic</code>
 
* <code>robin</code>
 
* <code>robin</code>
 +
* <code>rockwell</code>
 +
* <code>saab</code>
 +
* <code>short</code>
 +
* <code>sopwith</code>
 +
* <code>spad</code>
 +
* <code>sukhoi</code>
 +
* <code>supermarine</code>
 +
* <code>tupolev</code>
 
* <code>vickers</code>
 
* <code>vickers</code>
 
* <code>vought</code>
 
* <code>vought</code>
 +
* <code>wright</code>
 +
* <code>yakovlev</code>
 +
  
 
=== Eras ===
 
=== Eras ===
Line 125: Line 170:
 
This could get long, as always trying to focus on tags people might search for, for example: "show me all the VTOL aircraft" or "show me all the biplanes". Some will be very useful in improving the user experience; If the plane is tagged with seaplane we might be able to force a water start (but not for amphibious aircraft obviously).
 
This could get long, as always trying to focus on tags people might search for, for example: "show me all the VTOL aircraft" or "show me all the biplanes". Some will be very useful in improving the user experience; If the plane is tagged with seaplane we might be able to force a water start (but not for amphibious aircraft obviously).
  
* <code>prototype</code>
+
* <code>aerobatic</code>
* <code>experimental</code> - For X1 and similar X-planes
+
* <code>airship</code>
* <code>ifr</code> - Panel and equipment (radios, lighting) suitable for IFR flight
+
* <code>fixed-gear</code>
+
* <code>retractable-gear</code>
+
* <code>tail-dragger</code>
+
* <code>carrier-hook</code> - Do we need a separate tag for carrier-capable?
+
* <code>stol</code> - For short-takeoff
+
* <code>vtol</code> - For the Harrier, F-35 if it ever works, and the Osprey
+
* <code>floats</code>
+
 
* <code>amphibious</code>
 
* <code>amphibious</code>
 +
* <code>biplane</code>
 
* <code>canard</code> - Canard planform
 
* <code>canard</code> - Canard planform
 +
* <code>castering-wheel</code>
 +
* <code>combat</code>
 
* <code>delta</code> - Delta planform; Vulcan, Concorde, Space Shuttle
 
* <code>delta</code> - Delta planform; Vulcan, Concorde, Space Shuttle
* <code>variable-geometry</code> - For Tomcats and the like
+
* <code>etops</code> - ETOPS capable aircraft, presumably implies twin-engined
* <code>supersonic</code>
+
* <code>experimental</code> - For X1 and similar X-planes
 +
* <code>fictional</code>
 +
* <code>fixed-gear</code>
 +
* <code>floats</code>
 
* <code>glass-cockpit</code>
 
* <code>glass-cockpit</code>
 +
* <code>low-wing</code>
 +
* <code>mid-wing</code>
 +
* <code>high-wing</code>
 +
* <code>h-tail</code>
 +
* <code>hud</code>
 +
* <code>ifr</code> - Panel and equipment (radios, lighting) suitable for IFR flight
 +
* <code>lifting-body</code>
 +
* <code>pressurised</code> - Pressurised cabin
 +
* <code>prototype</code>
 
* <code>refuel</code> - Supports air-to-air refeuling
 
* <code>refuel</code> - Supports air-to-air refeuling
 +
* <code>retractable-gear</code>
 
* <code>seaplane</code> - Flying boat or float plane
 
* <code>seaplane</code> - Flying boat or float plane
* <code>etops</code> - ETOPS capable aircraft, presumably implies twin-engined
+
* <code>skis</code>
* <code>biplane</code>
+
* <code>stol</code> - For short-takeoff
 +
* <code>supersonic</code>
 +
* <code>supercharger</code>
 +
* <code>t-tail</code>
 +
* <code>tail-dragger</code>
 +
* <code>tricycle</code>
 +
* <code>tail-hook</code>
 
* <code>triplane</code>
 
* <code>triplane</code>
* <code>pressurised</code> - Pressurised cabin
+
* <code>twin-boom</code>
 +
* <code>v-tail</code>
 +
* <code>variable-geometry</code> - For Tomcats and the like
 +
* <code>vtol</code> - For the Harrier, F-35, and the Osprey
 
* <code>wing-fold</code> - usually for carrier aircraft
 
* <code>wing-fold</code> - usually for carrier aircraft
 +
* <code>water-drop</code>
  
 
=== FlightGear Features ===
 
=== FlightGear Features ===
Line 156: Line 219:
  
 
=== Propulsion ===
 
=== Propulsion ===
* <code>piston</code>
+
* <code>afterburner</code>
* <code>radial</code> - Radial piston engined
+
 
* <code>diesel</code>
 
* <code>diesel</code>
 +
* <code>electric</code> - For power-assisted gliders, mostly.
 
* <code>jet</code>
 
* <code>jet</code>
* <code>turboprop</code>
+
* <code>propeller</code>
* <code>1-engine</code>
+
* <code>piston</code>
* <code>2-engine</code>
+
* <code>radial</code> - Radial piston engined
* <code>3-engine</code>
+
* <code>4-engine</code>
+
* <code>turbocharged</code> - For pistons with a turbo-charger
+
* <code>afterburner</code>
+
 
* <code>rocket</code>
 
* <code>rocket</code>
* <code>electric</code> - For power-assisted gliders, mostly.
+
* <code>single-engine</code>
* <code>unpowered</code> - Balloons, etc
+
* <code>supercharged</code>
 +
* <code>turboprop</code> - For pistons with a turbo-charger
 +
* <code>twin-engine</code>
 +
* <code>four-engine</code>
 +
* <code>variable-pitch</code>
 +
* <code>fixed-pitch</code>
  
 
== Examples ==
 
== Examples ==

Revision as of 15:29, 16 August 2020

Tags with catalog metadata can be added to aircraft to help searching and filtering them, for example in the launcher or future versions of the aircraft center, so that a user can quicker find the aircraft of interest.

Status/news

Now that James has merged the preview and splash screen changes, he wants to start a concerted effort to improve the metadata of all the aircraft in FGaddon. This means:

  • Ensuring there is a suitable "long" description
  • Adding or updating ratings
  • Ensuring variant or primary info is correct
  • Ideally adapting to the new preview/splash system (but not required)
  • Adding metadata tags, for better searching/usability the future

All of these are intended to help users browsing the aircraft, via the launcher or other methods. The proposal by James is to post about this on the forum, and ask for volunteers to pick aircraft, and submit patches or updates to myself and some other willing reviewers (Stuart has also volunteered as reviewer, but more people are welcome). Aside form ensuring high quality, we also need to ensure that aircraft maintainers are given the opportunity to update their own aircraft. Any co-volunteers to manage the process, and especially suggestions on how to manage this in a way that is friendly towards aircraft maintainers, but also gives a reasonable chance that 90% of aircraft in FGaddon have up to date metatdata by the next release, are welcome. I am sure we will have the usual debate on subjectivity of ratings, but, that’s another thing the reviewers will have to deal with. (James Turner suggested there is some criteria on the wiki from the last time we did this?) (There is a task on me to link the tagging system into the aircraft search, so that searching on "fighter" or "glass-cockpit" brings up appropriate matches. This tends to work out anyway when aircraft have a long-description text, but it is still very beneficial to the launcher to have some meta-data about how aircraft are used).[1]

Catalogs

The overall aim is to support a decentralized development system with the only central point being the aircraft package manager for end users.[2]. Users can simply add a hangar URL for FGUK, Lake of Constance or similar, and browse those aircraft within the launcher.

Most importantly we can improve the end-user browsing and discovery experience by enforcing some required meta-data, images and similar in the catalogs, and we can manage the install process so that users don’t get confused about where to move an aircraft file.[3]

FGMeta contains a create_catalog.py script which runs over FGAddon but could be used against another aircraft store containing multiple aircraft to generate a catalog used by the launcher in combination with a webhost to publish aircraft to users.[4]

The catalog is just an XML file, and the other files needed are the thumbnail images for each package, and the package Zip files themselves; The system is deliberately designed to be able to be hosted statically on any web provider. The create_catalog.py gives one example of creating a suitable catalog XML file, but any other approach is also valid.[5]

Supported Tags

Note  Please do not extend this list without discussion and agreement.

The tags are translation and search keys, not human-readable strings. Any additions or changes mean updated translation files. The catalog-generator script will reject aircraft with non-standard tags!

The definitive list of tags can be found here: https://sourceforge.net/p/flightgear/fgmeta/ci/next/tree/python3-flightgear/flightgear/meta/aircraft_catalogs/catalogTags.py Tags are designed to be inclusive, not exclusive, to give the broadest range of search results. If multiple tags apply, use them. The DC-3 for example have had multiple civilian and military roles.

Aircraft types

  • aerobatic
  • airship
  • balloon
  • bizjet
  • bomber
  • cargo
  • carrier
  • fighter
  • ga
  • glider
  • groundvehicle
  • helicopter
  • interceptor
  • passenger
  • racer
  • spaceship
  • tanker
  • trainer
  • transport
  • ultralight
  • unpowered
  • uav
  • reconnaissance
  • seacraft
  • crop-duster
  • bush-plane

Manufacturers

The intention here is to provide logical groupings, not to track corporate history. For example the MD-80 and MD-11 would get the douglas tag, which will likely translate to "Douglas / McDonell-Douglas" in the user interface. The Boeing 717 could get the boeing and douglas tags. Also it is not supposed to be an exhaustive list. This is so we for example can search for "all glass-cockpit Boeing and Airbus aircraft". It might be worth actively lying in the tags, in essence group all Hawker-Siddley/BAC/Avro aircraft under the vickers tag.

  • airbus
  • antonov
  • arado
  • atr
  • avro
  • bae
  • bell
  • bleriot
  • boeing
  • bombardier
  • caudron
  • cessna
  • consolidated
  • dassault
  • diamond
  • dornier
  • douglas
  • embraer
  • eurocopter
  • fairchild
  • fairey
  • focke-wulf
  • fokker
  • general-dynamics
  • gotha
  • grumman
  • handley-page
  • hawker
  • heinkel
  • ilyushin
  • junkers
  • kawasaki
  • lockheed
  • mc-donnell-douglas
  • messerschmitt
  • mikoyan-gurevich
  • mitsubishi
  • north-american
  • northrop
  • pilatus
  • piper
  • republic
  • robin
  • rockwell
  • saab
  • short
  • sopwith
  • spad
  • sukhoi
  • supermarine
  • tupolev
  • vickers
  • vought
  • wright
  • yakovlev


Eras

Logical groupings, not historical accuracy. Some aircraft are going to have a lot of these, for example the B-52. Again the goal is intelligent searches: "show me all WW2 fighters". Wee would like to avoid this getting political too and comments on that are welcome.

  • 1910s
  • 1920s
  • 1930s
  • 1940s
  • 1950s
  • 1960s
  • 1970s
  • 1980s
  • 1990s
  • 2000s
  • 2010s
  • coldwar
  • early-pioneers
  • golden-age
  • gulfwar1
  • gulfwar2
  • vietnam
  • ww1
  • ww2

Aircraft Features

This could get long, as always trying to focus on tags people might search for, for example: "show me all the VTOL aircraft" or "show me all the biplanes". Some will be very useful in improving the user experience; If the plane is tagged with seaplane we might be able to force a water start (but not for amphibious aircraft obviously).

  • aerobatic
  • airship
  • amphibious
  • biplane
  • canard - Canard planform
  • castering-wheel
  • combat
  • delta - Delta planform; Vulcan, Concorde, Space Shuttle
  • etops - ETOPS capable aircraft, presumably implies twin-engined
  • experimental - For X1 and similar X-planes
  • fictional
  • fixed-gear
  • floats
  • glass-cockpit
  • low-wing
  • mid-wing
  • high-wing
  • h-tail
  • hud
  • ifr - Panel and equipment (radios, lighting) suitable for IFR flight
  • lifting-body
  • pressurised - Pressurised cabin
  • prototype
  • refuel - Supports air-to-air refeuling
  • retractable-gear
  • seaplane - Flying boat or float plane
  • skis
  • stol - For short-takeoff
  • supersonic
  • supercharger
  • t-tail
  • tail-dragger
  • tricycle
  • tail-hook
  • triplane
  • twin-boom
  • v-tail
  • variable-geometry - For Tomcats and the like
  • vtol - For the Harrier, F-35, and the Osprey
  • wing-fold - usually for carrier aircraft
  • water-drop

FlightGear Features

  • combat - Support this various MP combat / bomb-able options
  • dual-controls - Supports copilot over MP
  • tow - Supports glider towing over MP
  • rembrandt - Supports Rembrandt, obviously

Propulsion

  • afterburner
  • diesel
  • electric - For power-assisted gliders, mostly.
  • jet
  • propeller
  • piston
  • radial - Radial piston engined
  • rocket
  • single-engine
  • supercharged
  • turboprop - For pistons with a turbo-charger
  • twin-engine
  • four-engine
  • variable-pitch
  • fixed-pitch

Examples

  • B-52 would have: bomber, jet, boeing, coldwar, 1960s, vietnam, 1970s, 1980s, gulfwar1, nato, refuel, retractable-gear and ifr.
  • Citation would have: cessna, bizjet, jet, 2-engine, glass-cockpit, ifr and retractable-gear.
  • Cub would have: piper, piston, 1-engine, ga, trainer, fixed-gear, 1930s, ww2 and tail-dragger.

Adding metadata to aircraft

The tags are added to or included into the <sim> section of the Aircraft-set.xml file(s), like for example below:

<?xml version="1.0" encoding="UTF-8" ?>

<PropertyList>

 <!-- ... -->

 <sim>

  <!-- ... -->

  <tags>
   <tag>passenger</tag>
   <tag>boeing</tag>
   <tag>jet</tag>
   <tag>twin-engine</tag>
   <tag>retractable-gear</tag>
   <tag>etops</tag>
   <tag>glass-cockpit</tag>
   <tag>ifr</tag>
  </tags>

  <!-- ... -->

 </sim>

 <!-- ... -->

</PropertyList>

References

  1. James Turner  (Feb 26th, 2017). [Flightgear-devel] Improving FGaddon aircraft meta-data .
  2. James Turner (2015-02-13). Re: [Flightgear-devel] FGDATA split without Aircraft. Addon in SVN. (re)Suggesting a Submodule approach. (Re)Proposing a.
  3. James Turner (2015-03-11). Re: [Flightgear-devel] FGDATA and Jenkins .
  4. James Turner (2015-03-06). Re: [Flightgear-devel] FGData size reduction .
  5. James Turner (2015-03-11). Re: [Flightgear-devel] FGDATA and Jenkins.

Related content

Wiki articles

Forum topics

Developer mailing list threads

Source code