Changeset 228:bc6592d202b4 for doc

Timestamp:

06/06/12 17:19:08 (13 years ago)

Author:

István Váradi <ivaradi@…>

Branch:

default

Phase:

public

Message:

Minor fixes and added the screenshots for the English manual

Location:

doc/manual/en

Files:

• briefing.png (added)
• checklistEditor.png (added)
• connect.png (added)
• debugLogTab.png (added)
• finish.png (added)
• flightInfoTab.png (added)
• flightSelection.png (added)
• fuel.png (added)
• gateSelection.png (added)
• gatesTab.png (added)
• helpTab.png (added)
• index.html (modified) (32 diffs)
• landing.png (added)
• logTab.png (added)
• mainWindow.png (added)
• monitorWindow.png (added)
• payload.png (added)
• pirepLoaded.png (added)
• pirepViewer.png (added)
• prefsAdvanced.png (added)
• prefsGeneral.png (added)
• prefsMessages.png (added)
• prefsSounds.png (added)
• route.png (added)
• statusIcon1.png (added)
• statusIcon2.png (added)
• takeoff.png (added)
• time.png (added)

doc/manual/en/index.html

@@ -7 +7 @@
   <div align="center"><h1>MAVA Logger X User's Manual</h1></div>
 
-  <h2>Overview</h2>
+  <h2><a name="overview">Overview</a></h2>
 
   <p>
@@ -123 +123 @@
   </p>
 
-  <h3>Graphical User Interface</h3>
+  <h3><a name="gui">Graphical User Interface</a></h3>
 
   <p>
@@ -141 +141 @@
   which looks like the one on the picture below.
   </p>
+
+  <div align="center">
+    <table>
+      <tr>
+        <td>
+          <img src="statusIcon1.png" alt="The status icon" hspace="20"/>
+        </td>
+        <td>
+          <img src="statusIcon2.png" alt="The status icon menu" hspace="20"/>
+        </td>
+    </table>
+  </div>
 
   <p>
@@ -168 +180 @@
   </p>
   
-  <h2>The Main Window</h2>
+  <h2><a name="mainWindow">The Main Window</a></h2>
 
   <p>
@@ -176 +188 @@
   which is described below.
   </p>
+
+  <div align="center"><img src="mainWindow.png" alt="The main window"/></div>
 
   <p>
@@ -203 +217 @@
   possible that the logger application itself fails, in which case
   you, unfortunately, have to restart the flight. Do not forget to
-  notify the author if this happens.
+  notify the author if this happens. In this case, try to copy and
+  save the debug log and send it with your bug report.
   </p>
 
@@ -228 +243 @@
   </p>
 
-  <h3>The Flight Tab</h3>
-  
-  <p>
-  The flight tab is the most import tab. It consists of a sequence of
+  <h3><a name="tabFlight">The Flight Tab</a></h3>
+
+  <p>
+  The flight tab is the most important tab. It consists of a sequence of
   pages similar to wizards found in many programs. The first several of
   these pages guide you through the various steps of the preparations
@@ -266 +281 @@
   </p>
 
-  <h4>The <i>Login</i> Page</h4>
+  <h4><a name="loginPage">The <i>Login</i> Page</a></h4>
 
   <p>
@@ -300 +315 @@
   </p>
   
-  <h4>The <i>Flight selection</i> Page</h4>
-
+  <h4><a name="flightSelectionPage">The <i>Flight selection</i> Page</a></h4>
+
+  <img src="flightSelection.png" alt="The Flight selection page"/>
+  
   <p>
   This page displays the list of the flight you have booked previously
@@ -337 +354 @@
   </p>
 
-  <h4>The <i>LHBP gate selection</i> Page</h4>
+  <h4><a name="gataSelectionPage">The <i>LHBP gate selection</i> Page</a></h4>
+  
+  <img src="gateSelection.png" alt="The LHBP gate selection page"/>
   
   <p>
@@ -350 +369 @@
   </p>
 
-  <h4>The <i>Connect to the simulator</i> Page</h4>
-
+  <h4><a name="connectPage">The <i>Connect to the simulator</i> Page</a></h4>
+
+  <img src="connect.png" alt="The Connect to the simulator page"/>
+  
   <p>
   This page displays some important information about your flight,
@@ -372 +393 @@
   </p>
 
-  <h4>The <i>Payload</i> Page</h4>
-
+  <h4><a name="payloadPage">The <i>Payload</i> Page</a></h4>
+
+  <img src="payload.png" alt="The Payload page"/>
+  
   <p>
   This page displays the components of the flight's payload and the
@@ -392 +415 @@
   </p>
 
-  <h4>The <i>Time</i> Page</h4>
-
+  <h4><a name="timePage">The <i>Time</i> Page</a></h4>
+
+  <img src="time.png" alt="The Time page"/>
+  
   <p>
   This page displays the departure and arrival times of your
@@ -410 +435 @@
   </p>
 
-  <h4>The <i>Fuel</i> Page</h4>
-
+  <h4><a name="fuelPage">The <i>Fuel</i> Page</a></h4>
+
+  <img src="fuel.png" alt="The Fuel page"/>
+  
   <p>
   This page contains a graphical representation of the fuel tanks of
@@ -441 +468 @@
   </p>
 
-  <h4>The <i>Route</i> Page</h4>
+  <h4><a name="routePage">The <i>Route</i> Page</a></h4>
+  
+  <img src="route.png" alt="The Route page"/>
   
   <p>
@@ -458 +487 @@
   </p>
 
