Progress
Help Development
Guide


Creating a Contents File with Help Workshop

This section provides an orientation to creating contents files with Help Workshop by describing the elements unique to the contents file window. This section also illustrates the contents file window by showing you a portion of the Procedure Editor contents file as it appears in Help Workshop.

For a detailed description of the menu bar and tool bar of Help Workshop, consult the Help Author’s Guide (hcw.hlp). Also note that the contents file window and all the dialog boxes associated with it use field-level help. Click in any field and press F1 to see the help text for that field.

The area of the contents file window below the tool bar is divided into three sections. The topmost section contains two text areas and and Edit button. When you choose the Edit button, the Default Help Information dialog box appears. This dialog box has three text areas described below:

Use the center section to create, arrange, and edit heading and topic entries. This section features a graphical display showing how your heading and topic entries will appear on the Contents tab, as well as the following buttons:

The bottom section contains three buttons which are described below:

Figure 4–1 shows a portion of the contents file for the Procedure Editor help file as it appears in Help Workshop.

Figure 4–1: Help Contents File in Help Workshop

The text of the Procedure Editor contents file corresponding to the portion of the file shown in Figure 4–1 follows:

:Base EDITENG.HLP>main
:Title Procedure Editor Help
1 Procedure Editor: How To Tasks
2 Using Edit Buffers
3 Listing Open Buffers=Listing_Open_Buffers
3 Using Edit Buffers (Overview)=Using_Edit_Buffers
3 Switching Buffers=Switching_Buffers
3 Displaying Buffer Information=Displaying_Buffer_Information
3 Using the Pop-up Menu=Using_the_Pop_up_Menu
2 Working with Procedures
3 Creating a New Procedure=Creating_a_New_Procedure
3 Opening a Procedure=Opening_a_Procedure 


Copyright © 2004 Progress Software Corporation
www.progress.com
Voice: (781) 280-4000
Fax: (781) 280-4095