Build A Basic Windows® Help File

Completed *.RTF File

The completed *.rtf, in conjunction with a help project file, can now be compiled using any Winhelp compiler.

Notes:
1. As advertised, this example is a very basic, see Winhelp Books and WinHelp Tools, Utilities and Compilers for more complete references.

2. If you are an MS Word user, Microsoft provides a template (What Series) at no cost that automates many of the redundant tasks (jumps, popups, graphics references, etc.) in preparing a *.rtf file.

3. The completed *.rtf example includes browse sequences footnotes (+ plus sign) for the four controls on the interface. During the planning stage you should determine which topics are related to one another, and then assign them to browse sequences to help the end user navigate the help file. You designate the browse buttons with a macro in the [CONFIG] section of the help project file (*.hpj). When compiled, these buttons (<< >>) will be placed on the "main" window's button bar.

#.$.K.+. Control 1

In the *.rtf file, place the cursor at the left edge of the "C," insert the (+) footnote. Then type "Control: 0001" for the first Control. Do the same for each of the other controls, increasing the last digit. In this case "Control" is the name of the browse sequence. Each browse sequence must have a unique name, and a topic may only be assigned to a single browse sequence.

#.$.K. My Help File Contents Page

______page break__________

#.$.K. Overview (Non-scrolling area)
{bmc graphic.bmp}
Text(Scrolling area)

 ______page break__________
#.$.K. Toolbar (Non-scrolling area)
Text(Scrolling area)

 ______page break__________
#.$.K. File Menu(Non-scrolling area)
Text(Scrolling area)

 ______page break__________
#.$.K. Edit Menu(Non-scrolling area)
Text(Scrolling area)

 ______page break__________
#.$.K. Help Menu(Non-scrolling area)
Text(Scrolling area)

 ______page break__________
#.$.K.+. Control 1(Non-scrolling area)
Text(Scrolling area)

 ______page break__________
#.$.K.+. Control 2(Non-scrolling area)
Text(Scrolling area)

 ______page break__________
#.$.K.+. Control 3(Non-scrolling area)
Text(Scrolling area)

 ______page break__________
#.$.K.+. Control 4(Non-scrolling area)
Text(Scrolling area)

 ______page break__________
#.
Text (ASCII Popup)

 ______page break__________
#.$.K. About My Help File(Non-scrolling area)
(Scrolling area)

 ______page break__________

footnotes:
# Contents
$ My Help File Contents Page
K Contents

# Overview
$ Overview
K Overview; Getting Started; User Interface
#Toolbar

$ Toolbar
K Toolbar; Open; Close; Exit; Save; Save As

# FileMenu
$ File Menu
K File Menu; Open; Save; Save As; Close; Exit; Quit
# EditMenu
$ Edit Menu
K Copy; Paste; Cut; Clear
# HelpMenu
$ Help Menu
K Help; Context Sensitive Help; F1; What's This
# Control1
$ Control 1
K Control 1
+ Control: 0001
# Control2
$ Control 2
K Control 2
+ Control: 0002
# Control3
$ Control 3
K Control 3
+ Control: 0003
# Control4
$ Control 4
K Control 4
+ Control: 0004
# ASCII
# About

 

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