User Guide

208 Chapter 14 Customizing the Development Environment

Adding tag Help

You can associate an HTML-based Help document with a tag by embedding the

Help text inside the tagdescription block.

Here is an example of a tagdescription block and the result in a tag editor:

<B>cfapplication</B>

<P>Defines scoping for a ColdFusion application and

enables or disables storing client variables in the system

registry. By default, client variables are disabled.

Cfapplication is typically used in the application.cfm

file to set defaults for a specific ColdFusion application.

</tagdescription>

As the Help content grows, it might become cumbersome to specify the entire body

of the Help inside the tagdescription block. In addition, large bodies of Help

embedded in the editor file will cause the editor dialog box to open more slowly as

more markup has to be parsed to compose the editor. Under these circumstances, it

advisable to provide large Help contents in a separate HTML file. Such files can then

be referenced using a relative path from the tag editor template.

For example: