Creating Effective JavaHelp

Appendix A. HelpSet Tags

A JavaHelp HelpSet contains the following XML-format files:

• Map file

• Table of contents (TOC) file

• Index file

• HelpSet file

These files are discussed in Chapter 5, and Chapter 6. This appendix provides a quick reference to the XML elements and attributes used in these files.

Map File

Example:

<map version="1.0">
  <mapID target="img.toplevelfolder" url="Images/toplevel.gif"/>
  <mapID target="intro" url="Topics/introduction_to_aviation.htm"/>
</map>

Tag	Attribute	Required	Description
<map>		Yes	Top-level element, encompassing the entire map file. Nested within are elements that define the map IDs for the HelpSet.
	version	No	Version of JavaHelp for which the map file is created.
<mapID>		Yes	Defines one map ID, associating it with a help topic’s URL.
	target	Yes	Map ID, or shorthand name for a help topic. Used throughout JavaHelp to refer to that topic.
	url	Yes	URL of the help topic’s HTML file.