doc/xprism/READ_ME

This file explains the organization of the online HELP documantation 
directories for xprism2, xprism3, and Overlays of editimage.

There are 3 main directories that are used for the online HELP documentation
for xprism2, xprism3, and the Overlay subform of editimage.  These are 
annotations, xprism2, and xprism3.  Please note that the directory for overlays 
is used by the Overlay subform of xprism2, xprism3, and editimage. 

The online HELP documentation is provided in roff formatted files; these
files are identified by the ".doc" extension.  References to the HELP doc
in the ".form" (ie. xprism2.form, xprism3.form, editimage.form) files are 
made in one of two ways:

 1)  By referencing a single file (such as, ../annotations/Overlays ), which 
     provides the HELP doc for that particular pane in a single file 
     (ie. Overlays).

 2)  By referencing a directory (called "/help" ), which contains several 
     files that comprise the HELP doc for a particular pane 
     (ie. ../circle/help ).  Using this method, the HELP screen will 
     contain several buttons at the top of the form that allow specific 
     HELP selections to be made for a particular item.  This method breaks 
     up the online HELP doc into managable sections.


The DIRECTORIES and their ORGANIZATION are as follows:

 ANNOTATIONS  - online help for the overlay forms used in xprism2, xprism3,
              and editimage.

  ../annotations/Overlays        (online HELP doc for Main overlay subform)
  ../annotations/file/File       (online HELP doc for File pane)
  ../annotations/text/help       (online HELP doc for Text pane)
  ../annotations/circle/help     (online HELP doc for Circle pane)
  ../annotations/rectangle/help  (online HELP doc for rectangle pane)
  ../annotations/line/help       (online HELP doc for line pane)
  ../annotations/polygon/help    (online HELP doc for polygon pane)


 XPRISM2  - online help for the xprism2 forms, except annotations.

  xprism2/help               (online HELP doc for Master xprism2 form)

  xprism2/plot/Xp2Plot       (doc for guide pane HELP button of Plot subform)
  xprism2/plot/input_file/help      (online HELP doc for Input File pane)
  xprism2/plot/input_function/help  (online HELP doc for Input Function pane)
  xprism2/plot/transforms/help      (online HELP doc for Transforms pane)
  xprism2/plot/environment/help     (online HELP doc for Environment pane)
  xprism2/plot/attributes/help      (online HELP doc for Attributes pane)

  xprism2/options/Xp2Options  (doc for guide pane HELP button of Options subform)
  xprism2/options/labels/help       (online HELP doc for Labels pane)
  xprism2/options/axes/help         (online HELP doc for Axes pane)
  xprism2/options/colors/help       (online HELP doc for Colors pane)

  xprism2/output/Xp2Output    (doc for guide pane HELP button of Output subform)
  xprism2/output/files/help         (online HELP doc for Files pane)
  xprism2/output/postscript/help    (online HELP doc for Postscript pane)
  xprism2/output/imagen/help        (online HELP doc for Imagen pane)
  xprism2/output/hpgl/help          (online HELP doc for HPGL pane)
  xprism2/output/ln03/help          (online HELP doc for LN03 pane)

  NOTE: reference to annotations is described above.


 XPRISM3  - online help for the xprism3 forms, except annotations.

  xprism3/help               (online HELP doc for Master xprism3 form)

  xprism3/plot/Xp3Plot       (doc for guide pane HELP button of Plot subform)
  xprism3/plot/input_file/help      (online HELP doc for Input File pane)
  xprism3/plot/input_function/help  (online HELP doc for Input Function pane)
  xprism3/plot/perspective/help     (online HELP doc for Perspective pane)
  xprism3/plot/transforms/help      (online HELP doc for Transforms pane)
  xprism3/plot/environment/help     (online HELP doc for Environment pane)
  xprism3/plot/attributes/help      (online HELP doc for Attributes pane)

  xprism3/options/Xp3Options  (doc for guide pane HELP button of Options subform)
  xprism3/options/labels/help       (online HELP doc for Labels pane)
  xprism3/options/axes/help         (online HELP doc for Axes pane)
  xprism3/options/colors/help       (online HELP doc for Colors pane)
  xprism3/options/contours/help     (online HELP doc for Contours pane)
  xprism3/options/plot_bands/help   (online HELP doc for Plot Bands pane)

  xprism3/output/Xp3Output    (doc for guide pane HELP button of Output subform)
  xprism3/output/files/help         (online HELP doc for Files pane)
  xprism3/output/postscript/help    (online HELP doc for Postscript pane)
  xprism3/output/imagen/help        (online HELP doc for Imagen pane)
  xprism3/output/hpgl/help          (online HELP doc for HPGL pane)
  xprism3/output/ln03/help          (online HELP doc for LN03 pane)

  NOTE: reference to annotations is described above.

