| Summary: | ASTERISK-13548: M() Docs | ||
| Reporter: | ewieling (ewieling) | Labels: | |
| Date Opened: | 2009-02-09 17:11:21.000-0600 | Date Closed: | 2009-05-18 10:19:29 |
| Priority: | Trivial | Regression? | No |
| Status: | Closed/Complete | Components: | Applications/app_dial |
| Versions: | Frequency of Occurrence | ||
| Related Issues: | |||
| Environment: | Attachments: | ( 0) __20090212-Macro-doc-update.txt ( 1) 14444.patch | |
| Description: | (5:08:00 PM) ManxPower: Documentation suggestion: In the docs for Dial, them M() option, it would be helpful to mention that if the callee presses ANY DTMF, the caller will be connected and nothing in the macro will process the DTMF (like trying to get an extension) (5:08:14 PM) ManxPower: It would help people avoid wasted hours like the one I just had. | ||
| Comments: | By: Mark Michelson (mmichelson) 2009-02-12 19:46:30.000-0600 The description here is a bit off. The actual problem is that using the application WaitExten inside a macro will not work properly. It is not restricted to just using the 'M' option from Dial, although the reasons for the failure are different in the two cases. In the case of calling a macro from the dialplan, the WaitExten will eventually time out. If using the M option for Dial, then the problem is exactly as ewieling has pointed out. Furthermore, DTMF presses can be captured properly using the Read application from within a macro (including when the 'M' option to Dial is used). It seems like the proper documentation change is to add documentation to WaitExten and to Macro to alert users that those apps do not mesh well. A "see also" note can also be added for the 'M' option in Dial and the 'macro' parameter of Queue so that users may be directed to this information. By: Mark Michelson (mmichelson) 2009-02-16 16:22:15.000-0600 I've uploaded the changes I recommended last week. ewieling, would such documentation changes be sufficient? The actual patch I uploaded is actually for 1.4 and not 1.6.0. The reason for this is that this lack of documentation applies just as much to 1.4 as it does to 1.6.0. I have to start the merge process with 1.4, so it makes sense for me to write the patch against it. By: Leif Madsen (lmadsen) 2009-02-26 13:40:22.000-0600 This looks fine to me. The only thing I can think of is that you're using a macro here for a section of the documentation. Will it be hard to modify it so we can use the XML tagging? By: Digium Subversion (svnbot) 2009-05-16 15:01:23 Repository: asterisk Revision: 194982 U trunk/Makefile U trunk/doc/appdocsxml.dtd U trunk/main/xml.c ------------------------------------------------------------------------ r194982 | eliel | 2009-05-16 15:01:22 -0500 (Sat, 16 May 2009) | 20 lines Allow to include sections of other parts of the xml documentation. Avoid duplicating xml documentation by allowing to include other parts of the xml documentation using XInclude. Example: <xi:include xpointer="xpointer(/docs/function[@name='CHANNEL']/synopsis)" /> (Insert this line to include the synopsis of the CHANNEL function xml documentation). It is also possible to include documentation from other files in the 'documentation/' directory using the href="" attribute inside a xinclude element. (closes issue ASTERISK-14128) Reported by: lmadsen (issue ASTERISK-13548) Reported by: ewieling ------------------------------------------------------------------------ http://svn.digium.com/view/asterisk?view=rev&revision=194982 By: Digium Subversion (svnbot) 2009-05-18 08:46:11 Repository: asterisk Revision: 195093 _U branches/1.6.2/ U branches/1.6.2/Makefile U branches/1.6.2/doc/appdocsxml.dtd U branches/1.6.2/main/xml.c ------------------------------------------------------------------------ r195093 | eliel | 2009-05-18 08:46:10 -0500 (Mon, 18 May 2009) | 26 lines Merged revisions 194982 via svnmerge from https://origsvn.digium.com/svn/asterisk/trunk ........ r194982 | eliel | 2009-05-16 16:01:22 -0400 (Sat, 16 May 2009) | 20 lines Allow to include sections of other parts of the xml documentation. Avoid duplicating xml documentation by allowing to include other parts of the xml documentation using XInclude. Example: <xi:include xpointer="xpointer(/docs/function[@name='CHANNEL']/synopsis)" /> (Insert this line to include the synopsis of the CHANNEL function xml documentation). It is also possible to include documentation from other files in the 'documentation/' directory using the href="" attribute inside a xinclude element. (closes issue ASTERISK-14128) Reported by: lmadsen (issue ASTERISK-13548) Reported by: ewieling ........ ------------------------------------------------------------------------ http://svn.digium.com/view/asterisk?view=rev&revision=195093 By: Digium Subversion (svnbot) 2009-05-18 09:45:24 Repository: asterisk Revision: 195162 U trunk/apps/app_dial.c U trunk/apps/app_macro.c U trunk/main/pbx.c ------------------------------------------------------------------------ r195162 | eliel | 2009-05-18 09:45:24 -0500 (Mon, 18 May 2009) | 9 lines Warn about the use of the application WaitExten() within a Macro(). Update applications documentation to warn the user about the use of the WaitExten() application within a Macro(). Recommend the use of Read() instead. (closes issue ASTERISK-13548) Reported by: ewieling ------------------------------------------------------------------------ http://svn.digium.com/view/asterisk?view=rev&revision=195162 By: Digium Subversion (svnbot) 2009-05-18 09:54:39 Repository: asterisk Revision: 195164 _U branches/1.6.2/ U branches/1.6.2/apps/app_dial.c U branches/1.6.2/apps/app_macro.c U branches/1.6.2/main/pbx.c ------------------------------------------------------------------------ r195164 | eliel | 2009-05-18 09:54:38 -0500 (Mon, 18 May 2009) | 16 lines Merged revisions 195162 via svnmerge from https://origsvn.digium.com/svn/asterisk/trunk ........ r195162 | eliel | 2009-05-18 10:45:23 -0400 (Mon, 18 May 2009) | 9 lines Warn about the use of the application WaitExten() within a Macro(). Update applications documentation to warn the user about the use of the WaitExten() application within a Macro(). Recommend the use of Read() instead. (closes issue ASTERISK-13548) Reported by: ewieling ........ ------------------------------------------------------------------------ http://svn.digium.com/view/asterisk?view=rev&revision=195164 By: Digium Subversion (svnbot) 2009-05-18 10:13:35 Repository: asterisk Revision: 195167 _U branches/1.6.1/ U branches/1.6.1/apps/app_dial.c U branches/1.6.1/apps/app_macro.c U branches/1.6.1/main/pbx.c ------------------------------------------------------------------------ r195167 | eliel | 2009-05-18 10:13:35 -0500 (Mon, 18 May 2009) | 16 lines Merged revisions 195162 via svnmerge from https://origsvn.digium.com/svn/asterisk/trunk ........ r195162 | eliel | 2009-05-18 10:45:23 -0400 (Mon, 18 May 2009) | 9 lines Warn about the use of the application WaitExten() within a Macro(). Update applications documentation to warn the user about the use of the WaitExten() application within a Macro(). Recommend the use of Read() instead. (closes issue ASTERISK-13548) Reported by: ewieling ........ ------------------------------------------------------------------------ http://svn.digium.com/view/asterisk?view=rev&revision=195167 By: Digium Subversion (svnbot) 2009-05-18 10:19:28 Repository: asterisk Revision: 195177 _U branches/1.6.0/ U branches/1.6.0/apps/app_dial.c U branches/1.6.0/apps/app_macro.c U branches/1.6.0/main/pbx.c ------------------------------------------------------------------------ r195177 | eliel | 2009-05-18 10:19:28 -0500 (Mon, 18 May 2009) | 16 lines Merged revisions 195162 via svnmerge from https://origsvn.digium.com/svn/asterisk/trunk ........ r195162 | eliel | 2009-05-18 10:45:23 -0400 (Mon, 18 May 2009) | 9 lines Warn about the use of the application WaitExten() within a Macro(). Update applications documentation to warn the user about the use of the WaitExten() application within a Macro(). Recommend the use of Read() instead. (closes issue ASTERISK-13548) Reported by: ewieling ........ ------------------------------------------------------------------------ http://svn.digium.com/view/asterisk?view=rev&revision=195177 | ||