Changeset 228:bc6592d202b4 for doc


Ignore:
Timestamp:
06/06/12 17:19:08 (12 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:
27 added
1 edited

Legend:

Unmodified
Added
Removed
  • doc/manual/en/index.html

    r219 r228  
    77  <div align="center"><h1>MAVA Logger X User's Manual</h1></div>
    88
    9   <h2>Overview</h2>
     9  <h2><a name="overview">Overview</a></h2>
    1010
    1111  <p>
     
    123123  </p>
    124124
    125   <h3>Graphical User Interface</h3>
     125  <h3><a name="gui">Graphical User Interface</a></h3>
    126126
    127127  <p>
     
    141141  which looks like the one on the picture below.
    142142  </p>
     143
     144  <div align="center">
     145    <table>
     146      <tr>
     147        <td>
     148          <img src="statusIcon1.png" alt="The status icon" hspace="20"/>
     149        </td>
     150        <td>
     151          <img src="statusIcon2.png" alt="The status icon menu" hspace="20"/>
     152        </td>
     153    </table>
     154  </div>
    143155
    144156  <p>
     
    168180  </p>
    169181 
    170   <h2>The Main Window</h2>
     182  <h2><a name="mainWindow">The Main Window</a></h2>
    171183
    172184  <p>
     
    176188  which is described below.
    177189  </p>
     190
     191  <div align="center"><img src="mainWindow.png" alt="The main window"/></div>
    178192
    179193  <p>
     
    203217  possible that the logger application itself fails, in which case
    204218  you, unfortunately, have to restart the flight. Do not forget to
    205   notify the author if this happens.
     219  notify the author if this happens. In this case, try to copy and
     220  save the debug log and send it with your bug report.
    206221  </p>
    207222
     
    228243  </p>
    229244
    230   <h3>The Flight Tab</h3>
    231  
    232   <p>
    233   The flight tab is the most import tab. It consists of a sequence of
     245  <h3><a name="tabFlight">The Flight Tab</a></h3>
     246
     247  <p>
     248  The flight tab is the most important tab. It consists of a sequence of
    234249  pages similar to wizards found in many programs. The first several of
    235250  these pages guide you through the various steps of the preparations
     
    266281  </p>
    267282
    268   <h4>The <i>Login</i> Page</h4>
     283  <h4><a name="loginPage">The <i>Login</i> Page</a></h4>
    269284
    270285  <p>
     
    300315  </p>
    301316 
    302   <h4>The <i>Flight selection</i> Page</h4>
    303 
     317  <h4><a name="flightSelectionPage">The <i>Flight selection</i> Page</a></h4>
     318
     319  <img src="flightSelection.png" alt="The Flight selection page"/>
     320 
    304321  <p>
    305322  This page displays the list of the flight you have booked previously
     
    337354  </p>
    338355
    339   <h4>The <i>LHBP gate selection</i> Page</h4>
     356  <h4><a name="gataSelectionPage">The <i>LHBP gate selection</i> Page</a></h4>
     357 
     358  <img src="gateSelection.png" alt="The LHBP gate selection page"/>
    340359 
    341360  <p>
     
    350369  </p>
    351370
    352   <h4>The <i>Connect to the simulator</i> Page</h4>
    353 
     371  <h4><a name="connectPage">The <i>Connect to the simulator</i> Page</a></h4>
     372
     373  <img src="connect.png" alt="The Connect to the simulator page"/>
     374 
    354375  <p>
    355376  This page displays some important information about your flight,
     
    372393  </p>
    373394
    374   <h4>The <i>Payload</i> Page</h4>
    375 
     395  <h4><a name="payloadPage">The <i>Payload</i> Page</a></h4>
     396
     397  <img src="payload.png" alt="The Payload page"/>
     398 
    376399  <p>
    377400  This page displays the components of the flight's payload and the
     
    392415  </p>
    393416
    394   <h4>The <i>Time</i> Page</h4>
    395 
     417  <h4><a name="timePage">The <i>Time</i> Page</a></h4>
     418
     419  <img src="time.png" alt="The Time page"/>
     420 
    396421  <p>
    397422  This page displays the departure and arrival times of your
     
    410435  </p>
    411436
    412   <h4>The <i>Fuel</i> Page</h4>
    413 
     437  <h4><a name="fuelPage">The <i>Fuel</i> Page</a></h4>
     438
     439  <img src="fuel.png" alt="The Fuel page"/>
     440 
    414441  <p>
    415442  This page contains a graphical representation of the fuel tanks of
     
    441468  </p>
    442469
    443   <h4>The <i>Route</i> Page</h4>
     470  <h4><a name="routePage">The <i>Route</i> Page</a></h4>
     471 
     472  <img src="route.png" alt="The Route page"/>
    444473 
    445474  <p>
     
    458487  </p>
    459488
    460   <h4>The <i>Briefing</i> Pages</h4>
     489  <h4><a name="briefingPage">The <i>Briefing</i> Pages</a></h4>
     490 
     491  <img src="briefing.png" alt="The Briefing page"/>
    461492 
    462493  <p>
     
    478509  </p>
    479510 
    480   <h4>The <i>Takeoff</i> Page</h4>
    481 
     511  <h4><a name="takeoffPage">The <i>Takeoff</i> Page</a></h4>
     512
     513  <img src="takeoff.png" alt="The Takeoff page"/>
     514 
    482515  <p>
    483516  On this page you have to enter the name of the departure runway, the
     
    492525  </p>
    493526
    494   <h4>The <i>Landing</i> Page</h4>
     527  <h4><a name="landingPage">The <i>Landing</i> Page</a></h4>
     528
     529  <img src="landing.png" alt="The Landing page"/>
    495530
    496531  <p>
     
    508543  </p>
    509544
    510   <h4>The <i>Finish</i> Page</h4>
     545  <h4><a name="finishPage">The <i>Finish</i> Page</a></h4>
     546
     547  <img src="finish.png" alt="The Finish page"/>
    511548
    512549  <p>
     
    543580  </p>
    544581 
    545   <h3>The Flight info Tab</h3>
     582  <h3><a name="flightInfoTab">The Flight info Tab</a></h3>
     583
     584  <img src="flightInfoTab.png" alt="The Flight info tab"/>
    546585
    547586  <p>
     
    569608  </p>
    570609
    571   <h3>The Help Tab</h3>
     610  <h3><a name="helpTab">The Help Tab</a></h3>
     611
     612  <img src="helpTab.png" alt="The Help tab"/>
    572613
    573614  <p>
     
    595636  </p>
    596637 
    597   <h3>The Log Tab</h3>
     638  <h3><a name="logTab">The Log Tab</a></h3>
     639
     640  <img src="logTab.png" alt="The Log tab"/>
    598641
    599642  <p>
     
    612655  fault points have been awarded. For example, you may even decide to
    613656  abort the flight, if you think some of the faults are to
    614   embarrassing :)
    615   </p>
    616 
    617   <h3>The Gates Tab</h3>
     657  embarrassing :) For quick identification, the lines containing the
     658  fault messages are highlighted.
     659  </p>
     660
     661  <h3><a name="gatesTab">The Gates Tab</a></h3>
     662
     663  <img src="gatesTab.png" alt="The Gates tab"/>
    618664
    619665  <p>
     
    646692  </p>
    647693
    648   <h3>The Debug log</h3>
     694  <h3><a name="debugLog">The Debug log</a></h3>
     695
     696  <img src="debugLogTab.png" alt="The Debug log tab"/>
    649697
    650698  <p>
     
    657705  </p>
    658706
    659   <h2>Loading PIREPs</h2>
     707  <h2><a name="loadingPIREPs">Loading PIREPs</a></h2>
    660708
    661709  <p>
     
    677725  </p>
    678726
    679   <h2>Editing checklists</h2>
     727  <div align="center">
     728    <img src="pirepLoaded.png" alt="The loaded PIREP window"/>
     729  </div>
     730
     731  <p>
     732  You may also want to view a saved PIREP, for example, if it is a
     733  PIREP about an entrance exam flight. To do so, click the <b>View
     734  PIREP...</b> button. This displays the PIREP viewer window, which
     735  groups the data into three tabs. The <i>Data</i> tab contains the
     736  itemized data of the flight. The <i>Comments & defects</i> tab
     737  displays the comments and or flight defects entered by the
     738  user. The <i>Log</i> tab contains the flight log.
     739
     740  <div align="center">
     741    <img src="pirepViewer.png" alt="The PIREP Viewer"/>
     742  </div>
     743
     744  <h2><a name="checklistEditor">Editing checklists</a></h2>
     745
     746  <img src="checklistEditor.png" alt="The Checklist Editor"/>
    680747
    681748  <p>
     
    717784  </p>
    718785 
    719   <h2>The Preferences Window</h2>
     786  <h2><a name="prefs">The Preferences Window</a></h2>
    720787
    721788  </p>
     
    727794  </p>
    728795 
    729   <h3>The <i>General</i> Tab</h3>
    730  
     796  <h3><a name="prefsGeneral">The <i>General</i> Tab<a></h3>
     797 
     798  <img src="prefsGeneral.png" alt="The General Tab of Preferences"/>
     799
    731800  <p>
    732801  These are some general settings for various parts of the
     
    769838  </p>
    770839
    771   <h3>The <i>Messages</i> Tab</h3>
     840  <h3><a name="prefsMessages">The <i>Messages</i> Tab</a></h3>
    772841 
     842  <img src="prefsMessages.png" alt="The Messages Tab of Preferences"/>
     843
    773844  <p>
    774845  The program can display messages about certain events in the
     
    814885  </p>
    815886
    816   <h3>The <i>Sounds</i> Tab</h3>
    817  
     887  <h3><a name="prefsSounds">The <i>Sounds</i> Tab</a></h3>
     888 
     889  <img src="prefsSounds.png" alt="The Sounds Tab of Preferences"/>
     890
    818891  <p>
    819892  This tab controls how the sounds are played by the application.
     
    853926  </p>
    854927
    855   <h3>The <i>Advanced</i> Tab</h3>
     928  <h3><a name="prefsAdvanced">The <i>Advanced</i> Tab</a></h3>
     929
     930  <img src="prefsAdvanced.png" alt="The Advanced Tab of Preferences"/>
    856931
    857932  <p>
     
    867942  </p>
    868943
    869   <h2>The Monitor Window</h2>
     944  <h2><a name="monitorWindow">The Monitor Window</a></h2>
     945
     946  <img src="monitorWindow.png" alt="The Monitor Window"/>
    870947
    871948  <p>
Note: See TracChangeset for help on using the changeset viewer.