Aircraft metadata checklist: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
(+- Heading level cleanup. Highest level is used by the wiki for article title and should not be used.; +-link: catalogTags.py; Minor cleanup; +cat: Aircraft enhancement) |
||
| Line 3: | Line 3: | ||
(For each of these items, we need to show an example of the XML changes required) | (For each of these items, we need to show an example of the XML changes required) | ||
== Metadata / -set.xml == | |||
= Metadata / -set.xml = | |||
Checking / fixing these items should take about 30 minutes per aircraft (maybe a little longer the first time) | Checking / fixing these items should take about 30 minutes per aircraft (maybe a little longer the first time) | ||
| Line 10: | Line 9: | ||
* Ensure the aircraft ratings are set and not wildly inaccurate. | * Ensure the aircraft ratings are set and not wildly inaccurate. | ||
* Ensure any tags are from the official list of tags: | * Ensure any tags are from the official list of tags: {{fgmeta source|path=python3-flightgear/flightgear/meta/aircraft_catalogs/catalogTags.py|text=catalogTags.py}} | ||
* Ensure the aircraft has a suitable name and description | * Ensure the aircraft has a suitable name and description | ||
* For multi-variant aircraft, ensure the primary aircraft is a sensible choice ( | * For multi-variant aircraft, ensure the primary aircraft is a sensible choice (for example not a copilot or floats/skis variant), and that other variants declare a 'variant-of' referencing the primary | ||
In the primary (for example in <code>f16-block-52-set.xml</code>): | |||
<syntaxhighlight lang="xml"> | <syntaxhighlight lang="xml"> | ||
<sim> | <sim> | ||
| Line 21: | Line 21: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
In the variants: ( | In the variants: (for example in <code>f16-block-10-set.xml</code>): | ||
<syntaxhighlight lang="xml"> | <syntaxhighlight lang="xml"> | ||
<sim> | <sim> | ||
| Line 27: | Line 28: | ||
</sim> | </sim> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
* Add new-style preview images | * Add new-style preview images | ||
* Ensure the thumbnail is the correct size and follows the guidelines (not a logo, not a photograph) | * Ensure the thumbnail is the correct size and follows the guidelines (not a logo, not a photograph) (Insert the basic thumbnail size here) | ||
* Set <code>minimum-fg-version</code> and <code>compatible-fg-version</code> values in the <code>-set.xml</code> if required | |||
(Insert the basic thumbnail size here) | * Review the 'catalog generator' error messages for the aircraft (for example XML formatting errors) | ||
* Ensure any development files are excluded from the generated <code>.zip</code> (for example XCF or PSD files) | |||
* Set minimum-fg-version and compatible-fg-version values in the -set.xml if required | * Examine the console log and resolve any reported aircraft issues (for example PNG bad color profile, missing files, etc.) (Need to document options to do this) | ||
* Review the 'catalog generator' error messages for the aircraft ( | |||
* Ensure any development files are excluded from the generated .zip ( | |||
* Examine the console log and resolve any reported aircraft issues ( | |||
* Add an appropriate MP fallback model | * Add an appropriate MP fallback model | ||
= Code changes = | == Code changes == | ||
* Ensure the aircraft uses the global property for enabling/disabling the pilot model. | * Ensure the aircraft uses the global property for enabling/disabling the pilot model. | ||
* ? | * ? | ||
[[Category:Aircraft enhancement]] | |||
Latest revision as of 23:32, 23 August 2020
This list is various simple checks and modifications to improve user experience with aircraft.
(For each of these items, we need to show an example of the XML changes required)
Metadata / -set.xml
Checking / fixing these items should take about 30 minutes per aircraft (maybe a little longer the first time)
For full description of each item, see aircraft -set.xml description
- Ensure the aircraft ratings are set and not wildly inaccurate.
- Ensure any tags are from the official list of tags: catalogTags.py
- Ensure the aircraft has a suitable name and description
- For multi-variant aircraft, ensure the primary aircraft is a sensible choice (for example not a copilot or floats/skis variant), and that other variants declare a 'variant-of' referencing the primary
In the primary (for example in f16-block-52-set.xml):
<sim>
<primary-set type="bool">true</primary-set>
</sim>
In the variants: (for example in f16-block-10-set.xml):
<sim>
<variant-of>f16-block-52</variant-of>
</sim>
- Add new-style preview images
- Ensure the thumbnail is the correct size and follows the guidelines (not a logo, not a photograph) (Insert the basic thumbnail size here)
- Set
minimum-fg-versionandcompatible-fg-versionvalues in the-set.xmlif required - Review the 'catalog generator' error messages for the aircraft (for example XML formatting errors)
- Ensure any development files are excluded from the generated
.zip(for example XCF or PSD files) - Examine the console log and resolve any reported aircraft issues (for example PNG bad color profile, missing files, etc.) (Need to document options to do this)
- Add an appropriate MP fallback model
Code changes
- Ensure the aircraft uses the global property for enabling/disabling the pilot model.
- ?