Hi HelpIndex Bean Customiser

Last modified: 26 February 1998.

Page Contents Index Property Editor 
See also Bean information  Bean Class Documentation 

This page will describe the HelpIndex bean customizer when it appears.


Index Property Editor

The index property details the index and language files used by the HelpIndex bean.
index is an indexed property, ie an array of IndexParam objects.

Note that some IDEs may not be able to cope with indexed properties, so the index will not appear. However an equivalent indexes non-indexed property is also provided, so you can achieve the same effect by editing this.

A property editor is provided for IDEs to make it easy to set the index and language files.

IndexEditor Dialog

The initial IndexEditor dialog box lists the index and language files which are set up. It is initially blank. The following buttons may be used.
Add
Add a new index and language. The "Edit Index Parameter" dialog is displayed.
Edit
Edit the selected index and language in the "Edit Index Parameter" dialog.
Delete
Delete the selected index and language.
Move Up
Move the selected index up in the list
Move Down
Move the selected index down in the list
Done
Finish alterations
Double-clicking an index in the list is equivalent to pressing Edit.

Edit Index Parameter Dialog

This dialog box is shown when you add or edit an index parameter in the IndexEditor dialog.

Usually you just need to fill in the Index URL box and press the OK button.

Index URL
The index (.hi) file location.
Can be a relative or absolute URL, or a file on the CLASSPATH.
Encoding
The character encoding for the Index URL.
If blank then "8859_1" is used; this is equivalent to the Windows ANSI character set.
Language URL
The language (.hil) file location.
Can be a relative or absolute URL, or a file on the CLASSPATH.
If blank then the built-in English file is used.
Encoding
The character encoding for the Language URL.
Language code
The two letter ISO 639 language code. Obviously if using the french language file (french2.hil) then it is best to set the French language code ("fr").
Country code
The two letter ISO 3166 country code.
Options
Select "No Contents" if you do not want the Contents tab to appear.
Select "Index" if you want the Index tab to be selected initially.
Select "Sort" if you want the Contents sorted alphabetically
Select "Expanded" if you want all the Contents folders expanded initially.
Select URL
Enter the URL in the Contents that you want selected initially.
Initial Query
Enter the query that you want in the Index Look for box initially.

HelpIndex    PHD