Create a Help file for a new geoprocessing tool

[ehallisey]

I'm trying to create a simple Help file in ArcGIS 10 for a new geoprocessing tool created by a developer with whom I work. Here's all I can find from Esri on this:

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.?

I'm not a developer and I don't relish the idea of having to download, install, and learn how to use another software package just to create a few help pages. Also, I can't find a "Microsoft HTML Help 1.4 SDK" topic from the link Esri provides and the most recent version of HTML Help, downloadable from Microsoft, seems to be from 2003.

Does anyone know of a workaround? Has anyone worked with HTML Help? Any quick start tutorials? Any suggestions?

Thanks!
Elaine

Message was edited by: Curtis Price (reformatting to Geonet)

[KevinHibma]

Thanks for the follow up.
I cannot reproduce the problem as you describe on my 10.0 spX machine.
Just a guess, if you re-name your profile and re-start ArcMap, does it still happen?

Navigate to:
C:\Users\<user>\AppData\Roaming\esri
Rename the Desktop10.0 folder to something else
Open ArcMap, and try your steps.

When you're done if you can re-name the folder back if you want to regain the settings of ArcMap

[GerryGabrisch]

FYI, if you open your tools parameters in ArcToolbox and go to the General tab, you can enter valid HTML code in the Description box which is a simple way to create nice looking help.

[JonathanCusick]

Hey Curtis,

I created a script tool with Python and am trying to add documentation to it. I was able to enter a general description of the tool that appears in the tool help when it is first opened, but when I click on one of the specific input parameters, the description in the tool help is blank and I can't figure out where to edit it. I've also tried right clicking on the script tool itself in ArcCatalog (10.2.1) but do not get an "Item Description" button. Any suggestions?

Thanks!
Jon

[ATTACH=CONFIG]34950[/ATTACH][ATTACH=CONFIG]34951[/ATTACH]

Is this a custom tool (.NET) or a script tool?

If it's a script tool, documentation is added by right clicking the tool, selecting Item Description and editing the metadata.

For GP tools built using .NET (called a "custom geoprocessing tool" instead of the more common "script tool" built in Python or another scripting language) you do indeed need to create a .chm file and set the tools HelpFile property to point to it. Although the Microsoft Windows HTML Help SDK is still supported (in Windows 7), it's very difficult to use. This is usually handled using third-party help authoring applications (Esri uses one obviously) that create documentation in various formats (including .chm) from a single source. Robohelp is one of the most popular ones out there.

[curtvprice]

The right click thing is in ArcMap. In ArcCatalog, select the script, click the description button and click edit.

When editing script tools, it's best to have your Customize/Options/Metadata set to "Item Description" style.

[GerryGabrisch]

And you can use HTML tags to format the item description for a nicer looking tool.

[JonathanCusick]

Thank you!

The right click thing is in ArcMap. In ArcCatalog, select the script, click the description button and click edit.

When editing script tools, it's best to have your Customize/Options/Metadata set to "Item Description" style.

[TedKowal]

There are some alternatives ....  I will not say they are easier or better only cheaper if you are on a tight budget some of these are free or opensource.... At some point in time I have used all of the below.... ( I currently use Robohelp since now I have a software budget )

Sandcastle -- http://shfb.codeplex.com/

Help & Manual - The most popular help authoring and documentation tool

HTML Help Workshop and Documentation from Official Microsoft Download Center

KEL CHM Creator v.1.4.0.0 | Dumah's blog

HelpScribble - Complete Help Authoring Tool - WinHelp hlp, HTML Help chm, Printed Manual and Web Hel...

HelpNDoc | HTML help authoring tool, Word, PDF and eBook documentation generator

Hope this helps for those on a tight budget......

[tinaYang]

I have developed a script tool. Now I will edit the documentation by clicking the item description. However after I press the edit button, only generic information are available for editing. Some specific parameters (such as usage, input parameters ) are not shown up for editing. Anyone has suggestions on how to edit these specific parameters? thanks

[ShaunWalbridge]

Can you post a screenshot of what you're seeing when trying to modify the documentation of a tool?

[curtvprice]

Tina,

Make sure your app options, metadata tab are set to Item Description before trying to edit tool documentation. This will turn on a more appropriate stylesheet.