Changeset 493:3e43541298fb for doc

Timestamp:

04/01/13 12:36:02 (11 years ago)

Author:

István Váradi <ivaradi@…>

Branch:

default

Phase:

public

Message:

Added the documentation of the bug reporting facility (re #190)

Location:

doc/manual

Files:

• en/bugreport.png (added)
• en/index.html (modified) (2 diffs)
• hu/bugreport.png (added)
• hu/index.html (modified) (2 diffs)

doc/manual/en/index.html

@@ -132 +132 @@
   </p>
 
+  <p>
+  The program also includes a built-in <a href="#bugReportWindow">bug
+  reporting</a> facility, which can be used to report any trouble
+  encountered while using it.
+  </p>
+
   <h3><a name="gui">Graphical User Interface</a></h3>
 
@@ -1088 +1094 @@
   </p>
 
+  <h2><a name="bugReportWindow">The Bug Report Window</a></h2>
+
+  <img src="bugreport.png" alt="The Bug Report Window"/>
+
+  <p>
+  The bug reporting window can be used to report any non-fatal bugs
+  that occur during using the program. Bugs can be reported to
+  appropriate topic in the MAVA forum, via e-mail or tickets created
+  by hand on the project's website. However, utilizing this window not
+  only creates the ticket, it also includes automatically the texts of
+  the log and the debug log, making the life of the developers
+  easier. Of course, it might happen that the program crashes in a way
+  which makes this window inaccessible or to work incorrectly, in
+  which case you must resort to the other possibilities.
+  </p>
+
+  <p>
+  The bug report window can be displayed by selecting <b>Tools/Report
+  bug</b> or by pressing <b>Ctrl+B</b>. The summary must be entered
+  and it should be a short, one-sentence description or title of the
+  problem. The <i>Description</i> part is not mandatory, but if you
+  can think of any useful additional information, you might give it
+  here. As the program automatically appends the log and the debug to
+  the description, you should not copy them here. You can also give
+  your e-mail address to receive automatic notifications of the status
+  of your bug report, but consider that your e-mail address will then
+  appear on the project's website in the bug report.
+  </p>
+
+  <p>
+  By pressing <i>Send...</i>, you can create the bug report. If it is
+  successful, you will receive a message telling so and including the
+  ticket's ID that you may refer to later.
+  </p>
+
   <h2><a name="monitorWindow">The Monitor Window</a></h2>
 

doc/manual/hu/index.html

@@ -132 +132 @@
   </p>
 
+  <p>
+  A program tartalmaz egy <a href="#bugReportWindow">hibajelentő</a>
+  eszközt is, amivel a használata során előforduló problémákat jelenthetjük.
+  </p>
+
   <h3><a name="gui">A grafikus felhasználói felület</a></h3>
 
@@ -1116 +1121 @@
   </p>
 
+  <h2><a name="bugReportWindow">A Hibajelentés ablak</a></h2>
+
+  <img src="bugreport.png" alt="A Hibajelentés ablak"/>
+
+  <p>
+  A hibajelentés ablak segítségével a program használata során
+  tapasztalt, nem fatális problémákat jelenthetjük. Hibákat
+  jelenthetünk a MAVA fórum megfelelő topikjában, e-mailben vagy
+  saját kezűleg létrehozott tikettel a projekt honlapján. Azonban ezen
+  ablak használatával nem csak a tikettet hozzuk létre, hanem abba
+  automatikusan belekerül a napló és a debug napló szövege, ami
+  jelentősen megkönnyítheti a hiba megtalálását. Természetesen
+  előfordulhat, hogy a program úgy száll el, hogy ez az ablak nem
+  elérhető vagy rosszul működik. Ebben az esetben maradnak az egyéb
+  módszerek.
+  </p>
+
+  <p>
+  A hibajelentő ablakot az <b>Eszközök/Hibajelentés</b> menüpont
+  kiválasztásával vagy a <b>Ctrl+H</b> billentyűkombináció leütésével
+  jeleníthetjük meg. Az összefoglalást kötelező kitölteni a probléma
+  rövid, egy mondatos leírásával vagy címével. A <i>Leírás</i>t nem
+  szükséges kitölteni, de ha bármilyen egyéb, hasznos információ
+  eszünkbe jut, azt ide beírhatjuk. Mivel a program magától
+  hozzáfűzi a napló és a debug napló tartalmát, azokat ide ne másoljuk
+  be. Megadhatjuk továbbá az e-mail címünket is, hogy automatikusan
+  értesítést kapjunk a hibajelentés állapotáról, de ebben az esetben a
+  cím megjelenik a projekt honlapján, a hibajelentésben.
+  </p>
+
+  <p>
+  A <i>Küldés...</i> gomb megnyomásával elkészül a hibajelentés. Ha
+  sikerül létrehozni, erről üzenetet kapunk, amely tartalmazza a
+  hibajelentés azonosítóját is. Ezt célszerű feljegyezni, hogy a
+  későbbiekben hivatkozhassunk rá.
+  </p>
+
   <h2><a name="monitorWindow">A Monitor ablak</a></h2>