##### 16.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.

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 DITA XML, insert a hypertext Go to URL marker with content like the following:

    KLinkJump="index term1;index term2;..."

Separate index terms from each other with semicolons (no spaces). Index terms can contain spaces

Exact match required

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.

Previous Topic: 16.6.5.1 Configuring ALink jumps

Next Topic: 16.6.6 Creating target-and-jump ALinks for HTML-based Help

Parent Topic: 16.6.5 Adding ALink and KLink jumps in DITA XML

Sibling Topics:

16.6.5.1 Configuring ALink jumps

Table of Contents • Index