Help System file descriptions.

[Two Ducks <twoducks@globalserve.net>]

Following is a description of the main files which make up the
help system currently, along with a description of the purpose
of each.

Browser Main Window:
===================
  helpd : This tcl/tk script provides the main window functionality. It
          Provides the main frame and buttons, the navigation
functionality,
          and the interface with the Help API.
          
HTML Plugin/Process:
===================
  htmlPlugin : This tcl/tk script provides the plugin functionality for
               displaying html files within the main window. Currently
the
               "plugins" are actually separate processes, although
eventually
               they will be separate threads. The plugin is controlled
through
               a fifo pipe connecting it to the main program, though
this
               will probably change in the very near future.

  html_library.tcl : This is a library provided by SUN which performs
the
                     actual parsing and display of the html files.

Help API:
========
  helplib.c : This file compiles into a .so library file. This library
may
              be used by programs to embed the calls to the help display
              program within their source. This library uses fifo pipes
              to communicate with the main program. Using this API
ensures
              that only one helpd process is ever open at one time.
  
Command Line Interface:
======================
  xhelp.c : This is a simple program which uses the helplib.so library
to
            provide basic command line access to the help system.

I am currently in the process of cleaning up and commenting and
improving the
files and will be posting them over the next few days, and will post
updates
as improvements and additions are made.

As usual, any comments, suggestions, discussion, criticisms and whatever
are always welcome.

Really!

Ken Duck
twoducks@globalserve.net