<vxml>

Top-level element required in every VoiceXML document.

Attributes

This section describes the attributes you can set for this element.

Name

Data type

Default

application

CDATA

optional

version

2.0

2.0 (required)

xml:base

CDATA

optional

xml:lang

NMTOKENS

optional

xmlns

CDATA

#FIXED "http://www.w3.org/2001/vxml

xmlns:nuance

CDATA

#FIXED "http://voicexml.nuance.com/dialog"

application

Specifies the parent document.

version

The VoiceXML version used in the document. In Voice Platform, the VoiceXML version attribute must be set to 2.0.

xml:base

The base URL for resolving relative paths. Use this attribute to override the base of the VoiceXML document (see File header).

<vxml xml:base="http://mysite/">
    <grammar src = "grammars/mygrammar.grxml"/>
    <!--Refers to http://mysite/grammars/mygrammar.grxml-->
    <goto next="abc/def.vxml"/>
    <!--Refers to http://mysite/abc/def.vxml-->
</vxml>

xml:lang

The language and locale of the document using an identifier compliant with RFC 1766. If the xml:lang attribute is not specified, the default Java Virtual Machine locale is used. The value of the xml:lang attribute is defined as:

lang_value = language [DELIMITER country]
DELIMITER = "-"
language = <ISO-639 language code>
country = <ISO-3166 country code>

For example, some valid specifications of the xml:lang attribute are: 

fr French
en-US American English

It is possible to specify any valid RFC-1766 language code in the xml:lang attribute.See Localizing your deployment for information on constructing locales and localizing Voice Platform.

xmlns

The designated namespace for VoiceXML. By default, all VoiceXML elements and attributes belong to this namelist. This attribute must be set to http://www.w3.org/2001/vxml

xmlns:nuance

The designated namespace for Nuance. This attribute must be set to http://voicexml.nuance.com/dialog.

Children

Parents

None.

Sample code

<vxml>
    <link next="MainMenu.vxml">
        <grammar src="../grammars/Menu.grxml#Main">
    </link>
</vxml>

For a VoiceXML sample demonstrating the use of the <vxml> element within a multi-lingual application, see the United Nations applications located in $NVP_HOME/appservice/applications/webapps/UnitedNations. For information about samples, see Sample applications.