1
0
Fork 0
Commit graph

431 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
Stuart Buchanan
b339ff1358 Enhancement to the checklists function to support <condition>.
Checklist items now support a <condition> element that evaluates
when the checklist item is complete, and is used to provide color
coding in the checklist dialog.
2013-01-29 22:38:39 +00:00
Stuart Buchanan
bf6dd5ca93 FGShortRef for 2.10.0. 2013-01-29 21:52:52 +00:00
Stuart Buchanan
a8faa14418 2.10.0 versions of The FlightGear Manual. 2012-12-18 22:29:50 +00:00
Emilian Huminiuc
191988f98e Improve ubershader ReadMe readability
Signed-off-by: Emilian Huminiuc <emilianh@gmail.com>
2012-11-09 00:58:03 +02:00
Stuart Buchanan
8f692c78d9 Document new materials.xml elements controlling tree and object
distribution depending on slope angle.
2012-10-05 22:00:51 +01:00
Stuart Buchanan
5fbf85f881 Use multi-sampling where available to improve tree rendering. 2012-09-25 22:52:28 +01:00
Emilian Huminiuc
2c058f9c1f New effect: Effects/model-combined-transparent
Switch c172p and concorde glass effects to the new effect.
Docs/model-combined.eff/: Updated transparent effect template.

From now on Effects/model-combined should not be inherited from directly.
Use either Effects/model-combined-deferred
or Effects/model-combined-transparent

Signed-off-by: Emilian Huminiuc <emilianh@gmail.com>
2012-09-09 22:28:45 +03:00
Emilian Huminiuc
835ba95ddb adapt effect template to previous changes
Signed-off-by: Emilian Huminiuc <emilianh@gmail.com>
2012-09-09 14:22:51 +03:00
Emilian Huminiuc
efe52f4bf9 ubershader: fix reflection under Rembrandt
model-combined & model-combined-deferred effects: improve Rembrandt behaviour, and provide better effects for transparent
surfaces under Rembrandt.

This change breaks current effects using normalmaps when inheriting from model-combined-deferred under
Rembrandt.
Aircraft developers please change the technique numbers in the "normalmap include" part of your effects file from
<technique n="8"> to <technique n="7"> (again, only if inheriting from model-combined-deferred, and using normalmaps)

Effects inheriting from model-combined do not neeed any adaptation.

Sorry for the nuisance caused by this change.

