Chapter 8 Help System

This chapter describes the Help system in the Java Desktop System.

Introduction to the Help System

The source documents for the online Help in the Java Desktop System are XML files. The XML files are written to the DocBook XML Version 4.1.2 document type definition (DTD). The DocBook XML files are converted to HTML, and the HTML is displayed in the Help browser. For more information about DocBook XML, see the following URL:

http://www.oasis-open.org/docbook/xml

The Java Desktop System can display Help in the following Help browsers:

• JDSHelp

• Yelp

JDSHelp Browser

The JDSHelp browser is based on the Javahelp browser. For more information about Javahelp file formats, how to write documents for Javahelp, and how to group documents in hierarchies, see the following URL:

http://java.sun.com/products/javahelp/reference/docs/index.html

Yelp Browser

The Yelp browser uses Open Source Metadata Framework (OMF) files, and a cataloging system.

OMF Files

The XML file for each manual has an associated OMF file. The OMF file contains information about the manual that is used by the Yelp browser. OMF files have a .omf extension.

When you install an application, the installation process installs an OMF file to a directory of OMF files. If a Help document has an associated OMF file in an OMF file directory, users can access the Help document from the Yelp browser.

OMF files contain information about Help documents such as the following:

• The location of the XML file for the Help document

• The title of the Help document

• A subject category to which the Help document belongs