<help>

Description

Catches a help event thrown by the VoiceXML application or the IP Media Server. The <help> element associates a help handler with a document, dialog (i.e form or menu), or form item. It contains executable content. It is a shorthand notation for <catch event="help">.

Syntax


<help
    count="integer"
    cond="ECMAScript_Expression">
  child elements
</help>

Attributes

Attribute	Description
count	The count attribute allows you to handle different occurrences of the help event differently. Each form, menu, and form item maintains a counter for the help event while it is being visited; these counters are reset each time the menu or form item's form is re-entered. When there are more than one `<help>` element catching a help event, the element in the closest scope with the highest count that is less than or equal to the current counter will be selected. Optional. (Defaults to 1.)
cond	An ECMAScript expression to be evaluated and used as a boolean condition. This `<help>` element will only catch the help event if the expression evaluates to `true`. Optional. (Defaults to true.)

Anonymous Variables

Two anonymous variables are available within the scope of the <help> element:

_event - This contains the name of the event that was thrown (i.e. "help").
_message - This contains the message string from the corresponding <throw>, <choice>, <link>, or <return> element, or a platform defined value (i.e. "HELP") for help events thrown by the platform. If no message is specified, the value of this variable is ECMAScript undefined.

Parents

Children

<assign>, <audio>, <clear>, <data>, <disconnect>, <enumerate>, <exit>, <foreach>, <goto>, <if>, <log>, <prompt>, <reprompt>, <return>, <script>, <submit>, <throw>, <value>, <var>, #PCDATA

Extensions

None.

Limitations/Restrictions

With the com.voicegenie.STRICTCONFORMANCE property set to FALSE, if a catch element is in a different page (ex. application root) from the page that the event was thrown in, relative URIs in the catch element are resolved relative to the page that catches the event.

Example


<?xml version="1.0"?>
<vxml version="2.0" xmlns="http://www.w3.org/2001/vxml">
  <property name="universals" value="help"/>
  <form>
    <field name="field1" type="boolean">
      <help>
        Please say yes or no.
        <reprompt/>
      </help>
      <prompt> Is that correct? </prompt>
      <filled>
        You said <value expr="field1"/>.
      </filled>
    </field>
  </form>
</vxml>