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

Following the JavaHelp Process

The JavaHelp system begins by reading a HelpSet file, which provides information about a particular help project. To display navigation information, the JavaHelp system reads the navigation files listed in the HelpSet file. Additionally, the JavaHelp system uses the information in the map file to find the individual topic files in the HelpSet. Figure 1.2 demonstrates how the HelpSet files work together to display information in the viewer.

How a HelpSet’s files work together

Figure 1-2. How a HelpSet’s files work together

For example, let’s say that a person accesses online help to find a help topic on deleting files in an application. When the user opens the HelpSet for that application, the system first reads the HelpSet file and determines the location of the map file and the navigation files. The system then reads those map and navigation files and displays the navigation information in the navigation area of the HelpSet Viewer. The user can then use the navigation components (TOC, index, or word-search index) to find the topic on deleting files. The appropriate help topic then displays in the content area of the HelpSet Viewer.

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