Creating Help Project Files for Each Help file

After you have set up the directory structure for a multi-file Help project, you create a Help project file for each Help file in the project. The exact contents of the Help project file will vary depending on the type of Help system you are creating, but at a minimum it should include an [OPTIONS] section and a [FILES] section. The Help project file for one of the Help files in this sample project might look like this:

[OPTIONS]
ERRORLOG=PROGMAN.BUG
ROOT=C:\HYPER\PROGMAN
BMROOT=.\PROGMAN\ART
CONTENTS=cont_progman
TITLE=Program Manager
COMPRESS=OFF
REPORT=ON
WARNING=3
[FILES]
.\RTF\PROGMAN.IDX
.\RTF\PROGMAN.CON
.\RTF\PROGMAN.CMD
.\RTF\PROGMAN.HOW
.\RTF\PROGMAN.KBD
.\RTF\PROGMAN.QCK

Notice the following points:

nThe ERRORLOG option appears first so that all error messages will be recorded in the error file.

nThe ROOT option gives a full path to specify the project root directory. In this example, the root directory is the PROGMAN subdirectory of the \HYPER project directory.

nThe BMROOT option gives a path relative to the project directory. The full path for the bitmap root would be \HYPER\PROGMAN\ART.

nSimilarly, the relative paths in the [FILES] section refer to the project root directory.

nFor the first few builds of a new Help project, it is usually more important to build quickly than to get good compression in the built file, so compression is turned off.

nTo make debugging the Help files easier, the [OPTIONS] section includes the REPORT and WARNING options.