# This is a Bugz description file
# Drop it on to Bugz to submit a report

[*Title]
Bugz

[*Info]
Program: Bugz
Distribution: Public
Version: 1.15 (28 Apr 2002)
Release: Full public release

[*Mail]
bugz@movspclr.co.uk

[*Cat]
Bugz will aid reporting bugs in modules, or beta release components.
Please submit as much information about what you were doing that caused
a crash.

Known faults:
  * No checking in low memory situations
  * Little !Help support

You can still let us know if you wish these faults removing. They are not
considered a priority.

Note on JFShared: Although this application was written using JFShared, this
is purely because its DispLib and ExtEditLib provide facilities that make
such development very rapid. It is NOT expected that released components use
these.

Further note: JFShared isn't needed for Bugz to run.

[Modules]
Module handling is rudimentary at present.
Details presented as sections are :
  * SWI numbers
  * Services
  * Commands

It is believed that these are stable.

The modules list is sorted alphabetically, with the help name in brackets
if it differs from that of the module title.

[Applications]
Application handling is very basic. There is only so much information about
an application that can be gained once it is running. You are presented with
two areas for commentary - 'User interface' and 'Operation'. I believe this
covers the areas where applications need bugs and comments reporting.

[Report windows]
The reports window has three sections :

  * Informational
  * Sectioned (the sections that can be reported on)
  * Submission

Let us know :
  If the window is unclear
  If the sectioned section does not provide enough scope
  If the window appears off the screen

We know :
  That the Reports menu disappears if you click Adjust

[Display windows]
The display windows are provided by JFShared's DispLib and should be bug free.
If you see ANY faults in it, please let us know.

Known faults:
  * Selections sometimes lose the first line
    Let us know if you see this.

Note:
  * 'Edit->Clear display' is pretty much pointless
    Let us know if you think this should be removed (changes to DispLib for
    removing it)

[Details]
The details window provides you with means to configure the details that are
submitted at the bottom of all emails. You must include your email address
and developer number. The other fields are optional, but you will probably
want to fill them in anyhow.

If things vanish from this when you close the window, or you have difficulty
with any of the fields, let us know.

[Mail]
The mail window allows you to configure how mail is sent. You should use
automatic detection unless your transport is not detected, or you use a
local mail gateway.

If you use a local mail gateway, configure to 'direct sending' and set the
gateway name.
If you can't send emails in either of those form, you should - firstly -
contact us to say why you can't send emails. Secondly, you can set the mailer
up to append to a file. This may be useful for offline collection of emails
before sending via some other means (sneaker-net, etc).

[Editing]
The editing facilities are provided by your text editor using the external
edit protocol. This is in turn provided by JFShared's ExtEditLib. If there
are problems in this, let us know; it's likely that something has been
missed in its development. You may not include binary data in the edit
entries.

Edit support might be added; this is not a priority.

[Saving]
When saving the entries /all/ the text you provided should be included. If
this is not the case, let us know. The same routine is used for saving as
for sending, so what affects one will affect the other.

[Sending]
If you have problems sending reports, save them out and submit them via your
normal email program temporarily. Let us know about your internet
suite and mail transport. If a queued entry is produced that is rejected or
never sent, please supply details.

Ensure you have seen your transport application before attempting to use
the send option.

Currently very little debug is produced for the sending process. This can
be improved but will increase complexity quite a bit.

[Machine info]
The machine information window presents a simple summary of information
about the machine on which Bugz is running. It is mostly for the benefit of
the person receiving the report so that they can spot potential problems
quickly, or correlate likely fault causes.

[Icon]
If you don't like the icon, then go away. I like it :-)

[Overall]
Over everything else, you should find Bugz /easy/ to use. If this is not the
case, let us know, along with a recommendation, or what you found difficult
about it.

If you have general comments about how the application works, or what it does
then let us know.

[Things to do]
Quick list of things I'd like to do :

Add a means of attaching files.
