.INDEX
INDEX

~ORDERING~ .......... How to Order HYPER-HELP+
~CONCEPT~ ........... Introduction to HYPER-HELP
~PROG"PROGRAMMING"~ ....... Programming HYPER-HELP
~LIBRARIES~ ......... Linkable Libraries
~HELP_OPEN~ ......... C Function Description
~HELP_CLOSE~ ........ C Function Description
~HELP~ .............. C Function Description
~HELP_SETCOLORS~ .... C Function Description
~HELP_SET_CURSOR~ ... C Function Description
~HELP_EXPLODE~ ...... C Function Description
~HELPBLD~ ........... C Function Description
~MOUSE~ ............. Using Hyper-Help with a Mouse

.ORDERING
ORDERING                                                ~INDEX~

To order HYPER-HELP+, print and fill out the HYPER-HELP+ reg-
istration file "REGISTER.TXT" included with HYPER-HELP, and
send it with $39.95 to:

                          Robert Keyes
                       1814 Streamedge Ct.
                    Rochester Hills, MI. 48309


          For Information or Technical Support Contact:

                         Robert Keyes
                   Compu-Serve ID: 71331,140



Other Fine Software Products available are:

   ~LEARN-A-FORM~ .... Form Filler for Business.
   ~TASK-PRO~ ........ Task Tracking System.

.LEARN-A-FORM
LEARN-A-FORM                                            ~INDEX~

The "LEARN-A-FORM" Utility was created to provide a means of
filling out pre-printed forms using a PC and a standard printer.
Each form is 'learned' and stored on disk as a form image file.
The data to be merged with each form is also stored on disk for
future printing.  The "LEARN-A-FORM" software package is com-
plete with context sensitive help to provide the user with a
detailed description and usage for each menu selection.  All
printers compatible with the standard IBM Proprinter code seq-
uences may be used.

.TASK-PRO
TASK-PRO (by Business Technologies)                     ~INDEX~

TASK-PRO is a program which allows a manager to maintain a well
organized database of tasks.  Task-Pro allows related tasks to
be grouped into files which can be manipulated independently.
Tasks can be added, modified, deleted, sorted, prioritized and/
or reported on with ease.  Tasks may be assigned to individuals
and deadlines and time budgets may be assigned (with visual
indicators for those tasks which have exceeded their deadlines
or time budgets).  TASK-PRO incorporates a state-of-the-art
user interface and utilizes HYPER-HELP+ for context-sensitive
help.

.CONCEPT
CONCEPT                                                 ~INDEX~

HYPER-HELP allows you to incorporate professional help screens
into your application programs with minimum programming.
Please take the time to browse through these help screens to
get more information on HYPER-HELP (these screens were imple-
mented in HYPER-HELP themselves).

You will note that HYPER-HELP supports multi-page help text
while also providing the user with the means of jumping between
help topics (hence the prefix "HYPER").

There are two phases involved in incorporating HYPER-HELP into
your TURBO C applications programs.  The first phase is to
produce your own Help Source File using the TURBO C text editor
(or any editor that produces help files) and to process it
through the ~HELPBLD~ utility to produce a Help Object File
(the file actually used by your program).  The second phase is
to include the appropriate calls to HYPER-HELP functions within
your program and modify your project file(s) to reference the
appropriate HYPER-HELP ~libraries"library"~ (depending on the memory model
you are compiling under).

.PROG
HYPER-HELP PROGRAMMING                                  ~INDEX~

PC-based applications programs are generally keyboard driven.
An easy means of incorporating HYPER-HELP into your programs
is to produce a function which reads a keystroke from the key-
board, and to use this function to perform keyboard input
throughout your program.  This function would then call HELP
with the appropriate topic when an F1 (the industry standard)
keystroke is detected.

.LIBRARIES
LINKABLE LIBRARIES                                      ~INDEX~


All HYPER-HELP functions are defined in the following TURBO C
libraries:

        S_HELP.LIB is for the SMALL memory model
        M_HELP.LIB is for the MEDIUM memory model
        L_HELP.LIB is for the LARGE memory model

To use HYPER-HELP in your own TURBO C programs simply include
the name of the appropriate library file at the end of your
project file and call the help functions described below from
within your application program.

The following functions are defined in the HYPER-HELP library:

   ~HELP_OPEN~ ........ Opens a help file for use.
   ~HELP_CLOSE~ ....... Closes the currently opened help file.
   ~HELP~ ............. Brings up the help window for a topic.
   ~HELP_SET_CURSOR~ .. Sets the cursor style.
   ~HELP_SETCOLORS~ ... Changes HELP colors from defaults.
   ~HELP_EXPLODE~ ..... Enables/Disables exploding help windows.

.HELP_OPEN
HELP_OPEN                                               ~INDEX~

DESCRIPTION:

HELP_OPEN - called to open a Help Object File for use (any file
produced by the ~HELPBLD~ utility program).  This function should
be called at the start of the application program, or to open
a new help file after ~HELP_CLOSE~ has been called within the app-
lication program.

PROTOTYPE:
   int help_open (char *file, int mouse, void (*warning)());

