HELP_VIEWER(5) — FILE FORMATS

NAME

help_viewer − help viewer file format

SYNOPSIS

/usr/lib/help/∗/∗

AVAILABILITY

Sun386i systems only.

DESCRIPTION

The help_viewer reads and displays the following types of files:

1. Specially formatted ASCII text (for tables of contents). Example:

/usr/lib/help/language/USA-English/Top_Level

2. FrameMaker document files. Example:

/usr/lib/help/language/USA-English/sunview/Desktop_Basics

3. Interleaf files. Example:

/usr/lib/help/language/USA-English/help_guide/Help_Writer’s_Handbook

Each directory within /usr/lib/help/language/USA-English that corresponds to a SunView application name contains detailed information about that application. These are also FrameMaker files. The ∗.rf files in these directories store some of the pictures that appear in the help handbooks (other pictures are integral to the FrameMaker files). Thes ∗.rf files are stored in standard Sun compressed raster file format.

The Frame and Interleaf subdirectories of /usr/lib/help/format contain topic, contents, and index templates that can be used to create new Help Viewer handbooks.

By default, Help Viewer reads help files through /vol/help. The /vol/help/language/USA-English directory contains symbolic links to the individual help files and directories for the various applications on the system. Help files for Sun-supplied applications reside in /usr/lib/help/language/USA-English.

Developers who wish to add their own document directories to the system should create links to them from /vol/help.master/language/USA-English. Installation scripts should have the name of new handbooks added to the Top_Level file in /vol/help.master/language/USA-English.

FILES