11 Tags

This chapter provides detailed information about each VoiceXML tag. See:

•	Tag Summary for an overview of the tags, grouped by function
•	Tag Index for an alphabetical list of all tags

Each tag description includes the following information:

Syntax
Summary of how the tag is used.

Description
Description of attributes or other details.

Usage
Table of parent and children tags. Parent tags can contain this tag and children tags can be used within this tag.

See Also
Links to related information.

Examples
Short examples you can run as simple, standalone applications.

In the cases where the BeVocal VoiceXML interpreter deviates from the VoiceXML 2.0 Specification, the difference is clearly marked below in the following ways:

Not implemented

Functionality not currently available.

Extension

Added functionality.

Experimental Extension

Added functionality that may be included in a later specification for VoiceXML. If the extension is standardized, the BeVocal VoiceXML implementation will change as necessary to match the VoiceXML standard.

Deprecated

Non-standard or superseded feature that was supported by an earlier version but has been replaced by a new feature.

VoiceXML 1.0 only

Tag is part of the VoiceXML 1.0 standard, but has been removed from VoiceXML 2.0.

Tags and attributes that were added to the specification in VoiceXML 2.0 are marked New in VoiceXML 2.0.

VoiceXML Tag Summary lists any differences between the BeVocal VoiceXML implementation and the VoiceXML 2.0 standard.

Tag Summary

The following table classifies VoiceXML tags according to their purpose.

Purpose Tags

Defining the Application
<vxml> <meta> <metadata>

Dialogs
<form> <menu>

Input Items of a Form
<field> <bevocal:enroll> Extension <bevocal:listen> Extension <record> <bevocal:register> Extension <subdialog> <transfer> <bevocal:verify> Extension

Control Items of a Form
<initial> <block>

Menus
<menu> <choice> <grammar> <enumerate>

Fields
<field> <enumerate> <grammar> <option> <filled> <help> <noinput> <nomatch>

Subdialogs
<subdialog> <param> <return>

Controlling Dialog Transitions
<goto> <submit> <link> <choice>

Handling Events
<catch> <error> <help> <noinput> <nomatch>

Controlling Synthesized Speech
<break> <voice> New in VoiceXML 2.0 <emphasis> New in VoiceXML 2.0 <prosody> New in VoiceXML 2.0 <phoneme> New in VoiceXML 2.0 <say-as> New in VoiceXML 2.0 <sub> New in VoiceXML 2.0 <mark> New in VoiceXML 2.0 <s> New in VoiceXML 2.0 <sentence> New in VoiceXML 2.0 <p> New in VoiceXML 2.0 <paragraph> New in VoiceXML 2.0

Specifying Grammars
<grammar> <rule> New in VoiceXML 2.0 <ruleref> New in VoiceXML 2.0 <token> New in VoiceXML 2.0 <one-of> New in VoiceXML 2.0 <item> New in VoiceXML 2.0 <tag> New in VoiceXML 2.0 <example> New in VoiceXML 2.0 <lexicon> New in VoiceXML 2.0 <div> VoiceXML 1.0 only <dtmf> VoiceXML 1.0 only <emp> VoiceXML 1.0 only <pros> VoiceXML 1.0 only <sayas> VoiceXML 1.0 only

Speaker Verification (Extension)
<bevocal:register> Extension <bevocal:verify> Extension

Controlling the Interpreter
<property>

Containers for Executable Content
<block> <filled> <if> <bevocal:foreach> Extension <catch> <error> <help> <noinput> <nomatch> <object>

Declaring and Setting Variables
(executable content)
<var> <assign> <clear>

Procedural Logic
(executable content)
<if> <else> <elseif> <bevocal:foreach> Extension

Scripting logic
(executable content)
<script>

Producing Audio Output
(executable content)
<audio> <prompt> <reprompt> <value> <enumerate>

Throwing Events
(executable content)
<throw> <rethrow> Extension

