Changeset 493:3e43541298fb for doc/manual/en

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/en

Files:

• bugreport.png (added)
• 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>