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.

The following subjects are covered in this document:


Related information about VTML and WIZML:

Tutorial
The Visual Tool Markup Language (VTML)
Reference
VTML reference - overview
Context
TAG
Container for
Help text with HTML markup

top

Tools

TAGDESCRIPTION plays a role in the following VTML-driven tools:

  1. Tag Editor

top


Location

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

top


Function

Each Tag Editor can have its own help information which can be shown either in an embedded window (using the arrows mini-button) or in a free-floating window (using the clover mini-button).

The embedded window can show the current document or embedded help information; local links within the file will work, as well as links to other (local) files. Links to external files (HTTP) can not be followed, though. The free-floating mini-browser is somewhat more powerful in that it can be moved and resized; as with the embedded browser, "back" and "forward" navigation is not possible, however.

Both mini browsers support a subset of HTML 3.2, with the addition of tables. Images are not supported, however: an image symbol, and the ALT information (if present) will be shown instead.

The TAGDESCRIPTION tag can occur in two forms:


top

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 to the user; it can contain basically the kind HTML markup you can use with the BODY section of an HTML document. (Don't overdo it though: the embedded and floating mini-browsers have only small windows.)

Syntax and Attributes

<TAGDESCRIPTION ...> </TAGDESCRIPTION>
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

<TAGDESCRIPTION HEIGHT=100>
      <B>CFAPPLICATION</B>
      <P>Defines scoping for a Cold Fusion 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 Cold Fusion application.</P>
</TAGDESCRIPTION>

top



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

<TAGDESCRIPTION HELPFILE="../../../Help/HTML_Reference/Document_Structure_Elements/BASEF.HTM"
                HEIGHT=150/>

top