ArcGIS Desktop

  • Documentation
  • Support

  • My Profile
  • Help
  • Sign Out
ArcGIS Desktop

ArcGIS Online

The mapping platform for your organization

ArcGIS Desktop

A complete professional GIS

ArcGIS Enterprise

GIS in your enterprise

ArcGIS for Developers

Tools to build location-aware apps

ArcGIS Solutions

Free template maps and apps for your industry

ArcGIS Marketplace

Get apps and data for your organization

  • Documentation
  • Support
Esri
  • Sign In
user
  • My Profile
  • Sign Out

ArcMap

  • Home
  • Get Started
  • Map
  • Analyze
  • Manage Data
  • Tools
  • Extensions

Referencing a compiled help file

If you have a compiled help file (.chm), your tools can reference it. A compiled help file is used when viewing the tool reference page.

By providing the help context (the HTML topic ID), when the user right-clicks a tool, then clicks Help, the help topic associated with the help context ID in the .chm file will be displayed.

If you do not supply a help context ID or supply an incorrect one, the .chm file will be displayed with its default page.

There are many sources of information on creating and compiling HTML help or .chm files. A good starting point is the "Microsoft HTML Help 1.4 SDK" topic available from the Microsoft library (http://msdn.microsoft.com). In the library, you'll also find information on creating and compiling .chm files listed under Visual Tools and Languages, HTML Help.

  1. Right-click the tool and click Properties.
  2. Click the Help tab.
  3. Check Reference a compiled help (CHM) file for the tool help.
  4. Browse to the location of the .chm file, select it, then click Open.
  5. In the Properties window, enter a help context ID that corresponds to the topic in the .chm file.
  6. Click OK.

Related topics

  • A quick tour of documenting tools and toolboxes

ArcGIS Desktop

  • Home
  • Documentation
  • Support

ArcGIS Platform

  • ArcGIS Online
  • ArcGIS Desktop
  • ArcGIS Enterprise
  • ArcGIS for Developers
  • ArcGIS Solutions
  • ArcGIS Marketplace

About Esri

  • About Us
  • Careers
  • Insiders Blog
  • User Conference
  • Developer Summit
Esri
Tell us what you think.
© Copyright 2016 Environmental Systems Research Institute, Inc. | Privacy | Legal