TAGDESCRIPTION Section

You can add HTML help to specific tag dialogs using the TAGDESCRIPTION tag. This help can either take the form of embedded text with markup or a reference to an external file.

Location

This tag can occur only within a TAG tag in a Tag Definition file.

Function

Each tag editor can have its own help information. The default display is in the embedded Help window, which can be opened by clicking the Help button or pressing F1. The user can optionally click the Show help in separate window button (Ctrl+F1) to display Help text in a floatable, resizable view.

Tag Editor Help files are usually on the local machine, but you can also link to external files via HTTP. For example, this block,

<TAGDESCRIPTION>
<a href="http://www.w3.org/TR/xhtml1/">XHTML</a>
</TAGDESCRIPTION>
displays a link to XHTML information on the W3C site. Note that the user has to click this link in the Help pane - an extra step - to actually see the Help text.

The TAGDESCRIPTION tag can occur in two forms:

Embedded Help

For this purpose, the tag becomes a container and requires an end tag. The tag body is the help text to be displayed. You can use the same markup for help text as in the BODY section of an HTML document. Image files can be referenced, as well.

Syntax and Attributes

<TAGDESCRIPTION ...> </TAGDESCRIPTION>
HEIGHT Height of the embedded help browser that appears at the bottom of a tag editor. The width is inherited from the width of the dialog.

Examples

<TAGDESCRIPTION HEIGHT=100>
      <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.</P>
</TAGDESCRIPTION>

Help from an External File

In this form the tag is an empty tag; the source for the help information is a separate HTML file, referred to from an attribute in the tag.

Syntax and Attributes

<TAGDESCRIPTION .../>
HELPFILE Required for this form. (Relative) URL of the file that contains the help information.
HEIGHT Height of the little help browser window that will appear at the bottom of of a Tag Editor window when the embedded help window is requested. (The width is inherited from the width of the dialog.)

Examples

This is the Help file pointer that is in the <TAGDESCRIPTION> tag editor:

<TAGDESCRIPTION HELPFILE="../../../Help/VTML_Reference/Tagdescription.html" HEIGHT=150 LFHEIGHT=183/>

top