Changes between Version 22 and Version 23 of APP_BUG_REPORT_FORM_R0

Timestamp:

05/22/09 13:13:51 (16 years ago)

Author:

mitex

Comment:

--

APP_BUG_REPORT_FORM_R0

@@ -9 +9 @@
 The Bug report form eases communication between users and developers. The form contains:
  * A log containing information useful for debugging. This field is read only.
-  * including date, OS, sophie version and etc.
+  * including exception details, Java and OS version, log file, etc.
  * A custom text field containing user explanation on what happened. This is not a required field.
  * A text field for the user's e-mail address.
@@ -30 +30 @@
   * Save-as-file button - if the form is invoked automatically on error; saves the report as a plain text file (a file dialog is opened and the user selects a path for the file)
    * Plain text file with .log extension. This file can be used when sending bug reports from Help menu entry or submitting bugs on the site.
-  * Browse button - if the form is invoked manually - the user can attach already generated report file.
+  * Load-report-from-file button - if the form is invoked manually - the user can attach already generated report file.
+  * Attach-file button - allows the user to attach a book/video/etc. that causes Sophie to crash.
   * Cancel button - closes the form without saving or sending the report
  * Bug report contents (in this order):
   * Exception's stack trace if the form is invoked automatically on error.
+  * Current date and time.
+  * (in next revision - current version of Sophie)
   * Sophie's log file (currently it is not in distrib directory).
   * System properties such as operating system version, version of Java, ...
@@ -82 +85 @@
   * Use {{{BoundTextField}}}s.
    * The e-mail text field should perform validation using regular expression.
+  * String property {{{reportData}}} - serialized report data, without the user explanation and e-mail address.
+  * String property {{{userExplanation}}}
+  * String property {{{userEmail}}}
   * Register the dialog in the help module.
 
@@ -91 +97 @@
   * method {{{BugReportDialogInput collectReportData(Throwable t)}}} that collects all required report data:
    * the exception is taken as a parameter
+   * gets current date and time.
    * reads the log file
    * gets all system properties
@@ -99 +106 @@
   * method {{{String generateReport(BugReportDialogInput)}}} that serializes all the data to string.
    * The exception is serialized using printStackTrace.
-  * SAVE_TO_FILE: opens a file dialog, saves the result of {{{generateReport}}} and closes the form.
+   * Use ISO format for the date.
+   * Use UTF-8 encoding.
+  * SAVE_TO_FILE: opens a file dialog, saves the result of {{{generateReport}}} (without the attached file) and closes the form.
+  * LOAD_FROM_FILE: opens a file dialog, replaces the generated report.
   * ATTACH_FILE: opens a file dialog, sets the attachment field in BugReportDialogInput.
   * CLOSE: closes the form.