Progress
Help Development
Guide


Creating a Project File with Help Workshop

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

Help Workshop, \Program Files\Progress\bin\hcw.exe, is supplied with Progress. It is a utility for creating help contents files and help project files, and for running the help compiler, \Program Files\Progress\bin\hcrtf.exe.

For complete reference information on all aspects of online help development including compiler notes, warnings, and error messages, see the Help Author’s Guide , an online help file, hcw.hlp,that accompanies the Help Workshop. The Help Author’s Guide also includes a detailed description of the menu bar and tool bar of Help Workshop.

The project 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 project file window displays two text areas and a vertically arranged set of buttons. (Refer to Figure 4–3 for the placement of these elements.) The small text area, labeled Help File, displays the directory pathname and file name to use for the compiled help file. You can edit this text area directly, or on the Files tab of the Options dialog box, as described below.

The large text area displays the text of the project file. As you create new project file entries using the dialog boxes associated with the project file window buttons, Help Workshop inserts them into this display area. If you want to edit an existing entry, you can double-click on it in this display area, and Help Workshop will launch the appropriate dialog box (with the correct tab on top, where applicable).

The remainder of this section lists the buttons that appear in the project file window and describes the dialog boxes they launch:

Figure 4–3 shows the Procedure Editor help project file as it appears in Help Workshop.

Figure 4–3: Help Project File in Help Workshop


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