| Summary: | ASTERISK-21900: help text syntax example for Read application delivered onto wiki incorrectly | ||
| Reporter: | Oliver Nauliv (nauliv) | Labels: | |
| Date Opened: | 2013-06-12 01:21:46 | Date Closed: | 2014-07-17 12:34:31 |
| Priority: | Trivial | Regression? | |
| Status: | Closed/Complete | Components: | Documentation |
| Versions: | 11.0.0 | Frequency of Occurrence | Constant |
| Related Issues: | |||
| Environment: | Attachments: | ||
| Description: | https://wiki.asterisk.org/wiki/display/AST/Asterisk+11+Application_Read
The syntax reads: Read(variablefilename&filename2[&...],maxdigits,options,attempts,timeout) And should read: Read(variable,filename&filename2[&...],maxdigits,options,attempts,timeout) [bug posted as requested by David M. Lee] | ||
| Comments: | By: David Woolley (davidw) 2013-06-12 05:10:49.506-0500 If it really is a Wiki, I believe the answer is to edit it yourself. I do note it is missing the discussion overlay I would expect from a wiki, and which could be used by someone not confident enough to edit the main page. By: Malcolm Davenport (mdavenport) 2013-06-12 07:33:55.953-0500 It is in fact a Wiki, however some portions of it - notably the "Asterisk (version) Command Reference" are in fact derived from the Asterisk source itself. That way, the main content of those sections is always in line with the actual code. We have a wiki bot that trolls the code and updates those sections of the wiki whenever needed. The comments that exist on the pages that are otherwise automatically updated are preserved and not destroyed. So...we do need an issue opened here because it's an inconsistency in the source code that's causing the trouble in the wiki. By: Oliver Nauliv (nauliv) 2013-06-12 20:53:14.359-0500 folks - if you point me to where it needs to be changed, i will be happy to carefully make the change. i find those type of typos on a regular basis and can assist in fixing. By: David Woolley (davidw) 2013-06-13 05:30:34.867-0500 I think Malcolm is referring to this code in apps/app_read.c: {code} /*** DOCUMENTATION <application name="Read" language="en_US"> <synopsis> Read a variable. </synopsis> <syntax> <parameter name="variable" required="true"> <para>The input digits will be stored in the given <replaceable>variable</replaceable> name.</para> </parameter> <parameter name="filenames" argsep="&"> <argument name="filename" required="true"> <para>file(s) to play before reading digits or tone with option i</para> </argument> <argument name="filename2" multiple="true" /> </parameter> {code} However, I think the real bug may be in the tooling that does the "trolling", as it seems to have put in the comma without an explicit argsep, in other cases. By: Rusty Newton (rnewton) 2013-06-14 17:13:04.614-0500 For quick reference, here is the "core show application read" excerpt for syntax {noformat} [Syntax] Read(variable[,filename[&filename2[&...]][,maxdigits[,options[,attempts[,timeout]]]]]) {noformat} By: Matt Jordan (mjordan) 2014-07-17 12:34:26.406-0500 This should be fixed now - see https://wiki.asterisk.org/wiki/display/AST/Asterisk+12+Application_Read | ||