Create A Basic WinHelp 3.1 Project File

Scenario: Build a basic help project file for an application with a toolbar; file, edit and help menus; and four major controls on the user interface.
[OPTIONS] Section

The Help Compiler Guide insists that this section is optional. While technically correct, the concept of a project file without a [OPTIONS] section is just plain silly. The [OPTIONS] section header should always be the first entry of the help project file.

CONTENTS=CONTEXTSTIRNG:
The context string entry wanted here is that alphanumeric footnote entry (#) you assigned to the Contents topic of your *.rtf file. (See the Basic Help File page.) The entry is optional, but recommended. If no entry is made, WinHelp 3.1 will assume that the first help topic is the primary contents page. WinHelp 4.0 will ignore this entry, in favor of the Contents Tab. (See the Contents File page[*.cnt])

TITLE=TITLENAME:
The TITLE entry is that text you wish to display in the WinHelp title bar. The title name can contain up to fifty characters; however, depending on the user's default system font and font size, and how the WinHelp window is sized, long title names may be truncated. If no TITLE entry is made, "Microsoft Help" will be displayed in the WinHelp title bar.

ICON=*.ICO:
You may substitute the standard WinHelp icon with one of your own choosing. Enter the path and file name of the icon. The selected icon must be maintained in the same directory as the completed help file. Too, it will only be automatically displayed when the help file is miniaturized, and not automatically displayed in Program Manager Groups or other graphical displays. WinHelp 4.0 does not support this option.

COPYRIGHT=COPYRIGHTNOTICE:
The copyright notice is displayed in the WinHelp About screen. The Help Compiler Guide will tell you this text string may contain up to fifty characters; however, depending on the user's default system font and font size, the use of more than thirty characters may cause your string to be truncated. WinHelp 4.0 supports up to 255 characters, and provides more space for the entry.

CITATION=COPYPRINTNOTICE:
The CITATION text string entered here will be printed along with the user selected topic. Also, any portion of the help file copied to the clip board will also contain this string. Though far from foolproof, this entry exist to remind the help file user that the material being printed or copied is copyrighted. I tend to use both the COPYRIGHT and CITATION entries. The CITATION entry's maximum length for Windows 3.1 is undocumented; however, WinHelp 4.0 supports 2000 characters.

REPORT=ON (default):
Depending on the WARNING level selected, the REPORT option displays messages on the screen during compiling. These messages list the compiling phases, and any error(s) the compiler encounters. If no REPORT entry is made, the compiler will assume the default value.

WARNING=VALUE:
The WARNING level determines the amount of information reported. 1 = Only the most severe errors. 2 = Medium to major errors. 3 = All errors and warnings. I recommend 3, and use same myself.

ERRORLOG=*.ERR:
This entry contains the file name and path of the project error file. If no entry is made, the error file will be created in the compiler's directory/folder. The error file is an ASCII text file, that lists all error messages that appear on the screen. Print this file out, and check off the errors as you correct them.

COMPRESSION=OFF (default):
If no COMPRESSION entry is made, the compiler will assume the default value. I try to avoid compression only because it slows the compiler. It has little effect on Winhelp's ability to speedily display help files. If disk space is at a premium, use the heck out of it. COMPRESSION=MEDIUM: The compiler uses block compression. Expect about a forty percent compression rate. COMPRESSION=HIGH: The compiler uses block and key-phrase compression. Expect about a fifty percent compression rate.

OLDKEYPHRASE=FALSE (default):
When compiling at a high level of compression, the compiler creates a phrase-table file with a *.ph file extension. The *.ph file speeds up the compression process; therefore, you might want to use the old key phrase table for recompilations. However, you get maximum compression if you do not use this option.

Continued on Next Page

The Freelance Story Teller

Voice: 405 720 7995

Fax: 405 720 7995

11808 Silvermoon Drive, Oklahoma City, OK 73162