nWrite messages displayed during the build to the CARD.LOG file.Syntax
[OPTIONS]
option
.
.
.
The [OPTIONS] section includes options that control how a Help file is built and what feedback the build process displays. If you include this section in the Help project file, list it first so that the options apply during the entire build process.
Parameters
option
Specifies one of the following project-file options.
| Option | Description |
| BMROOT | Specifies the directory containing the bitmap files named in bmc, bml, and bmr references in the Help topic files. |
| BUILD | Determines which topics to include in the build. |
| CITATION | Adds a unique copyright message whenever users copy information in the Help file using the Copy command. |
| COMPRESS | Specifies the type of compression to use during the build. |
| CONTENTS | Specifies the context string of the Help file’s Contents topic. |
| COPYRIGHT | Adds a unique copyright message for the Help file to the About dialog box. |
| ERRORLOG | Puts compilation errors in a file during the build. |
| FORCEFONT | Forces all authored fonts in the topic files to appear in a different font when displayed in the Help file. |
| ICON | Specifies the icon file to be displayed when the Help file is minimized. |
| LANGUAGE | Specifies a different sorting order for Help files authored in a Scandinavian language. |
| MAPFONTSIZE | Maps a font size in the topic file to a different font size in the compiled Help file. |
| MULTIKEY | Specifies an alternate keyword table to use for mapping topics. |
| OLDKEYPHRASE | Specifies whether the compiler should use the existing key phrase table or create a new one during the build. |
| OPTCDROM | Optimizes the Help file for CD-ROM use. |
| REPORT | Controls the display of messages during the build process. |
| ROOT | Specifies the directories containing the topic and data files listed in the Help project file. |
| TITLE | Specifies the text that is displayed in the title bar of the Help window when the file is open. |
| WARNING | Indicates the level of error-message reporting the compiler is to display during the build. |
Comments
These options can appear in any order within the [OPTIONS] section. The [OPTIONS] section is not required.
Example
The following shows the [OPTIONS] section in a sample Help project file:
[OPTIONS]
ERRORLOG=CARD.LOG
ROOT=C:\HELP\PROJECT
BMROOT=C:\HELP\PROJECT\BMP1;C:\HELP\PROJECT\BMP2;C:\HELP\PROJECT\BMP3;
TITLE=My Help File
CONTENTS=IDX_CONTENTS
COMPRESS=HIGH
OLDKEYPHRASE=NO
ICON=C:\HELP\PROJECT\BMP2\HLPFILE.ICO
WARNING=3
REPORT=ONThis sample [OPTIONS] section indicates the following to the Help compiler:
nWrite messages displayed during the build to the CARD.LOG file.
nThe project directory is C:\HELP\PROJECT.
nBitmap files reside in three subdirectories off of the project root directory: \BMP1, \BMP2, and \BMP3.
nThe title bar caption for the Help file is My Help File.
nThe context string of the Help file's Contents topic is IDX_CONTENTS.
nUse high compression during the build.
nDo not use the old key-phrase table during compression.
nUse HLPFILE.ICO as the minimized Help icon.
nReport all errors and warnings.
nDisplay messages throughout the build to indicate when processes are occurring.
See Also
BMROOT Option, BUILD Option, CITATION Option, COMPRESS Option, CONTENTS Option, COPYRIGHT Option, ERRORLOG Option, FORCEFONT Option, ICON Option, LANGUAGE Option, MAPFONTSIZE Option, MULTIKEY Option, OLDKEYPHRASE Option, OPTCDROM Option, REPORT Option, ROOT Option, TITLE Option, WARNING Option