ARGUMENTS:
   filename = name of the Help Object file to be used for help
     (file extension included).

   use_mouse = Enable or Disable using a ~mouse~ with Hyper-Help.
               1=Enable  0=Disable

   Note:  The mouse driver must be installed prior to using
          Hyper-Help.

   warning = a user supplied function for creating different
             warning tones.

SAMPLE USAGE:

         help_open("SAMPLE.HLP", 1, my_beep);
         help_open("SAMPLE.HLP", 0, NULL);

.HELP_CLOSE
HELP_CLOSE                                              ~INDEX~

DESCRIPTION:

HELP_CLOSE - called to close the currently opened help file.
Should be called before termination of any program using
Hyper-Help.

PROTOTYPE:   void help_close(void);

ARGUMENTS:  - none -

SAMPLE USAGE:  help_close();   /* Close help file */

See Also: ~HELP_OPEN~.

.HELP
HELP                                                    ~INDEX~

DESCRIPTION:
    HELP - called to bring up the help window for a particular
           topic.

PROTOTYPE:
        int help (char *keyword);

ARGUMENTS:
  keyword = Keyword associated with the topic to be accessed.
    This keyword is NOT case-sensitive.

SAMPLE USAGE:  help("TEXT_EDITING");

.HELP_SETCOLORS
HELP_SETCOLORS                                          ~INDEX~

DESCRIPTION:

HELP_SETCOLORS (optional) - allows the programmer to customize
the colors used in the help windows.  If this function is not
called a default set of colors are used within the help window.
The mnemonics for the colors are defined in the standard TURBO
C include file CONIO.H.  Additionally the constant NO_CHANGE,
defined in HELP.H, can be supplied to preserve the default
value for a particular color parameter while changing others
with this call.




PROTOTYPE:
  void help_setcolors (int bor, int bortxt, int txt, int back,
                       int hitxt, int hiback, int himark,
                       int prback, int prlow, int prhigh);
ARGUMENTS:
  bor = border color for window.
  bortxt = text color for help window border.
  txt = text color for window.
  back = background color for window.
  hitxt = text color for highlighted filenames.
  hiback = background color for highlighted filenames.
  himark = text color for unhighlighted keywords.
  prback = background color for bottom prompt line.
  prlow = low intensity text color for bottom prompt line.
  prhigh = high intensity text color for bottom prompt line.

SAMPLE USAGE:

   help_setcolors(BLUE,WHITE,YELLOW,BLUE,BLACK,
                  MAGENTA,BLACK,MAGENTA,YELLOW,BLUE);

.HELP_SET_CURSOR
HELP_SET_CURSOR                                         ~INDEX~

DESCRIPTION:

HELP_SET_CURSOR - sets the cursor style.  This is required to
inform HELP how to restore the cursor shape before exiting
(help causes the cursor to be hidden).  This function should
be called sometime before HELP is called to bring up the help
window.


PROTOTYPE:

        void HELP_SET_CURSOR(unsigned shape);


ARGUMENTS:

   shape = NO_CURSOR for hidden cursor, UNDERSCORE_CURSOR for
       an underscore cursor or BLOCK_CURSOR for a block cursor.
       The constants UNDERSCORE_CURSOR, BLOCK_CURSOR and
       NO_CURSOR are defined in HELP.H.


SAMPLE USAGE:  HELP_SET_CURSOR(UNDERSCORE_CURSOR);

.HELP_EXPLODE
HELP_EXPLODE                                            ~INDEX~

DESCRIPTION:

HELP_EXPLODE (optional) - controls whether Help uses explod-
ing or non-exploding windows as a 'special effect' when help
windows are brought up to the screen.  By default Help uses
non-exploding windows.

PROTOTYPE:

 int help_explode (int exp);

ARGUMENTS:

 exp = 0 to disable exploding windows or 1 to enable
   exploding windows.

SAMPLE USAGE:

  help_explode(1);  /* Enable exploding windows */

.HELPBLD
HELPBLD                                                 ~INDEX~

HELPBLD is the preprocessor that turns Help Source Files into
Help Object Files (for use by your program).  HELPBLD comp-
resses, encrypts and reorganizes the Help Source File such
that HYPER-HELP can process it more efficiently.

To run HELPBLD simply enter the following at the DOS prompt:

      HELPBLD <source file name> <object file name>

(filenames should include extension).

.MOUSE
MOUSE                                                   ~INDEX~

                     Navigating with a Mouse

To use a mouse with Hyper-Help, the mouse driver must be loaded
prior to calling ~help_open~.  To enable the use of a mouse inside
Hyper-Help, the following syntax should be used when calling
help_open.

                   help_open("sample.hlp", 1, NULL);

To select a topic, move the mouse cursor to the specific topic,
and press the left mouse button. To page up or down, place the
mouse cursor on the PgUp or PgDn prompt at the bottom right of
the help window and press the left mouse button.  The bottom
status line of Hyper-Help is also active using the mouse.
Placing the mouse cursor at any one of the status line prompts
and pressing the left mouse button, will preform the described
function. The right mouse button has the same action as the
ESC key.
