English

Bug: Custom geoprocessing tool documentation graphics display issues

Description

When the documentation for a custom tool includes a graphic (illustration) the full path to the graphic must be included for it to display correctly. When only the graphic name is specified an 'empty graphic' icon appears in the help doc.

When the full path is included, further issues are raised when the custom tool is shared. To have the graphic display correctly, all users sharing the tool must have access to the location of the graphic.

Cause

Functionality that allows users to specify graphic file names and the application to look to the same folder as the parent tbx (toolbox) file must be added.

Workaround

Follow the steps below.

  1. Place copies of the desired graphics in the ...\\ArcGIS\Help\gp folder of the install.
  2. Prefix all graphic name references with the following variable: ARCTOOLBOXHELP. This is a system variable that adds the install path to the GP folder listed in Step 1.
    [O-Image] gp doc editor illustration path variable