Changeset 460:13cac3147759 for doc


Ignore:
Timestamp:
03/12/13 16:47:30 (11 years ago)
Author:
István Váradi <ivaradi@…>
Branch:
version_0.15
hg-Phase:
(<MercurialRepository 1 'hg:/home/ivaradi/mlx/hg' '/'>, 'public')
Message:

Updated the English-language user's guide

File:
1 edited

Legend:

Unmodified
Added
Removed

  • doc/manual/en/index.html

    r285 r460  
    3535  <p>
    3636  Besides the faults the program also monitors many other parameters,
    37   which are recorded in a textual <a href="#logTab"><i>log</i></a>. 
     37  which are recorded in a textual <a href="#logTab"><i>log</i></a>.
    3838  This log is sent as a part of your PIREP
    39   (<b>PI</b>lot's <b>REP</b>ort), and will be   analyzed, and possibly 
     39  (<b>PI</b>lot's <b>REP</b>ort), and will be   analyzed, and possibly
    4040  commented on by more experienced pilots of  Malév Virtual. This way
    4141  you can perfect the way you execute your flights.
    … …  
    4444  <p><a name="flightStages"/>
    4545  The application breaks up your flight into
    46   several <i>stage</i>s. The advancement from one stage to another is 
     46  several <i>stage</i>s. The advancement from one stage to another is
    4747  detected automatically. These stages and the conditions under which
    4848  they are entered are as follows:
    … …  
    5353    or your ground speed becomes 5 knots or greater during the
    5454    boarding stage, your flight enters this stage.</li>
    55     <li><b>takeoff</b>: If you turn on the landing and/or the strobe
    56     lights or your ground speed exceeds 80 knots during taxi or after
    57     a rejected takeoff (RTO).</li>
     55    <li><b>takeoff</b>: If you turn on the strobe lights
     56    during taxi or after a rejected takeoff (RTO). If your plane has
     57    not strobe lights, the program will track your status after
     58    exceeding 50 knots during the <i>taxi</i> stage, and if you lift
     59    off within less than 30 seconds, it will be considered a takeoff.</li>
    5860    <li><b>climb</b>: When you retract the gears or you reach 3000
    5961    feet altitude AGL with a positive climb rate after takeoff.</li>
    … …  
    7072    <li><b>taxi after landing</b>: When the aircraft is in the
    7173    ground and its ground speed is below 50 knots after landing.</li>
    72     <li><b>parking</b>: If the parking brake is activated after taxi.</li>
    7374    <li><b>end</b>: If the N<sub>1</sub> of the turbines becomes
    7475    less than 0.5, or the RPM of the piston engines becomes 0 during
    … …  
    7778
    7879  <p>
    79   To enhance the simulation, the program can play various 
     80  To enhance the simulation, the program can play various
    8081  <a href="#prefsSounds">sound</a> files
    8182  during the various stages of your flight, such as the announcements
    … …  
    8485  a certain hotkey in the flight simulator. You can also organize
    8586  pre-recorded sound files
    86   into <a href="#checklistEditor">checklists</a> for the each aircraft 
     87  into <a href="#checklistEditor">checklists</a> for the each aircraft
    8788  type, and these files can also be played back one-by-one when you
    88   repeatedly press a key combination in the simulator. See 
     89  repeatedly press a key combination in the simulator. See
    8990  <a href="#prefsSounds">below</a> for more information on this.
    9091  </p>
    … …  
    9495  displays the status of the flights in progress. The data appears on
    9596  the front page of the <a href="http://virtualairlines.hu">MAVA
    96   website</a> and also on a 
     97  website</a> and also on a
    9798  <a href="http://virtualairlines.hu/acars2/show.html">map</a>.
    9899  </p>
    … …  
    108109  at the indicated gate or stand in the simulator. If your flight
    109110  begins at Ferihegy and the aircraft is away (usually due to someone
    110   else's flight), you can <a href="#gateSelectionPage">select</a> 
     111  else's flight), you can <a href="#gateSelectionPage">select</a>
    111112  from which gate or stand you start your flight. The database of the
    112   Online Gate System can also be <a href="#gatesTab">displayed</a> 
     113  Online Gate System can also be <a href="#gatesTab">displayed</a>
    113114  by using the application.
    114115  </p>
    … …  
    165166  the icon, the flight stage and the current rating will be
    166167  displayed. The tray icon has a right-button menu as well with the
    167   following items: 
     168  following items:
    168169  <ul>
    169170    <li><b>Show main window</b>: displays or hides the main window.</li>
    170     <li><b>Show monitor window</b>: displays or hides the 
     171    <li><b>Show monitor window</b>: displays or hides the
    171172      <a href="#monitorWindow">monitor window</a>.</li>
    172173    <li><b>Quit</b>: quit the application. A confirmation window will
    … …  
    185186  starting a new instance of the program.
    186187  </p>
    187  
     188
    188189  <h2><a name="mainWindow">The Main Window</a></h2>
    189190
    … …  
    194195  which is described below.
    195196  </p>
    196  
     197
    197198  <a name="mainWindowShot"/>
    198199  <div align="center"><img src="mainWindow.png" alt="The main window"/></div>
    … …  
    205206  colour indicates the health of this communication channel.
    206207  </p>
    207  
     208
    208209  <p>
    209210  If it is grey, the program is not connected. This is normal before
    … …  
    226227  notify the author if this happens. In this case, try to copy and
    227228  save the <a href="#debugLog">debug log</a> and send it with your bug
    228   report. 
     229  report.
    229230  </p>
    230231
    … …  
    271272  the bottom.
    272273  </p>
    273  
     274
    274275  <p>
    275276  Most of the pages contain two buttons: <b>Next</b> and
    … …  
    285286  Many of the pages also contain a <b>Cancel flight</b>
    286287  button. Clicking this button will allow you to cancel the flight and
    287   go back to the <a href="#flightSelectionPage">flight selection</a> 
     288  go back to the <a href="#flightSelectionPage">flight selection</a>
    288289  if you have logged in to the MAVA server, or to the login page, after
    289290  a confirmation of your intent.
    … …  
    293294
    294295  <p>
    295   The program starts with the Login page (see the 
     296  The program starts with the Login page (see the
    296297  <a href="#mainWindowShot">picture</a> above) where you can enter the
    297298  your pilot's ID and password for the MAVA website. Both data are
    … …  
    304305  the program, so you don't have to enter it all the time. Note,
    305306  however, that the password is saved in a readable form into a
    306   configuration file, so you this possibility only if your home
    307   directory can be  accessed only by people you trust. The pilot's ID
     307  configuration file, so use this possibility only if your home
     308  directory can be accessed only by people you trust. The pilot's ID
    308309  is saved anyway.
    309310  </p>
    … …  
    325326  next page, without trying to log in to the MAVA server.
    326327  </p>
    327  
     328
    328329  <h4><a name="flightSelectionPage">The <i>Flight selection</i> Page</a></h4>
    329330
    330331  <img src="flightSelection.png" alt="The Flight selection page"/>
    331  
     332
    332333  <p>
    333334  This page displays the list of the flight you have booked previously
    … …  
    366367
    367368  <h4><a name="gateSelectionPage">The <i>LHBP gate selection</i> Page</a></h4>
    368  
     369
    369370  <img src="gateSelection.png" alt="The LHBP gate selection page"/>
    370  
     371
    371372  <p>
    372373  This page is displayed after the flight selection page only if your
    … …  
    383384
    384385  <img src="connect.png" alt="The Connect to the simulator page"/>
    385  
     386
    386387  <p>
    387388  This page displays some important information about your flight,
    … …  
    398399  or <b>Cancel</b> to go back to the flight selection or to the login page.
    399400  </p>
    400  
     401
    401402  <p>
    402403  Note, that after a successful connection, the monitoring of your
    … …  
    407408  <h4><a name="payloadPage">The <i>Payload</i> Page</a></h4>
    408409
    409   <img src="payload.png" alt="The Payload page"/>
    410  
     410  <img src="payload.png" alt="The Payload page"/><!-- TODO: update -->
     411
    411412  <p>
    412413  This page displays the components of the flight's payload and the
    413   calculated Zero-Fuel Weight (ZFW). You can enter here the cargo
    414   weight you determined for your flight. You can also press the <b>ZFW
     414  calculated Zero-Fuel Weight (ZFW). You can modify all input data,
     415  but generally it is needed to enter the cargo weight you determined
     416  for the flight, if it is different from 0. You can also press the <b>ZFW
    415417  from FS</b> button, which queries the ZFW from the simulator and
    416418  displays the retrieved value. If the ZFW calculated from the payload
    … …  
    425427  becomes available, which you can use if you have failed to set up
    426428  the correct payload in the simulator. See a more detailed
    427   description of it <a href="#helpTab">below</a>. 
     429  description of it <a href="#helpTab">below</a>.
    428430  </p>
    429431
    … …  
    431433
    432434  <img src="time.png" alt="The Time page"/>
    433  
     435
    434436  <p>
    435437  This page displays the departure and arrival times of your
    … …  
    451453
    452454  <img src="fuel.png" alt="The Fuel page"/>
    453  
     455
    454456  <p>
    455457  This page contains a graphical representation of the fuel tanks of
    456458  your aircraft. The yellowish colour represents the current level of
    457459  the fuel in the tank, and turquoise slider is the expected level,
    458   which is also displayed numerically (in kilograms) below each graph. 
     460  which is also displayed numerically (in kilograms) below each graph.
    459461  </p>
    460462
    … …  
    478480  growing or shrinking (fuel may be pumped out of a tank as
    479481  well). This is a relatively quick process and should finish within a
    480   few seconds. 
     482  few seconds.
    481483  </p>
    482484
    483485  <h4><a name="routePage">The <i>Route</i> Page</a></h4>
    484  
     486
    485487  <img src="route.png" alt="The Route page"/>
    486  
     488
    487489  <p>
    488490  This page displays the cruise level and the flight plan route. The
    … …  
    501503
    502504  <h4><a name="briefingPage">The <i>Briefing</i> Pages</a></h4>
    503  
     505
    504506  <img src="briefing.png" alt="The Briefing page"/>
    505  
     507
    506508  <p>
    507509  These pages display the NOTAMs and the METAR for the departure and
    … …  
    521523  the boarding stage.
    522524  </p>
    523  
     525
    524526  <h4><a name="takeoffPage">The <i>Takeoff</i> Page</a></h4>
    525527
    526   <img src="takeoff.png" alt="The Takeoff page"/>
    527  
     528  <img src="takeoff.png" alt="The Takeoff page"/><!-- TODO: update -->
     529
    528530  <p>
    529531  On this page you have to enter the name of the departure runway, the
    … …  
    540542
    541543  <p>
     544  For most aircraft in the fleet you should also enter the takeoff
     545  derate setting. Its exact format and value depends on the type.
     546  </p>
     547
     548  <p>
     549  You can also select here whether you have turned on any anti-ice
     550  systems (apart from the pitot heat). However, for most aircraft, the
     551  logger can detect the setting, and if anti-icing is turned on, the
     552  check box will be checked automatically. If you have checked it
     553  yourself, it will not be unchecked by the program (unless it gains
     554  self-awareness sometime in the future).
     555  </p>
     556
     557  <p>
    542558  You can proceed to the next page after takeoff, and if all data has
    543559  been entered, by pressing the <b>Next</b> button.
    544560  </p>
    545561
     562  <h4><a name="cruisePage">The <i>Cruise</i> Page</a></h4>
     563
     564  <img src="cruise.png" alt="The Cruise page"/><!-- TODO: create -->
     565
     566  <p>
     567  This page displays your cruise altitude as set on the
     568  <a href="#routePage">Route page</a>. If you need to modify your
     569  cruise level due to airspace requirements, step climb or any other
     570  justified reason, you can set the new level here and then press
     571  the <b>Update</b> button when you have reached the specified level.
     572  </p>
     573
     574  <p>
     575  If you are preparing for landing, you can pressing the <b>Next</b>
     576  button to go to the next page.
     577  </p>
     578
    546579  <h4><a name="landingPage">The <i>Landing</i> Page</a></h4>
    547580
    548   <img src="landing.png" alt="The Landing page"/> 
     581  <img src="landing.png" alt="The Landing page"/><!-- TODO: update -->
    549582
    550583  <p>
    551584  On this page you have to enter the name of the STAR and/or
    552585  transition you planned to follow (even if you get a different one,
    553   or simply vectors from ATC, in which case add a 
     586  or simply vectors from ATC, in which case add a
    554587  <a href="#flightInfoTab">comment</a> about it),
    555588  the approach type (e.g. <q>ILS</q>, <q>VOR</q>, <q>VISUAL</q>,
    … …  
    561594
    562595  <p>
     596  This page also contains a checkbox for the anti-ice system, which is
     597  handled the same way as the one on
     598  the <a href="#takeoffPage">Takeoff page</a>.
     599
     600  <p>
    563601  When you have entered all data, press the <b>Next</b> button. It is
    564602  active only, if the flight has ended.
    … …  
    567605  <h4><a name="finishPage">The <i>Finish</i> Page</a></h4>
    568606
    569   <img src="finish.png" alt="The Finish page"/> 
     607  <img src="finish.png" alt="The Finish page"/>
    570608
    571609  <p>
    … …  
    582620  the Online Gate System, you also need to specify the number of the
    583621  gate or stand you have parked you aircraft at.
     622  </p>
     623
     624  <p>
     625  If all necessary data has been entered, and the program is so
     626  <a href="#prefsGeneral">configured<a>, it will automatically save
     627  the PIREP.
    584628  </p>
    585629
    … …  
    601645  you have logged in to the MAVA server, or to
    602646  the <a href="#loginPage">login page</a>, if your flight has been an
    603   offline flight. 
    604   </p>
    605  
     647  offline flight.
     648  </p>
     649
    606650  <h3><a name="flightInfoTab">The Flight info Tab</a></h3>
    607651
    608   <img src="flightInfoTab.png" alt="The Flight info tab"/> 
    609 
    610   <p>
    611   This tab allows one to enter some additional information about the 
     652  <img src="flightInfoTab.png" alt="The Flight info tab"/>
     653
     654  <p>
     655  This tab allows one to enter some additional information about the
    612656  flight, if necessary.
    613657  </p>
    614  
     658
    615659  <p>
    616660  The <i>Comments</i> text area should contain any general information
    … …  
    634678  <h3><a name="helpTab">The Help Tab</a></h3>
    635679
    636   <img src="helpTab.png" alt="The Help tab"/> 
     680  <img src="helpTab.png" alt="The Help tab"/>
    637681
    638682  <p>
    … …  
    653697  the <b>Simulator data</b> button, the data coming from the simulator
    654698  can be queried and displayed. If the data is out of the tolerances,
    655   it is displayed in red, otherwise in green. 
     699  it is displayed in red, otherwise in green.
    656700  </p>
    657701
    … …  
    661705  those maximums during the flight.
    662706  </p>
    663  
     707
    664708  <h3><a name="logTab">The Log Tab</a></h3>
    665709
    666   <img src="logTab.png" alt="The Log tab"/> 
     710  <img src="logTab.png" alt="The Log tab"/>
    667711
    668712  <p>
    … …  
    687731  <h3><a name="gatesTab">The Gates Tab</a></h3>
    688732
    689   <img src="gatesTab.png" alt="The Gates tab"/> 
     733  <img src="gatesTab.png" alt="The Gates tab"/>
    690734
    691735  <p>
    … …  
    721765  <h3><a name="debugLog">The Debug log</a></h3>
    722766
    723   <img src="debugLogTab.png" alt="The Debug log tab"/> 
     767  <img src="debugLogTab.png" alt="The Debug log tab"/>
    724768
    725769  <p>
    … …  
    753797
    754798  <div align="center">
    755     <img src="pirepLoaded.png" alt="The loaded PIREP window"/> 
     799    <img src="pirepLoaded.png" alt="The loaded PIREP window"/>
    756800  </div>
    757801
    … …  
    763807  itemized data of the flight. The <i>Comments & defects</i> tab
    764808  displays the comments and or flight defects entered by the
    765   user. The <i>Log</i> tab contains the flight log. 
     809  user. The <i>Log</i> tab contains the flight log.
    766810  </p>
    767811
    768812  <div align="center">
    769     <img src="pirepViewer.png" alt="The PIREP Viewer"/> 
     813    <img src="pirepViewer.png" alt="The PIREP Viewer"/>
    770814  </div>
    771815
    772816  <h2><a name="checklistEditor">Editing checklists</a></h2>
    773817
    774   <img src="checklistEditor.png" alt="The Checklist Editor"/> 
     818  <img src="checklistEditor.png" alt="The Checklist Editor"/>
    775819
    776820  <p>
    … …  
    796840  from the list. Then you can remove them with the <b>Remove</b>
    797841  button, or move them up or down by pressing <b>Move up</b>
    798   and <b>Move down</b>. 
     842  and <b>Move down</b>.
    799843  </p>
    800844
    … …  
    812856  the old checklist, or no checklist if there was none).
    813857  </p>
    814  
     858
    815859  <h2><a name="calloutsEditor">Editing approach callouts</a></h2>
    816860
    817   <img src="calloutsEditor.png" alt="The Approach callouts Editor"/> 
     861  <img src="calloutsEditor.png" alt="The Approach callouts Editor"/>
    818862
    819863  <p>
    … …  
    822866  approach callouts editor window allows editing the list of these
    823867  callout files for each aircraft. The window can be displayed by
    824   selecting  <b>Tools/Approach Callouts Editor...</b> or by  pressing 
     868  selecting  <b>Tools/Approach Callouts Editor...</b> or by  pressing
    825869  <b>Ctrl+E</b>.
    826870  </p>
    … …  
    842886  contains a number that is possible as an altitude, that will be used
    843887  as the altitude given to the file, otherwise some meaningful default
    844   is selected based on the lowest or highest altitude. 
     888  is selected based on the lowest or highest altitude.
    845889  There can be no two files with the same altitude. If you set an
    846890  altitude, which is already present in the list, a dialog box will be
    … …  
    861905  list of callouts have any effect during the flight.
    862906  </p>
    863  
     907
    864908  <h2><a name="prefs">The Preferences Window</a></h2>
    865909
    … …  
    871915  tabs grouping the options logically.
    872916  </p>
    873  
     917
    874918  <h3><a name="prefsGeneral">The <i>General</i> Tab<a></h3>
    875  
    876   <img src="prefsGeneral.png" alt="The General Tab of Preferences"/> 
     919
     920  <img src="prefsGeneral.png" alt="The General Tab of Preferences"/>
    877921
    878922  <p>
    … …  
    921965  </p>
    922966
     967  <p>
     968  If the <b>Save PIREP automatically</b> check box is checked, and you
     969  have finished your flight and entered all required data, the PIREP
     970  will be saved automatically into the directory given above.
     971  </p>
     972
    923973  <h3><a name="prefsMessages">The <i>Messages</i> Tab</a></h3>
    924  
    925   <img src="prefsMessages.png" alt="The Messages Tab of Preferences"/> 
     974
     975  <img src="prefsMessages.png" alt="The Messages Tab of Preferences"/><!-- TODO: update -->
    926976
    927977  <p>
    … …  
    941991    <li><b>Information Messages</b>: informational messages about,
    942992    e.g., the flight stage, the end of an audio checklist, etc.</li>
     993    <li><b>In-flight Stage Message</b>: messages about the flight stage for those stage when the plane is not on the ground</li>
    943994    <li><b>Fault Messages</b>: messages about the non-NO GO faults the program detects.</li>
    944995    <li><b>NO GO Fault Messages</b>: messages about the NO GO faults the program detects</li>
    945     <li><b>Gate System Messages</b>: messages related to the 
     996    <li><b>Gate System Messages</b>: messages related to the
    946997    <a href="#onlineGateSystem">Online Gate System</a>. For example,
    947998    when you have landed at Ferihegy, it can display the list of the
    948999    available gates so that you can choose where to park, if there is
    949     no ATC available.</li> 
     1000    no ATC available.</li>
    9501001    <li><b>Environment Messages</b>: other messages, e.g. the welcome
    9511002    message when the flight has ended.</li>
    … …  
    9701021
    9711022  <h3><a name="prefsSounds">The <i>Sounds</i> Tab</a></h3>
    972  
    973   <img src="prefsSounds.png" alt="The Sounds Tab of Preferences"/> 
     1023
     1024  <img src="prefsSounds.png" alt="The Sounds Tab of Preferences"/>
    9741025
    9751026  <p>
    … …  
    9981049  If the <b>Enable approach callouts</b> checkbox is
    9991050  checked, and you have also <a href="#calloutsEditor">set up</a>
    1000   approach callouts for the aircraft being used, you will hear those 
     1051  approach callouts for the aircraft being used, you will hear those
    10011052  callouts during approach.
    10021053  </p>
    … …  
    10141065  checkbox is selected. In this case another hotkey should be
    10151066  specified. If you press this hotkey, the next file from the
    1016   checklist will be played. 
     1067  checklist will be played.
    10171068  </p>
    10181069
    10191070  <h3><a name="prefsAdvanced">The <i>Advanced</i> Tab</a></h3>
    10201071
    1021   <img src="prefsAdvanced.png" alt="The Advanced Tab of Preferences"/> 
     1072  <img src="prefsAdvanced.png" alt="The Advanced Tab of Preferences"/>
    10221073
    10231074  <p>
    … …  
    10351086  <h2><a name="monitorWindow">The Monitor Window</a></h2>
    10361087
    1037   <img src="monitorWindow.png" alt="The Monitor Window"/> 
     1088  <img src="monitorWindow.png" alt="The Monitor Window"/><!-- TODO: update -->
    10381089
    10391090  <p>
    … …  
    10481099  program.
    10491100  </p>
    1050  
     1101
    10511102</html>
Note: See TracChangeset for help on using the changeset viewer.