18.7.2 Adding ALink and KLink jumps for HTML Help

You can use PI markers or paragraph formats for ALink and KLink jumps; however, DITA2Go provides support only for PI markers. In HTML Help, a related-topic jump is implemented with an <object> linked to the HTML Help OLE control:  

Markers

If you use PI markers for ALink or KLink jumps, DITA2Go provides the <object> macro code automatically; see §18.7.3 Configuring ALink and KLink jumps for HTML Help. Put the PI markers in paragraphs by themselves, located where you want the jump to appear in output.

Formats

If you use paragraph formats for ALink or KLink jumps, you have to provide macro code for the ALink object; see §18.7.4 Rolling your own macros for ALink jumps in HTML Help.

See also §16.6.5 Adding ALink and KLink jumps in DITA XML.

Note:  Because both ALink/KLink jumps and secondary windows/pop-ups use objects in HTML Help, they cannot be combined; for example, you cannot display an ALink-accessed page in a secondary window.

ALinks work in uncompiled HTML Help, if you use the HTML Help viewer instead of a Web browser.

Previous Topic:  18.7.1 Adding ALink keywords for HTML Help

Next Topic:  18.7.3 Configuring ALink and KLink jumps for HTML Help

Parent Topic:  18.7 Creating related-topic links for HTML Help

Sibling Topics:

18.7.1 Adding ALink keywords for HTML Help

18.7.3 Configuring ALink and KLink jumps for HTML Help

18.7.4 Rolling your own macros for ALink jumps in HTML Help

18.7.5 Using the same format for ALink keywords and jumps

18.7.6 Creating buttons for other types of related-topic links

Table of ContentsIndex