Omni Systems, Inc.

  

Mif2Go User's Guide, Version 55

  

Valid HTML 4.01!

 

Made with Mif2Go

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.1 Adding related-topic link keywords via markers


7.6.4.1 Adding related-topic link keywords via markers

You can use FrameMaker ALink markers to insert ALink keywords. The content of the marker is an ALink keyword that identifies the ALink set to which the topic belongs. An ALink keyword is case sensitive, and must consist of a single alphanumeric term, without punctuation. However, in OmniHelp (only), spaces are allowed in ALink keywords, and you can include as many keywords as you want in a single marker, separated by semicolons.

If your FrameMaker document already has an index, you do not need to insert keywords for KLink jumps; the keywords are already present in your FrameMaker index markers.

You can provide markers to use for ALink keywords in any of the following ways:

Add custom marker type ALink to your FrameMaker document; see §29.2 Adding custom marker types.

Clone an existing marker type; see §5.11 Repurposing FrameMaker markers

For HTML-based Help only, redefine the behavior of an existing marker type; see §29.4 Defining and redefining marker behavior.

For example, to use Subject markers for ALinks, you could specify the following:

[Markers]

Subject = ALink

Then, any Subject markers in your document whose content conforms to the requirements for ALink keywords can serve as ALink keyword markers. To make those Subject markers serve as KLink keyword markers also, you could specify the following:

[Markers]

Subject = ALink Index

Then, the content of any Subject markers in your document would also show up in the FrameMaker index (if any), and would be included in KLink lists.

Note:  For WinHelp, you need additional settings for ALink keyword markers; see §8.11.2 Adding ALinks and KLinks with markers.



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.1 Adding related-topic link keywords via markers