Zat Home
Support | Bug Report

443

deliver documentation with product install; add shortcuts at minimum

I continue to get mail from people that indicates that they
are not aware of the Spin documentation. I think we should
include the full manual set with the Spin distribution,
installed in a new subdirectory of the Spin install directory
called "manuals".

We should install shortcuts (on windows, and the equivalent on
other platforms) so that they can click on an icon (or whatever)
and the main index page for the Spin documentation would be
opened in their default browser.

In addition, is it possible to put a menu entry into the View
menu in Spin, which will open up the main index page for the
documentation in a web browser? If so, I would also like a
menu entry that opens up the main HTML file pointed to by
the JDKDocDirectory preference (e.g., something like
JDK1.1.8/docs/api/packages.html and if possible to
JDK1.1.8/docs/index.html as well).

Finally we need a shortcut and menu entry for the Spin
JavaDoc documentation (e.g., Spin/docs/packages.html).

By the way, the file AllNames.html in the Spin documentation
is empty (not being generated I guess) and in the
packages.html guide, the link to the API user's guide is
invalid. Also, if you display the documentation for any
of the packages, there are lots of images that don't
display properly.

In summary, I'd like to see two entries in the View menu,
one called Manuals, and one called Docs. The latter would
cascade to two entries, one for the Spin JavaDocs, and one
for the JDK JavaDocs. The former could also cascade to
two entries, one for the Spin manuals (index page), and one
for the JDK docs index page.

I would *really* like at least the shortcuts to be in the
upcoming release, and if is relatively easy to do, the new menu
items as well.

** Wm 4/29/99 **

Added documentation.html file to installation, and to shortcut
generation. Contains links to on-line docs, and also to local
docs on Spin's beans.

Moved bug report to feature/design for future improvements.

** Philip 5/3/99 **

Redecided to Add two entries to View menu in new release

1) Spin Documentation (opens browser on local documentation file)
2) Spin Resources (opens browser on http://www.zat.com/world.html)

** Wm, Philip, Brian 2/25/2000 **

Generated on: Mon Apr 10 11:49:39 PDT 2000