Author: derek Date: Wed Jun 13 20:06:45 2007 New Revision: 324 Modified: sofaswitch/trunk/callflow/docs/chap2.sgml sofaswitch/trunk/callflow/docs/chap3.sgml Log: More tidyups. Modified: sofaswitch/trunk/callflow/docs/chap2.sgml ============================================================================== --- sofaswitch/trunk/callflow/docs/chap2.sgml (original) +++ sofaswitch/trunk/callflow/docs/chap2.sgml Wed Jun 13 20:06:45 2007 @@ -16,8 +16,9 @@ designed to handle that particular incoming call. </para> -<sect1> +<sect1 id="HelloWorkdExampleSec"> <title>Hello World example</title> +<titleabbrev id="HelloWorldExample">Hello World Example</titleabbrev> <para> Perhaps the simplest example of a graph you can create is the standard "Hello World" example, shown here, in figure <xref xrefstyle="select: labelnumber" @@ -112,8 +113,9 @@ </sect1> -<sect1> +<sect1 id="ForLoopsSec"> <title>For Loops</title> +<titleabbrev id="ForLoops">For Loops</titleabbrev> <para> The flow of execution is to follow the graph on the screen and behaves likes a for loop in the pogramming language "C". Thus, start at the beginning, @@ -146,8 +148,9 @@ </sect1> -<sect1> +<sect1 id="EventHandlingExampleSec"> <title>Event handling</title> +<titleabbrev id="EventHandlingExample">Event handling</titleabbrev> <para> We describe the handling of events in this section, with a simple example, shown in figure <xref xrefstyle="select: labelnumber" linkend="simpleeventexample"/>. @@ -224,8 +227,9 @@ </sect1> -<sect1> +<sect1 id="TrivialTransferSec"> <title>Trivial transfer of audio</title> +<titleabbrev id="TrivialTransfer">Trivial Transfer</titleabbrev> <para> Key to the operation of &sofaswitch; is the ability to move audio from one entity to another. This audio passes directly betweeen entities, and does not @@ -263,8 +267,9 @@ </sect1> -<sect1> +<sect1 id="TransferTimerExampleSec"> <title>Transfer audio, and timer example</title> +<titleabbrev id="TransferTimerExample">Transfer & timer example</titleabbrev> <para> We describe the handling of events in this section, with a simple example (figure <xref xrefstyle="select: labelnumber" linkend="amtestexample"/>). @@ -295,8 +300,9 @@ </para> </sect1> -<sect1> +<sect1 id="ProcessingIssuesSec"> <title>Processing issues</title> +<titleabbrev id="ProcessingIssues">Processing Issues</titleabbrev> <para> We have described how &callflow; uses the twisted module (<ulink URL="http://twistedmatrix.com/trac"></ulink>) in Python to handle events. Further, the outcome of this has been stated as @@ -328,7 +334,7 @@ message is only sent when execution of control items on this graph is suspended. The third item on this graph causes the id assigned to this graph to be deleted. Thus, on processing the terminate processing control item -(section <xref endterm="TermProc" linkend="TerminateProcessing"/>), +(section <xref endterm="TerminateProcessing" linkend="TerminateProcessingSec"/>), the message that was queued for sending is never sent. Perusal of the message log on the server will show the creation of a new node (this graph) and the destruction of this node. Modified: sofaswitch/trunk/callflow/docs/chap3.sgml ============================================================================== --- sofaswitch/trunk/callflow/docs/chap3.sgml (original) +++ sofaswitch/trunk/callflow/docs/chap3.sgml Wed Jun 13 20:06:45 2007 @@ -19,8 +19,9 @@ -<sect1> +<sect1 id="AcceptCallSec"> <title>Accept call (yes/no)</title> +<titleabbrev id="AcceptCall">Accept Call</titleabbrev> <para> Consider figure <xref xrefstyle="select: labelnumber" linkend="answercallicon"/> which shows the icon and graph representation of the control structure used to indicate to a remote @@ -96,8 +97,9 @@ -<sect1> +<sect1 id="ConditionalExecutionSec"> <title>Conditional execution</title> +<titleabbrev id="ConditionalExecution">Conditional Execution</titleabbrev> <para> Consider the figure <xref xrefstyle="select: labelnumber" linkend="conditionalicon"/> which shows the icon and graph representation of the control structure used to direct the flow of @@ -182,9 +184,9 @@ -<sect1 id="TerminateProcessing"> +<sect1 id="TerminateProcessingSec"> <title>Death - terminate processing of this graph</title> -<titleabbrev id="TermProc">Terminate Processing</titleabbrev> +<titleabbrev id="TerminateProcessing">Terminate Processing</titleabbrev> <para> Consider the figure <xref xrefstyle="select: labelnumber" linkend="deathicon"/> which shows the icon and graph representation of the control structure used to immediately terminate @@ -267,8 +269,9 @@ -<sect1> +<sect1 id="EndCallSec"> <title>End a call</title> +<titleabbrev id="EndCall">End Call</titleabbrev> <para> Consider the figure <xref xrefstyle="select: labelnumber" linkend="endcallicon"/> which shows the icon and graph representation of the control structure used to end a call, or @@ -354,8 +357,9 @@ -<sect1> +<sect1 id="EndForLoopSec"> <title>End for loop</title> +<titleabbrev id="EndForLoop">End For Loop</titleabbrev> <para> Consider figure <xref xrefstyle="select: labelnumber" linkend="endforloopicon"/> which shows the icon and graph representation of the control structure used to indicate the end of a @@ -438,9 +442,9 @@ -<sect1> -<title>End timer -</title> +<sect1 id="EndTimerSec"> +<title>End timer</title> +<titleabbrev id="EndTimer">End Timer</titleabbrev> <para> Consider figure <xref xrefstyle="select: labelnumber" linkend="endtimericon"/> which shows the icon and graph representation of the control structure used to terminate a running @@ -519,8 +523,9 @@ -<sect1> +<sect1 id="EventCollectionRegistrationSec"> <title>Event collection and registration</title> +<titleabbrev id="EventCollectionRegistration">Event Collection/Registration</titleabbrev> <para> Consider the figure <xref xrefstyle="select: labelnumber" linkend="eventicon"/> which shows the icon and graph representation of the control structure used to collect events, and register @@ -674,8 +679,9 @@ -<sect1> +<sect1 id="JoinItemsSec"> <title>Join items</title> +<titleabbrev id="JoinItems">Join Items</titleabbrev> <para> Consider the figure <xref xrefstyle="select: labelnumber" linkend="joinlinesicon"/> which shows the icon representation of the control structure used to @@ -769,8 +775,9 @@ -<sect1> +<sect1 id="LoadNewGraphSec"> <title>Load new graph</title> +<titleabbrev id="LoadNewGraph">Load New Graph</titleabbrev> <para> Consider the figure <xref xrefstyle="select: labelnumber" linkend="loadnewgraphicon"/> which shows the icon and graph representation of the control structure used to load a new graph file @@ -945,8 +952,9 @@ -<sect1> +<sect1 id="MakeCallSec"> <title>Make a call</title> +<titleabbrev id="MakeCall">Make Call</titleabbrev> <para> Consider the figure <xref xrefstyle="select: labelnumber" linkend="makecallicon"/> which shows the icon and graph representation of the control structure used to cause a @@ -1035,8 +1043,9 @@ -<sect1> +<sect1 id="ExecutePythonSec"> <title>Execute arbitrary Python command</title> +<titleabbrev id="ExecutePython">Execute Python</titleabbrev> <para> Consider the figure <xref xrefstyle="select: labelnumber" linkend="Pythonicon"/> which shows the icon and graph representation of the control structure used to define and execute an @@ -1179,8 +1188,9 @@ -<sect1> +<sect1 id="ReadFromFileSec"> <title>Read from file</title> +<titleabbrev id="ReadFromFile">Read From File</titleabbrev> <para> Consider the figure <xref xrefstyle="select: labelnumber" linkend="readfromfileicon"/> which shows the icon and graph representation of the control structure used to request an answering @@ -1264,8 +1274,8 @@ -<sect1> -<title id="MasterNodeSec">Master node</title> +<sect1 id="MasterNodeSec"> +<title>Master node</title> <titleabbrev id="MasterNode">Master node</titleabbrev> <para> Consider figure <xref xrefstyle="select: labelnumber" @@ -1347,8 +1357,9 @@ -<sect1> +<sect1 id="MessageSendArbitrarySec"> <title>Message - send arbitrary &sofaswitch; command</title> +<titleabbrev id="MessageSendArbitrary">Message Send</titleabbrev> <para> Consider figure <xref xrefstyle="select: labelnumber" linkend="messageicon"/> which shows the icon and graph representation of the control structure used to send an arbitrary @@ -1434,8 +1445,9 @@ -<sect1> +<sect1 id="RequestNodeSec"> <title>Request node</title> +<titleabbrev id="RequestNode">Request Node</titleabbrev> <para> Consider the figure <xref xrefstyle="select: labelnumber" linkend="requestnodeicon"/> which shows the icon and graph representation of the control structure used to request a worker node @@ -1557,8 +1569,9 @@ -<sect1> +<sect1 id="SendDtmfSec"> <title>Send DTMF</title> +<titleabbrev id="SendDtmf">Send DTMF</titleabbrev> <para> Consider figure <xref xrefstyle="select: labelnumber" linkend="senddtmficon"/> which shows the icon and graph representation of the control structure used to cause DTMF to be sent @@ -1647,8 +1660,9 @@ -<sect1> +<sect1 id="StartForLoopSec"> <title>Start for loop</title> +<titleabbrev id="StartForLoop">Start For Loop</titleabbrev> <para> Consider the figure <xref xrefstyle="select: labelnumber" linkend="StartForLoopIcon"/> which shows the icon and graph representation of the control structure used to begin a <literal>for @@ -1747,8 +1761,9 @@ </sect1> -<sect1> +<sect1 id="StartGraphProcessingSec"> <title>Start graph processing</title> +<titleabbrev id="StartGraphProcessing">Start Graph Processing</titleabbrev> <para> Consider the figure <xref xrefstyle="select: labelnumber" linkend="graphprocessicon"/> which shows the icon and graph representation of the control structure used to initiate processing @@ -1820,8 +1835,8 @@ -<sect1> -<title id="SuspendProcessingSec">Suspend graph processing</title> +<sect1 id="SuspendProcessingSec"> +<title>Suspend graph processing</title> <titleabbrev id="SuspendProcessing">Suspend processing</titleabbrev> <para> Consider the figure <xref xrefstyle="select: labelnumber" linkend="suspendprocessingicon"/> which shows the icon @@ -1897,8 +1912,9 @@ -<sect1> +<sect1 id="Timer Sec"> <title>Timer</title> +<titleabbrev id="Timer">Timer</titleabbrev> <para> Consider the figure <xref xrefstyle="select: labelnumber" linkend="timericon"/>, which contains the toolbar icon and graph represeentation of the control structure used to create a timer. @@ -1988,8 +2004,9 @@ -<sect1> +<sect1 id="TransferAudioSec"> <title>Transfer of audio between two &sofaswitch; entities</title> +<titleabbrev id="TransferAudio">Transfer Audio</titleabbrev> <para> Consider the figure <xref xrefstyle="select: labelnumber" linkend="transfermediaicon"/>, which shows the icon and graph representation of the control structure used to enable the flow of audio between @@ -2087,8 +2104,9 @@ -<sect1> +<sect1 id="WriteToFileSec"> <title>Write to file</title> +<titleabbrev id="WriteToFile">Write To File</titleabbrev> <para> Consider the figure <xref xrefstyle="select: labelnumber" linkend="writetofileicon"/>, which shows the icon and graph representation of the control structure used to cause the answering