Creating the Index

General Remark

The index provides an overview of keywords describing your help content. Usually it is alphabetically ordered.

Common Operations

The Index Editor provides the functionality to create the index. It is accessible when a project is loaded or newly created. The index can be manipulated by the Target Content View and the Item Order View . The two views are synchronized.

Clear Index

You can delete all index entries by pressing Clear Index in the toolbar. The underlying index file is only overwritten, if you click on Export Index afterwards.

Export Index

When you change something in your index then the Export Index Button in the toolbar becomes activated. Before you can see the changes in the helpviewer, you should click on it or on Create All. JHelpDev then writes the contents of the index to the file %projectdir%/%projecttitle%Index.xml. The entries appear exactly as in the Item Order View. Refer to the JavaHelp User Guide for the specification of this file.

Import Index

You can import the existing file from %projectdir%/%projecttitle%Index.xml by clicking on Import Index. The existing index entries are deleted and then created from the contents of that file.

Invalid Targets

Invalid targets are not displayed in the Target Content View at all and appear red in the Item order View. When you rename content files, the underlying index entries become invalid after Create Map. The other valid targets of course remain unchanged.

See also: Naming Conventions, Import XML