Hi HelpIndex Examples

Last modified: 9 February 1998.
Page Contents Site Index Example  JDK API Example  Database Example  Recognised key presses 
See also Office CD-ROM examples  French and German prompts Example 

Site Index Example

The PHD Hi HelpIndex applet helps users explore your site. There is a Contents tree and a keyword Index with links to your pages.

In "icon" mode, Hi HelpIndex initially just shows itself as an icon (below). The user must click on the icon to see Hi HelpIndex in a window.

Sorry, your browser is not set up to run Java applets.
How to get a Java VM.
<-- Click this icon to see the help index applet in action.


Hi HelpIndex Contents tab screenshot Contents Screenshot

This screen shot shows Hi HelpIndex's Contents tab card. You can select the other cards by selecting one of the other tabs at the top.

This view shows the structure of the whole site, ie there are main categories "Basics", "Using on your site", "Advanced" and "PHD" as well as "Welcome".

You can expand and contract the Contents tree branches by clicking the mouse on the + or - bullets or using the keyboard equivalents.

Currently the "Examples" page is highlighted. Double-clicking here, pressing the Return key or selecting the Display Page button will show the page in the browser.

Various key presses may be used. If necessary, a scroll bar is shown on the right hand side.


Index Screenshot

This screen shot shows the keyword Index to the PHD web site. Note that the card tabs have shrunk to become just icons as the window is not very wide.

The user has typed in J to find all keywords starting with J. Various keywords have been found.

The user has then selected Java Articles and found several pages with this keyword. Selecting the Display Page button will display the "Netscape IFC" page.

The Tab and Shift+Tab keys may be used to move between fields. Pressing the Return/Enter key is the same as selecting Display Page. Double-clicking a page name also displays it. Escape sets the query text to its initial setting, ie usually clears it.

Hi HelpIndex Index tab screenshot

Hi HelpIndex Select tab screenshot Select Screenshot

If the Select tab is showing, a list of the available help index files is shown.

Note that the language shown is the language of the Hi HelpIndex prompts, not the language of the pages. In this example, the Hi HelpIndex site index can be viewed with English, French or German prompts.

Select a new index and then either double-click it or press the Select Index (language) button.

The Select tab is not available if only one help index file has been specified.


JDK API Example

This is a screen shot of an example use of Hi HelpIndex for Java programmers.

This example provides an easy to use index into the Java Development Kit (JDK) Application Programmer Interface (API). Loading the 190kB help index once is quicker than rummaging through the standard javadoc Index pages.

JDK Example Screenshot
Hi HelpIndex JDK screenshot

As you can see, it is easy to look up Java keywords. In this example, the user has found all the keywords which begin with get.

Try this JDK 1.1 API example which refers directly to Sun's pages. Note that the 190kB help index file may take some time to arrive. It is better to set this up for use locally, as PHD does on its local intranet.
Use Hi Lab (or MakeHelpIndex) to scan AllNames.html to roll your own help index. Note that some useful keywords are not present as appropriate keywords have not been set up in the HTML.


Database Example

If you give Hi HelpIndex a suitable help index file and language file then it can look like a small database program.

Try this User database example.

Note that in this case Hi Lab or MakeHelpIndex will not aid you to set up the help index file. We strongly suggest that you write a program to generate the required index file from your existing real database. Please contact us if you would like us to quote for this job.


Recognised key presses

Use Tab and Shift+Tab to move around the window.
Use Space to press a button.
Contents
Return, Enter Display the selected page
down arrow Move selection down
up arrow Move selection up
Shift+up and down arrows Select and expand the next main branch
left arrow Collapse branch, or move selection left
right arrow Expand branch, or move right
Home Select first visible item
End Select last visible item
Page down Move selection down a window
Page up Move selection up a window
* Expand all lower branches
+ Expand branch
- Collapse branch
F1 or spacebar Shows or hides the page tip
other keys Select the next item which begins with that key
Index
Return, Enter Display the selected page
Escape Set to the initial query
Standard cursor and edit keys may be used in the Query field.
Card Tabs
left arrow, right arrow Select next tab
Home Select Contents tab
End Select About tab

HelpIndex    PHD