Omni Systems, Inc.

  

Mif2Go User's Guide, Version 55

  

Valid HTML 4.01!

 

Made with Mif2Go

8 Generating WinHelp > 8.4 Converting cross references > 8.4.1 Creating help context markers


8.4.1 Creating help context markers

Mif2Go can convert cross references to help context markers; this is the default for WinHelp:

[HelpOptions]

; Xrefs = Help (make context markers) or None (plain text)

Xrefs=Help

You can specify whether to use the FrameMaker numeric cross-reference ID (the default), or the full text of the cross reference:

[HelpOptions]

; XrefType = = Numeric (default) or Full (use only to eliminate dupes)

XrefType=Numeric

If you specify XrefType=Full, you get the complete referenced text in the WinHelp context marker. Such text can easily exceed the 63-character size limit for cross-reference IDs in WinHelp, and might contain characters that are not valid in WinHelp IDs.

If you specify XrefType=Numeric (or if you omit the setting entirely) Mif2Go uses FrameMaker ObjectIDs instead of the full cross-reference text.

Duplicate references

In the great majority of cases, XrefType=Numeric produces the correct result. However, you run a very small chance of encountering duplicate cross-reference ID numbers, which cause the WinHelp compiler to complain. If this happens, you must replace one of each pair of duplicate ID numbers in your FrameMaker document. To find the duplicates in FrameMaker, generate an Index of Markers (IOM) for your document, selecting only cross-reference markers, and checking Create Hypertext Links. A duplicated number has two references listed instead of one.



8 Generating WinHelp > 8.4 Converting cross references > 8.4.1 Creating help context markers