Building a Help File

Building the Help file is quite simple.

To build a Help file

1.1.Edit the Help project file and enter the following lines in the [OPTIONS] section so you can monitor the build process on your screen:

WARNING=3
REPORT=ON

When the WARNING option is set as above, the compiler reports all warnings and errors it encounters during the build. When the REPORT option is set, the compiler displays its messages as it performs the different phases of the build, including compiling the file, resolving jumps, and verifying browse sequences.

2.2.Change to the directory that holds the Help project file.

3.3.Type the HC command using the following syntax:

HC projectfile

The projectfile is the name of your Help project file. The compiler assumes that your Help project file has an .HPJ file extension. If it does, or if it has no extension, you can type just the filename, as in the following example:

hc myhelp

The compiler displays periods on the screen to show its progress and displays warnings and error messages when it encounters problems. For more information, see Chapter 18, “Help Error Messages.”

If everything goes smoothly, the Help compiler creates a Help file in the project directory and then returns to the MS-DOS prompt. The Help file has the same name, but with an .HLP extension, as the Help project file. For example, the command in the previous example would produce MYHELP.HLP.