7.6.5.2 Configuring KLink jumps
A KLink jump can specify one or more index terms; this should give you, in effect, one or more links to any other topics for which there are index entries that consist of those terms. In FrameMaker, that would be any other topic that contains an Index marker (or another type of marker cloned to Index) that has the same content as a term specified in the KLink jump.
JavaHelp and Oracle Help for Java do not support KLink jumps. Although HTML Help, OmniHelp, and WinHelp 4 nominally support KLink jumps, the jumps actually work only in restricted circumstances. KLink jumps are problematic at best, and should be tested individually.
To add a KLink jump in FrameMaker, insert a hypertext Go to URL marker with content like the following:
message URL klink:index term1;index term2;...
URL must be capitalized. Separate index terms from each other with semicolons (no spaces). Index terms can contain spaces; however, no spaces are allowed after the colon that follows klink.
Commas or colons for level separators
Mif2Go treats commas and colons in FrameMaker index markers as exactly equivalent, and changes all colons to commas. If there is no space after a colon or comma, Mif2Go adds a space. After changing colons to commas and sorting index entries, Mif2Go treats commas as level separators if two successive entries match through a comma, or if the shorter entry ends at a comma in the longer entry.
The text of each index term in a KLink jump must match exactly, including case, the text of the corresponding entry in the index, with the following restrictions:
• Escape double quotes. If an index entry contains double quotes, you must escape each double quote with a backslash in the KLink jump
• Eschew semicolons as punctuation. Because semicolons are always index-term separators, a KLink jump cannot specify an index term that contains a semicolon; the semicolon cannot be escaped with a backslash.
> 7 Producing on-line Help > 7.6 Providing related-topic links for Help systems > 7.6.5 Adding ALink and KLink jumps in FrameMaker > 7.6.5.2 Configuring KLink jumps