580
edits
Aircraft-set.xml: Difference between revisions
Jump to navigation
Jump to search
no edit summary
No edit summary |
No edit summary |
||
| Line 76: | Line 76: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
The | The name that will be shown in the aircraft selection dialog of [[FGRun]] and other GUIs. It's called 'description' but consider it the human-readable name for the aircraft. It's the primary thing users will see of your aircraft in UIs, so try to make it as informative as possible without being too long. | ||
<syntaxhighlight lang="xml"> | |||
<long-description>The Cessna 172 is the most popular general aviation aircraft in the world, with | |||
over 40,000 examples built. The aircraft evolved from the earlier Cessna 170, and is available with | |||
a huge range of instruments and engines. This examples features the a Lycoming IO-360 engine | |||
and traditional mechanical flight instruments, typical of a new aircraft from 1986. | |||
</long-description> | |||
</syntaxhighlight> | |||
A brief description of the aircraft, typically a few sentences or paragraphs. Do not including formatting in this text since it will be re-formatted by the UI. (Line breaks to separate paragraphs are ok). Since this text is also searchable, this is a good place to include nick-names or other information (eg, historical manufacturer names) to aid in discovery. | |||
<syntaxhighlight lang="xml"> | <syntaxhighlight lang="xml"> | ||
| Line 111: | Line 121: | ||
<syntaxhighlight lang="xml"> | <syntaxhighlight lang="xml"> | ||
<author><!-- Name of author (development area), Name of author (development area), etc. --></author> | <author><!-- Name of author (development area), Name of author (development area), etc. --></author> | ||
<authors> | |||
<author n="0"> | |||
<name>Wilbur Wirght</name> | |||
<description>FDM, systems</description> | |||
<nick>wwright</nick> | |||
</author> | |||
<author n="1"> | |||
<name>Orville Wirght</name> | |||
<description>model and sounds</description> | |||
</author> | |||
</authors> | |||
</syntaxhighlight> | </syntaxhighlight> | ||
Previously, aircraft could define a single <author> tag with a string listing the authors of the aircraft. This often ended up containing other information, and for complex aircraft, could become very long and unreadable in some places, such as the splash screen. | |||
For FlightGear 2018.3.0 onwards there is a replacement system, based around a structured list of authors. For each author their name can be supplied, and optionally other data if desired: nickname, email and a description of what they contributed. (The strucutre of this XML deliberately matches that used for add-ons) | |||
Both the old and and new data can co-exist to allow aircraft compatability with older versions of FlightGear. | |||
To distinguish contributions and previous authors from active maintainers, there is a seperate maintainers section which can be provided. The syntax is the same as for the authors, but the contact email is more important. In the future this might potentially be used to contact / notify all maintainers of aircraft. (Nickname and description are not used for maintainers) | |||
<syntaxhighlight lang="xml"> | |||
<maintainers> | |||
<maintainer n="0"> | |||
<name>Wilbur Wirght</name> | |||
<email>ww@wright-brothers.com</email> | |||
</maintainer> | |||
</maintainers > | |||
</syntaxhighlight> | |||
<syntaxhighlight lang="xml"> | <syntaxhighlight lang="xml"> | ||