VTML reference - overview

This document gives an overview of the available VTML reference documentation. Documents and tags ordered by a few different criteria to facilitate finding what you are looking for.


Related information about VTML and WIZML:

Tutorial
The Visual Tool Markup Language (VTML)

top

Introduction

VTML and WIZML

VTML stands for Visual Tool Markup Language. It us used to define the user interface and determine behavior of a number of tools in the HomeSite and ColdFusion Studio environment. Thanks to this open architecture, you can create your own definition files for these tools or customize existing ones to extend and adapt your working environment.

VTML can be used to customize the following tools:

Generally, VTML defines a user interface and determines its behavior; the "sublanguage" WIZML handles the logic of writing code based on user input in Tag Editors and Wizards.

The language elements (tags, expressions and functions) used for all of these tools (except Tag Outline Profiles) are fully documented in this reference.

Versions

There are several versions of VTML around now. The original version of the language was released with HomeSite and ColdFusion Studio 3.0. When Version 4.0 of these programs was released, VTML was also upgraded to VTML 2. All tags and attributes that are new with VTML 2 are indicated with a graphical marker, also used on the VTML Tag Editors for those tags. With version 4.5 of HomeSite and Studio we see yet again some new extensions to VTML; again, these extensions are indicated with a graphical marker for VTML 3. These markers are used throughout this documentation:

VTML 2 VTML 2 VTML 2
VTML 3 VTML 3 VTML 3

Older versions of the programs do not support these new tags and attributes; they will simply be ignored. If you must distribute tag definitions that work with older versions of these programs, you can use these markers in this documentation to take compatibility into account.

Syntax

All examples in this documentation show the syntax as introduced with VTML 2: empty tags are now written as <TAG .../> while container tags are (still) written as <TAG ...> </TAG>. Note that WIZML does not use this syntax.

The VTML Tag Editors also write code in conformance with this standard. Since HomeSite 3.01 and ColdFusion Studio 3.11 have no problems with this syntax, it was no longer necessary to show (or write) the older syntax of VTML 1.

Obsolete atributes

Some attributes are marked as Obsolete: they may still occur in some Tag Editors distributed with older versions of HomeSite and ColdFusion Studio but do not actually have any effect. They are left-overs from an early development version of VTML. They are mentioned only for completeness since you may come across them in older VTML code.


top

Documentation about aspects shared by Tag Definitions and Wizard profiles

Subject Documented in Description
Flags Flags.html Boolean attributes and attributes that take either Yes or No as a value.
Searching Searching.html How HomeSite and Studio find a tag definition file and how you can control this.
Functions and expressions Functions.html Functions available in WIZML. Usage and syntax of expressions.

top

VTML tags - alphabetically

