Chapter 10. Glossary

Configuration file

A text file with instructions that tell JavaHelp’s indexer how to customize the word-search index. You use the configuration file when running the jhindexer command so that the information specified in the configuration file is applied to the word-search database as it is created.

Context-sensitive help

Online help that displays a help topic specific to the active function of the software application or situation under which the application is running. Context-sensitive help can be in the form of an online help system opening to a specific help topic, or it can be a feature that displays a brief explanation for a selected control in the application window (known as What’s This or field-level help).

DTD (Document Type Definition)

A file that contains the rules for the valid syntax, format, and structure for defining the markup elements in an XML document. JavaHelp has DTDs to specify how to process JavaHelp XML files.

Embedded help

Online help that is built into the software application’s interface. With embedded help, the user does not have to activate the online help system; it is already displayed with the application’s interface. Embedded help does not necessarily have to be in the form of an online help system (although embedded help with JavaHelp is in this form). It can be any help that is embedded in the interface, such as tips and descriptive icons.

Field-level help

Context-sensitive help in which the system displays a brief explanation for ...

Get Creating Effective JavaHelp now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.