Omni Systems, Inc.

  

Mif2Go User's Guide, Version 55

  

Valid HTML 4.01!

 

Made with Mif2Go

9 Generating Microsoft HTML Help > 9.12 Setting up CSH for HTML Help > 9.12.5 Understanding alias-file entries


9.12.5 Understanding alias-file entries

By default Mif2Go generates alias-file entries of the following form:

symbolic_ID=helptopicfile.htm

For example:

IDH_CnvDsgnr=02x998989.htm

IDH_Export=02x999005.htm

Mid-topic destinations

To make a CSH link take the user directly to a mid-topic destination, the alias-file entry for the symbolic ID must include a hash value after the file name:

symbolic_ID=helptopicfile.htm#symbolic_ID

For example:

IDH_110100=ac960367.htm#IDH_110100

IDH_110200=ac960367.htm#IDH_110200

To direct Mif2Go to generate alias-file entries of this form, specify the following option:

[MSHtmlHelpOptions]

UseAliasAName=Yes

See §9.12.1 Inserting CSH destinations in your document.

First entry cannot have a mid-topic destination

There is a catch: because of a defect in HTML Help alias-file processing, the very first entry in the alias file must not have a hash value. Even when you specify UseAliasAName=Yes, Mif2Go omits the hash value for the first entry; therefore, the CSH link for the first symbolic ID listed in the alias file always takes you to the beginning of the topic that contains the relevant destination. If this is not acceptable, you can provide a dummy first entry by inserting a newlink marker containing a dummy symbolic ID at the start of the first file in the book. This symbolic ID must also appear in a valid entry in the map file, so you might have to get the developers to add a corresponding dummy entry to the map file.

Even with this workaround, HTML Help Workshop will report an error on every alias with a hash value; but the CSH links work anyway.



9 Generating Microsoft HTML Help > 9.12 Setting up CSH for HTML Help > 9.12.5 Understanding alias-file entries