-  <h4>The <i>Briefing</i> Pages</h4>
+  <h4><a name="briefingPage">The <i>Briefing</i> Pages</a></h4>
+  
+  <img src="briefing.png" alt="The Briefing page"/>
   
   <p>
@@ -478 +509 @@
   </p>
   
-  <h4>The <i>Takeoff</i> Page</h4>
-
+  <h4><a name="takeoffPage">The <i>Takeoff</i> Page</a></h4>
+
+  <img src="takeoff.png" alt="The Takeoff page"/>
+  
   <p>
   On this page you have to enter the name of the departure runway, the
@@ -492 +525 @@
   </p>
 
-  <h4>The <i>Landing</i> Page</h4>
+  <h4><a name="landingPage">The <i>Landing</i> Page</a></h4>
+
+  <img src="landing.png" alt="The Landing page"/> 
 
   <p>
@@ -508 +543 @@
   </p>
 
-  <h4>The <i>Finish</i> Page</h4>
+  <h4><a name="finishPage">The <i>Finish</i> Page</a></h4>
+
+  <img src="finish.png" alt="The Finish page"/> 
 
   <p>
@@ -543 +580 @@
   </p>
   
-  <h3>The Flight info Tab</h3>
+  <h3><a name="flightInfoTab">The Flight info Tab</a></h3>
+
+  <img src="flightInfoTab.png" alt="The Flight info tab"/> 
 
   <p>
@@ -569 +608 @@
   </p>
 
-  <h3>The Help Tab</h3>
+  <h3><a name="helpTab">The Help Tab</a></h3>
+
+  <img src="helpTab.png" alt="The Help tab"/> 
 
   <p>
@@ -595 +636 @@
   </p>
   
-  <h3>The Log Tab</h3>
+  <h3><a name="logTab">The Log Tab</a></h3>
+
+  <img src="logTab.png" alt="The Log tab"/> 
 
   <p>
@@ -612 +655 @@
   fault points have been awarded. For example, you may even decide to
   abort the flight, if you think some of the faults are to
-  embarrassing :)
-  </p>
-
-  <h3>The Gates Tab</h3>
+  embarrassing :) For quick identification, the lines containing the
+  fault messages are highlighted.
+  </p>
+
+  <h3><a name="gatesTab">The Gates Tab</a></h3>
+
+  <img src="gatesTab.png" alt="The Gates tab"/> 
 
   <p>
@@ -646 +692 @@
   </p>
 
-  <h3>The Debug log</h3>
+  <h3><a name="debugLog">The Debug log</a></h3>
+
+  <img src="debugLogTab.png" alt="The Debug log tab"/> 
 
   <p>
@@ -657 +705 @@
   </p>
 
-  <h2>Loading PIREPs</h2>
+  <h2><a name="loadingPIREPs">Loading PIREPs</a></h2>
 
   <p>
@@ -677 +725 @@
   </p>
 
-  <h2>Editing checklists</h2>
+  <div align="center">
+    <img src="pirepLoaded.png" alt="The loaded PIREP window"/> 
+  </div>
+
+  <p>
+  You may also want to view a saved PIREP, for example, if it is a
+  PIREP about an entrance exam flight. To do so, click the <b>View
+  PIREP...</b> button. This displays the PIREP viewer window, which
+  groups the data into three tabs. The <i>Data</i> tab contains the
+  itemized data of the flight. The <i>Comments & defects</i> tab
+  displays the comments and or flight defects entered by the
+  user. The <i>Log</i> tab contains the flight log. 
+
+  <div align="center">
+    <img src="pirepViewer.png" alt="The PIREP Viewer"/> 
+  </div>
+
+  <h2><a name="checklistEditor">Editing checklists</a></h2>
+
+  <img src="checklistEditor.png" alt="The Checklist Editor"/> 
 
   <p>
@@ -717 +784 @@
   </p>
   
-  <h2>The Preferences Window</h2>
+  <h2><a name="prefs">The Preferences Window</a></h2>
 
   </p>
@@ -727 +794 @@
   </p>
   
-  <h3>The <i>General</i> Tab</h3>
-  
+  <h3><a name="prefsGeneral">The <i>General</i> Tab<a></h3>
+  
+  <img src="prefsGeneral.png" alt="The General Tab of Preferences"/> 
+
   <p>
   These are some general settings for various parts of the
@@ -769 +838 @@
   </p>
 
-  <h3>The <i>Messages</i> Tab</h3>
+  <h3><a name="prefsMessages">The <i>Messages</i> Tab</a></h3>
  
+  <img src="prefsMessages.png" alt="The Messages Tab of Preferences"/> 
+
   <p>
   The program can display messages about certain events in the
@@ -814 +885 @@
   </p>
 
-  <h3>The <i>Sounds</i> Tab</h3>
-  
+  <h3><a name="prefsSounds">The <i>Sounds</i> Tab</a></h3>
+  
+  <img src="prefsSounds.png" alt="The Sounds Tab of Preferences"/> 
+
   <p>
   This tab controls how the sounds are played by the application.
@@ -853 +926 @@
   </p>
 
-  <h3>The <i>Advanced</i> Tab</h3>
+  <h3><a name="prefsAdvanced">The <i>Advanced</i> Tab</a></h3>
+
+  <img src="prefsAdvanced.png" alt="The Advanced Tab of Preferences"/> 
 
   <p>
@@ -867 +942 @@
   </p>
 
-  <h2>The Monitor Window</h2>
+  <h2><a name="monitorWindow">The Monitor Window</a></h2>
+
+  <img src="monitorWindow.png" alt="The Monitor Window"/> 
 
   <p>