1
0
Fork 0
Commit graph

396 commits

Author SHA1 Message Date
Stuart Buchanan
9f7e17a434 Support for <group> of checklists.
Checklists now support grouping by placing a group of checklists
under a <group> node.

e.g. /sim/checklists/group/checklist

The group can have a <name>, which is used by the checklist dialog
and can be used by other interfaces, such as the FG1000.
2018-04-12 22:24:57 +01:00
Florent Rougon
82417eb962 Docs/README.add-ons: document addon.storagePath and addon.createStorageDir()
These were added in FlightGear commit
9a044a474bdb6ccc471cbe4c69dced5d2a9f447e.
2018-03-21 08:43:14 +01:00
Florent Rougon
c88f766950 Docs/README.add-ons: minor changes 2018-02-27 20:31:10 +01:00
Florent Rougon
9b6b6d7f6d Docs/README.add-ons: document support for add-on-specific menus and dialogs
Document these new features of FlightGear 2018.2.
2018-02-27 13:16:11 +01:00
Florent Rougon
2724f71978 Docs/README.add-ons: document property subtree reserved for add-on developers
For each add-on, the subtree of the global Property Tree starting at
/addons/by-id/ADDON_ID/addon-devel is reserved for the specific needs of
the add-on, where ADDON_ID stands for the add-on identifier.
2018-02-23 10:04:04 +01:00
Florent Rougon
c17d9377f8 Add-ons: more specific file names for the interface between FG core and add-ons
The add-on framework now uses the following files in each add-on
directory:
  - addon-config.xml (previously: config.xml)
  - addon-main.nas   (previously: main.nas)

This is consistent with the addon-metadata.xml file that is already part
of the interface between FG core and add-ons. The goal is to make it
clearer, when browsing an add-on directory, which files belong to the
"FG core <-> add-on" interface and which files belong to the add-on
proper. This will be beneficial also when more files are added to the
"FG core <-> add-on" interface, such as possibly addon-events.xml in the
future.

This change is incompatible, thus it is the right time to do *before*
2018.2.1 is out, especially considering that this upcoming release
already has incompatible changes in the add-on API, namely the
requirement of the addon-metadata.xml file and the type of the argument
passed to each add-on's main() function. We'll try harder not to break
compatibility in the add-on API once 2018.2.1 is out. For now, it is
still a good time to try to get the API as clean as possible.
2018-02-10 19:50:00 +01:00
Florent Rougon
e0f721450a Docs/README.add-ons: document the '[addon=ADDON_ID]relative/path' syntax
The '[addon=ADDON_ID]relative/path' syntax can be used in resource paths
handled by the SimGear ResourceManager, when one wants to target a file
from a particular add-on (see FG commit 8c82fca4 and following ones).
This commit documents this feature.

Note: when the resource path is prepared by Nasal code, prefer using
      addons.Addon.resourcePath().
2018-01-18 09:56:58 +01:00
Florent Rougon
9556b901ee README.add-ons: minor change
The property-rule configuration file was probably a bad example, because
I believe the path has to be specified inside a PropertyList file (so
far). It can thus be done with the '[addon=ADDON_ID]relative/path'
syntax so as to ensure the file is found by
flightgear::addons::ResourceProvider, however in this particular case,
addons.Addon.resourcePath() is probably not going to be very useful.
2018-01-10 19:10:03 +01:00
Florent Rougon
acd54efff7 Docs/README.add-ons: add documentation for addons.Addon.resourcePath() 2018-01-10 14:13:25 +01:00
Florent Rougon
a57aed195e Add-ons: pass the addons.Addon ghost to main() instead of the base path
The addons.Addon instance (ghost) is much more interesting than its base
path. The base path is immediately accessible from the addons.Addon
instance using its 'basePath' attribute. The addons.Addon instance
allows main() to easily access essentially all of the add-on metadata,
including the add-on identifier, which makes it possible to write
main.nas without hardcoding the add-on id at all.

This is an incompatible change of course, so better do it now than
later.
2018-01-08 09:55:55 +01:00
Florent Rougon
72414d039a Docs/README.add-ons: update regarding /addon/authors and /addon/maintainers
With FlightGear commit 4d36082, the contents of /addon/authors (resp.
/addon/maintainers) in addon-metadata.xml files is now structured. It
may contain an arbitrary number of 'author' (resp. 'maintainer') child
nodes, each of which contains subnodes 'name', 'email' and 'url' ('name'
being mandatory, 'email' and 'url' being optional).

