Glossary Navigator and File

The glossary file describes for the glossary navigator the content and layout of the glossary. The format of a glossary file is the same as that of an index file. The glossary file format, as with the index file format, is based on the World Wide Web Consortium Extended Markup Language (XML).

The following XML code shows a sample definition of a glossary navigator in the helpset file:

   <view xml:lang="en" mergetype="javax.help.SortMerge">
      <name>glossary</name>
      <label>Glossary</label>
      <type>javax.help.GlossaryView</type>
      <data>glossary.xml</data>
  </view>

The following XML code shows a small example of a glossary file:

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

   <index version="2.0">
      <indexitem text="applet" target="applet_def"/>
      <indexitem text="application" target="application_def"/>
      <indexitem text="application server" 
                 target="appServer_def"/>
      <indexitem text="AWT" target="awt_def"/>
      <indexitem text="beans" target="bean_def"/>
   </index>

The Glossary Tags

The following table describes the glossary tags:

<index>

Defines the glossary. It can contains <indexitem> tags and the following optional attributes. xml:lang="lang" Language for the glossary. Use the standard locale-country-variant format. Some examples: xml:lang="de" xml:lang="en" xml:lang="en-US" version="1.0"|"2.0" Version of JavaHelp software. .

<indexitem>

Defines a glossary entry. Nesting entry1 within entry2 defines entry2 to be hierarchically contained within entry1. Uses the following attributes: xml:lang="lang" Language for the glossary item. Use the standard locale-country-variant format. Some examples: xml:lang="de" xml:lang="en" xml:lang="en-US" text="string" Specifies the text that displays in the glossary. target="string" Specifies the map ID of the topic that displays when the entry is chosen by the user. IDs are defined (associated with a URL) in the map file. mergetype="class" (optional) Specifies the path to a valid merge class for the glossary. The default merge class for a glossary is javax.help.AppendMerge. The merge classes are: javax.help.UniteAppendMerge javax.help.SortMerge javax.help.AppendMerge javax.help.NoMerge For more information, see Merging Helpsets. expand="true|false" (optional) Specifies whether to expand the glossary item and its subitems when the glossary initially opens. The default setting is "none", a setting that expands only the top level items. presentationtype (optional) Specifies the type of window in which the topic will be displayed (defined in the <presentation> section of the .hs file). For more information, see the presentation feature in Helpset File. presentationname (optional) Specifies the name of the window in which the topic will be displayed.

See also:

The Helpset File

Map File

JAR Files

Table of Contents File

Index File

Favorites File

Creating the Full-Text Search Database