Termination the Session
(executable content)
<disconnect> <exit>

Placing and Controlling Outbound Calls
(executable content)
<bevocal:dial> Extension <bevocal:hold> Extension <bevocal:connect> Extension <bevocal:whisper> Extension <bevocal:disconnect> Extension

Sending and Fetching Data
(executable content)
<submit> <send> VoiceXML 1.0 only, Extension <data> Extension

Debugging
<log> New in VoiceXML 2.0

Tag Index

The following table lists the available tags, including tags for:

•	VoiceXML elements
•	Elements in the XML form of the W3C Speech Recognition Grammar Format, which are used to define grammars in that format
•	Elements in the W3C Speech Synthesis Markup Language
•	VoiceXML 1.0 only. Elements in the Java Speech Markup Language

Tag	Description
`<assign>`	Assigns a value to a variable.
`<audio>`	Plays an audio clip to the user.
`<bevocal:connect>`	Extension. Reconnects the user with an outbound call that was placed on hold.
`<bevocal:dial>`	Extension. Initiates an outbound call, allowing the user to talk to a third party at another destination.
`<bevocal:disconnect>`	Extension. Disconnects an outbound call or the inbound call.
`<bevocal:enroll>`	Extension: Create and modify enrolled grammars.
`<bevocal:foreach>`	Extension. Iterates over the elements of an array.
`<bevocal:hold>`	Extension. Places an outbound call on hold.
`<bevocal:listen>`	Extension. Allows the application to suspend execution and listen to the user during an outbound call.
`<bevocal:whisper>`	Extension. Interrupts an outbound call, allowing the application to play audio output to the called third party while the user is on hold.
`<block>`	Contains (non-interactive) executable code.
`<break>`	Speech Synthesis Markup Language element that inserts a pause in audio output.
`<catch>`	Catches an event.
`<choice>`	Defines a menu item.
`<clear>`	Clears one or more form-item variables.
`<data>`	Experimental Extension. Fetches arbitrary XML data from an HTTP server, or submits values to a server.
`<disconnect>`	Disconnects a telephone session.
`<div>`	VoiceXML 1.0 only. Java Speech Markup Language element that classifies a region of text as a particular type.
`<dtmf>`	VoiceXML 1.0 only. Specifies a touch-tone key grammar.
`<else>`	Marks the beginning of an else clause within an `<if>` element.
`<elseif>`	Marks the beginning of an else-if clause within an `<if>` element.
`<emp>`	VoiceXML 1.0 only. Java Speech Markup Language element that changes the emphasis of speech output.
`<emphasis>`	New in VoiceXML 2.0. Speech Synthesis Markup Language element that changes the emphasis of speech output.
`<enumerate>`	Generates audio output that enumerates the options in a field or the choices in a menu.
`<error>`	Catches an error event.
`<example>`	New in VoiceXML 2.0. XML grammar element with an example phrase that matches the containing grammar rule.
`<exit>`	Exits a session.
`<field>`	Declares an input field in a form.
`<filled>`	Contains actions to be executed when fields are filled.
`<form>`	Presents information and collects data.
`<goto>`	Goes to another location in the same or different document.
`<grammar>`	Specifies a speech-recognition grammar.
`<help>`	Catches a help event.
`<if>`	Executes actions conditionally.
`<initial>`	Declares initial logic upon entry into a (mixed-initiative) form.
`<item>`	New in VoiceXML 2.0. XML grammar input element that indicates optional or repeated user input.
`<lexicon>`	New in VoiceXML 2.0. XML grammar input element that indicates a source of pronunciation information.
`<link>`	Specifies a transition common to all dialogs in the link's scope.
`<log>`	New in VoiceXML 2.0. Writes debugging information to a BeVocal Café call log, which you can view on the Café web site.
`<mark>`	New in VoiceXML 2.0. Speech Synthesis Markup Language element that places a marker into the output stream for asynchronous notification.
`<menu>`	Allows user to choose among alternative destinations.
`<meta>`	Defines a meta-data item as a name/value pair.
`<metadata>`	Currently this tag has no effect.
`<noinput>`	Catches a no-input event.
`<nomatch>`	Catches a no-match event.
`<object>`	Always throws an unsupported object exception.
`<one-of>`	New in VoiceXML 2.0. XML grammar input element that indicates alternative user inputs.
`<option>`	Specifies an option in a `<field>`.
`<p>`	New in VoiceXML 2.0. Speech Synthesis Markup Language element that classifies a region of text as a paragraph.
`<paragraph>`	New in VoiceXML 2.0. Speech Synthesis Markup Language element that classifies a region of text as a paragraph.
`<param>`	Specifies a parameter in a `<subdialog>` element.
`<phoneme>`	New in VoiceXML 2.0. Speech Synthesis Markup Language element that provides a phonetic pronunciation for the contained text.
`<prompt>`	Queues TTS and audio output to the user.
`<property>`	Controls settings specific to the BeVocal VoiceXML implementation platform.
`<pros>`	VoiceXML 1.0 only. Java Speech Markup Language element that changes the prosody of speech output.
`<prosody>`	New in VoiceXML 2.0. Speech Synthesis Markup Language element that changes the prosody of speech output.
`<record>`	Records an audio sample.
`<bevocal:register>`	Extension. Register a voice print that can be used to verify caller identity.
`<reprompt>`	Plays a field prompt when a field is re-visited after an event.
`<rethrow>`	Extension. Causes the event currently being handled to be rethrown.
`<return>`	Returns from a subdialog.
`<rule>`	New in VoiceXML 2.0. XML grammar element that defines a grammar rule.
`<ruleref>`	New in VoiceXML 2.0. XML grammar input element that references another rule.
`<s>`	New in VoiceXML 2.0. Speech Synthesis Markup Language element that classifies a region of text as a sentence.
`<say-as>`	New in VoiceXML 2.0. Speech Synthesis Markup Language element that modifies how the enclosed word or phrase is spoken.
`<sayas>`	VoiceXML 1.0 only. Java Speech Markup Language element that modifies how a word or phrase is spoken.
`<script>`	Specifies a block of client-side scripting logic in JavaScript.
`<send>`	VoiceXML 1.0 only; Experimental Extension. Submits values to a web server without transitioning to a new VoiceXML document.
`<sentence>`	New in VoiceXML 2.0. Speech Synthesis Markup Language element that classifies a region of text as a sentence.
`<speak>`	New in VoiceXML 2.0. The `<speak>` element is the root element of a standalone SSML document which contains all other SSML elements.
`<sub>`	New in VoiceXML 2.0. Attribute provides substitute text to be spoken instead of the contained text.
`<subdialog>`	Invokes another dialog as a subdialog of the current one.
`<submit>`	Submits values to a document server.
`<tag>`	New in VoiceXML 2.0. XML grammar element that specifies how to interpret the user input.
`<throw>`	Throws an event.
`<token>`	New in VoiceXML 2.0. XML grammar input element that specifies words to be spoken by the user.
`<transfer>`	Transfers the user's call to a third party at another destination.
`<value>`	Inserts the value of a expression into audio output.
`<var>`	Declares a variable.
`<bevocal:verify>`	Extension. Verify that the speaker's voice matches a stored voice print.
`<voice>`	New in VoiceXML 2.0. Speech Synthesis Markup Language element that requests a change in speaking voice.
`<vxml>`	Contains the VoiceXML code of a document.