This commit updates Docs/README.add-ons regarding this change in the
syntax for addon-metadata.xml files, as well as the related
modifications to the add-on Nasal interface.
2018-01-03 00:18:00 +01:00
Florent Rougon
4393697753 Update Docs/README.add-ons: new fields and more details
Document new fields:

    authors
    maintainers
    license/{designation,file,url}
    url/{home-page,download,support,code-repository}
    tags

Add precisions concerning how fields are parsed, a bit more structure,
etc.

Mailing-list discussion:

  around https://sourceforge.net/p/flightgear/mailman/message/36155660/
2017-12-26 19:51:27 +01:00
Florent Rougon
2eb6e7b367 README.add-ons: adapt example to new header (with meta and file-type nodes) 2017-12-10 22:38:38 +01:00
Florent Rougon
33bc7eabb3 README.add-ons: use explicit node typing in the sample metadata file and more spacing
The explicit typing shouldn't change anything for the parsing code in
flightgear/src/Add-ons/AddonManager.cxx, because for each field, this
code knows the correct type and explicitly asks for it (and only once),
but external code might include addon-metadata.xml in some prop tree,
and then the explicit typing is likely to give better results.
2017-12-09 13:49:20 +01:00
Florent Rougon
c535306b3d Add-ons: simplify loading using the new API, set the 'loaded' flag
Also:
  - use the namespace __addon[ADDON_ID]__ when loading an add-on's
    main.nas file (previously, the namespace used was __addon[i]__ where
    i is 0 for the first registered add-on, 1 for the second one, etc.);
  - use logprint() instead of printlog(), because the former writes a
    more helpful source file and line number for the log call in
    fgfs.log (i.e., not always src/Scripting/NasalSys.cxx...);
  - remove the listener once it has been fired;
  - add documentation in Docs/README.add-ons.
2017-12-08 00:37:21 +01:00
Florent Rougon
70277258bf Adapt doc following renaming of ResourceProxy to EmbeddedResourceProxy in SimGear
simgear::ResourceProxy has been renamed to
simgear::EmbeddedResourceProxy in SimGear commit
2200fad30ebfd68cefd461d5443b8612621b4643[1]. Adapt
Docs/README.embedded-resources accordingly.

[1] This was done in order to avoid confusion with the unrelated classes
    simgear::ResourceProvider and simgear::ResourceManager.
2017-10-07 16:48:12 +02:00
Florent Rougon
1131ddd38f Add documentation for the embedded resources system and related classes
This document (Docs/README.embedded-resources) explains how to use the
embedded resources system and presents SimGear's CharArrayStream and
ZlibStream families of classes, as well as the ResourceProxy class.
2017-10-02 00:02:45 +02:00
Stuart Buchanan
6f2ccdd395 Add support for sprintf() formatting to tutorial
<message> tags can now contain sprintf() format
strings (%d, %.2f etc), with

<message-param>
  <property>/some/prop</property>
</message-param>

