Build A Basic Windows® Help FileBuild A Basic Windows® Help File
Typical *.RTF Topic
______page break__________
#.$.K. Overview (Non-scrolling area)
(Scrolling area)
______page break__________
footnotes:
# Overview
$ Overview
K Overview; Getting Started
In the Contents topic, we assigned the hidden text "Overview" as the Overview topic's context string; and now we see it verified as the topic's context string in the (#) footnote. When the *.rtf file is compiled, the help file user will be able to click on the "Overview" entry in the Contents topic, and WinHelp will display the Overview topic above. This is how "jumps" are created.
Next, highlight "#.$.K. Overview," making sure there is no paragraph mark above the title. Then using your word processor's commands, select the format option of "keep text together." You have now set the topic's non-scrolling area. That is, if the topic's contents exceed a single window, when the help file user scrolls to read the remainder of the topic, this selected area will not move. There are a number of reasons you might include non-scrolling areas, the simplest being it tends to pretty up the page. For more concrete reasons see the Help Author's Guide.
The use of a non-scrolling area is not strictly speaking a basic necessary for a help file, but it can be easily contrived, and provides for a professional touch. The non-scrolling area is always directly under the main window's menu bar, or the secondary windows' title bar, and must include the first paragraph (topic title) of a topic. The background color of the non-scrolling area is set in the [Windows] section of the help project file; light gray from the Windows pallet being a common choice.
Note: Styles. The help compiler will display frames (bordered text) and simplified tables. It has trouble with bulleted list and specialized (proprietary) RTF script. The help compiler does not recognize sub and super scripts, nor proprietary word processor commands, like Microsoft Word's "All Caps" option. Elsewise, if you stick to generally accepted punctuation and basic writing techniques, you will have no problem with the Winhelp compilers.
Note: Fonts. When selecting a font, keep two thoughts in mind. (1) Font sizes expand and contract with screen resolution. For that reason, many help authors write for 640 x 480 (VGA). (2) If your help file is going to be viewed on any other computer than your own, select a font that ships with Windows. Else, WinHelp will substitute your non-standard font for one that resides on the target computer. The result can be ugly! Microsoft tends to use 8 point Arial font for text in its help files. In my commercial work, I tend to use 9 point Arial for text. However, I have used 12 point Times New Roman. Accepted practice is to use Arial, MS Serif or MS San Serif. Fonts like Times New Roman are generally better for printing than for screen displays.
 |
| The Freelance Story Teller  |
| Voice: 405 720 7995 |
| Fax: 405 720 7995 |
| 11808 Silvermoon Drive, Oklahoma City, OK 73162 |