Progress
Help Development
Guide
Inserting Control Codes
Control codes are footnotes that the WinHelp compiler uses to build the help file. Table 3–1 summarizes the control codes. See the sections following for additional information on the individual control codes.
Follow these steps to assign a build tag, context string, topic title, keyword, and browse sequence to a help topic using MS-Word. Figure 3–3 shows the relationship between the footnote markers and the content of their corresponding footnotes for the most common control codes.
- Place the cursor immediately to the left of the first character in the help topic text with no space between the cursor and the first character in the heading.
- Choose Insert
Footnote.
The Footnote dialog box appears.
- Select the Custom Footnote Mark radio button.
- Enter the appropriate control code (* for build tag, # for context string, $ for topic title, K or A for keywords, or + for browse sequence) in the Custom Footnote Mark field.
- Choose OK.
MS-Word automatically performs the following actions:
- Enter the appropriate footnote text in the footnote pane following the footnote symbol.
For example, in Figure 3–3, “Menu_Commands” is a context string that is entered after the # symbol in the footnote window to uniquely identify the Procedure Editor Menu Commands help topic. There should be one space only between the footnote symbol and the footnote text.
- When you finish entering the footnote text, choose the Close button in the Footnote pane.
NOTE: You can also insert help macros as a control code in a similar manner. For more information, see the "Using Help Macros" section.Figure 3–3 shows the appearance of the control codes and their corresponding footnotes for a typical help topic.
Figure 3–3: Example of Control Codes for a Help Topic
![]()
Copyright © 2004 Progress Software Corporation www.progress.com Voice: (781) 280-4000 Fax: (781) 280-4095 |