Omni Systems, Inc.

  

Mif2Go User's Guide, Version 55

  

Valid HTML 4.01!

 

Made with Mif2Go

11 Generating JavaHelp or Oracle Help > 11.10 Creating ALinks for Oracle Help


11.10 Creating ALinks for Oracle Help

An ALink keyword in Oracle Help for Java must consist of a single term; no spaces or punctuation. An ALink jump can specify only one ALink keyword.

Oracle Help for Java uses a link file for ALinks (regular JavaHelp does not support ALinks). Mif2Go creates the ALink file for Oracle Help, by default. However, if you know you are not using ALinks, you can save a little time and disk space by directing Mif2Go not to include this file:

[OracleHelpOptions]

; MakeALinkFile = Yes (default, include OracleHelp ALinks) or No

MakeALinkFile = No

You can determine whether ALinks go to the beginning of the referenced topic file, or to the beginning of the paragraph that contains the ALink keyword. The default is the beginning of the topic file:

[OracleHelpOptions]

; ALinkRefs = File (default) or Para (start of containing para)

ALinkRefs = File

For ways to include ALink keywords and ALink jumps in your FrameMaker document, see §7.6 Providing related-topic links for Help systems.

To create a “pool” of ALinks, where every instance serves both as a jump and a target, you can use a FrameMaker format combined with Mif2Go macros. For example, suppose you designate paragraph format AlinkUse for this purpose. You could create an ALink reference and get both an ALink keyword (which makes the current topic a member of the group) and a hotspot that calls up that list of topics:

[HTMLParaStyles]

; ALink uses the contents of the para for the value of the ALink

; Name parameter of an ALink object.

ALinkUse = ALink CodeBefore CodeAfter

[ParaStyleCodeBefore]

ALinkUse = <a href="alink:

[ParaStyleCodeAfter]

ALinkUse = ">Related Topics</a>

When you assemble ALink jumps using macros, you do not access Mif2Go code that automatically interprets the alink protocol (see §7.6.5.1 Configuring ALink jumps); what you build is passed through to Oracle Help unaltered.



11 Generating JavaHelp or Oracle Help > 11.10 Creating ALinks for Oracle Help