# <enumerate>

Description

The `<enumerate>` element is an automatically generated description of the choices available to the user. It specifies a template that is applied to each choice in the order they appear in the `<menu>` element, or in the `<field>` element that contains `<option>` elements.

Note that the `<enumerate>` element may only be used within the prompts and the catch elements associated with `<menu>` elements and with `<field>` elements that contain `<option>` elements. As well, when used in catch elements for such elements, the `<enumerate>` element is not supported in form, document, and application level event handlers; only in handlers within `<field>` or `<menu>` elements.

Syntax

    <enumerate>
      child elements
    </enumerate>

Anonymous Variables

If `<enumerate>` is used with no content, a default template that lists all choices is used. If it has content, the content is the template specifier. This specifier may refer to two special variables:

- _prompt: This is the prompt for the current choice (the content of the `<choice>` or `<option>`).
- _dtmf: This is the assigned DTMF sequence for the current choice.

Parents

<audio>, <catch>, <error>, <field>, <foreach>, <help>, <if>, <menu>, <noinput>, <nomatch>, <prompt>

Children

<audio>, <value>, Speech Markup (SSML), #PCDATA

Extensions

None.

Limitations / Restrictions

- Currently, `<enumerate>` is not supported as a child of any Speech Markup (SSML) tags.
- Currently, `<mark>` is not supported within SSML content in `<enumerate>`.
- `<enumerate>` is only supported as a child of `<foreach>` when `<foreach>` is used within `<prompt>`.

Example

    <?xml version="1.0"?>
    <vxml version="2.0" xmlns="http://www.w3.org/2001/vxml">
      <form>
        <field name="maincourse">
          <prompt>
            Please select an entree.
            <enumerate>
              For <value expr="_prompt"/>, press <value expr="_dtmf"/>.
            </enumerate>
          </prompt>
          <option dtmf="1"> sword fish </option>
          <option dtmf="2"> roast beef </option>
          <filled>
            Very good.
            I'll bring out your <value expr="maincourse"/>.
          </filled>
        </field>
      </form>
    </vxml>