English

How To: Include a graphic on geoprocessing model and script dialog side-panels

Summary

Instructions provided describe how to include a graphic on geoprocessing model and script dialog side-panels. It is possible to include a graphic such as: *.jpeg, *.gif, or *.bmp, on a model or script dialog to further explain the tool. This graphic appears on the dialog's side-panel along with the general description of the tool. It appears when the dialog opens and each time the dialog's grey area is clicked.

Note:
Verify that a copy of the graphic is sent to everyone the model/script is shared with. Those users need to place a copy of the graphic in the \\ArcGIS\Help\gp folder of the ArcGIS Desktop installation.

Procedure

Manipulate the help file contents outside of the Documentation Editor that is found in the applications. A simple text (XML) editor, such as Microsoft Notepad, may be used.

  1. Export the custom tool's documentation to an XML file. To do this, users must be working in ArcCatalog and the Metadata toolbar must be visible.

    A. Select the desired custom tool in the ArcCatalog tree.
    B. Click the Metadata window tab. The Metadata toolbar should now be enabled.
    C. Click the last button on the toolbar, the Export Metadata button. A dialog box opens.
    D. When the dialog box appears, select a file name and location, and select an XML format -- the last option in the list, from the Format drop-down list.
    [O-Image] KB27463_1

    E. Click OK.
  2. Open the XML file in Notepad.
  3. To include a graphic that further explains the tool and appears as soon as the dialog opens, use the <toolIllust/> tag. It is recommended that a search is performed, inside the text editor, for: toolIllust.
  4. If the tag is found, perform the following:

    Examine the attributes for the <toolIllust> tag. Does it contain a 'vsrc' attibute? If so, make the attribute equal to the name of the graphic preceeded by "ARCTOOLBOXHELP/".

    Code:
    <toolIllust src="" alt="" vsrc="ARCTOOLBOXHELP/clip_esri.gif"/>

    If the <toolIllust> tag doesnt contain a 'vsrc' attribute, then it must be added, and it must be made equal to the name of the graphic preceeded by "ARCTOOLBOXHELP/".

    Code:
    <toolIllust src="" alt="" vsrc="ARCTOOLBOXHELP/clip_esri.gif"/>

    or

    If the tag is not found during the search, do the following:

    A. Since it does not already exist in the XML file, add it. Run a second search, for: </summary>. This is the closing tag for the summary (description) of the tool.
    B. Copy and paste the following directly after the </summary> closing tag: <toolIllust src="" alt="" vsrc=""/>

    Note:
    Explanation of <toolIllust> attributes:
    src = path to the graphic that will appear in the help document
    alt = text that appears when you hover your mouse over the help documents' graphic
    vsrc = path to the graphic that will appear on the tool dialog side-panel
    C. For the 'vsrc' attribute type the name of the graphic preceeded by "ARCTOOLBOXHELP/".

    Code:
    <toolIllust src="" alt="" vsrc="ARCTOOLBOXHELP/clip_esri.gif"/>


    Note:
    ARCTOOLBOXHELP is a system variable that determines where the user has installed ArcGIS Desktop. It must preceed all graphic names so that when the help file for the custom tool is viewed it includes the graphic.

  5. Save the changes to the XML file and close it.
  6. Import the newly changed XML back into the custom tool. To do this, click the Import Metadata button on the Metadata toolbar in ArcCatalog. Navigate to the location of the XML file and change the format to: XML and click OK.
    [O-Image] KB27463_3
  7. Place a copy of the graphic referenced in the following folder in the ArcGIS Desktop installation: \\ArcGIS\Help\gp.
    [O-Image] KB27463_2
  8. Close ArcCatalog and re-open it.
  9. Open the dialog box for the custom tool and the graphic appears on the side-panel.