Every project file consists of one or more sections. Each section has a section name, enclosed in brackets ([]), that defines the purpose and format of statements and options in the section. Following are the sections used in project files:
Section | Description |
---|---|
[ALIAS] | Assigns one or more context strings to the same topic. |
[BAGGAGE] | Lists files that are to be placed within the help file (which contains its own file system). |
[BITMAPS] | Specifies bitmap files. This section is not required if the project file lists a path for bitmap files by using the BMROOT or ROOT option. |
[BUILDTAGS] | Specifies valid build tags. |
[CONFIG] | Specifies help macros that define nonstandard menus and buttons used in the help file. This section is required if the help file uses any of these features. |
[CONFIG:x] | Contains one or more macros that Windows Help runs when opening the corresponding window, x. |
[FILES] | Specifies topic files to be included in the build. This section is required. |
[MAP] | Associates topic identifiers with context numbers. |
[MACROS] | Associates macros with keywords. |
[OPTIONS] | Specifies options that control the build process. If this section is used, it should be the first section listed in the project file, so that the options will apply during the entire build process. |
[WINDOWS | Defines the characteristics of the primary Help window and the secondary-window types used in the help file. This section is required if the help file uses secondary windows. |
Every project file requires a [FILES] section. This section names the topic files. Most project files also have an [OPTIONS] section that specifies how to build the help file. A very useful option in the [OPTIONS] section is the COMPRESS option, which specifies whether the help file should be compressed or uncompressed. Compressing a help file reduces its size considerably and saves valuable disk space. For more information, see the Help Author's Guide (HCW.HLP) included with the Help Workshop.
The following example creates a compressed help file from two topic files, MAIN.RTF and MENUS.RTF:
[OPTIONS]
COMPRESS=TRUE
[FILES]
MAIN.RTF
MENUS.RTF