Progress
Help Development
Guide


Assigning Topic Titles

A topic title is a word or phrase that identifies a help topic in the help viewer. The help viewer uses the topic title string to represent the topic on the Index tab of the Help Topics dialog box and in navigation functions like the History or Bookmark functions.

One space separates the control code ($) and the topic title footnote text. Do not use any special formatting for the topic title text:

$ Procedure Editor Menu 

Note that the topic title text you embed in the $ footnote is not automatically used by the help engine to display a title for the topic in the help window. You must include the title that will appear in the help window at the beginning of the help topic itself. For the sake of clarity, the topic title text in the $ footnote should be identical to the title text that appears at the beginning of the help topic in the help window.

Although the help compiler accepts a topic title that is up to 128 characters long, each function has a different limit to how many characters it can display. A long topic title may be truncated by the Bookmark function or on the Index tab of the Help Topics dialog box.


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