18.11.4 Creating an alias file for CSH links

When you use PI markers for CSH destinations, by default DITA2Go generates an alias file for you, named after your document, with extension .hha; for example, MyDoc.hha. DITA2Go also creates an entry for the alias file in the HTML Help project file; for example:

[ALIAS]
#include "MyDoc.hha"

The alias file must be located in or below the directory that contains your .hhp file. The alias file contains an entry for each symbolic ID in your document that:

Alias prefixes

To specify prefixes for symbolic IDs:

[MSHtmlHelpOptions]
; AliasPrefix = all prefixes wanted in alias file, comma or space
;  delimited; if omitted, all newlinks are included
;  NOTE: wildcards do not work in prefixes
AliasPrefix=HIDC_, IDH_

With this setting, the alias file would include the content of every TopicAlias PI marker in your document that contains a name prefixed with HIDC_ or IDH_. See §18.11.5 Understanding alias-file entries for examples.

No alias file

To prevent DITA2Go from creating an alias file:

[MSHtmlHelpOptions]
; MakeAliasFile = Yes (default, make list of newlinks and files) or No
MakeAliasFile=No

When MakeAliasFile=No, DITA2Go does not generate an alias file. In that case, if you are using PI markers for CSH destinations, you must create the alias file manually, and manually insert the corresponding entry in the HTML Help project file.

When MakeAliasFile=Yes, but your document contains no TopicAlias PI markers that qualify, DITA2Go does not generate an alias file.

Previous Topic:  18.11.3 Specifying a map file for CSH links

Next Topic:  18.11.5 Understanding alias-file entries

Parent Topic:  18.11 Setting up CSH for HTML Help

Sibling Topics:

18.11.1 Inserting CSH destinations in your document

18.11.2 Determining whether you need map and alias files

18.11.3 Specifying a map file for CSH links

18.11.5 Understanding alias-file entries

18.11.6 Producing a list of aliases and associated topic titles