Index File

The index file describes to the index navigator the content and layout of the index. The format of the index file is based on the World Wide Web Consortium Extended Markup Language (XML). The following is a very small example of a index file:

   <?xml version='1.0' encoding='ISO-8859-1'  ?>
   <!DOCTYPE index
     PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp Index Version 1.0//EN"
            "http://java.sun.com/products/javahelp/index_1_0.dtd">

   <index version="1.0">
      <indexitem text=".prof extension (profile data)" target="prof.profile" />
      <indexitem text="accelerators (keyboard), see 'keyboard commands'" />
      <indexitem text="adding an existing portfolio" target="proj.import" />
      <indexitem text="adding an existing project">
         <indexitem text="naming the project" target="proj.importdirectory" />
         <indexitem text="naming the storage directory" target="proj.importdirectory" />
         <indexitem text="procedures for" target="proj.importproject2" />
      </indexitem>
      <indexitem text="analyzing program performance, see 'profiler'" />
   </index>

This example produces the following index display:

The Index Tags

The following table describes the index tags:

<index>	Defines the index. It can contains <indexitem> tags.
<indexitem>	Defines a index entry. Nesting entry1 within entry2 defines entry2 to be hierarchically contained within entry1. Uses the following attribute: text Specifies the text for the entry. target (optional) Specifies the ID to display when the entry is chosen by the user. IDs are defined (associated with a URL) in the map file.

The HelpSet File

The Map File

JAR Files

Table of Contents File

Creating the Full-Text Search Database