Skip to Main Content
Creating Effective JavaHelp
book

Creating Effective JavaHelp

by Kevin Lewis
June 2000
Intermediate to advanced content levelIntermediate to advanced
192 pages
4h 53m
English
O'Reilly Media, Inc.
Content preview from 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.

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Start your free trial

You might also like

Expert One-on-One™ J2EE™ Development without EJB™

Expert One-on-One™ J2EE™ Development without EJB™

Rod Johnson, Juergen Hoeller
Pro JavaFX 9: A Definitive Guide to Building Desktop, Mobile, and Embedded Java Clients

Pro JavaFX 9: A Definitive Guide to Building Desktop, Mobile, and Embedded Java Clients

Johan Vos, Stephen Chin, Weiqi Gao, James Weaver, Dean Iverson

Publisher Resources

ISBN: 1565927192Supplemental ContentCatalog PageErrata