Tag reference Context Description
ATTRIB Attributes.html Defines an attribute. Databinding between an existing attribute in a tag being edited and the user interface in a Tag Editor or Tag Inspector. Also serves as input for Tag Insight and Tag Tips.
ATTRIBCATEGORIESVTML 2 Tag.html Container for ATTRIBGROUP tags.
ATTRIBGROUPVTML 2 Attribcategories.html Names a category of attributes and all attributes that belong in this category; used in Tag Inspector.
ATTRIBOPTIONVTML 2 Attributes.html Defines one possible value for an attribute with a predefined list of possible values.
ATTRIBUTES Tag.html Container tag for ATTRIB and EVENT tags.
CAT   Defines a category which can contain elements (E) and other categories. Used in Tag Chooser and Expression Builder.
CONTAINER Layout.html Defines a container in which controls or other containers can be placed. Part of the user interface definition for a Tag Editor or a custom Wizard page.
CONTROL Layout.html Defines a control on a user interface for a Tag Editor or a custom Wizard page.
E   Defines an element for Tag Chooser or Expression Builder.
EDITORLAYOUT Layout.html Defines the canvas on which containers and controls can be laid out for the Tag Editor user interface.
EVENTVTML 2 Attributes.html Defines an event for which an event handler can be written in a scripting language. Used by Tag Inspector only.
INPUTVTML 2 Wizards.html Controls databinding between an input control on a page and a PARAM; used by Wizards only
ITEM Control.html Defines one possible choice in a CONTROL with multiple choices, such as a dropdown, a listbox or a radio group.
NEXTPAGEVTML 2 Wizards.html Controls the next Wizard page to be shown depending on the evaluation of a boolean expression.
PAGEVTML 2 Wizards.html Declares a page of a Wizard.
PAGELAYOUTVTML 2 Layout.html Defines the canvas on which containers and controls can be laid out for a page in a Wizard.
PARAMVTML 2 Wizards.html Defines a parameter for a Wizard or a Wizard page.
TAG   Container for a complete tag definition. Contains EDITORLAYOUT, ATTRIBUTES, ATTRIBCATEGORIES, TAGLAYOUT and TAGDESCRIPTION sections.
TAGDESCRIPTION Tag.html Provides help information for a Tag Editor.
TAGLAYOUT Tag.html Section in a tag definition file that controls how code will be written by a Tag Editor based on user input.
TEMPLATEVTML 2 Wizards.html Defines a template file that controls how code will be written by a Wizard based on user input, and which file will be created.
WIZARDVTML 2 Wizards.html Container for a complete Wizard profile file.
WIZBREAK Wizml.html Stops execution of a loop and continues execution with the first statement after </WIZLOOP>.
WIZCONTINUE Wizml.html Skips further processing of any following statements in the loop and initiates the next iteration of the loop with the <WIZLOOP> statement.
WIZELSE Wizml.html Contained code will be extecuted if none of the other conditions in the WIZIF clause evaluate to true; part of a WIZIF clause.
WIZELSEIF Wizml.html Defines an alternative condition under which the contained WIZML code will be executed; part of a WIZIF clause.
WIZIF Wizml.html Defines a condition under which the contained WIZML code will be executed.
WIZINCLUDE Wizml.html Defines a file with WIZML code to be executed at this point. Active only in Wizard template files, not tag definitions.
WIZLOOP Wizml.html Defines how and under what condition the contained WIZML code will be repeatedly executed.
WIZSET Wizml.html Creates and initializes a variable or assigns a value to an existing variable

top

VTML tags - by function

Tag Chooser, Expression Builder and Function Insight

Tag reference Description
CAT Defines a category which can contain elements (E) and other categories.
E Defines an element for Tag Chooser or Expression Builder. Drives Function Insight if the element is defined as a function.

top

Tag Editor

Tag reference Context Description
TAG   Container for a complete tag definition. Contains EDITORLAYOUT, ATTRIBUTES, ATTRIBCATEGORIES, TAGLAYOUT and TAGDESCRIPTION sections.
EDITORLAYOUT Layout.html Defines the canvas on which containers and controls can be laid out for the Tag Editor user interface.
CONTAINER Layout.html Defines a container in which controls or other containers can be placed. Part of the user interface definition for a Tag Editor or a custom Wizard page.
CONTROL Layout.html Defines a control on a user interface for a Tag Editor or a custom Wizard page.
ITEM Control.html Defines one possible choice in a CONTROL with multiple choices, such as a dropdown, a listbox or a radio group.
ATTRIBUTES Tag.html Container tag for ATTRIB and EVENT tags.
ATTRIB Attributes.html Defines an attribute. Databinding between an existing attribute in a tag being edited and the user interface in a Tag Editor or Tag Inspector. Also serves as input for Tag Insight and Tag Tips.
TAGLAYOUT Tag.html Section in a tag definition file that controls how code will be written by a Tag Editor based on user input.
TAGDESCRIPTION Tag.html Provides help information for a Tag Editor.

top

Tag InspectorVTML 2

