Progress
Help Development
Guide


Headings and Topics

Headings and topics are the elements that give the Contents tab its book-and-page appearance. In the contents file, each heading and topic is preceded by a number from 1 through 9, representing its level. Headings, represented by book icons, are used to categorize topics and lower levels of headings. Topics, represented by page icons, represent jumps to help topics, either as jumps, cross-file jumps, or KLink or ALink topic searches.

If a numbered line in the contents file contains only text, the help engine recognizes that line as a heading. If a line contains text followed by an equals sign and a macro or jump, the help engine recognizes that line as a topic.

You might want to make a topic icon appear directly on the Contents tab, so that the user does not have to double-click on a book icon to see it. To do this, place the topic at the beginning of the list of heading and topic entries in the contents file; you cannot place it after a book icon.

For examples of the appearance of heading and topic lines in a contents file, and the effect of their placement on the appearance of the contents tab, compare Figure 4–1 to the contents file text fragment immediately below it.


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