Progress
Help Development
Guide


Creating a Project File

A project file is a text file that contains a variety of information, such as the name of each source file, specifications for each window type, and copyright information, all of which, tells the help compiler how to build a help file from specified source files. Help project files must have a .hpj file extension.

A project file consists of sections, or categories, of compiler instructions. Before you create the project file, you need to analyze the help system to determine which sections of compiler instructions you need to include in the project file.

Table 4–2 tells you which project file section you’ll need for each of several commonly-used help functions. By analyzing the considerations in the left-hand column, you can determine the minimum set of sections to include in your project file.

Table 4–2: Project File Considerations 
Help System Consideration
Project File Section Required
Context-sensitive help calls
[MAP]
Graphics
[BITMAPS]
Table of Contents
[OPTIONS]
Special help viewer features, such as browse buttons
[CONFIG]
Secondary windows?
[WINDOWS]
Build tag (*) control code for conditional compile (build) options
[BUILDTAGS]

Note that Help Workshop creates an [OPTIONS] section by default. A particularly useful option in the [OPTIONS] section is COMPRESS, in which you can specify compression to considerably reduce the size of a help file.


Copyright © 2004 Progress Software Corporation
www.progress.com
Voice: (781) 280-4000
Fax: (781) 280-4095