Hangar catalog: Difference between revisions

From FlightGear wiki
Jump to navigation Jump to search
(Created a new page to document the catalog.xml file.)
 
(→‎Wiki articles: +-link: FlightGear hangars → FlightGear hangars#Third party sites, so that it point to directly to section with some hangars that have an catalog.xml file)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
In the FlightGear launcher, all the aircraft from the [[FGAddon|official FGAddon FlightGear hangar]] are displayed.  This is via the default ''catalog.xml'' file.  This will in the future be used for the in-sim Aircraft Center.  [[Flightgear hangars#Third party sites|3rd party hangars]] can also provide a catalog URL via their own ''catalog.xml'' file.
{{Package Management}}
The default '''hangar catalog''', <code>catalog.xml</code>, is used by the in-sim Aircraft Center to list all the aircraft of the [[FGAddon|official FGAddon FlightGear hangar]].  [[Flightgear hangars#Third party sites|3rd party hangars]] can also provide a catalog URL via their own <code>catalog.xml</code> file.


== Catalog generation ==
== Catalog generation ==
 
The <code>catalog.xml</code> file can be generated using the {{fgmeta source|path=catalog/update-catalog.py|text=update-catalog.py}} Python script.  Alongside the script is the <code>fgaddon-catalog/</code> directory, which is the configuration files used to generate the catalog for the [[FGAddon]] official hangar.  To generate the FGAddon catalog, as an example, type:
The ''catalog.xml'' file can be generated using the {{fgmeta source|path=catalog/update-catalog.py|text=update-catalog.py}} Python script.  Alongside the script is the ''fgaddon-catalog/'' directory, which is the configuration files used to generate the catalog for the [[FGAddon]] official hangar.  To generate the FGAddon catalog, as an example, type:


<syntaxhighlight lang="sh">
<syntaxhighlight lang="sh">
Line 10: Line 10:


The idea is to create a subdirectory tree for each catalog.  This subdirectory can have any name, and it contains the config and administrative files for maintaining the catalog.  The config file inside the catalog directory will need to be adjusted for each new hangar.  The script builds the content locally which then needs to be uploaded to an appropriate place on a server.
The idea is to create a subdirectory tree for each catalog.  This subdirectory can have any name, and it contains the config and administrative files for maintaining the catalog.  The config file inside the catalog directory will need to be adjusted for each new hangar.  The script builds the content locally which then needs to be uploaded to an appropriate place on a server.
== See also ==
=== Wiki articles ===
* [[Aircraft Center]]
* [[Catalog metadata]]
* [[FlightGear hangars#Third party sites]] - List of third-party hangars, of which some have an <code>catalog.xml</code> file.
=== Mailing list threads ===
* [https://sourceforge.net/p/flightgear/mailman/message/35488166/ <nowiki>[</nowiki>Flightgear-devel<nowiki>]</nowiki> Testing changes to update_catalog.py] (November 2016)
=== Source code ===
* {{fgmeta file|path=catalog}} - update_calalog script, templates, etc.
=== Default catalog ===
* http://fgfs.goneabitbursar.com/official/catalog.xml
[[Category:Aircraft enhancement]]
[[Category:FlightGear]]

Latest revision as of 12:00, 10 October 2020

The default hangar catalog, catalog.xml, is used by the in-sim Aircraft Center to list all the aircraft of the official FGAddon FlightGear hangar. 3rd party hangars can also provide a catalog URL via their own catalog.xml file.

Catalog generation

The catalog.xml file can be generated using the update-catalog.py Python script. Alongside the script is the fgaddon-catalog/ directory, which is the configuration files used to generate the catalog for the FGAddon official hangar. To generate the FGAddon catalog, as an example, type:

./update-catalog.py fgaddon-catalog

The idea is to create a subdirectory tree for each catalog. This subdirectory can have any name, and it contains the config and administrative files for maintaining the catalog. The config file inside the catalog directory will need to be adjusted for each new hangar. The script builds the content locally which then needs to be uploaded to an appropriate place on a server.

See also

Wiki articles

Mailing list threads

Source code

Default catalog