[asterisk-commits] mmichelson: branch mmichelson/features_config_docs r391038 - /team/mmichelson...
SVN commits to the Asterisk project
asterisk-commits at lists.digium.com
Sun Jun 9 14:19:50 CDT 2013
Author: mmichelson
Date: Sun Jun 9 14:19:47 2013
New Revision: 391038
URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=391038
Log:
Add applicationmap documentation.
There are a couple of oddball things to deal with here.
1. Configuration documentation doesn't seem to have a good way
of indicating that the option name can be whatever is desired. For
now I'm using "name" as the configuration option and clarifying in
the description how applicationmap items are configured.
2. The syntax provided in the XML does not get printed to the console
when performing a "config show help features applicationmap name".
Modified:
team/mmichelson/features_config_docs/main/features_config.c
Modified: team/mmichelson/features_config_docs/main/features_config.c
URL: http://svnview.digium.com/svn/asterisk/team/mmichelson/features_config_docs/main/features_config.c?view=diff&rev=391038&r1=391037&r2=391038
==============================================================================
--- team/mmichelson/features_config_docs/main/features_config.c (original)
+++ team/mmichelson/features_config_docs/main/features_config.c Sun Jun 9 14:19:47 2013
@@ -130,12 +130,12 @@
to be monitored by the <literal>Monitor</literal> application. The
format for the recording is determined by the <replaceable>TOUCH_MONITOR_FORMAT</replaceable>
channel variable. If this variable is not specified, then <literal>wav</literal> is the
- default. The filename is constructed in the following manner:
+ default. The filename is constructed in the following manner:</para>
- prefix-timestamp-filename
-
- where prefix is either the value of the <replaceable>TOUCH_MONITOR_PREFIX</replaceable>
- channel variable or <literal>"auto"</literal> if the variable is not set. The timestamp
+ <para> prefix-timestamp-filename</para>
+
+ <para>where prefix is either the value of the <replaceable>TOUCH_MONITOR_PREFIX</replaceable>
+ channel variable or <literal>auto</literal> if the variable is not set. The timestamp
is a UNIX timestamp. The filename is either the value of the <replaceable>TOUCH_MONITOR</replaceable>
channel variable or the callerID of the channels if the variable is not set.</para>
</description>
@@ -163,11 +163,59 @@
</configOption>
</configObject>
<configObject name="applicationmap">
- <synopsis>
- </synopsis>
- <configOption name="applicationmap_item" regex="true">
- <synopsis>
- </synopsis>
+ <synopsis>Section for defining custom feature invocations during a call</synopsis>
+ <description>
+ <para>The applicationmap is an area where new custom features can be created. Items
+ defined in the applicationmap are not automatically accessible to bridged parties. Access
+ to the individual items is controled using the <replaceable>DYNAMIC_FEATURES</replaceable> channel variable.
+ The <replaceable>DYNAMIC_FEATURES</replaceable> is a <literal>#</literal> separated list of
+ either applicationmap item names or featuregroups.</para>
+ </description>
+ <configOption name="name" regex="true">
+ <synopsis>A custom feature to invoke during a bridged call</synopsis>
+ <description>
+ <para>Each item listed here is a comma-separated list of parameters that determine
+ how a feature may be invoked during a call</para>
+ <para> Example:</para>
+ <para> eggs = *5,self,Playback(hello-world),default</para>
+ <para>This would create a feature called <literal>eggs</literal> that could be invoked
+ during a call by pressing the <literal>*5</literal>. The party that presses the DTMF
+ sequence would then trigger the <literal>Playback</literal> application to play the
+ <literal>hello-world</literal> file. The application invocation would happen on the
+ party that pressed the DTMF sequence since <literal>self</literal> is specified. The
+ other parties in the bridge would hear the <literal>default</literal> music on hold
+ class during the playback.</para>
+ <para>In addition to the syntax outlined in this documentation, a backwards-compatible alternative
+ is also allowed. The following applicationmap lines are functionally identical:</para>
+ <para> eggs = *5,self,Playback(hello-world),default</para>
+ <para> eggs = *5,self,Playback,hello-world,default</para>
+ <para> eggs = *5,self,Playback,"hello-world",default</para>
+ <para> eggs = *5,caller,Playback(hello-world),default</para>
+ <para>The following lines are also functionally identical:</para>
+ <para> eggs = *5,peer,Playback(hello-world),default</para>
+ <para> eggs = *5,callee,Playback(hello-world),default</para>
+ </description>
+ <syntax argsep=",">
+ <parameter name="dtmf" required="true">
+ <para>The DTMF sequence used to trigger the option</para>
+ </parameter>
+ <parameter name="activate_on" required="true">
+ <para>The party that the feature will be invoked on</para>
+ <optionlist>
+ <option name="self"><para>Feature is invoked on party that presses the DTMF sequence</para></option>
+ <option name="peer"><para>Feature is invoked on other parties in the bridge</para></option>
+ </optionlist>
+ </parameter>
+ <parameter name="app" required="true">
+ <para>The dialplan application to run when the DTMF sequence is pressed</para>
+ <argument name="app_args" required="false">
+ <para>The arguments to the dialplan application to run</para>
+ </argument>
+ </parameter>
+ <parameter name="moh_class" required="false">
+ <para>Music on hold class to play to bridge participants that are not the target of the application invocation</para>
+ </parameter>
+ </syntax>
</configOption>
</configObject>
<configObject name="featuregroup">
More information about the asterisk-commits
mailing list