7.5.2 Preparing index entries for Microsoft Help Viewer

Microsoft Help Viewer 1.x requires extra meta elements for index terms, so converting FrameMaker index markers to HTML or XHTML is not enough.

To have Mif2Go prepare index entries for eventual use in Microsoft Help Viewer 1.x:

[Index]

; UseHVIndex = No (default) or Yes, prepare meta elements for use

; with Microsoft Help Viewer 1.x

UseHVIndex = Yes

You must also remap index markers as follows:

[Markers]

Index = HVIndex

Mif2Go will also carry out normal index processing for HTML-based output if you clone index markers as well as remapping them:

[Markers]

Index = Index HVIndex

See §29.3.1 Remapping and cloning marker types.

When UseHVIndex=Yes, Mif2Go processes FrameMaker HVIndex marker content as follows:

• Removes the sequences <...> and [...].

• Converts commas to %2C.

• Converts colons to commas (with added space if needed).

• Passes through UTF-8 (from FrameMaker version 8 and later versions).

• Splits at semicolons.

• Respects backslash escapes.

• Produces five XML entities where needed.

Numeric character references are not needed, because Mif2Go uses UTF-8 for all non-ANSI characters.

Index terms for Microsoft Help Viewer 1.x look like this:

<meta name="Microsoft.Help.Keywords" content="Marker, Plain index" />

<meta name="Microsoft.Help.Keywords" content="Unicode%2C mañana…" />

<meta name="Microsoft.Help.Keywords" content="Index marker, First" />

<meta name="Microsoft.Help.Keywords" content="Index marker, Second" />

---

> 7 Producing on-line Help > 7.5 Configuring index entries for Help systems > 7.5.2 Preparing index entries for Microsoft Help Viewer