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: |
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/JRun 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.
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 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.
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.
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.
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 ColdFusion/JRun 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. |
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. |
ATTRIBCATEGORIES![]() |
tag.html | Container for ATTRIBGROUP tags. |
ATTRIBGROUP![]() |
attribcategories.html | Names a category of attributes and all attributes that belong in this category; used in Tag Inspector. |
ATTRIBOPTION![]() |
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. |
EVENT![]() |
attributes.html | Defines an event for which an event handler can be written in a scripting language. Used by Tag Inspector only. |
INPUT![]() |
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. |
NEXTPAGE![]() |
wizards.html | Controls the next Wizard page to be shown depending on the evaluation of a boolean expression. |
PAGE![]() |
wizards.html | Declares a page of a Wizard. |
PAGELAYOUT![]() |
layout.html | Defines the canvas on which containers and controls can be laid out for a page in a Wizard. |
PARAM![]() |
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. |
TEMPLATE![]() |
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. |
WIZARD![]() |
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 |
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. |
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. |
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. |
ATTRIBOPTION![]() |
attributes.html | Defines one possible value for an attribute with a predefined list of possible values. |
EVENT![]() |
attributes.html | Defines an event for which an event handler can be written in a scripting language. Used by Tag Inspector only. |
ATTRIBCATEGORIES![]() |
tag.html | Container for ATTRIBGROUP tags. |
ATTRIBGROUP![]() |
attribcategories.html | Names a category of attributes and all attributes that belong in this category; used in Tag Inspector. |
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. |
ATTRIBOPTION![]() |
attributes.html | Defines one possible value for an attribute with a predefined list of possible values. |
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. |
ATTRIBOPTION![]() |
attributes.html | Defines one possible value for an attribute with a predefined list of possible values. |
Tag reference | Context | Description |
---|---|---|
WIZARD![]() |
wizards.html | Container for a complete Wizard profile file. |
PARAM![]() |
wizards.html | Defines a parameter for a Wizard or a Wizard page. |
PAGE![]() |
wizards.html | Declares a page of a Wizard. |
PAGELAYOUT![]() |
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. |
INPUT![]() |
wizards.html | Controls databinding between an input control on a page and a PARAM; used by Wizards only |
NEXTPAGE![]() |
wizards.html | Controls the next Wizard page to be shown depending on the evaluation of a boolean expression. |
TEMPLATE![]() |
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. |
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. |