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:
- Default Help filename — If you enter a filename in this area, Help Workshop creates a :Base command in the contents file.
- Default window — If you enter a window type in this area, Help Workshop adds this to the :Base command.
- Default title — If you enter text in this area, Help Workshop creates a :Title command.
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:
- Edit — Allows you to edit an existing entry. Select the entry in the graphical display area, then choose the Edit button.
- Remove — Removes a selected entry from the contents file.
- Add Above/Add Below — Make your first entry by clicking either the Add Above or Add Below button to display the Edit Contents Tab Entry dialog box. This dialog box features a radio set at the top that gives you the choice of creating a heading or topic entry, calling a macro, or including the entries from a second contents file (which embeds an :Include command in the contents file). Note that the lower portion of the dialog box changes appearance depending on which radio button you select.
Insert new entries in the list by selecting an entry and choosing the appropriate Add button.
- Move Right/Move Left — The Move Right and Move Left buttons allow you to change the heading level of heading and topic entries.
The bottom section contains three buttons which are described below:
- Tabs — Displays the Custom Tabs dialog box which allows you to add custom tabs to the Help Topics dialog box. Each entry in the Custom Tabs dialog box creates a :Tab command in the contents file.
- Link Files — Displays the Help Link Files dialog box, which allows you to specify files to include in KLink and ALink searches. Each entry in the Help Link Files dialog box creates a :Link command in the contents file.
- Index Files — Displays the Index Files dialog box which allows you to specify help files whose keywords and text words are to be included in the Index and Find tabs of the Help Topics dialog box. Each entry in the Index Files dialog box creates an :Index command in the contents file.
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:
Copyright © 2004 Progress Software Corporation www.progress.com Voice: (781) 280-4000 Fax: (781) 280-4095 |