<help>

Catches a help event.

Syntax

 <help
     count="integer"
     cond="js_expression"
 >
   Executable Content
 </help>

Description

Attribute Description

count
Minimum number of times an error must have occurred during a form or menu invocation. Optional (default is 1).

cond
JavaScript expression that must also evaluate to true for an event to be caught. Optional (default is true).

If multiple handlers for help events are defined in, or inherited by, the element in which the events occurs, one handler is chosen based on event count, scope, and document order.

A help event is thrown whenever user input matches the predefined help universal grammar.

•	When the `<vxml>` tag's `version` attribute is `2.0` or greater, all universal grammars are deactivated by default. You can activate the `help` grammars by setting the `universals` property. The following tag activates all universal grammars, including `help`:
	<property name="universals" value="all" />
	The following tag activates the `help` grammar and deactivates the other predefined universal grammars:
	<property name="universals" value="help"/>
•	When the `<vxml>` tag's `version` attribute is `1.0`, all universal grammars are active by default. You can deactivate the `help` grammar by setting the `universals` property. The following tag deactivates all universal grammars, including `help`:
	<property name="universals" value="none" />
	The following tag deactivates the `help` grammar and activates the other predefined universal grammars:
	<property name="universals" value="exit cancel goback"/>

For additional information about universal grammars, see Universal Commands and Grammars.

Tip:

•	If a JavaScript expression contains any of the characters "`<`", "`>`", or "`&`", that character must be replaced with the corresponding escape sequence "`<`", "`>`", or "`&`". For more information, see JavaScript Quick Reference.

Usage

Parents Children

<bevocal:listen> <bevocal:register> <bevocal:verify> <field> <form> <initial> <menu> <record> <subdialog> <transfer> <vxml> <audio> <assign> <bevocal:connect> <bevocal:dial> <bevocal:disconnect> <bevocal:foreach> <bevocal:hold> <bevocal:whisper> <clear> <data> <disconnect> <enumerate> <exit> <goto> <if> <log> <prompt> <reprompt> <rethrow> <return> <script> <send> <subdialog> <submit> <throw> <var> <value>

See Also

•	VoiceXML 2.0 Specification: `<help>`
•	Related tags: `<catch>`, `<error>`, `<noinput>`, `<nomatch>`, `<rethrow>`, `<throw>`

Examples

 <?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">
   <form id="foo">
     <property name="universals" value="help"/> 
     <field name="sports">
       <grammar type="application/x-nuance-gsl">
         [ football basketball tennis skiing ] 
       </grammar>
       <help> Please say one of football, basketball, tennis or skiing </help>
       <prompt> What is your favorite sport ? </prompt> 
       <filled>
         <prompt> 
           Looks like <value expr="sports"/> is your favorite sports.
         </prompt>
       </filled>
     </field>
   </form>
 </vxml>

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

Attribute	Description
`count`	Minimum number of times an error must have occurred during a form or menu invocation. Optional (default is `1`).
`cond`	JavaScript expression that must also evaluate to `true` for an event to be caught. Optional (default is `true`).

Parents	Children
`<bevocal:listen>` `<bevocal:register>` `<bevocal:verify>` `<field>` `<form>` `<initial>` `<menu>` `<record>` `<subdialog>` `<transfer>` `<vxml>`	`<audio>` `<assign>` `<bevocal:connect>` `<bevocal:dial>` `<bevocal:disconnect>` `<bevocal:foreach>` `<bevocal:hold>` `<bevocal:whisper>` `<clear>` `<data>` `<disconnect>` `<enumerate>` `<exit>` `<goto>` `<if>` `<log>` `<prompt>` `<reprompt>` `<rethrow>` `<return>` `<script>` `<send>` `<subdialog>` `<submit>` `<throw>` `<var>` `<value>`