Create A Basic WinHelp 3.1 Project File

[OPTIONS] Section Continued

BUILD=EXPRESSION:
This entry is generally for advanced users, however, there has been many a case where a first time help author has had to resort to build tags. The [BUILD] entry is a instructional statement that specifies which *.rtf topics are included / excluded when compiling. You may use the BUILD option only if the *.rtf topic(s) have associated footnotes (*), and the [BUILDTAGS] section is added to the project file. The EXPRESSION contains build tags and logical operators. Examples:
BUILD
=VERSION1, compile topics that contain the VERSION1 tag, or topics with no tags.
BUILD
=VERSION1 & VERSION2, compile topics that contain both the VERSION1 and VERSION2 tags, or topic that contain no tags.
BUILD
=VERSION1 | VERSION2, compile topics that have either the VERSION1 or VERSION2 tag, or topics with no tags.
BUILD
=(VERSION1 | VERSION2) & VERSION3, compile topics that have either the VERSION1 or VERSION2 tag, and that have the VERSION3 tag or topics with no tags.
BUILD
=~VERSION1, compile topics that do not have a VERSION1 tag, or topics with no tags.

FORCEFONT=FONT:
You can change the font(s) used in your *.rtf file to another single font by including the FORCEFONT entry. Example: FORCEFONT=NEW TIMES ROMAN.

MAPFONSIZE=M[-N]:P:
I have never had cause to use this option, but this is how it works. You can change one or more font sizes from your *.rtf file, by including the MAPFONTSIZE entry(ies). m[-n]:p specifies the size and range of the source font(s). The "m" entry is a single point size. The "m-n" entry is a range of point sizes. If a range is specified, all fonts in the range are changed to the size specified by the "p". Elsewise, the "p" specifies the size of the changed font. You may make up to five MAPFONTSIZE entries. If you enter more than one font size change, the source font size or range cannot overlap one to another. Example: m = 6, 8 = n and p = 10. Result = 6-8:10, meaning that fonts sizes 6, 7, and 8 in the *.rtf file will be changed to font size 10 in the compiled help file. In this example: 8:10, means that font size 8 in the *.rtf file would be changed to font size 10 in the compiled help file.

LANGUAGE=LANGUAGENAME:
This is an obscure option that only applies to Scandinavian sort ordering.

MULTIKEY=FOOTNOTECHARTER:
Key word tables store the words / phrases used by the help file's search engine. This entry(ies) specifies the *.rtf file footnote character that identifies a alternate keyword table. Alternate keyword tables allow help file authors to distinguish sources of data. If, for example, you use the standard keyword table (K) for search queries in the parent application, then you might use a second keyword table for search queries in a add-on (plug) application that shares the same help file. Standard / alternate keyword tables are not distinguishable to the help file user. Multikey entry(ies) should be a single, uppercase alphabetic character. You may not use "K," which is reserved for the standard keyword table. There is a theoretical limit of five keyword tables (including the standard table). The practical limit, however, is two (or three if small) keyword tables. It is unclear whether WinHelp 4.0 supports this entry. There two standard tables built in to the newer version (K & A); each with a different function.

BMROOT=GRAPHICFILEPATH:
Enter the path where your graphical files are located. You may list more then one path: C:\Graphics, D:\Pictures, etc. Including graphical images by reference is the preferred solution, but there are several ways to accomplish this task, and project file entries may not be the best solution. (See the
Basic Help File page.) However, when only the file name is included in the *.rtf file ("bmX"), and the associated graphic files are not located in the same directory as the *.rft file, you must include the BMROOT option or a [BITMAPS] section. Both of these entries are not required, but if there is no BMROOT path listed in the [OPTIONS] section, the complete path and file name of each file must be listed in the [BITMAPS] section.

ROOT=ADDONFILEPATH:
Path and file name entries for add-on (external) files which are typically multimedia elements such as sound, video, bitmaps, etc. The use of a third party reference when working in this area is strongly recommended. Enter the path where these files are located. You may list more then one path: C:\Video, D:\Sounds, etc. There are several ways to load a multimedia file by reference, and project file entries may not be the best solution. (See the
Basic Help File page.) However, when only the file name is included in the *.rtf file, and the associated files are not located in the same directory as the *.rtf file, you must include the ROOT option or a [BAGGAGE] section. Both of these entries are not required, but if there is no ROOT path listed in the [OPTIONS] section, the complete path and file name of each file must be listed in the [BAGGAGE] section.

Continue on Next Page

  
The Freelance Story Teller
Voice: 405 720 7995
Fax: 405 720 7995
11808 Silvermoon Drive, Oklahoma City, OK 73162