16.6.6 Creating target-and-jump ALinks for HTML-based Help

You can insert ALink information in DITA XML that serves as both an ALink-list target and an ALink jump, so that all ALink instances with the same keyword belong to a “pool” of ALinks; clicking any one of them displays a list of links to all other topics that have the same keyword.

OmniHelp

For OmniHelp, just inserting ALink keyword PI markers has this effect. Whenever the OmniHelp navigation control is set to Related, if the currently displayed topic contains an ALink keyword PI marker, the navigation pane displays a list of links to all other topics that contain ALink PI markers with the same keyword.

HTML Help, Oracle Help for Java

For HTML Help or Oracle Help for Java, you use a block element with a special @outputclass to specify ALink keywords, and supply macro code to surround the resulting paragraph for the ALink jump. When you assemble ALink jumps using macros, you are not making use of any DITA2Go code to interpret the alink protocol; whatever you build is passed through to the Help system, unaltered.

HTML Help

For HTML Help, the ALink jump code can produce a button; see §18.7.4 Rolling your own macros for ALink jumps in HTML Help.

Oracle Help for Java

For Oracle Help for Java, the ALink jump code creates a hotspot; see§20.10 Creating ALinks for Oracle Help.

Previous Topic:  16.6.5.2 Configuring KLink jumps

Next Topic:  16.6.7 Specifying ALink and KLink list-link destinations

Parent Topic:  16.6 Providing related-topic links for Help systems

Sibling Topics:

16.6.1 Understanding related-topic links

16.6.2 Understanding how ALinks work

16.6.3 Understanding how KLinks work

16.6.4 Adding related-topic link keywords in DITA XML

16.6.5 Adding ALink and KLink jumps in DITA XML

16.6.7 Specifying ALink and KLink list-link destinations