Progress
Help Development
Guide
Project File Conventions
The next section shows you how to create a project file using Help Workshop. If you choose to create your project files in a text editor, make sure you observe the following conventions:
- All project filenames must have an .hpj extension.
- Each section must begin with a section name that is enclosed in brackets ([ ]).
NOTE: To compile the help project (.hpj) file, the help compiler must know where to find the help source files. By default, the compiler looks for help source files in the directory where the project file resides. For help topic files that reside in another directory, you should use the ROOT option in the [OPTIONS] section. For graphic files that reside in another directory, you should use the BMROOT option the [OPTIONS] section of the project file. See the "[OPTIONS] Section" section for more information.- All project files require a [FILES] section, which the help compiler uses to identify the help topic files to include in the build, and an [OPTIONS] section, which specifies options that control the build process.
- Sections can appear in any order, except that the [OPTIONS] section should appear first and the [ALIAS] section must precede the [MAP] section if both of these sections are present.
- To insert a comment, use a semicolon to precede the comment text. The help compiler ignores all text from the semicolon to the end of the line in which it occurs.
Copyright © 2004 Progress Software Corporation www.progress.com Voice: (781) 280-4000 Fax: (781) 280-4095 |