1
0
Fork 0
Commit graph

381 commits

Author SHA1 Message Date
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
Philosopher
39093a35a0 Nasal internals LaTeX document (.tex & .pdf)
This is a document Hooray and I have been working on for a while. Its
focused on the internals, and very likely in a messy state and very
weird, but hopefully some others will want to contribute. There's some
empty sections, random "test" code snippets, and lots of \todos in
there. Also, lines aren't wrapped at all, but it does generate a nice
PDF that contains, I hope, something that will be useful.

The PDF was rendered by writeLaTeX.com
2014-01-21 11:44:03 -06:00
Clément de l'Hamaide
346103ba22 Fix conflict Tab key vs cycle mouse mode 2014-01-16 19:11:58 +01:00
Eric van den Berg
281036e1e5 static port and pitot tube new features, doc update 2013-11-16 23:55:19 +01:00
Gijs de Rooy
b5cc1494c9 Model howto: fix OSG wiki link 2013-10-07 12:50:02 +02:00
Stuart Buchanan
f9c190692f Update documentation for 2.12.0 release. 2013-07-30 21:20:31 +01:00
Gijs de Rooy
3450cfa0a7 Update Docs/index.html 2013-07-23 17:08:04 +02:00
Stuart Buchanan
aacd7945b9 Updated readme.pdf with less margin-bleeding from overlong lines in README. 2013-06-20 23:06:40 +01:00
Stuart Buchanan
c974f5242d Clean up README files.
- Remove trailing whitespace
- Replace tabs with spaces
- Reformat to < 85 characters to avoid autogenerate readme.pdf bleeding over
  margins.
2013-06-20 23:02:17 +01:00
Stuart Buchanan
08eabfb67d Bring README.checklists up to date. 2013-06-20 21:32:52 +01:00
Stuart Buchanan
a3b14a15b7 Add compilation of all README file as a PDF. Generator located in the getstart repository. 2013-06-18 22:48:54 +01:00
Stuart Buchanan
0857d81ec6 Document additional spacing on tree textures. 2013-05-19 21:45:42 +01:00
Stuart Buchanan
266313486d Add dynamic selection of tree texture based on season and snow level.
All tree texture sheets now contain 4 different texture sets for
different conditions.  See Docs/README.materials for details.

Also retire the -summer and -winter variants of tree textures, which
are now redundant.
2013-04-20 21:09:03 +01:00
Eric van den Berg
756bd7c44b fix for bug 1089: concorde airspeed indicator value at subsonic speeds
updated README.airspeed indicator
added README.systems
2013-03-28 12:11:50 +01:00
Stuart Buchanan
5491f952ca Add optional <page> and <marker> tags to checklists
Checklists may now be split into individual sections made up
of <pages> containing the <item> tags.  Each page is displayed
individually with Previous/Next buttons to allow navigation.

Checklists items also support <marker> tags.  These display
a marker when a ? button is pressed next to the checklist item.
The format is identical to that of the tutorial system.
2013-02-27 22:28:44 +00:00
Emilian Huminiuc
355af4e72e Adapt model-combined effect templates provided with the documentation to latest developments (new technique for ligthfield shader).
Adapt a couple of aircraft effects to latest effect state too.
Signed-off-by: Emilian Huminiuc <emilianh@gmail.com>
2013-02-01 13:22:29 +02:00