Summary:	ASTERISK-18689: Error in documentaion of Application_AGI
Reporter:	Robert Nilsson (rnn)	Labels:
Date Opened:	2011-10-07 02:42:55	Date Closed:	2011-12-23 09:18:18.000-0600
Priority:	Trivial	Regression?	Yes
Status:	Closed/Complete	Components:	Documentation
Versions:	1.8.6.0	Frequency of Occurrence	Constant
Related Issues:
Environment:	All	Attachments:
Description:	In file asterisk-1.8.6.0/doc/AST.pdf, page 172, in the description of Application_AGI a part of the beginning has been pasted in the middle of a sentence. The text is now (with the error marked in red) {quote} Executes an Asterisk Gateway Interface compliant program on a channel. AGI allows Asterisk to launch external programs written in any language to control a telephony channel, play audio, read DTMF digits, etc. by communicating with the AGI protocol on stdin and stdout. As of 1.6.0, this channel will not stop dialplan execution on hangup inside of this application. Dialplan execution will continue normally, even upon hangup until the AGI application signals a desire to stop (either by exiting or, in the case of a net script, by closing the connection). A locally executed AGI script will receive SIGHUP on hangup from the channel except when using DeadAGI. A fast AGI server will correspondingly receive a HANGUP inline with the command dialog. Both of theses signals may be disabled by setting the {color:red} Executes an Asterisk Gateway Interface compliant program on a channel. AGI allows Asterisk to launch external programs written in any language to control a telephony channel, play audio, read DTMF digits, etc. by communicating with the AGI protocol on{color} None - AGISIGHUP channel variable to no before executing the AGI application.{quote}
Comments:	By: Leif Madsen (lmadsen) 2011-11-03 14:02:18.926-0500 The output of the PDF comes directly from the Asterisk wiki, and the text there is imported directly from the Asterisk source code using wikibot. I'm looking at the markup in the code, and I don't see anything wrong, so there must be a problem with the way wikibot is parsing the code. This is what I see in the code: {code:xml} <description>                        <para>Executes an Asterisk Gateway Interface compliant                        program on a channel. AGI allows Asterisk to launch external programs written                        in any language to control a telephony channel, play audio, read DTMF digits,                        etc. by communicating with the AGI protocol on <emphasis>stdin</emphasis> and                        <emphasis>stdout</emphasis>. As of <literal>1.6.0</literal>, this channel will                        not stop dialplan execution on hangup inside of this application. Dialplan                        execution will continue normally, even upon hangup until the AGI application                        signals a desire to stop (either by exiting or, in the case of a net script, by                        closing the connection). A locally executed AGI script will receive SIGHUP on                        hangup from the channel except when using DeadAGI. A fast AGI server will                        correspondingly receive a HANGUP inline with the command dialog. Both of theses                        signals may be disabled by setting the <variable>AGISIGHUP</variable> channel                        variable to <literal>no</literal> before executing the AGI application.</para>                        <para>Use the CLI command <literal>agi show commands</literal> to list available agi                        commands.</para>                        <para>This application sets the following channel variable upon completion:</para>                        <variablelist>                                <variable name="AGISTATUS">                                        <para>The status of the attempt to the run the AGI script                                        text string, one of:</para>                                        <value name="SUCCESS" />                                        <value name="FAILURE" />                                        <value name="NOTFOUND" />                                        <value name="HANGUP" />                                </variable>                        </variablelist>                </description> {code} By: Kinsey Moore (kmoore) 2011-12-21 15:57:41.066-0600 Looking for more examples of this bug, it seems that it only occurs if the para in question is a child of a description element.  This occurs in both application and manager action descriptions. By: Kinsey Moore (kmoore) 2011-12-23 09:18:18.465-0600 This should be fixed with the next push of documentation.  The fix to the doc conversion tool is committed.