Changeset 251:95fad03e0af0


Ignore:
Timestamp:
06/23/12 15:01:47 (12 years ago)
Author:
István Váradi <ivaradi@…>
Branch:
default
Phase:
public
Message:

Fixed some issues and added internal cross-references

File:
1 edited

Legend:

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

    r244 r251  
    1111  <p>
    1212  MAVA Logger X is an application that monitors the execution of a
    13   Malév Virtual flight, and collects data that can be sent to the MAVA
    14   website for further evaluation. This manual describes how to use
    15   this program. To be able to use all features of the program, you
    16   need to have a working Internet connection, even if you don't fly
    17   on-line on VATSIM or IVAO. However, it is possible to perform a
    18   flight completely offline as well.
    19   </p>
    20 
    21   <p>
     13  Malév Virtual flight, and collects data that can be sent to
     14  the <a href="http://virtualairlines.hu">MAVA website</a> for further
     15  evaluation. This manual describes how to use this program. To be
     16  able to use all features of the program, you need to have a working
     17  Internet connection, even if you don't fly on-line on VATSIM or
     18  IVAO. However, it is possible to perform a flight completely offline
     19  as well.
     20  </p>
     21
     22  <p><a name="flightRating"/>
    2223  While monitoring your flight, the program continuously checks if your
    2324  airplane's configuration is always within the parameters prescribed
     
    3435  <p>
    3536  Besides the faults the program also monitors many other parameters,
    36   which are recorded in a textual <i>log</i>. This log is sent as a
    37   part of your PIREP (<b>PI</b>lot's <b>REP</b>ort), and will be
    38   analyzed, and possibly commented on by more experienced pilots of
    39   Malév Virtual. This way you can perfect the way you execute your
    40   flights.
    41   </p>
    42 
    43   <p>
     37  which are recorded in a textual <a href="#logTab"><i>log</i></a>.
     38  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
     40  commented on by more experienced pilots of  Malév Virtual. This way
     41  you can perfect the way you execute your flights.
     42  </p>
     43
     44  <p><a name="flightStages"/>
    4445  The application breaks up your flight into
    4546  several <i>stage</i>s. The advancement from one stage to another is
     
    7677
    7778  <p>
    78   To enhance the simulation, the program can play various sound files
     79  To enhance the simulation, the program can play various
     80  <a href="#prefsSounds">sound</a> files
    7981  during the various stages of your flight, such as the announcements
    8082  made by the flight attendants. These files are supplied with the
    8183  application, and they can be played automatically, or when you press
    8284  a certain hotkey in the flight simulator. You can also organize
    83   pre-recorded sound files into checklists for the each aircraft
     85  pre-recorded sound files
     86  into <a href="#checklistEditor">checklists</a> for the each aircraft
    8487  type, and these files can also be played back one-by-one when you
    85   repeatedly press a key combination in the simulator. See below for
    86   more information on this.
    87   </p>
    88 
    89   <p>
     88  repeatedly press a key combination in the simulator. See
     89  <a href="#prefsSounds">below</a> for more information on this.
     90  </p>
     91
     92  <p><a name="onlineACARSSystem"/>
    9093  Malév Virtual have implemented an <i>Online ACARS System</i>, which
    9194  displays the status of the flights in progress. The data appears on
     
    9396  </p>
    9497
    95   <p>
     98  <p><a name="onlineGateSystem"/>
    9699  Malév Virtual have also implemented an <i>Online Gate System</i>
    97100  which maintains a database of the aircraft in the airline's fleet
     
    188191  which is described below.
    189192  </p>
    190 
     193 
     194  <a name="mainWindowShot"/>
    191195  <div align="center"><img src="mainWindow.png" alt="The main window"/></div>
    192196
     
    218222  you, unfortunately, have to restart the flight. Do not forget to
    219223  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.
     224  save the <a href="#debugLog">debug log</a> and send it with your bug
     225  report. 
    221226  </p>
    222227
     
    228233  <p>
    229234  To the right of the connection status icon, you can see the current
    230   stage of the flight, if the monitoring has begun. Otherwise it is a
    231   single dash. It is followed by the simulator time, if the program is
    232   already connected to the simulator. Then comes the current flight
    233   rating.
     235  <a href="#flightStages">stage</a> of the flight, if the monitoring
     236  has begun. Otherwise it is a single dash. It is followed by the
     237  simulator time, if the program is already connected to the
     238  simulator. Then comes the current <a href="#flightRating">flight rating</a>.
    234239  </p>
    235240
     
    269274  cases you can go back to previously visited pages by using
    270275  the <b>Previous</b> button, although you cannot edit the contents of
    271   those pages once finalized by moving to the next page using
     276  most of the pages once finalized by moving to the next page using
    272277  the <b>Next</b> button. There are a few exceptions though, as
    273278  detailed below.
     
    277282  Many of the pages also contain a <b>Cancel flight</b>
    278283  button. Clicking this button will allow you to cancel the flight and
    279   go back to the flight selection if you have logged in to the MAVA
    280   website, or the login page, after a confirmation of your intent.
     284  go back to the <a href="#flightSelectionPage">flight selection</a>
     285  if you have logged in to the MAVA website, or to the login page, after
     286  a confirmation of your intent.
    281287  </p>
    282288
     
    284290
    285291  <p>
    286   Each flight starts with the Login page where you can enter the your
    287   pilot's ID and password for the MAVA website. Both data are given
    288   to you when joining Malév Virtual. The pilot's ID usually starts
    289   with the letter <q>P</q> followed by three digits.
     292  Each flight starts with the Login page (see the
     293  <a href="#mainWindowShot">picture</a> above) where you can enter the
     294  your pilot's ID and password for the MAVA website. Both data are
     295  given to you when joining Malév Virtual. The pilot's ID usually
     296  starts with the letter <q>P</q> followed by three digits.
    290297  </p>
    291298
     
    293300  If you check <b>Remember password</b>, the password will be saved by
    294301  the program, so you don't have to enter it all the time. Note,
    295   however, that the password is saved plainly into a configuration
    296   file, so you this possibility only if your home directory can be
    297   accessed only by people you trust. The pilot's ID is saved anyway.
     302  however, that the password is saved in a readble form into a
     303  configuration file, so you this possibility only if your home
     304  directory can be  accessed only by people you trust. The pilot's ID
     305  is saved anyway.
    298306  </p>
    299307
     
    321329  <p>
    322330  This page displays the list of the flight you have booked previously
    323   on the MAVA website, if you have logged in properly. If you chose to
    324   fly offline, the list is empty.
     331  on the MAVA website, if you have <a href="#loginPage">logged in</a>
     332  properly. If you chose to fly offline, the list is empty.
    325333  </p>
    326334
     
    350358
    351359  <p>
    352   Select a flight from the list, and press <b>Next</b> button to
     360  Select a flight from the list, and press the <b>Next</b> button to
    353361  proceed with that flight.
    354362  </p>
     
    410418  <p>
    411419  If you have finished with this page, press the <b>Next</b>
    412   button. At this point, the <i>Help</i> tab becomes available, which
    413   you can use if you have failed to set up the correct payload in the
    414   simulator. See a more detailed description of it below.
     420  button. At this point, the <a href="#helpTab"><i>Help</i> tab</a>
     421  becomes available, which you can use if you have failed to set up
     422  the correct payload in the simulator. See a more detailed
     423  description of it <a href="#helpTab">below</a>.
    415424  </p>
    416425
     
    448457  <p>
    449458  You can enter the requested amount of fuel numerically, or you can
    450   set it by the turquoise sliders, though this method less accurate. The
    451   lever can be moved by clicking in the fuel tank's representation,
     459  set it by the turquoise sliders, though this method is less accurate. The
     460  lever can be moved by clicking withinin the fuel tank's representation,
    452461  and you can drag it if you keep the button pressed. If your mouse
    453462  has a wheel, that can also be used to modify the expected level. To
     
    498507  entering the landing stage, unless you have edited it before. The
    499508  METARs can be edited during the whole duration of the flight. If you
    500   do so, please, comment it in the <i>Comments</i> sections of
    501   the <i>Flight info</i> tab.
     509  do so, please, comment on it in the <i>Comments</i> sections of
     510  the <a href="#flightInfoTab"><i>Flight info</i> tab</a>.
    502511  </p>
    503512
     
    536545
    537546  <p>
    538   On this page you have to enter the name of the STAR and/or transition followed
    539   (if you get vectors from ATC, enter <q>VECTORS</q> here), the
    540   approach type (e.g. <q>ILS</q>, <q>VOR</q>, <q>VISUAL</q>, etc.),
    541   the name of the landing runway, and the landing reference speed,
     547  On this page you have to enter the name of the STAR and/or
     548  transition you planned to follow (even if you get a different one,
     549  or simply vectors from ATC, in which case add a
     550  <a href="#flightInfoTab">comment</a> about it),
     551  the approach type (e.g. <q>ILS</q>, <q>VOR</q>, <q>VISUAL</q>,
     552  etc.), the name of the landing runway, and the landing reference speed,
    542553  V<sub>ref</sub>. You can enter this data during the flight, or after
    543554  you have landed, at your discretion. Note, that if you fly one of
    544   the Tupolev or Yak aircraft, the speed will have to be entered in
    545   km/h.
     555  the Tupolev or Yak aircraft, the speed will have to be entered in km/h.
    546556  </p>
    547557
     
    571581
    572582  <p>
    573   With all data entered, you may want it review your flight, then save
    574   or send the PIREP created from it. These can be accomplished by
    575   pressing one of the buttons at the bottom. A saved PIREP can be
    576   loaded later and sent, if the sending fails for some reason. When a
    577   PIREP is sent, it becomes available for review by the designated
    578   PIREP reviewers of Malév Virtual.
     583  With all data entered, you may want it review your flight (i.e. the
     584  earlier pages or some of the other tabs), then save or send the
     585  PIREP created from it. These can be accomplished by pressing one of
     586  the buttons at the bottom. A saved PIREP can be loaded later and
     587  sent, if the sending fails for some reason. When a PIREP is sent, it
     588  becomes available for review by the designated PIREP reviewers of
     589  Malév Virtual.
    579590  </p>
    580591
     
    583594  button. If you have not saved or sent the PIREP, you will be asked
    584595  to confirm your intention. When starting a new flight you are taken
    585   to the flight selection page, if you have logged in to the MAVA
    586   website, or to the login page, if your flight has been an offline
    587   flight.
     596  to the <a href="#flightSelectionPage">flight selection page</a>, if
     597  you have logged in to the MAVA website, or to
     598  the <a href="#loginPage">login page</a>, if your flight has been an
     599  offline flight. 
    588600  </p>
    589601 
     
    622634  <p>
    623635  This tab provides some help for calculating and setting the payload
    624   weight of the aircraft. It can be used once the <i>Payload</i>
     636  weight of the aircraft. It can be used once the
     637  <a href="#payloadPage"><i>Payload</i></a>
    625638  (i.e. the cargo weight) is finalized. To use this tab, check
    626639  the <b>Using help</b> checkbox. It causes the page to become
    627640  sensitive and filled with data. Note, that the fact of using the
    628   help is logged, so the PIREP reviewers will know about it.
     641  help is <a href="#logTab">logged</a>, so the PIREP reviewers will
     642  know about it.
    629643  </p>
    630644
     
    662676  the log to see what happened exactly, so that you know why so many
    663677  fault points have been awarded. For example, you may even decide to
    664   abort the flight, if you think some of the faults are to
     678  abort the flight, if you think some of the faults are too
    665679  embarrassing :) For quick identification, the lines containing the
    666680  fault messages are highlighted.
     
    672686
    673687  <p>
    674   This tab displays information retrieved from the MAVA Online Gate
     688  This tab displays information retrieved from
     689  the <a href="#onlineGateSystem">MAVA Online Gate</a>
    675690  System. If the program needs to retrieve data, this tab's contents
    676   are refreshed automatically, but you can refresh them manually
     691  are refreshed automatically, but you can also refresh them manually
    677692  anytime using the <b>Refresh data</b> button.
    678693  </p>
     
    710725  useful for debugging. If you experience some problem with the
    711726  program, please, include the contents of this log with your bug
    712   report. It can help a low with finding a solution to the problem.
     727  report. It can help a lot with finding a solution to the problem.
    713728  </p>
    714729
     
    756771  <p>
    757772  The checklists are lists of audio files. When checklist playback is
    758   enabled (see the description of the <i>Preferences</i> window below), and
    759   there is a checklist for the type of the aircraft used for the
    760   flight, the files constituting the checklist can be played
    761   one-by-one by pressing the checklist hotkey repeatedly.
     773  enabled (see the <a href="#prefsSounds">description</a> of
     774  the <i>Preferences</i> window below), and there is a checklist for
     775  the type of the aircraft used for the flight, the files constituting
     776  the checklist can be played one-by-one by pressing the checklist
     777  hotkey repeatedly.
    762778  </p>
    763779
     
    770786
    771787  <p>
    772   The files making up the checklist for the currently selected flight
     788  The files making up the checklist for the currently selected aircraft
    773789  are displayed on the right. You can move a file up or down by
    774790  dragging it with the mouse. You can also select one or more files
     
    798814  selecting <b>Tools/Preferences</b> or by
    799815  pressing <b>Ctrl+P</b>. Here you can set options that you usually
    800   don't have to change for every flight. This window also consists of
     816  don't have to change for every flight. This window consists of
    801817  tabs grouping the options logically.
    802818  </p>
     
    819835  it will actually disappear completely (i.e. not appear among the
    820836  other minimized windows). You can make it appear by using the tray
    821   icon.
     837  icon. If the <b>Quit when the window close button is clicked</b>
     838  checkbox is checked, the program will quit, after you have confirmed
     839  it. Otherwise it will just disappear, and you can use the tray icon
     840  to display it again.
    822841  </p>
    823842
    824843  <p>
    825844  The <i>MAVA Online Systems</i> frame contains settings related to
    826   the online systems of MAVA, the gate and the ACARS systems mentioned
    827   above. It is recommended to enabled these for normal operations.
     845  the online systems of MAVA, the <a href="#onlineGateSystem">gate</a>
     846  and the <a href="#onlineACARSSystem">ACARS</a> systems mentioned
     847  above. It is recommended to enable these for normal operations.
    828848  </p>
    829849
     
    836856  experiencing some very high indicated airspeeds, which in turn can
    837857  also cause the autopilot to suddenly increase the climb rate to
    838   counter the high speeds. Since this phenomenon is difficult to
    839   protect oneself against without buying extra products, like FSUIPC,
    840   the logger provides the possibility to average the IAS and/or the VS
    841   over a few seconds so that spikes in these values are
    842   smoothed. The <b>Enable the smoothing of IAS/VS over N sec.</b>
    843   options allow controlling this feature. The number of seconds may
    844   need experimenting with, but note that every change for which you
    845   press the <b>OK</b> button is taken into account immediately.
     858  counter the high speeds or other erratic behaviour. Since these
     859  phenomena are difficult to protect oneself against without buying
     860  extra products, like FSUIPC, the logger provides the possibility to
     861  average the IAS and/or the VS over a few seconds so that spikes in
     862  these values are smoothed. The <b>Enable the smoothing of IAS/VS
     863  over N sec.</b> options allow controlling this feature. The number
     864  of seconds may need experimenting with, but note that every change
     865  for which you press the <b>OK</b> button is taken into account
     866  immediately.
    846867  </p>
    847868
     
    868889    <li><b>Fault Messages</b>: messages about the non-NO GO faults the program detects.</li>
    869890    <li><b>NO GO Fault Messages</b>: messages about the NO GO faults the program detects</li>
    870     <li><b>Gate System Messages</b>: messages related to the Online
    871     Gate System. For example, when you have landed at Ferihegy, it can display
    872     the list of the available gates so that you can choose where to
    873     park, if there is no ATC available.</li>
     891    <li><b>Gate System Messages</b>: messages related to the
     892    <a href="#onlineGateSystem">Online Gate System</a>. For example,
     893    when you have landed at Ferihegy, it can display the list of the
     894    available gates so that you can choose where to park, if there is
     895    no ATC available.</li>
    874896    <li><b>Environment Messages</b>: other messages, e.g. the welcome
    875897    message when the flight has ended.</li>
     
    928950  The lower part, named <i>Checklist</i> contains some settings
    929951  related to the audio checklists belonging to the aircraft. They are
    930   available only if the <b>Enable aircraft-specific checklist></b>
     952  available only if the <b>Enable aircraft-specific checklist</b>
    931953  checkbox is selected. In this case another hotkey should be
    932954  specified. If you press this hotkey, the next file from the
Note: See TracChangeset for help on using the changeset viewer.