Ignore:
Timestamp:
04/01/13 12:36:02 (12 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:
2 added
2 edited

Legend:

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

    r481 r493  
    132132  </p>
    133133
     134  <p>
     135  The program also includes a built-in <a href="#bugReportWindow">bug
     136  reporting</a> facility, which can be used to report any trouble
     137  encountered while using it.
     138  </p>
     139
    134140  <h3><a name="gui">Graphical User Interface</a></h3>
    135141
     
    10881094  </p>
    10891095
     1096  <h2><a name="bugReportWindow">The Bug Report Window</a></h2>
     1097
     1098  <img src="bugreport.png" alt="The Bug Report Window"/>
     1099
     1100  <p>
     1101  The bug reporting window can be used to report any non-fatal bugs
     1102  that occur during using the program. Bugs can be reported to
     1103  appropriate topic in the MAVA forum, via e-mail or tickets created
     1104  by hand on the project's website. However, utilizing this window not
     1105  only creates the ticket, it also includes automatically the texts of
     1106  the log and the debug log, making the life of the developers
     1107  easier. Of course, it might happen that the program crashes in a way
     1108  which makes this window inaccessible or to work incorrectly, in
     1109  which case you must resort to the other possibilities.
     1110  </p>
     1111
     1112  <p>
     1113  The bug report window can be displayed by selecting <b>Tools/Report
     1114  bug</b> or by pressing <b>Ctrl+B</b>. The summary must be entered
     1115  and it should be a short, one-sentence description or title of the
     1116  problem. The <i>Description</i> part is not mandatory, but if you
     1117  can think of any useful additional information, you might give it
     1118  here. As the program automatically appends the log and the debug to
     1119  the description, you should not copy them here. You can also give
     1120  your e-mail address to receive automatic notifications of the status
     1121  of your bug report, but consider that your e-mail address will then
     1122  appear on the project's website in the bug report.
     1123  </p>
     1124
     1125  <p>
     1126  By pressing <i>Send...</i>, you can create the bug report. If it is
     1127  successful, you will receive a message telling so and including the
     1128  ticket's ID that you may refer to later.
     1129  </p>
     1130
    10901131  <h2><a name="monitorWindow">The Monitor Window</a></h2>
    10911132
  • doc/manual/hu/index.html

    r481 r493  
    132132  </p>
    133133
     134  <p>
     135  A program tartalmaz egy <a href="#bugReportWindow">hibajelentő</a>
     136  eszközt is, amivel a használata során előforduló problémákat jelenthetjük.
     137  </p>
     138
    134139  <h3><a name="gui">A grafikus felhasználói felület</a></h3>
    135140
     
    11161121  </p>
    11171122
     1123  <h2><a name="bugReportWindow">A Hibajelentés ablak</a></h2>
     1124
     1125  <img src="bugreport.png" alt="A Hibajelentés ablak"/>
     1126
     1127  <p>
     1128  A hibajelentés ablak segítségével a program használata során
     1129  tapasztalt, nem fatális problémákat jelenthetjük. Hibákat
     1130  jelenthetünk a MAVA fórum megfelelő topikjában, e-mailben vagy
     1131  saját kezűleg létrehozott tikettel a projekt honlapján. Azonban ezen
     1132  ablak használatával nem csak a tikettet hozzuk létre, hanem abba
     1133  automatikusan belekerül a napló és a debug napló szövege, ami
     1134  jelentősen megkönnyítheti a hiba megtalálását. Természetesen
     1135  előfordulhat, hogy a program úgy száll el, hogy ez az ablak nem
     1136  elérhető vagy rosszul működik. Ebben az esetben maradnak az egyéb
     1137  módszerek.
     1138  </p>
     1139
     1140  <p>
     1141  A hibajelentő ablakot az <b>Eszközök/Hibajelentés</b> menüpont
     1142  kiválasztásával vagy a <b>Ctrl+H</b> billentyűkombináció leütésével
     1143  jeleníthetjük meg. Az összefoglalást kötelező kitölteni a probléma
     1144  rövid, egy mondatos leírásával vagy címével. A <i>Leírás</i>t nem
     1145  szükséges kitölteni, de ha bármilyen egyéb, hasznos információ
     1146  eszünkbe jut, azt ide beírhatjuk. Mivel a program magától
     1147  hozzáfűzi a napló és a debug napló tartalmát, azokat ide ne másoljuk
     1148  be. Megadhatjuk továbbá az e-mail címünket is, hogy automatikusan
     1149  értesítést kapjunk a hibajelentés állapotáról, de ebben az esetben a
     1150  cím megjelenik a projekt honlapján, a hibajelentésben.
     1151  </p>
     1152
     1153  <p>
     1154  A <i>Küldés...</i> gomb megnyomásával elkészül a hibajelentés. Ha
     1155  sikerül létrehozni, erről üzenetet kapunk, amely tartalmazza a
     1156  hibajelentés azonosítóját is. Ezt célszerű feljegyezni, hogy a
     1157  későbbiekben hivatkozhassunk rá.
     1158  </p>
     1159
    11181160  <h2><a name="monitorWindow">A Monitor ablak</a></h2>
    11191161
Note: See TracChangeset for help on using the changeset viewer.