Overview

This is a quick reference for XVCL tags.

x-frame

 <x-frame name="n" [ language="x" ] [ outdir="d" ] [ outname="f" ] />

For XVCL, a frame is defined when this tag is the outer-most tag of an XML document. In turn, the x-frame tag contains text and other tags, such as

• adapt
• break
• ifdef
• ifndef
• insert
• insert-after
• insert-before
• message
• select
• set
• value-of

adapt

 <adapt x-frame="n" [ outdir="d" ] [ outname="f" ] [ src="s" ] />

This tag invokes another frame.

In turn, this tag contains text and other tags, such as

• insert
• insert-after
• insert-before

src attribute

• When src="yes", an x-frame is copied, without invoking XVCL commands.
• When src="no", default, an x-frame is processed.

break

 <break name="n"/>

This tag defines a location within a frame.

ifdef

 <ifdef var="n"/>

This tag emits only when a variable is defined.

ifndef

 <ifndef var="n"/>

This tag emits only when a variable is not defined.

insert

 <insert break="n"/>

This tag defines text used in an insert. Text from an insert replaces a corresponding break.

insert-after

 <insert-after break="n"/>

This tag defines text used in an insert. Text from an insert-after follows a corresponding break.

insert-before

 <insert-before break="n"/>

This tag defines text used in an insert. Text from an insert-before precedes a corresponding break.

message

 <message text="t" [ continue="yes|no"] />

Ant cross-reference: This tag is similar to the echo tag.

option

 <option value="v"/>

This tag depends on the select tag.

otherwise

 <otherwise/>

This tag depends on the select tag.

property

This command is proposed. It sets variables from a Java properties file.

 <property document="d" [ prefix="p" ]
     [ defer-evaluation="yes|no] />

or

 <property name="n" value="v" [ defer-evaluation="yes"|"no"/>

document=d - name of Java properties file. When relative, relative to the x-frame. prefix=p - optional prefix. When a prefix is specified, every property in the properties file is given the same prefix.

See also Xvcl And Property.

remove

 <remove var="n"/>

This tag removes a variable.

select

 <select option="n">
 [ <option value="v">...</option> ]
 [ <otherwise>...</otherwise> ]
 </select>

To select one alternative from a list, use the select tag.

In the following example, the select tag emits only one alternative based upon the value of a variable called version.

 <set var="version" value="v"/>
 :
 <select option="version">
 <option value="1">
 alternative-1
 </option>
 <option value="2">
 alternative-2
 </option>
 <otherwise>
 alternative-x
 </otherwise>
 </select>

set

 <set var="n" value="v"/>

To set a variable, use the set tag.

In the following example, the set tag assignes a variable called version.

 <set var="version" value="1.0"/>

Ant cross-reference: This tag is similar to the param and property tags.

Note: When a value starts with a digit, the entire value is interpreted as a number. For more information, see also Xvcl And Number.

set-multi

 <set-multi var="n" value="v"/>

Like the set command, set-multi sets a variable. Unlike the set command, the value attribute is a comma-delimited list of values.

value-of

 <value-of expr="x"/>

This tag evaluates an expression and emits it.

In the following example, the set tag assigns the message variable. In turn, the value-of tag emits it.

 <set var="message" value="hello, world!"/>
 <value-of expr="?@message?"/>

while

 <while using-items-in="name">...</while>

This tag performs a block for each value in a multi-valued variable. Use with set-multi.

See also Xvcl And While.

xmlproperty

This command is proposed. It sets variables from an XML document.

 <xmlproperty document="d" [ collapse-attributes="c" ] [ keep-root="k" ] [ prefix="p" ] />

document - name of XML file. When relative, relative to the x-frame. collapse-attributes

• When "yes", dot notation is used for attributes.
• Otherwise (default), an attribute name is in parentheses.

keep-root

• When "yes", root element of XML document is used.
• Otherwise (default), root element of XML document is ignored.

prefix=p - optional prefix. When a prefix is specified, every variable is given this prefix.

See also Xvcl And Xml Property.