7.6.4.2 Adding related-topic keywords via format properties

You can assign a property to a FrameMaker format to make the text of every instance of that format act as a related-topic keyword. Create and catalog a special format to use for this purpose.

WinHelp

For WinHelp, you can use either a character format or a paragraph format for related-topic keywords. For example, if an ALink keyword (“A” footnote) appears as a word in topic text, you can apply a special character format to the word, and in the configuration file assign property AKey to the format:

[HelpStyles]

ALinkCharFmt = AKey

Or, you can insert an ALink keyword in a paragraph by itself, apply a special paragraph format (or special character format, provided you do not use the same format to mark words in topic text), and also assign property Delete to the format:

[HelpStyles]

ALinkParaFmt = AKey Delete

See §8.11 Creating related-topic links in WinHelp.

HTML-based Help

For HTML-based Help you must use a paragraph format (as opposed to a character format) for related-topic keywords. For example, you can put an ALink keyword in a paragraph by itself, apply a special paragraph format, and in the configuration file assign property ALink to the format (and property Delete, if you do not want the paragraph to appear in topic text):

[HTMLParaStyles]

; ALink, effective for MS HTML, OH, and Oracle Help, uses the contents

;  of the para for the value of the ALink Name parameter of an ALink

;  object.

ALinkParaFmt = ALink Delete

---

> 7 Producing on-line Help > 7.6 Providing related-topic links for Help systems > 7.6.4 Adding related-topic link keywords in FrameMaker > 7.6.4.2 Adding related-topic keywords via format properties