From 804b0396a4c4506ba41b590a0d7879695c20e8eb Mon Sep 17 00:00:00 2001
From: Thomas Geymayer <tomgey@gmail.com>
Date: Thu, 20 Sep 2012 00:01:48 +0200
Subject: [PATCH] Documentation browser dialog (for files in /Docs - Thanks to
 Hooray)

---
 Translations/de/menu.xml    |   2 +
 Translations/en/menu.xml    |   1 +
 gui/dialogs/doc-browser.xml | 140 ++++++++++++++++++++++++++++++++++++
 gui/menubar.xml             |   8 +++
 4 files changed, 151 insertions(+)
 create mode 100644 gui/dialogs/doc-browser.xml

diff --git a/Translations/de/menu.xml b/Translations/de/menu.xml
index 0203f0df2..d9a35dec5 100644
--- a/Translations/de/menu.xml
+++ b/Translations/de/menu.xml
@@ -123,7 +123,9 @@
 	<!-- Help menu -->
 	<help>Hilfe</help>   <!-- English: "Help" -->
 	<help-browser>Hilfe (im Browser)</help-browser>   <!-- English: "Help  (opens in browser)" -->
+	<doc-browser>Erweiterte Dokumentation</doc-browser> <!-- English: "Documentation Browser" -->
 	<aircraft-keys>Flugzeug Hilfe</aircraft-keys>   <!-- English: "Aircraft Help" -->
+	<aircraft-checklists>Flugzeug Checklisten</aircraft-checklists> <!-- English: "Aircraft Checklists" -->
 	<common-keys>Tastenbelegung (Flugzeugsteuerung)</common-keys>   <!-- English: "Common Aircraft Keys" -->
 	<basic-keys>Tastenbelegung (allgemein)</basic-keys>   <!-- English: "Basic Simulator Keys" -->
 	<joystick-info>Joystick Informationen</joystick-info>   <!-- English: "Joystick Information" -->
diff --git a/Translations/en/menu.xml b/Translations/en/menu.xml
index 51c6e8e8d..70c2c6af8 100644
--- a/Translations/en/menu.xml
+++ b/Translations/en/menu.xml
@@ -108,6 +108,7 @@
 	<!-- Help menu -->
 	<help>Help</help>
 	<help-browser>Help  (opens in browser)</help-browser>
+	<doc-browser>Documentation Browser</doc-browser>
 	<aircraft-keys>Aircraft Help</aircraft-keys>
   <aircraft-checklists>Aircraft Checklists</aircraft-checklists>
 	<common-keys>Common Aircraft Keys</common-keys>
diff --git a/gui/dialogs/doc-browser.xml b/gui/dialogs/doc-browser.xml
new file mode 100644
index 000000000..ffe3052e6
--- /dev/null
+++ b/gui/dialogs/doc-browser.xml
@@ -0,0 +1,140 @@
+<?xml version="1.0"?>
+<PropertyList>
+  <x>-20</x>
+  <y>-20</y>
+  <name>doc-browser</name>
+  <dialog-name>doc-browser</dialog-name>
+  <layout>vbox</layout>
+  <resizable>true</resizable>
+
+  <group>
+    <layout>hbox</layout>
+    <empty>
+      <stretch>1</stretch>
+    </empty>
+    <text>
+      <label>Documentation Browser</label>
+    </text>
+    <empty>
+      <stretch>1</stretch>
+    </empty>
+    <button>
+      <pref-width>16</pref-width>
+      <pref-height>16</pref-height>
+      <legend/>
+      <keynum>27</keynum>
+      <border>2</border>
+      <binding>
+        <command>dialog-close</command>
+      </binding>
+    </button>
+  </group>
+
+  <hrule/>
+
+  <group>
+    <layout>hbox</layout>
+    <list>
+      <pref-width>170</pref-width>
+      <pref-height>500</pref-height>
+      <name>filename</name>
+      <halign>fill</halign>
+      <property>/sim/gui/dialogs/doc-browser/filename</property>
+      <value>clear</value>
+      <binding>
+        <command>dialog-apply</command>
+        <object-name>filename</object-name>
+      </binding>
+      <binding>
+        <command>dialog-update</command>
+        <object-name>editfield</object-name>
+      </binding>
+    </list>
+    <textbox>
+      <name>editfield</name>
+      <halign>fill</halign>
+      <valign>fill</valign>
+      <stretch>true</stretch>
+      <pref-width>600</pref-width>
+      <pref-height>250</pref-height>
+      <padding>6</padding>
+      <slider>20</slider>
+      <editable>falsee</editable>
+      <wrap>false</wrap>
+      <font>
+        <name>FIXED_8x13</name>
+      </font>
+      <property>/sim/gui/dialogs/doc-browser/edit</property>
+    </textbox>
+  </group>
+
+  <nasal>
+    <open>
+       var self = cmdarg();
+       var dlg = props.globals.getNode("/sim/gui/dialogs/doc-browser", 1);
+       var edit = dlg.getNode("edit", 1);
+       if( !contains(globals, "__doc_browser") )
+         globals["__doc_browser"] = {};
+  
+       var path = getprop("/sim/fg-root") ~ "/Docs/";
+       # hard coded list of file names, because not all files are plain text - not even the README* files
+       # TODO: it would probably make sense to sort these files (README, introduction, properties etc)
+       var doc_files = [
+         "README",
+         "README.introduction",
+         "README.fgjs",
+         "README.xmlsyntax",
+         "README.multiscreen",
+         "README.properties",
+         "README.IO",
+         "README.logging",
+         "README.protocol",
+         "README.scenery",
+         "README.materials",
+         "README.yasim",
+         "README.JSBsim",
+         "README.submodels",
+         "README.3DClouds",
+         "README.flightrecorder",
+         "README.jsclient",
+         "README.multiplayer",
+         "README.tutorials",
+         "README.conditions",
+         "README.commands",
+         "README.digitalfilters",
+         "README.airspeed-indicator",
+         "README.hud",
+         # "README.xmlhud", deprecated?
+         "README.gui",
+         "README.layout",
+         "README.osgtext",
+         "README.wildfire",
+         "README.electrical",
+         "README.effects",
+         "README.xmlparticles",
+         "README.sound",
+         "README.xmlsound",
+         "README.xmlpanel",
+         "README.minipanel"
+       ];
+       var filename_list = self.getNode("group[1]/list");
+       var n=0;
+       # add the filenames to the list box
+       foreach(var file; doc_files)
+       {
+         filename_list.getChild("value",n,1).setValue( file );
+         n+=1;
+       }
+       var filename_property = "/sim/gui/dialogs/doc-browser/filename";
+       var update = func {
+         var file = getprop(filename_property);
+           var doc_file = path ~ file;
+           setprop("/sim/gui/dialogs/doc-browser/edit", io.readfile(doc_file));
+       }
+  
+       var listener = setlistener(filename_property, update);
+       setprop("/sim/gui/dialogs/doc-browser/filename", "README.introduction");
+    </open>
+    <close>removelistener(listener);</close>
+  </nasal>
+</PropertyList>
diff --git a/gui/menubar.xml b/gui/menubar.xml
index aadd572fb..8432d39cb 100644
--- a/gui/menubar.xml
+++ b/gui/menubar.xml
@@ -703,6 +703,14 @@
 			</binding>
 		</item>
 
+		<item>
+			<name>doc-browser</name>
+			<binding>
+				<command>dialog-show</command>
+				<dialog-name>doc-browser</dialog-name>
+			</binding>
+		</item>
+
 		<item>
 			<key>?</key>
 			<name>aircraft-keys</name>