Signed-off-by: Emilian Huminiuc <emilianh@gmail.com>
2012-09-09 13:54:07 +03:00
Thomas Geymayer
a23464f809 Update docs for rate parameter of property-interpolate 2012-09-06 14:14:08 +02:00
Vivian Meazza
c80abcda73 Tidy up
Signed-off-by: Vivian Meazza <vivian.meazza@lineone.net>
2012-08-13 23:51:08 +01:00
Stuart Buchanan
47685d1794 Document use of the <parameters> section of the materials definition. 2012-08-01 21:08:42 +01:00
Stuart Buchanan
bd4e8764de Correct waiting period for exit statements without conditions,
update tutorial README with <wait> tag.
2012-07-14 20:27:31 +01:00
Christian Schmitt
7d10fb4619 Doc: Update scenery readme for upcoming signs changes 2012-06-08 23:01:29 +02:00
Clement de l'Hamaide
057cf86290 Document the new OBJECT_SHARED/OBJECT_STATIC pitch/roll options 2012-06-06 12:08:20 +02:00
Stuart Buchanan
ddf9445a8e Update documentation for materials.xml and random buildings. 2012-05-04 21:14:23 +01:00
Stuart Buchanan
f718148d68 Correction to README. 2012-04-24 21:59:33 +01:00
Stuart Buchanan
98e7a194e8 Random buildings - initial commit of data portion. Requires
simgear change to have any effect.
2012-04-24 21:55:37 +01:00
ThorstenB
e3bb3b9042 README.xmlsound: update description 2012-04-01 13:06:40 +02:00
Emilian Huminiuc
d43770ab58 Effects/model-default.eff move skydome to technique 5 to provide more headroom
Effects/model-combined.eff fix techniques numbering. Make active under rembrandt too. add model-combined-deferred as a stub for now for specific
Rembrandt use.
Users of model-combined with normalmaps should change the technique number to 9, and duplicate that entry for technique 8.
Fix some longstanding png warnings. Provide null_reflectdir.png for model-combined
This should fix part of bug #726
Signed-off-by: Emilian Huminiuc <emilianh@gmail.com>
2012-03-31 15:00:36 +03:00
Martin Spott
37d8bb2627 Latest fixes 2012-02-16 14:42:38 +01:00
Torsten Dreyer
f62c9fe77d Documentation for property-interpolate 2012-02-12 19:57:44 +01:00
Stuart Buchanan
f65c50f14a README documentation for materials.xml. 2012-02-08 22:56:50 +00:00
Vivian Meazza
a41bc4e8cc Documentation for the use of the uber-shader
Signed-off-by: Vivian Meazza <vivian.meazza@lineone.net>
2011-12-15 10:16:21 +00:00
ThorstenB
a79833070a Switch to generic "open-browser" command. 2011-10-09 12:45:50 +02:00
Stuart Buchanan
c0bebf5404 Updates to 3D clouds to use the new shading parameters. 2011-10-06 21:21:13 +01:00
ThorstenB
bde90daa71 Replay upgrade, part III: New flight recorder configuration files.
Provide templates for various aircraft components or complete aircraft
types. Better to have this stuff available/adaptable than hard-coded
somewhere inside fgfs.
2011-10-01 23:16:48 +02:00
Stuart Buchanan
975e7d6c54 Update to the 3DClouds README file covering recent changes. 2011-09-11 22:24:41 +01:00
ThorstenB
3db846729f Documentation fix
There is no "hide" option - but a "visible" option...
2011-08-21 15:18:09 +02:00
ThorstenB
ac6613b2f6 #398: Fix incorrect mail address.
Thanks to Toshi-san for spotting this.
2011-08-09 22:13:05 +02:00
ThorstenB
72bb98d400 #398: Updated FG html help page
- Replaced link to getstarted.html with pdf version
- Updated mailing list info
- Added link to FG forum
- Added logo & GPL info
- Corrected link to (missing) css
Thanks to Toshi for reporting dead links and other issues.
2011-08-08 20:58:48 +02:00
Martin Spott
0f01c069ab Re-render PDF as requested. 2011-08-07 19:43:22 +02:00
Stuart Buchanan
2d073cc8f9 Updated Manual including in-sim TerraSync option. 2011-08-06 20:46:14 +01:00
Martin Spott
9f0c124a95 Updated version number to v2.4.0 2011-08-05 23:05:07 +02:00
ThorstenB
e2cb030351 OpenSuSE: Fix inconsistent line-feeds in READMEs
Also drop a stray ".bak" file.
Thanks to OpenSuSE build service.
2011-08-01 19:45:13 +02:00
ThorstenB
f81385b36a Document "not-equals" condition. 2011-07-10 10:29:45 +02:00
ThorstenB
0ece95127c Thorsten Renk: local weather 1.18
fixes for a couple of issues, some improved textures/cloud model changes,
smooth instead of hard visibility transitions, updated documentation.
Also removed 'Test' entries from the menu.
(ThorstenB: Also cleaned-up Docs/ folder, moving local weather
documentation images to sub folder).
2011-07-03 23:39:01 +02:00
ThorstenB
b8eecab9cf Introduce "PRESERVE" flag to protect properties on sim reset.
Protect values of some specific properties on sim-reset.
2011-06-12 20:40:11 +02:00
ThorstenB
910cda3fce Tutorials: improve timing when repeating messages
Don't confuse user by repeating messages when he just fulfilled the
tutorial's step exit condition.
2011-06-04 14:14:49 +02:00
ThorstenB
f2d2b8e8b1 issue #281: tutorial's view direction messed-up/unusable by outside views
When user switched to a different view mode (e.g. chase/helicopter/tower
view) before or during a tutorial, everything went wrong...
Need to control (save/restore/switch) the view number (view mode) during
tutorials.  Also adds an option to explicitly change view mode during
a tutorial, i.e. tutorials can switch to tower view, chase view, ... now.
2011-06-03 00:39:05 +02:00
Frederic Bouvier
aa6680b4a6 Local Weather 1.1 by Thorsten Renk 2011-05-14 15:18:40 +02:00
Stuart Buchanan
2b54e87da8 Update documentation for 3D clouds - clouds can now be moved with an offset. 2011-05-13 19:51:34 +01:00
Stuart Buchanan
53b1836ab3 Update README file to cover new 3D cloud commands. 2011-04-23 22:23:08 +01:00
Frederic Bouvier
65c166c12c Local Weather 1.0 by Thorsten Renk 2011-03-19 14:03:28 +01:00
Martin Spott
5f580b156a Technical update to the PDF 2011-01-05 21:15:15 +01:00
Stuart Buchanan
936f6b6eba V2.2.0 of the FG Manual (getstart.pdf) and the FG Short Reference. 2010-12-29 18:00:13 +00:00
Frederic Bouvier
758f691a1c Local Weather version 0.9 by Thorsten Renk 2010-10-26 21:42:36 +02:00
Frederic Bouvier
a0803ad074 Local Weather v0.85 by Thorsten Renk 2010-09-10 08:52:21 +02:00
Vivian Meazza
4ae6709663 Add new submodel parameters
Signed-off-by: Vivian Meazza <vivian.meazza@lineone.net>
2010-08-05 16:13:03 +01:00
Frederic Bouvier
4dd0ef9a08 Local weather v0.81 by Thorsten Renk 2010-08-03 08:18:14 +02:00