Changeset 774:3891bf84376d for doc/manual

Timestamp:

05/08/16 12:10:56 (9 years ago)

Author:

István Váradi <ivaradi@…>

Branch:

default

Phase:

public

Message:

Updated the documentation to reflect the changes related to the registration (re #285)

Location:

doc/manual

Files:

• en/index.html (modified) (2 diffs)
• en/mainWindow.png (modified) ( previous)
• en/registration.png (added)
• en/registrationDialog.png (added)
• en/student.png (added)
• hu/index.html (modified) (2 diffs)
• hu/mainWindow.png (modified) ( previous)
• hu/registration.png (added)
• hu/registrationDialog.png (added)
• hu/student.png (added)

doc/manual/en/index.html

@@ -200 +200 @@
   </p>
 
+  <p>
+  When the program is first started on your computer, you will be presented
+  with the dialog below:
+  </p>
+  <div align="center">
+    <img src="registrationDialog.png" alt="The registration query dialog"/>
+  </div>
+
+  <p>
+  If you have not registered with MAVA yet, click on <b>Register</b>. The
+  registration process is described <a href="#registration">here</a>.
+  If you have a pilot ID and a password already, click <b>Cancel</b> and
+  continue as below.
+  </p>
+
   <h2><a name="mainWindow">The Main Window</a></h2>
 
@@ -1238 +1253 @@
   </p>
 
+  <h2><a name="registration">Registration</a></h2>
+
+  <img src="registration.png" alt="The Registration page"/>
+
+  <p>
+  When you choose to register, the <i>Registraton</i> page is displayed. Enter
+  the data requested. The data items in italics (phone number and nationality)
+  are not mandatory. One of VATSIM or an IVAO ID are mandatory, so register
+  with one of these on-line networks first. The password should be at least 5
+  characters long. It is recommended to use one that consists of a mix of
+  upper- and lower-case letters, numbers and possibly special characters.
+  </p>
+
+  <p>
+  When all necessary data has been entered, click <b>Register</b>. Your data
+  will be recored in the MAVA database, and if all goes well, a dialog is
+  displayed containing your <i>Pilot ID</i>, which is in the
+  format <i>Pnnn</i>, where <i>nnn</i> is a 3-digit number (e.g. <i>P210</i>).
+  Note it down for further reference along with your password. These data can
+  be used to log in to the MAVA website, forums and education centre.
+  </p>
+
+  <p>
+  When you click <b>OK</b> in the dialog, you will be taken to the <i>Student</i>
+  page:
+  </p>
+
+  <img src="student.png" alt="The Student page"/>
+
+  <p>
+  This page displays the status of you entry exam and check flight and you can
+  also initiate these from here.
+  </p>
+
+  <p>
+  The entry exam is an online theoretical exam, taken in the
+  <a href="http://mavasystems.hu/moodle">MAVA Education Centre</a>. Clicking
+  the <b>Take the entry exam</b> button takes you to the login page, where you
+  should enter your pilot ID and password to get access to the exam. If you
+  have successfully completed the test the status in the <i>Student</i> page
+  will update. However, this might take a few minutes until the website will
+  update itself and the logger will also notice it.
+  </p>
+
+  <p>
+  The check flight is a simple flight, during which you take off from the
+  Budapest Ferihegy Airport (LHBP), fly a SID, fly to the entry point of an
+  approach transition, fly the transition and land. (If you are not familiar
+  with these ideas, please, learn about them as you will need to know them
+  perform your regular flights for MAVA.) You can select the type of the
+  aircraft you wish to fly (currently the Boeing 737NG family and the Bomardier
+  Dash-8 Q400 are available), and then click on <b>Perform the check
+  flight</b>. You will be then <a href="#tabFlight">taken through</a> the steps
+  of the flight almost as in case of a regular flight starting with the
+  <a href="#connectPage"><i>Connect</i></a> page.
+  </p>
+
+  <p>
+  Your flight is successful, if you commit no NO-GO mistakes, otherwise you
+  need to try it again. In both cases you can save the PIREP into a file and
+  send it to your mentor at MAVA for further advice.
+  </p>
+
+  <p>
+  If you start the program later, it will check your rank. If it is STU
+  (student), you will always be taken to this page. If you have passed both the
+  entry exam and the check flight, your rank will become FO (First Officer) and
+  which case you select flights via the MAVA website and fly them with the
+  logger. In this case, you will be taken to
+  the <a href="#flightSelectionPage">Flight selection</a> page after a
+  successful login.
+  </p>
+
 </html>

doc/manual/hu/index.html

@@ -198 +198 @@
   </p>
 
+  <p>
+  Ha a számítógépen először fut a program, az alábbi dialógus ablak jelenik meg:
+  </p>
+  <div align="center">
+    <img src="registrationDialog.png" alt="A regisztrációra rákérdező dialógus"/>
+  </div>
+
+  <p>
+  Ha még nincs regisztrációnk a MAVA-nál, kattintsunk a <b>Regisztráció</b>
+  gombra. A regisztráció folyamatának leírása <a href="#registration">itt</a>
+  olvasható el. Ha már van pilóta azonosítónk és jelszavunk, kattintsunk a
+  <b>Mégse</b> gombra, és az alábbiakban leírtaknak megfelelően haladjunk tovább.
+  </p>
+
   <h2><a name="mainWindow">A főablak</a></h2>
 
@@ -1275 +1289 @@
   </p>
 
+  <h2><a name="registration">Regisztráció</a></h2>
+
+  <img src="registration.png" alt="A Regisztráció oldal"/>
+
+  <p>
+  Ha a regisztrálás mellett döntöttünk, a <i>Regisztráció</i> oldal jelenik
+  meg. Írjuk be a kért adatokat. A dőlt betűvel jelölt adatokat (a
+  telefonszámot és a nemzetiséget) nem kötelező megadni. A VATSIM és az IVAO
+  azonosítók közül az egyiket viszont kötelező megadni, így valamelyik
+  hálózatban regisztráljunk előbb. A jelszónak legalább 5 karakter hosszúnak
+  kell lennie. Javasolt olyat választani, amelyben kis- és nagybetűk, számok
+  és akár speciális karakterek is egyaránt megtalálhatók.
+  </p>
+
+  <p>
+  Ha minden szükséges adatot beírtunk, kattintsünk a <b>Regisztráció</b>
+  gombra. Az adatok bekerülnek a MAVA adatbázisába, és ha minden jól megy, egy
+  dialógus ablakban megkapjuk a <i>pilóta azonosító</i>nkat. Ennek alkja
+  <i>Pnnn</i>, ahol <i>nnn</i> egy háromjegyű szám (pl. <i>P210</i>).
+  Ezt a jelszóval együtt célszerű lejegyezni. Ezekkel az adatokkal tudunk
+  bejelentkezni a MAVA weboldalára, fórumába és az oktatóközpontba.
+  </p>
+
+  <p>
+  Ha a megjelenő dialógus ablakban az <b>OK</b>-ra kattintunk, a <i>Jelölt</i>
+  lap jelenik meg:
+  </p>
+
+  <img src="student.png" alt="A Jelölt lap"/>
+
+  <p>
+  Itt megtekinthetjük az elméleti vizsga és az ellenőrző repülés állapotát,
+  valamint elindíthatjuk ezen tevékenységeket.
+  </p>
+
+  <p>
+  Az elméleti vizsgált az Interneten,
+  a <a href="http://mavasystems.hu/moodle">MAVA Oktatási Központban</a>
+  tehetjük le. Az <b>Elméleti vizsga</b> gomb megnyomásával a böngészőnkben
+  megjelenik a Központ weboldala, ahol a pilóta azonosítóval és a
+  jelszavunkkal történő bejelentkezés után letehetjük a vizsgát. Ha az sikerül,
+  a <i>Jelölt</i> lapon a vizsga állapota frissül. Erre azonban csak néhány
+  perc elteltével kerül sor, mire a háttérben futó rendszerekben frissül az
+  állapot és erről a logger is értesül.
+  </p>
+
+  <p>
+  Az ellenőrző repülés egy egyszerű repülés, amely során a ferihegyi
+  repülőtérről (LHBP) felszállünk, lerepüljük a szabványos indulási eljárást
+  (SID-et), majd egy megközelítési transition kezdőpontjára repülünk,
+  lerepüljük a transitiont és végül leszállunk. (Ha az előző mondatban szereplő
+  egyes fogalmak jelentése nem világos, úgy nézzünk ezeknek utána, mert a
+  normál járatok teljesítéséhez is tudnunk kell, mit jelentenek ezek.)
+  Válasszuk ki a használni kívánt repülőgép típusát (jelenleg a Boeing 737NG
+  család valamelyik típusát vagy a Bombardier Dash-8 Q400-ast), majd
+  kattintsünk az <b>Ellenőrző repülés</b> gombra. Ekkor a normál járatok
+  teljesítésével szinte teljesen megegyező
+  folyamaton <a href="#tabFlight">végigvezet</a> minket a program a
+  <a href="#connectPage"><i>Kapcsolódás</i></a> oldaltól kezdve.
+  </p>
+
+  <p>
+  Az ellenőrző repülés akkor sikeres, ha nem vétettünk olyan súlyos hibát,
+  amelyre már a program is azt mondja, hogy NO-GO. Ellenkező esetben újra kell
+  próbálkoznunk. Ha a járattal kapcsolatban tanácsot szeretnénk kérni, a
+  PIREP-et mindkét esetben elmenthetjük fájlba, és azt elküldhetjünk a MAVA
+  mentorunknak.
+  </p>
+
+  <p>
+  Ha a későbbiekben elindítjuk a programot és bejelentkezünk, az mindig
+  ellenőrzi a rangunkat. Ha az még STU (student - jelölt), akkor mindig
+  a <i>Jelölt</i> oldalra kerülünk a belépés után. Ha minde az elméleti
+  vizsgát, mind az ellenőrző repülést sikeresen teljesítetjük, a rangunk FO
+  (First Officer - elsőtiszt) lesz. Ekkor már foglalhatunk járatokat a MAVA
+  weboldaláln és a logger segítségével le is repülhetjük azokat. Ebben az
+  esetben a <a href="#flightSelectionPage">Járatválasztás</a> oldal jelenik meg
+  a sikeres belépés után.
+  </p>
+
 </html>