[svn-commits] mmichelson: branch mmichelson/features_config_docs r391475 - /team/mmichelson...

[SVN commits to the Digium repositories]

Author: mmichelson
Date: Tue Jun 11 19:51:14 2013
New Revision: 391475

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=391475
Log:
Add documentation for the featuregroup.


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=391475&r1=391474&r2=391475
==============================================================================
--- team/mmichelson/features_config_docs/main/features_config.c (original)
+++ team/mmichelson/features_config_docs/main/features_config.c Tue Jun 11 19:51:14 2013
@@ -190,7 +190,7 @@
 					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">
+				<configOption 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
@@ -238,11 +238,29 @@
 				</configOption>
 			</configObject>
 			<configObject name="featuregroup">
-				<synopsis>
-				</synopsis>
-				<configOption name="applicationmap_item" regex="true">
-					<synopsis>
-					</synopsis>
+				<synopsis>Groupings of items from the applicationmap</synopsis>
+				<description>
+					<para>Feature groups allow for multiple applicationmap items to be
+					grouped together. Like with individual applicationmap items, feature groups
+					can be part of the <replaceable>DYNAMIC_FEATURES</replaceable> channel variable.
+					In addition to creating groupings, the feature group section allows for the
+					DTMF sequence used to invoke an applicationmap item to be overridden with
+					a different sequence.</para>
+				</description>
+				<configOption name="^.*$" regex="true">
+					<synopsis>Applicationmap item to place in the feature group</synopsis>
+					<description>
+						<para>Each item here must be a name of an item in the applicationmap. The
+						argument may either be a new DTMF sequence to use for the item or it
+						may be left blank in order to use the DTMF sequence specified in the
+						applicationmap. For example:</para>
+						<para>	eggs => *1</para>
+						<para>	bacon =></para>
+						<para>would result in the applicationmap items <literal>eggs</literal> and
+						<literal>bacon</literal> being in the featuregroup. The former would have its
+						default DTMF trigger overridden with <literal>*1</literal> and the latter would
+						have the DTMF value specified in the applicationmap.</para>
+					</description>
 				</configOption>
 			</configObject>
 		</configFile>