used as the substitute value.  Could be extended
in the future with perhaps Nasal evaluation?
2017-03-28 21:38:34 +01:00
Stuart Buchanan
fac7983f43 Updated docs for 2017.1 Bergen 2017-01-26 22:10:17 +00:00
Stuart Buchanan
dd575d2cd4 Updated documentation for 2016.4.1 Zurich release. 2016-11-12 19:11:23 +00:00
Jonathan Schellhase
b7a95c3c4f Here's the VFR tutorial for the 2016.4 Zurich release 2016-10-25 21:20:29 +02:00
Erik Hofman
138c356fb1 Latest version of the Chinese manual by Tong Hui 2016-08-15 09:56:19 +02:00
Stuart Buchanan
756d3ce4f9 Updated docs for 2016.2.1 Barcelona 2016-05-16 22:36:06 +01:00
Jonathan Schellhase
c34aaa7fa1 Adding the VFR cross-country tutorial from LEBL to LEIG 2016-05-13 20:42:42 +02:00
Torsten Dreyer
8f5e1bd626 Move marker.xml, marker.ac to Aircraft/Generic
also adjust (hopefully) all references to the old location
2016-03-23 11:00:18 +01:00
Stuart Buchanan
be1b5ea8b0 Chinese translation of The Manual from TONGHUIX. 2016-02-14 20:50:12 +00:00
Stuart Buchanan
46a914fa05 Upated documentation for 2016.1.0 2016-01-22 15:19:01 +00:00
Torsten Dreyer
ef898ec277 Add a svg version of our FG logo 2015-11-05 20:52:31 +01:00
Stuart Buchanan
e253f1ee50 c172p auto-generated documentation 2015-07-24 19:43:45 +01:00
Stuart Buchanan
18089cb03a Update documentation version for V3.6.0 2015-07-24 19:40:15 +01:00
Torsten Dreyer
703ee0b6fb Move the http property browsers' css to it's new home 2015-04-18 13:08:06 +02:00
Torsten Dreyer
847af289a5 Propertybrowser: style bool properties 2015-04-15 10:54:46 +02:00
Torsten Dreyer
ba5879a899 Tiny style mod for the property browser 2015-02-13 11:41:36 +01:00
Ruben De Smet
ad9525022e Implemented a documentation compiler, initially for Aircraft
Forum thread: http://forum.flightgear.org/viewtopic.php?f=72&t=25119
The documentation compiler will iterate over all Aircraft and generate
LaTeX files for each aircraft. It will then compile them to a pdf. Please
refer to the forum thread for an example of such a pdf file.

It will also generate a separate pdf file just for the checklists.

Currently, the compiler uses the checklist files and additional files in a
Docs/ subdirectory of the aircraft.

To use this script, you need python > 2.7 and a recent version of pdflatex
with hyperref support installed.
2015-01-14 18:42:04 -05:00
Stuart Buchanan
f68ba39c93 Checking updated readme.pdf file. 2015-01-11 20:28:33 +00:00
Stuart Buchanan
cb23664511 Update Doc version number and menu items for V3.4.0 2015-01-01 17:47:58 +00:00
Torsten Dreyer
2b60ae3e22 Add the FlightGear logo from the wiki 2014-09-17 09:05:19 +02:00
Stuart Buchanan
fa05088304 Updated docs for V3.2.0 - menu changes 2014-08-11 16:24:37 +01:00
Stuart Buchanan
8b28472efa Updated docs for V3.2.0 2014-08-11 15:52:17 +01:00
Torsten Dreyer
e46764624d Move the web gui to its own folder
serve FGDATA/webgui as url /gui/ and move the files
out of FGDATA/Docs (which was a bad place for those).
2014-03-14 21:15:51 +01:00
Torsten Dreyer
2f4da2fd49 Overhauled radio webgui: use websockets and fgcommands 2014-03-12 22:45:35 +01:00
Torsten Dreyer
188843cb78 webgui radio: fixes and code format
access properties by index
reformatted js
2014-03-08 15:01:50 +01:00
Torsten Dreyer
3341ee6c52 webgui: don't hide global props object 2014-03-07 22:25:23 +01:00
Torsten Dreyer
bcbf080388 webgui: improve the radio form
* use the new recursive json request feature
  to spare many requests.
* add some microdocumentation to the code
2014-03-07 22:22:01 +01:00
Torsten Dreyer
0ea6d47156 Add a sample JSON based web form
This is a sample for the new httpd and it's JSON capability.
Need to run fgfs with --httpd=<YourHttpPort> and point your browser
at http://localhost:<YourHttpPort>/gui/radio.html
2014-03-07 12:07:13 +01:00
Torsten Dreyer
9844056ab7 Prepare the ground for the new httpd 2014-03-06 13:17:04 +01:00
Clément de l'Hamaide
167e947c4c update Joystick documentation for new delay-sec and release-delay-sec properties 2014-03-05 00:46:48 +01:00
Stuart Buchanan
566ecd25a5 Updated README.effects with full documentation for texture-unit. Further documentation required. 2014-02-18 22:28:14 +00:00
Curtis L. Olson
bdd839a7fb Add a short note to document the 'overrideRedirect' flag. This gives an
extra hint to multi-headed Gnome based linux system that we really wish to
open up a full screen window that spans *all* physical displays.
2014-02-05 10:00:34 -06:00
Stuart Buchanan
bbc2ad5b59 Updated Manuals, readme.pdf and short reference. Includes Italian translation of Manual. 2014-01-21 19:33:56 +00:00