Creating Effective JavaHelp

HelpSet File

Example:

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

<helpset version="1.0">
  <title>Aviation Information</title>
  <maps>
    <homeID>intro</homeID>
    <mapref location="Map.jhm"/>
  </maps>
  <view>
    <name>TOC</name>
    <label>Aviation TOC</label>
    <type>javax.help.TOCView</type>
    <data>TOC.xml</data>
  </view>
  <view>
    <name>Index</name>
    <label>Aviation Index</label>
    <type>javax.help.IndexView</type>
    <data>Index.xml</data>
  </view>
  <view>
    <name>Search</name>
    <label>Aviation Word Search</label>
    <type>javax.help.SearchView</type>
  <data engine="com.sun.java.help.search.DefaultSearchEngine">
      JavaHelpSearch
    </data>
  </view>
</helpset>

Tag	Attribute	Required	Description
<helpset>		Yes	Top-level element, encompassing the entire HelpSet file.
	version	No	Version of JavaHelp for which the HelpSet file is created.
<title>		No	Title that appears in the HelpSet Viewer’s titlebar. If you omit this element, the titlebar displays Unnamed HelpSet.
<maps>		Yes	Contains subelements (<homeID> and <mapref>) that describe properties related to the HelpSet’s map file.
<homeID>		No	Map ID of the default help topic, displayed when the HelpSet Viewer opens the HelpSet. This is a subelement of <maps>.
<mapref>		Yes	Specifies the HelpSet’s map file through the location attribute. This is a subelement of <maps>.
	location	Yes	URL of ...