Tag Descriptions

The remainder of this chapter contains tag descriptions is alphabetical order.

[Show Frames] [FIRST] [PREVIOUS] [NEXT]

Syntax	Summary of how the tag is used.
Description	Description of attributes or other details.
Usage	Table of parent and children tags. Parent tags can contain this tag and children tags can be used within this tag.
See Also	Links to related information.
Examples	Short examples you can run as simple, standalone applications.

Not implemented	Functionality not currently available.
Extension	Added functionality.
Experimental Extension	Added functionality that may be included in a later specification for VoiceXML. If the extension is standardized, the BeVocal VoiceXML implementation will change as necessary to match the VoiceXML standard.
Deprecated	Non-standard or superseded feature that was supported by an earlier version but has been replaced by a new feature.
VoiceXML 1.0 only	Tag is part of the VoiceXML 1.0 standard, but has been removed from VoiceXML 2.0.

Purpose	Tags
Defining the Application	`<vxml>` `<meta>` `<metadata>`
Dialogs	`<form>` `<menu>`
Input Items of a Form	`<field>` `<bevocal:enroll> Extension` `<bevocal:listen> Extension` `<record>` `<bevocal:register> Extension` `<subdialog>` `<transfer>` `<bevocal:verify> Extension`
Control Items of a Form	`<initial>` `<block>`
Menus	`<menu>` `<choice>` `<grammar>` `<enumerate>`
Fields	`<field>` `<enumerate>` `<grammar>` `<option>` `<filled>` `<help>` `<noinput>` `<nomatch>`
Subdialogs	`<subdialog>` `<param>` `<return>`
Controlling Dialog Transitions	`<goto>` `<submit>` `<link>` `<choice>`
Handling Events	`<catch>` `<error>` `<help>` `<noinput>` `<nomatch>`
Controlling Synthesized Speech	`<break>` `<voice> New in VoiceXML 2.0` `<emphasis> New in VoiceXML 2.0` `<prosody> New in VoiceXML 2.0` `<phoneme> New in VoiceXML 2.0` `<say-as> New in VoiceXML 2.0` `<sub> New in VoiceXML 2.0` `<mark> New in VoiceXML 2.0` `<s> New in VoiceXML 2.0` `<sentence> New in VoiceXML 2.0` `<p> New in VoiceXML 2.0` `<paragraph> New in VoiceXML 2.0`
Specifying Grammars	`<grammar>` `<rule> New in VoiceXML 2.0` `<ruleref> New in VoiceXML 2.0` `<token> New in VoiceXML 2.0` `<one-of> New in VoiceXML 2.0` `<item> New in VoiceXML 2.0` `<tag> New in VoiceXML 2.0` `<example> New in VoiceXML 2.0` `<lexicon> New in VoiceXML 2.0` `<div> VoiceXML 1.0 only` `<dtmf> VoiceXML 1.0 only` `<emp> VoiceXML 1.0 only` `<pros> VoiceXML 1.0 only` `<sayas> VoiceXML 1.0 only`
Speaker Verification (Extension)	`<bevocal:register> Extension` `<bevocal:verify> Extension`
Controlling the Interpreter	`<property>`
Containers for Executable Content	`<block>` `<filled>` `<if>` `<bevocal:foreach> Extension` `<catch>` `<error>` `<help>` `<noinput>` `<nomatch>` `<object>`
Declaring and Setting Variables (executable content)	`<var>` `<assign>` `<clear>`
Procedural Logic (executable content)	`<if>` `<else>` `<elseif>` `<bevocal:foreach> Extension`
Scripting logic (executable content)	`<script>`
Producing Audio Output (executable content)	`<audio>` `<prompt>` `<reprompt>` `<value>` `<enumerate>`
Throwing Events (executable content)	`<throw>` `<rethrow> Extension`
Termination the Session (executable content)	`<disconnect>` `<exit>`
Placing and Controlling Outbound Calls (executable content)	`<bevocal:dial> Extension` `<bevocal:hold> Extension` `<bevocal:connect> Extension` `<bevocal:whisper> Extension` `<bevocal:disconnect> Extension`
Sending and Fetching Data (executable content)	`<submit>` `<send> VoiceXML 1.0 only, Extension` `<data> Extension`
Debugging	`<log> New in VoiceXML 2.0`