<enumerate>

Generates audio output that enumerates the options in a field or the choices in a menu.

Syntax

 <enumerate>
   Optional Template Content
 </enumerate>

Description

Automatically generates a description of acceptable input based on the template you provide. An <enumerate> element may be used in prompts and event handlers within <menu> elements and within <field> elements that contain <option> elements; an error.semantic event is though if it is used elsewhere.

When this tag is in a <menu> element or a prompt or event handler that is executed while a menu is active, it enumerates all <choice> elements within the active menu. When this tag is in a <field> element or a prompt or event handler that is executed while a field is active, it enumerates all <option> elements within the active field.

Two special variables are available for use in template content for auto-generated text.

Variable Meaning
_prompt

Prompt of current choice.

_dtmf

DTMF sequence assigned to current choice.

If this tag has no content, the generated text simply lists the prompts from the option or choice elements in the field or menu.

Usage

Parents Children
<audio>
<bevocal:whisper>
<block>
<catch>
<choice>
<emphasis>
<enumerate>
<error>
<field>
<filled>
<help>
<if>
<initial>
<menu>
<noinput>
<nomatch>
<p>
<paragraph>
<prompt>
<prosody>
<record>
<s>
<sentence>
<subdialog>
<transfer>
<voice>
<audio>
<break>
<emphasis>
<enumerate>
<mark>
<p>
<paragraph>
<phoneme>
<prosody>
<s>
<say-as>
<sentence>
<value>
<voice>

See Also

 •  VoiceXML 2.0 Specification: <enumerate>
 •  Related tags: <menu>, <field>

Examples

If you run this example, the menu's prompt will be:

"Welcome to BeVocal. For movie finder, say movie finder. For horoscopes, say horoscopes. For news desk, say news desk."

 <?xml version="1.0" ?>
 <!DOCTYPE vxml PUBLIC "-//BeVocal Inc//VoiceXML 2.0//EN"
  "http://cafe.bevocal.com/libraries/dtd/vxml2-0-bevocal.dtd">
 
 <vxml version="2.0" xmlns="http://www.w3.org/2001/vxml">
   <menu>
     <prompt>
       Welcome to BeVocal.
       <enumerate>
         For the <value expr="_prompt"/> service, say <value expr="_prompt"/>
       </enumerate>
     </prompt>
     <choice accept="approximate" next="movies.vxml">movie finder</choice>
     <choice next="horoscopes.vxml">horoscopes</choice>
     <choice accept="approximate" next="news.vxml">news desk</choice>
   </menu>
 </vxml>  

[Show Frames]   [FIRST] [PREVIOUS] [NEXT]
BeVocal, Inc. Café Home | Developer Agreement | Privacy Policy | Site Map | Terms & Conditions
Part No. 520-0001-02 | © 1999-2007, BeVocal, Inc. All rights reserved | 1.877.33.VOCAL