[svn-commits] mmichelson: branch mmichelson/features_config_docs r391029 - in /team/mmichel...

[SVN commits to the Digium repositories]

Author: mmichelson
Date: Sat Jun  8 18:11:06 2013
New Revision: 391029

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=391029
Log:
Add documentation for featuremap configuration.


Modified:
    team/mmichelson/features_config_docs/doc/appdocsxml.dtd
    team/mmichelson/features_config_docs/main/features_config.c

Modified: team/mmichelson/features_config_docs/doc/appdocsxml.dtd
URL: http://svnview.digium.com/svn/asterisk/team/mmichelson/features_config_docs/doc/appdocsxml.dtd?view=diff&rev=391029&r1=391028&r2=391029
==============================================================================
--- team/mmichelson/features_config_docs/doc/appdocsxml.dtd (original)
+++ team/mmichelson/features_config_docs/doc/appdocsxml.dtd Sat Jun  8 18:11:06 2013
@@ -71,7 +71,7 @@
   <!ELEMENT see-also (ref|xi:include)*>
 
   <!ELEMENT ref (#PCDATA)>
-  <!ATTLIST ref type (application|function|astcli|link|manpage|filename|agi|manager|managerEvent) #REQUIRED>
+  <!ATTLIST ref type (application|function|astcli|link|manpage|filename|agi|manager|managerEvent|configOption) #REQUIRED>
   <!ATTLIST ref module CDATA #IMPLIED>
 
   <!ELEMENT synopsis (#PCDATA)>

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=391029&r1=391028&r2=391029
==============================================================================
--- team/mmichelson/features_config_docs/main/features_config.c (original)
+++ team/mmichelson/features_config_docs/main/features_config.c Sat Jun  8 18:11:06 2013
@@ -95,31 +95,71 @@
 				</configOption>
 			</configObject>
 			<configObject name="featuremap">
-				<synopsis>
-				</synopsis>
+				<synopsis>DTMF options that can be triggered during bridged calls</synopsis>
 				<configOption name="atxfer">
-					<synopsis>
-					</synopsis>
+					<synopsis>DTMF sequence to initiate an attended transfer</synopsis>
+					<description>
+						<para>The transferee parties will be placed on hold and the
+						transferrer may dial an extension to reach a transfer target. During an
+						attended transfer, the transferrer may consult with the transfer target
+						before completing the transfer. Once the transferrer has hung up or pressed
+						the <replaceable>atxfercomplete</replaceable> DTMF sequence, then the transferees
+						and transfer target will be bridged.</para>
+					</description>
 				</configOption>
 				<configOption name="blindxfer">
-					<synopsis>
-					</synopsis>
+					<synopsis>DTMF sequence to initiate a blind transfer</synopsis>
+					<description>
+						<para>The transferee parties will be placed on hold and the
+						transferrer may dial an extension to reach a transfer target. During a
+						blind transfer, as soon as the transfer target is dialed, the transferrer
+						is hung up.</para>
+					</description>
 				</configOption>
 				<configOption name="disconnect">
-					<synopsis>
-					</synopsis>
+					<synopsis>DTMF sequence to disconnect the current call</synopsis>
+					<description>
+						<para>Entering this DTMF sequence will cause the bridge to end, no
+						matter the number of parties present</para>
+					</description>
 				</configOption>
 				<configOption name="automon">
-					<synopsis>
-					</synopsis>
+					<synopsis>DTMF sequence to start or stop monitoring of a call</synopsis>
+					<description>
+						<para>This will cause the channel that pressed the DTMF sequence
+						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:
+							
+							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
+						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>
 				</configOption>
 				<configOption name="parkcall">
-					<synopsis>
-					</synopsis>
+					<synopsis>DTMF sequence to park a call</synopsis>
+					<description>
+						<para>The parking lot used to park the call is determined by using either the
+						<replaceable>PARKINGLOT</replaceable> channel variable or a configured value on
+						the channel (provided by the channel driver) if the variable is not present. If
+						no configured value on the channel is present, then <literal>"default"</literal>
+						is used. The call is parked in the next available space in the parking lot.</para>
+					</description>
 				</configOption>
 				<configOption name="automixmon">
-					<synopsis>
-					</synopsis>
+					<synopsis>DTMF sequence to start or stop mixmonitoring of a call </synopsis>
+					<description>
+						<para>Operation of the automixmon is similar to the <literal> automon </literal>
+						feature, with the following exceptions:
+							<replaceable>TOUCH_MIXMONITOR</replaceable> is used in place of <replaceable>TOUCH_MONITOR</replaceable>
+							<replaceable>TOUCH_MIXMONITOR_FORMAT</replaceable> is used in place of <replaceable>TOUCH_MIXMONITOR</replaceable>
+							There is no equivalent for <replaceable>TOUCH_MONITOR_PREFIX</replaceable>. <literal>"auto"</literal> is always how the filename begins.</para>
+					</description>
+					<see-also><ref type="configOption">automon</ref></see-also>
 				</configOption>
 			</configObject>
 			<configObject name="applicationmap">