English

How To: Create an [ALIAS] file for geoprocessing toolboxews/tools and use it to create a compiled help system (CHM)

Summary

Instructions provided describe how to create an [ALIAS] file for geoprocessing toolboxews/tools and use it to create a compiled help system (CHM). Each compiled help file (CHM) requires a single [ALIAS] file. This [ALIAS] file contains a textual reference to each toolbox/tool. Enter each text string on a separate line.
[O-Image] kb27681_1
The first portion of each line is the same textual ID found in the [MAP] file. This value connects both files and ultimately connects the application to the compiled help system.

Procedure

All [ALIAS] files follow the format below:
IDH_ + <tbxname/toolname> + =ms-its: + <CHMname> + ::/ + <HTML filename>

The following is an example:
IDH_Clip=ms-its:AnalysisTools.chm::/clip_esri.htm

Note:
The <tbxname/toolname> is a variable describing the toolbox or tool. It does not need to be the exact name as the toolbox/tool, it only needs to match the variable used in the [ALIAS] file. The examples above uses the toolbox/tool name for clarity and easy of use.

Follow the steps below to create an [ALIAS] file.

  1. Create an [ALIAS] file from scratch by opening any text editor.
  2. Follow the format above and enter a single line of text for each toolbox/tool to reference, for example:

    IDH_Clip=ms-its:AnalysisTools.chm::/clip_esri.htm

  3. Reference all toolboxes/tools and save the file with an *.ali extension. Save the *.ali file in the same location as the rest of the CHM project files.

    It must be compiled with all the other CHM files so that its functionality is embedded in the CHM and the help files open properly.

Related Information