help VoiceXML element - Zvon reference

ZVON > References > VoiceXML Reference

Element:	help
Attributes:	\| cond \| count \|
Parents:	\| field \| form \| initial \| menu \| object \| record \| subdialog \| transfer \| vxml \|
Children:	\| assign \| audio \| clear \| disconnect \| enumerate \| exit \| goto \| if \| prompt \| reprompt \| return \| script \| submit \| throw \| value \| var \|
Description:	Go to Standard

Examples:

<help>No help is available.</help>

<catch event="help"> Please say visa, mastercard, or amex. </catch>
<help>Please say visa, mastercard, or amex.</help>

<field name="flavor">
     <prompt>What is your favorite flavor?</prompt>
     <help>Say one of vanilla, chocolate, or strawberry.</help>
     <grammar type="application/x-jsgf"> vanilla {van} | chocolate {choc} | strawberry {straw} </grammar>
     <dtmf type="application/x-jsgf"> 1 {van} | 2 {choc} | 3 {straw} </dtmf>
</field>

<field name="lo_fat_meal" type="boolean">
     <prompt> Do you want a low fat meal on this flight? </prompt>
     <help> Low fat means less than 10 grams of fat, and under 250 calories. </help>
     <filled>
          <prompt> I heard
               <emp>
                    <value expr="lo_fat_meal"/>
               </emp>.
          </prompt>
     </filled>
</field>

<field name="ticket_num" type="digits">
     <prompt> Read the 12 digit number from your ticket. </prompt>
     <help>The 12 digit number is to the lower left.</help>
     <filled>
          <if mcond="ticket_num.length != 12">
               <prompt> Sorry, I didn't hear exactly 12 digits. </prompt>
               <assign name="ticket_num" expr="undefined"/>
          </if>
     </filled>
</field>

<form id="tapered">
     <block>
          <prompt bargein="false"> Welcome to the ice cream survey. </prompt>
     </block>
     <field name="flavor">
          <grammar>vanilla|chocolate|strawberry</grammar>
          <prompt count="1">What is your favorite flavor?</prompt>
          <prompt count="3">Say chocolate, vanilla, or strawberry.</prompt>
          <help>Sorry, no help is available.</help>
     </field>
</form>

<form id="launch_missiles">
     <field name="password">
          <prompt>What is the code word?</prompt>
          <grammar>rutabaga</grammar>
          <help>It is the name of an obscure vegetable.</help>
          <catch event="nomatch noinput" count="3">
               <prompt>Security violation!</prompt>
               <submit next="apprehend_felon" namelist="user_id"/>
          </catch>
     </field>
     <block>
          <goto next="#get_city"/>
     </block>
</form>

<vxml version="1.0">
     <form id="getcredit">
          <var name="status" expr="'no_result'"/>
          <var name="username"/>
          <field name="creditcardnum">
               <prompt> What is your credit card number? </prompt>
               <help> I am trying to collect your credit card information.
                    <reprompt/>
               </help>
               <nomatch>
                    <return namelist="status"/>
               </nomatch>
               <grammar/>
          </field>
          <field name="expirydate" type="date">
               <prompt> What is the expiry date of this card? </prompt>
               <help> I am trying to collect the expiry date of the credit card number you provided.
                    <reprompt/>
               </help>
               <nomatch>
                    <return namelist="status"/>
               </nomatch>
          </field>
          <block>
               <assign name="status" expr="'result'"/>
               <return namelist="status creditcardnum expirydate"/>
          </block>
     </form>
</vxml>

<form id="weather_info">
     <grammar src="cityandstate.gram" type="application/x-jsgf"/>
     <block>
          <prompt bargein="false"> Welcome to the weather information service.
               <audio src="http://www.online-ads.example/wis.wav"/>
          </prompt>
     </block>
     <initial name="start">
          <prompt> For what city and state would you like the weather? </prompt>
          <help> Please say the name of the city and state for which you you would like a weather report.</help>
          <noinput count="1">
               <reprompt/>
          </noinput>
          <noinput count="2">
               <reprompt/>
               <assign name="start" expr="true"/>
          </noinput>
     </initial>
     <field name="state">
          <prompt>What state?</prompt>
          <help>Please speak the state for which you want the weather.</help>
     </field>
     <field name="city">
          <prompt>Please say the city in
               <value expr="state"/> for which you want the weather.
          </prompt>
          <help>Please speak the city for which you want the weather.</help>
          <filled>
               <if cond="city == 'Los Angeles' && state == undefined">
                    <assign name="state" expr="'California'"/>
               </if>
          </filled>
     </field>
     <field name="go_ahead" type="boolean" modal="true">
          <prompt>Do you want to hear the weather for
               <value expr="city"/>,
               <value expr="state"/>?
          </prompt>
          <filled>
               <if cond="go_ahead">
                    <prompt bargein="false">
                         <audio src="http://www.online-ads.example/wis2.wav"/>
                    </prompt>
                    <submit next="/servlet/weather" namelist="city state"/>
               </if>
               <clear namelist="start city state go_ahead"/>
          </filled>
     </field>
</form>