VTINCLUDEVTML 2

VTINCLUDE lets you embed a reference to another VTML file within a VTML file.

The syntax is <vtinclude file="file_name"> with the value of file being a logical path to an existing file (absolute or relative). The Extensions/Includes folder may be used for VTINCLUDE files, but any valid path will work.

Location

Insert a VTINCLUDE tag at the place in a VTML file where you want to reference the included file.

Function

The VTINCLUDE tag lets you place content in a single file and reference that file as needed.
You can nest VTINCLUDE tags, but not recursively.

Syntax

<VTINCLUDE file="file_name">

Whitespace around the equals sign is allowed.

Attributes

FILE> Required. Reference to the included file. This can be a relative or absolute file reference; relative is relative to the currently executing file.

Usage

Enables a modular approach to VTML development and simplifies maintenance tasks.

Editing

The RMB Edit Include File command opens the file, src, template, or page referenced in the include tag. Note that this command only works with absolute and relative paths, it does not work for logical file references, that is, virtual mappings on the server. This command is available for editing the following tags, as well:

Example

This tag appears near the top of every XHTML tag definition file:

<VTINCLUDE FILE="../../Includes/tdIconsDialog_all.inc"/>

The included file contains code that is used to display icons in each of the XHTML tag editors. The .inc extension is a naming convention adopted for the Visual Tools, but any valid VTML included file will be processed correctly, regardless of the extension.

top