Difference between revisions of "Catalog metadata"
(→Related content: +link: Hangar catalog)
|Line 217:||Line 217:|
* [[Aircraft rating system]]
* [[Aircraft rating system]]
* [[Simplifying Aircraft Deployment]]
* [[Simplifying Aircraft Deployment]]
Revision as of 11:08, 15 April 2019
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’s a suitable ‘long' description
- adding / updating ratings
- ensuring variant / 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. James's proposal is to post about this on the forum, and ask for volunteers to pick aircraft, and submit patches / updates to myself and some other willing reviewers (Stuart has also volunteered as reviewer, 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’m 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’s some criteria on the wiki from the last time we did this?) (There’s 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’s still very beneficial to the launcher to have some meta-data about how aircraft are used) 
The overall aim is to support a decentralized development system with the only central point being the aircraft package manager for end users. . 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. 
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. 
The catalog is just an XML file, and the other files needed are the thumbnail images for each package, and the package .zips themselves; the system is deliberately designed to be host-able 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. 
|Note Please do not extend this list without discussion and agreement.|
The tags are translation / 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/catalog/catalogTags.py
Tags are designed to be inclusive, not exclusive, to give the broadest range of search results. If multiple tags apply, use them - for example the DC-3 has had multiple civilian and military roles.
- glider - But does this includes the Space Shuttle, Virgin Galactic's SpaceShipeOne, as well?
- bizjet - Not just for jets, but I can't think of a better term
- trainer - Used in a pilot training role
Intention here is to provide logical groupings, not to track corporate history - so the MD-80 and MD-11 would get the 'douglas' tag, which will likely translate to 'Douglas / McDonell-Douglas' in the UI. The 717 could get the boeing and douglas tags. Also not supposed to be an exhaustive list, this is so we can search on 'all glass-cockpit Boeing and Airbus aircraft'. It might be worth actively lying in the tags, i.e group all Hawker-Siddley / BAC / Avro aircraft under the Vickers tag.
Logical groupings, not historical accuracy - some aircraft are going to have a lot of these, e.g. the B-52. Again the goal is intelligent searches: 'show me all WW2 fighters'. Would like to avoid this getting political too, comments on that are welcome
This could get long, as always trying to focus on tags people might search on - '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 (not for amphibious obviously).
- experimental - For X1 and similar X-planes
- ifr - Panel and equipment (radios, lighting) suitable for IFR flight
- carrier-hook - Do we need a separate tag for carrier-capable?
- stol - For short-takeoff
- vtol - For the Harrier, F-35 if it ever works, and the Osprey
- canard - Canard planform
- delta - Delta planform; Vulcan, Concorde, Space Shuttle
- variable-geometry - For Tomcats and the like
- refuel - Supports air-to-air refeuling
- seaplane - Flying boat or float plane
- etops - ETOPS capable aircraft, presumably implies twin-engined
- pressurised - Pressurised cabin
- wing-fold - usually for carrier aircraft
- 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
- radial - Radial piston engined
- turbocharged - For pistons with a turbo-charger
- electric - For power-assisted gliders, mostly.
- unpowered - Balloons, etc
- B-52 would have: bomber, jet. boeing, coldwar, 1960s, vietnam, 1970s, 1980s, gulfwar1, nato, refuel, retractable-gear, ifr
- Citation would have: cessna, bizjet, jet, 2-engine, glass-cockpit, ifr, retractable-gear
- Cub would have: piper, piston, 1-engine, ga, trainer, fixed-gear, 1930s, ww2, tail-dragger
Adding metadata to aircraft
The tags are added to or included into the sim section of the -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>
- James Turner (Feb 26th, 2017). [Flightgear-devel] Improving FGaddon aircraft meta-data .
- James Turner (2015-02-13). Re: [Flightgear-devel] FGDATA split without Aircraft. Addon in SVN. (re)Suggesting a Submodule approach. (Re)Proposing a.
- James Turner (2015-03-11). Re: [Flightgear-devel] FGDATA and Jenkins .
- James Turner (2015-03-06). Re: [Flightgear-devel] FGData size reduction .
- James Turner (2015-03-11). Re: [Flightgear-devel] FGDATA and Jenkins.