Tag reference Context Description
TAG   Container for a complete tag definition. Contains EDITORLAYOUT, ATTRIBUTES, ATTRIBCATEGORIES, TAGLAYOUT and TAGDESCRIPTION sections.
ATTRIBUTES Tag.html Container tag for ATTRIB and EVENT tags.
ATTRIB Attributes.html Defines an attribute. Databinding between an existing attribute in a tag being edited and the user interface in a Tag Editor or Tag Inspector. Also serves as input for Tag Insight and Tag Tips.
ATTRIBOPTIONVTML 2 Attributes.html Defines one possible value for an attribute with a predefined list of possible values.
EVENTVTML 2 Attributes.html Defines an event for which an event handler can be written in a scripting language. Used by Tag Inspector only.
ATTRIBCATEGORIESVTML 2 Tag.html Container for ATTRIBGROUP tags.
ATTRIBGROUPVTML 2 Attribcategories.html Names a category of attributes and all attributes that belong in this category; used in Tag Inspector.

top

Tag InsightVTML 2

Tag reference Context Description
TAG   Container for a complete tag definition. Contains EDITORLAYOUT, ATTRIBUTES, ATTRIBCATEGORIES, TAGLAYOUT and TAGDESCRIPTION sections.
ATTRIBUTES Tag.html Container tag for ATTRIB and EVENT tags.
ATTRIB Attributes.html Defines an attribute. Databinding between an existing attribute in a tag being edited and the user interface in a Tag Editor or Tag Inspector. Also serves as input for Tag Insight and Tag Tips.
ATTRIBOPTIONVTML 2 Attributes.html Defines one possible value for an attribute with a predefined list of possible values.

top

Tag TipsVTML 2

Tag reference Context Description
TAG   Container for a complete tag definition. Contains EDITORLAYOUT, ATTRIBUTES, ATTRIBCATEGORIES, TAGLAYOUT and TAGDESCRIPTION sections.
ATTRIBUTES Tag.html Container tag for ATTRIB and EVENT tags.
ATTRIB Attributes.html Defines an attribute. Databinding between an existing attribute in a tag being edited and the user interface in a Tag Editor or Tag Inspector. Also serves as input for Tag Insight and Tag Tips.
ATTRIBOPTIONVTML 2 Attributes.html Defines one possible value for an attribute with a predefined list of possible values.

top

Wizards

Tag reference Context Description
WIZARDVTML 2 Wizards.html Container for a complete Wizard profile file.
PARAMVTML 2 Wizards.html Defines a parameter for a Wizard or a Wizard page.
PAGEVTML 2 Wizards.html Declares a page of a Wizard.
PAGELAYOUTVTML 2 Layout.html Defines the canvas on which containers and controls can be laid out for a page in a Wizard.
CONTAINER Layout.html Defines a container in which controls or other containers can be placed. Part of the user interface definition for a Tag Editor or a custom Wizard page.
CONTROL Layout.html Defines a control on a user interface for a Tag Editor or a custom Wizard page.
ITEM Control.html Defines one possible choice in a CONTROL with multiple choices, such as a dropdown, a listbox or a radio group.
INPUTVTML 2 Wizards.html Controls databinding between an input control on a page and a PARAM; used by Wizards only
NEXTPAGEVTML 2 Wizards.html Controls the next Wizard page to be shown depending on the evaluation of a boolean expression.
TEMPLATEVTML 2 Wizards.html Defines a template file that controls how code will be written by a Wizard based on user input, and which file will be created.

top

WIZML (Tag Editors and Wizards)

Tag reference Context Description
Functions and expressions Functions.html Functions available in WIZML. Usage and syntax of expressions.
WIZSET Wizml.html Creates and initializes a variable or assigns a value to an existing variable
WIZIF Wizml.html Defines a condition under which the contained WIZML code will be executed.
WIZELSEIF Wizml.html Defines an alternative condition under which the contained WIZML code will be executed; part of a WIZIF clause.
WIZELSE Wizml.html Contained code will be extecuted if none of the other conditions in the WIZIF clause evaluate to true; part of a WIZIF clause.
WIZLOOP Wizml.html Defines how and under what condition the contained WIZML code will be repeatedly executed.
WIZBREAK Wizml.html Stops execution of a loop and continues execution with the first statement after </WIZLOOP>.
WIZCONTINUE Wizml.html Skips further processing of any following statements in the loop and initiates the next iteration of the loop with the <WIZLOOP> statement.
WIZINCLUDE Wizml.html Defines a file with WIZML code to be executed at this point. Active only in Wizard template files, not tag definitions.

top