Progress
Help Development
Guide


Options in the [Options] Section of the Project File

Table B–1 describes the options in the [OPTIONS] section of a help project file.

Table B–1: [OPTIONS] Section Options
Option (with syntax)
Description
BMROOT=pathname
Where graphic files are stored. Use this option if any graphic files are stored in a different directory from the directory that contains the help project file.
BUILD=expression
What topics to include in the build. This option works exactly like the [BUILDTAGS] section of the project file. Note that if you use this option, you must also include the build name in the [BUILDTAGS] section.
CHARSET=charset-value
The default character set to use for the fonts in the help file.
CITATION=text
To include a citation in the help file, that will be appended to the end of any information that is copied for printed from the help file. This option is commonly used to attach a copyright notice to information copied or printed from your help file.
COMPRESS=compression-
level
To compress the generated help file. See the Help Author’s Guide (hcw.hlp) for a list of possible values for compression-level.
CONTENTS=topic-id
The topic identified by topic-id is the default topic for the help file. This topic is displayed by default if the help engine encounters a broken jump or if the contents file associated with the help file is missing.
CNT=contents-file
The name of the contents file to associate with the help file.
COPYRIGHT=copyright-
notice
Adds a custom copyright message for the help file to the Version dialog box.
DBCS=value
Indicates that the source files use a double-byte character set.
DEFFONT=fontname,font-
size,charset
The default font for the lists that appear on the Contents, Index, and Find tabs of the Help Topics dialog box and in the Topics Found dialog box.
ERRORLOG=error-filename
To write all error messages to the specified file.
FORCEFONT=fontname
To force all authored fonts in the topic files to appear in the specified font when displayed in a help window. See the Help Author’s Guide (hcw.hlp) for a list of possible values for fontname.
FTS=fts-value
The type of index file to create for the full-text search feature represented by the Find tab of the Help Topics dialog box.
HCW=value
This option is reserved for internal use by the help compiler.
HLP=help-file
The name of the compiled help file.
INDEX-SEPARATORS=
“separators”
What characters to recognize as delimiters for keyword entries.
LCID=language case-insensitive case-sensitive
What language the help file uses.
MAPFONTSIZE=m[-n]:p
Changes the font size in the compiled version to ensure readability at different video resolutions.
MULTIKEY=footnote-
character
The control characters used to identify alternate keyword tables.
NOTES=[0/1/yes/no]
To display notes while compiling the help file.
OLDKEYPHRASE=value
To use the existing key-phrase table or create a new one during the build. The OLDKEYPHRASE option can be assigned one of the following parameters: No (create new table) or Yes (use existing table). The default is No.
REPLACE=
old-prefix=new-prefix
To replace pathname prefixes with a new prefix. By using this option you can avoid editing pathnames elsewhere in the project file, or in included files, if any source files move to a different server or folder.
REPORT=[yes/no]
To display messages while compiling the help file. These messages indicate when the help compiler is performing the different phases of the build, including compiling the file, resolving jumps, and verifying browse sequences.
ROOT=pathname
Where to look for the help topic files.
TMPDIR=folder
The name of a folder to use for storing temporary files created while compiling the help file.
TITLE=titlename
The title of the help file. The help engine displays the text specified in titlename in several places:
The title bar of the Help Topics dialog box, if a title is not specified in the contents file.
The title bar of the main help window whenever it displays the help file if a caption has not already been defined for it and no title was specified in the contents file.
The Topics Found dialog box, if you have set up your keyword jump to display the title of the Help file with the topic title.
The Version dialog box if the COPYRIGHT option was not specified in the project file.


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