HiDemo Example Java Application

Page Contents	Features  Usage

The HiDemo application shows how the HelpIndex and Hi Brow beans can be used in a Java application to provide GUI help.

This application is provided as a part of the Hi HelpIndex evaluation kit. Alternatively, a stand alone package of this HiDemo application is available at the PHD web site in file hidemo10.zip (approx 130kB).
Unzip hidemo10.zip in a new directory. Either read this file hidemo.html or run RunDemo.
This stand alone package does not have any documentation and will not run the Hi Jump applet at the top and bottom of this page.

Features

• Hi HelpIndex Contents and Index in pane on left.
• Hi Brow browsers shows help text in main window.
• Menu Help+Topics brings up dialog with Hi HelpIndex Contents and Index.
  Depending on state of Help+Show in main window checkbox, help is then either shown in the main window or in a window above the application.
• Synchronisation between the browser and Hi HelpIndex, ie as user navigates to new pages, the Hi HelpIndex Contents selection changes to match the current page.
• When the user presses F1 in a GUI application, the word under the cursor can be looked up in the Hi HelpIndex keyword index. This is simulated using a text box and a Lookup Keyword button. The Index results are displayed, and - if just one hit - the help page displayed.
• The Hi HelpIndex Contents and Index panes can be separately as a part of the application general Workspace pane.
  The HelpIndex window can be shown as a floating window above the application.
  The View menu demonstrates these view options.
• Demo not available yet. Previous/Next in contents buttons, like Hi Jump.
• Source code available for you to copy in file HiDemo.java.

Windows

Either

Click on "Start+Run..." and select C:\Program Files\PHD\hi\doc\RunDemo.bat.

Or

at a command prompt type

cd C:\Program Files\PHD\hi\doc\
RunDemo

Change the directory if you have installed Hi HelpIndex elsewhere.

The RunDemo batch file first tries to run the Microsoft jview program to run the HiDemo application. This will only work if you have Internet Explorer 4 loaded.
If jview is not present, then the standard java command is used. The java program must be on the executables PATH and the standard CLASSPATH environment variable must be set correctly. You must be using the latest JDK 1.1 version. You may want to use the jre program instead.
Edit RunDemo.bat if necessary.

Explorer 4 jview appears to have a bug in its Menu operation. The first top menu you click on, selects an sub-menu automatically. Eg if you just click on the View menu (and nothing else) then one of Index Only or Contents Only gets selected.

Unix

NOT TESTED YET. PLEASE TELL ME IF THIS WORKS OR NOT.

Move to the directory where you installed Hi HelpIndex
Run the RunDemo.sh sh batch file.

The java command must be available and standard CLASSPATH environment variable must be set correctly.