- Sofaswitch-svn - FreeSWITCH Mailing Lists

[commit] r343 - in sofaswitch/trunk: controller get_started
by SofaSWITCH SVN 04 Jul '07

04 Jul '07

Author: derek Date: Tue Jul 3 21:28:06 2007 New Revision: 343 Modified: sofaswitch/trunk/controller/testonesound.py sofaswitch/trunk/controller/testsound.py sofaswitch/trunk/get_started/answeringmachine.sgml Log: updates Modified: sofaswitch/trunk/controller/testonesound.py ============================================================================== --- sofaswitch/trunk/controller/testonesound.py (original) +++ sofaswitch/trunk/controller/testonesound.py Tue Jul 3 21:28:06 2007 @@ -41,7 +41,5 @@ timedelta = time.time() - expstart; -controller.send_message_to('quitnow', 'sound') - controller.terminate_now() Modified: sofaswitch/trunk/controller/testsound.py ============================================================================== --- sofaswitch/trunk/controller/testsound.py (original) +++ sofaswitch/trunk/controller/testsound.py Tue Jul 3 21:28:06 2007 @@ -20,7 +20,7 @@ #thread.start_new_thread(controller.read_incoming,()) -calls = range(1,100) +calls = range(1,3) for i in calls: print 'Iteration ', i Modified: sofaswitch/trunk/get_started/answeringmachine.sgml ============================================================================== --- sofaswitch/trunk/get_started/answeringmachine.sgml (original) +++ sofaswitch/trunk/get_started/answeringmachine.sgml Tue Jul 3 21:28:06 2007 @@ -31,7 +31,7 @@ <para> For the test script to work, we expect that am is launched from a directory -containing a 16bit, 8khz sound file, called "sample_message.wav" +containing a 16bit, 8khz sound file, called <literal>../prompts/sample_message.wav"</literal> </para> <para> @@ -48,16 +48,61 @@ <para> The server reports the following messages. <screen> -controller : am:REQUESTNEWID - am : controller:REQUESTNEWID am1 -controller : am1:transferudp sound - am1 : controller:OutgoingCall am1 - am1 : sound:transferudp sound 10.0.0.5:64000 - sound : am1:transferudp sound 10.0.0.5:61000 done -controller : am1:setannouncementfile sample_message.wav -controller : am1:setreceivedmsgfile derek.wav -controller : am1:hangup - am1 : controller:Terminating + 4/ 7/2007 12:25:27. 10630 Recv New node of am + 4/ 7/2007 12:25:27. 11245 Recv New node of am1 + 4/ 7/2007 12:25:27. 12104 Recv New node of am2 + 4/ 7/2007 12:25:27. 12905 Recv New node of am3 + 4/ 7/2007 12:25:27. 13702 Recv New node of am4 + 4/ 7/2007 12:25:27. 14512 Recv New node of am5 + 4/ 7/2007 12:25:27. 15403 Recv New node of am6 + 4/ 7/2007 12:25:27. 16324 Recv New node of am7 + 4/ 7/2007 12:25:27. 17175 Recv New node of am8 + 4/ 7/2007 12:25:27. 18024 Recv New node of am9 + 4/ 7/2007 12:25:27. 18882 Recv New node of am10 + 4/ 7/2007 12:25:32.628728 Recv New node of controller + 4/ 7/2007 12:25:33.131056 Recv from controller am:REQUESTNEWID + 4/ 7/2007 12:25:33.131179 Send to am controller:REQUESTNEWID + 4/ 7/2007 12:25:33.131714 Recv from am controller:REQUESTNEWID am1 + 4/ 7/2007 12:25:33.131954 Send to controller am:REQUESTNEWID am1 + 4/ 7/2007 12:25:33.132316 Recv from am1 AdviseOnTermination controller + 4/ 7/2007 12:25:33.132846 Recv New node of am11 + 4/ 7/2007 12:25:33.182851 Recv from controller am1:transferudp sound + 4/ 7/2007 12:25:33.182973 Send to am1 controller:transferudp sound + 4/ 7/2007 12:25:33.183001 Recv from controller am1:setannouncementfile ../prompts/sample_message.wav + 4/ 7/2007 12:25:33.183043 Send to am1 controller:setannouncementfile ../prompts/sample_message.wav + 4/ 7/2007 12:25:33.184101 Recv from am1 sound:transferudp sound 192.168.1.109:62000 + 4/ 7/2007 12:25:33.184372 Send to sound am1:transferudp sound 192.168.1.109:62000 + 4/ 7/2007 12:25:33.185435 Recv from sound am1:transferudp sound 192.168.1.108:63000 done + 4/ 7/2007 12:25:33.185512 Send to am1 sound:transferudp sound 192.168.1.108:63000 done + 4/ 7/2007 12:25:33.222891 Recv from controller am1:setreceivedmsgfile derek.wav + 4/ 7/2007 12:25:33.223003 Send to am1 controller:setreceivedmsgfile derek.wav + 4/ 7/2007 12:25:36.758717 Recv from am1 controller:FinishedFile + 4/ 7/2007 12:25:36.758832 Send to controller am1:FinishedFile + 4/ 7/2007 12:25:36.782828 Recv from controller am1:hangup + 4/ 7/2007 12:25:36.782940 Send to am1 controller:hangup + 4/ 7/2007 12:25:37.478655 Send to controller am1:Terminating + 4/ 7/2007 12:25:37.782748 Recv from controller am:REQUESTNEWID + 4/ 7/2007 12:25:37.782974 Send to am controller:REQUESTNEWID + 4/ 7/2007 12:25:37.783350 Recv from am2 AdviseOnTermination controller + 4/ 7/2007 12:25:37.783448 Recv from am controller:REQUESTNEWID am2 + 4/ 7/2007 12:25:37.783587 Send to controller am:REQUESTNEWID am2 + 4/ 7/2007 12:25:37.784109 Recv New node of am12 + 4/ 7/2007 12:25:37.834613 Recv from controller am2:transferudp sound + 4/ 7/2007 12:25:37.834921 Send to am2 controller:transferudp sound + 4/ 7/2007 12:25:37.835046 Recv from controller am2:setannouncementfile ../prompts/sample_message.wav + 4/ 7/2007 12:25:37.835196 Send to am2 controller:setannouncementfile ../prompts/sample_message.wav + 4/ 7/2007 12:25:37.835788 Recv from am2 sound:transferudp sound 192.168.1.109:62001 + 4/ 7/2007 12:25:37.835898 Send to sound am2:transferudp sound 192.168.1.109:62001 + 4/ 7/2007 12:25:37.836975 Recv from sound am2:transferudp sound 192.168.1.108:63000 done + 4/ 7/2007 12:25:37.837022 Send to am2 sound:transferudp sound 192.168.1.108:63000 done + 4/ 7/2007 12:25:37.874580 Recv from controller am2:setreceivedmsgfile derek.wav + 4/ 7/2007 12:25:37.874889 Send to am2 controller:setreceivedmsgfile derek.wav + 4/ 7/2007 12:25:41.406340 Recv from am2 controller:FinishedFile + 4/ 7/2007 12:25:41.406441 Send to controller am2:FinishedFile + 4/ 7/2007 12:25:41.435340 Recv from controller am2:hangup + 4/ 7/2007 12:25:41.435452 Send to am2 controller:hangup + 4/ 7/2007 12:25:42.434595 Recv from controller am1:hangup + 4/ 7/2007 12:25:42.434659 Recv from controller am2:hangup </screen> The messages are in four groups. <itemizedlist> @@ -73,7 +118,15 @@ <listitem><para>Advisement notices (call setup, call terminating)</para></listitem> </itemizedlist> +You will note that the same file is played twice to the sound entity. This is +correct, and illustrates that the connection of audio between &sofaswitch +entities can be changed at any time. Further, the last two lines in the log +above report two message received from the controller which were never sent on +to the intended destination. This is because <literal>am1</literal> and +<literal>am2</literal> were dead and gone by this stage. The messages were +there therefore dropped. No error message is reported back to the controller. </para> + <para> As before, this simple test can be extended by running the <literal>client.py</literal> python script file described above. You can enquire of the answering machine for status information (command <literal>am:status full</literal>) and you @@ -94,7 +147,7 @@ </para> <para> -There are 11 Comms instances currently availble. One is used in an active call (am51), and the +There are 11 Comms instances currently availble. One is used in an active call (<literal>am51</literal>), and the remaining 10 have connected to the message server. These remaining 10 are therefore ready for immediate use, should they be requested by the controller. </para>

1 0

[commit] r342 - sofaswitch/trunk/get_started
by SofaSWITCH SVN 04 Jul '07

04 Jul '07

Author: derek Date: Tue Jul 3 20:17:43 2007 New Revision: 342 Added: sofaswitch/trunk/get_started/answeringmachine.sgml Log: Add this file, which describes the use of the answering machine. Added: sofaswitch/trunk/get_started/answeringmachine.sgml ============================================================================== --- (empty file) +++ sofaswitch/trunk/get_started/answeringmachine.sgml Tue Jul 3 20:17:43 2007 @@ -0,0 +1,165 @@ +<chapter> +<title>Answering machine utility</title> +<titleabbrev>Audio play/record</titleabbrev> + + + +<para> +The sound card (described in previous section) can be utilised in the &sofaswitch; environment, +and it can send/receive audio with any other &sofaswitch; audio +component. The Answering Machine is perhaps the simplest other +audio component, which can play/record audio from/to a wav file. +</para> + +<para> +Build and run the answering machine utility with the commands +<itemizedlist> +<listitem><literal>cd am</literal></listitem> +<listitem><literal>make both</literal></listitem> +<listitem><literal> + ./obj_linux_x86_r/am -s machine_running_server +</literal></listitem> +</itemizedlist> +The options to the answering machine utility specify the name of the machine running the +sofa message server. you will need to adjust the options to correctly specify +the name of the machine running the message server. Thus, if the message server +and the answering machine are on the same computer, you will use the string +<literal>localhost</literal>. +You can see all the available command +options by running the answering machine utility with the command parameter <literal>-h</literal> +</para> + +<para> +For the test script to work, we expect that am is launched from a directory +containing a 16bit, 8khz sound file, called "sample_message.wav" +</para> + +<para> +In the controller directory, there is a python script that will connect the audio +streams from the answering machine and sound executables together. Run this +utility with: +<screen> +python testsound.py machine_running_server +</screen> +Again, you will need to modify this command line to correctly specify the +location of the machine running the server. +</para> + +<para> +The server reports the following messages. +<screen> +controller : am:REQUESTNEWID + am : controller:REQUESTNEWID am1 +controller : am1:transferudp sound + am1 : controller:OutgoingCall am1 + am1 : sound:transferudp sound 10.0.0.5:64000 + sound : am1:transferudp sound 10.0.0.5:61000 done +controller : am1:setannouncementfile sample_message.wav +controller : am1:setreceivedmsgfile derek.wav +controller : am1:hangup + am1 : controller:Terminating +</screen> +The messages are in four groups. +<itemizedlist> +<listitem><para> The controller requests an answering machine entity to send/receive audio from. + The answering machine supervisor sends a message back to the controller, advising + the controller of the new identity. </para></listitem> + +<listitem><para> The controller tells the new identy (<literal>am1</literal>) to connect audio streams with the <literal>sound</literal> + identity. Notice that the controller is not aware of the address used to transfer audio. + </para></listitem> +<listitem><para> The controller tells the answering machine identity to play audio from the file + <literal>sample_message.wav</literal>, and record to the file <literal>derek.wav</literal>.</para></listitem> + +<listitem><para>Advisement notices (call setup, call terminating)</para></listitem> +</itemizedlist> +</para> +<para> +As before, this simple test can be extended by running the <literal>client.py</literal> python script file described above. +You can enquire of the answering machine for status information (command <literal>am:status full</literal>) and you +will see what is available. The answerine machine will reply back +<screen> +am:status full +am:Current Status:----------- +Comms instance count 61 50 11 +Consumer instance count 50 50 0 +pre, active & dead calls 0 1 0 + + Current active nodes: + am51 +</screen> +These figures are designed to provide some diagnostic information about what is going on. +There main purpose is tell you the counts of constructed/allocated class instances, and therefore +provide some guide as to if the system is leaking memory. +</para> + +<para> +There are 11 Comms instances currently availble. One is used in an active call (am51), and the +remaining 10 have connected to the message server. These remaining 10 are therefore ready for +immediate use, should they be requested by the controller. +</para> + +<para> +The Consumer instance count is a class that is very short lived, and designed +to clean up calls after the call has terminated.. In this case, 50 have been +constructed, 50 deleted, and balance is zero. If there are several available +Consumer instances, we have evidence that the calls are not being cleaned up. +Each Consumer instance is a separate thread, created to clean up one call. A +call is cleaned up independently (well, as much as possible) from all other calls. +</para> + +<para> +From running the <literal>client.py</literal> script, while the <literal>testsound.py</literal> script is running, we +can interrogate the message server to see what is happening. We send the command <literal>status full</literal>, +which looks like: +<screen> +status full + Status of the Server +------------------------- +Constructed/Deleted TcpConnections 98 72 26 +Count ready made TcpConnections 10 +Messages Sent Received Dropped Diff 1274 972 108 194 +Current list size 15 + + current nodes + controller + sound + am + am51 + am52 + am53 + am54 + am55 + am56 + am57 + am58 + am59 + am60 + am61 + test +</screen> +</para> + +<para> +The server has reported that there are 26 available <literal>TcpConnection</literal> +class instances. One <literal>TcpConnection</literal> instance is used for each connected +node to the server. The figure of 26 above is correct. +<itemizedlist> +<listitem> 15 are used for the 15 entries in the list</listitem> +<listitem> 10 are stored away, ready for use in connecting nodes</listitem> +<listitem> 1 is on hand, ready to use immediately with the next incoming +connection.</listitem> +</itemizedlist> +</para> + +<para> +The list contains 15 nodes, which is correct. <literal>Controller</literal> is there, who +is running the <literal>testsound.py</literal> script file. Further, <literal>sound</literal> is there, who is +managing the sound card, and is an endpoint for the test. The supervisor +<literal>am</literal> for the answering machine is there. Also, <literal>test</literal> is there, +which is the identity of the node from the <literal>client.py</literal> &python; script. +<literal>am51</literal> is there, who is the current active answering machine node. +Nodes <literal>am52..am61</literal> are the nodes that the answering machine +supervisor has prebuilt, which are ready for use. +</para> +</chapter> \ No newline at end of file

1 0

[commit] r341 - sofaswitch/trunk/get_started
by SofaSWITCH SVN 04 Jul '07

04 Jul '07

Author: derek Date: Tue Jul 3 20:17:17 2007 New Revision: 341 Modified: sofaswitch/trunk/get_started/get_started.xml Log: add call to sound answering machine file. Modified: sofaswitch/trunk/get_started/get_started.xml ============================================================================== --- sofaswitch/trunk/get_started/get_started.xml (original) +++ sofaswitch/trunk/get_started/get_started.xml Tue Jul 3 20:17:17 2007 @@ -9,10 +9,11 @@ <!ENTITY sofa "<literal>sofa</literal>"> <!ENTITY sofaswitch "<emphasis>SofaSwitch</emphasis>"> -<!ENTITY build SYSTEM "build.sgml"> +<!ENTITY build SYSTEM "build.sgml"> <!ENTITY server SYSTEM "server.sgml"> -<!ENTITY sound SYSTEM "sound.sgml"> -<!ENTITY app1 SYSTEM "app1.sgml"> +<!ENTITY sound SYSTEM "sound.sgml"> +<!ENTITY am SYSTEM "answeringmachine.sgml"> +<!ENTITY app1 SYSTEM "app1.sgml"> @@ -51,6 +52,7 @@ &build; &server; &sound; +&am; &app1; </book>

1 0

[commit] r340 - sofaswitch/trunk/get_started
by SofaSWITCH SVN 03 Jul '07

03 Jul '07

Author: derek Date: Tue Jul 3 00:56:27 2007 New Revision: 340 Added: sofaswitch/trunk/get_started/sound.sgml Modified: sofaswitch/trunk/get_started/get_started.xml Log: More docs - on how to use the sound utility. Modified: sofaswitch/trunk/get_started/get_started.xml ============================================================================== --- sofaswitch/trunk/get_started/get_started.xml (original) +++ sofaswitch/trunk/get_started/get_started.xml Tue Jul 3 00:56:27 2007 @@ -11,7 +11,7 @@ <!ENTITY build SYSTEM "build.sgml"> <!ENTITY server SYSTEM "server.sgml"> -<!ENTITY chap3 SYSTEM "chap3.sgml"> +<!ENTITY sound SYSTEM "sound.sgml"> <!ENTITY app1 SYSTEM "app1.sgml"> @@ -50,6 +50,7 @@ &build; &server; +&sound; &app1; </book> Added: sofaswitch/trunk/get_started/sound.sgml ============================================================================== --- (empty file) +++ sofaswitch/trunk/get_started/sound.sgml Tue Jul 3 00:56:27 2007 @@ -0,0 +1,70 @@ +<chapter> +<title>Sound card utility</title> +<titleabbrev>sound</titleabbrev> + +<para> +This is a very simple test, which is designed to get you familiar with +the sound utility, and introduce you to a couple of the commands which +control sofa utiliities. +</para> + +<para> +The server is expected to be running before starting this test. If the +&sofaswitch; server is not running (or cannot be connected to), the sound +utility will exit immediately. +</para> + +<para> +Build and run the sound utility with the commands +<itemizedlist> +<listitem><literal>cd sound</literal></listitem> +<listitem><literal>make both</literal></listitem> +<listitem><literal> + ./obj_linux_x86_r/sound -s machine_running_server -d Ensoniq\ AduioPCI +</literal></listitem> +</itemizedlist> +The options to the sound utility specify the name of the machine running the +sofa message server, and the sound device. If this +utility is unable to open the sound device, it will list the available +(and valid) sound device names and exit. You can see all the available command +options by running the sound utility with the command parameter <literal>-h</literal> +</para> + +<para> +In the <literal>sofaswitch/controller</literal> directory, there is a python +script, <literal>testonesound.py</literal>. +Run this script file with the command +<screen> +python testonesound.py machine_running_server +</screen> +The options for the &python; program specify the name of the machine running the +sofa message server. Again, it is assumed the server is running. +</para> + +<para> +This test simply tells the sound card to echo audio from the microphone +back to the speaker, so you will hear the transmitted audio with a slight +delay. The test enquires of the sound program for status information +every 2 seconds, which is reported to the console. After 40 seconds of +operation, the sound utility is closed, and the <literal>testonesound.py</literal> +script file ends. +</para> + + +<para> +This mode of operation is a bit unusual, in that we have a sofa +utility sending audio to itself. However, we are trying to introduce +things at a gradual and slow rate, so are only describing one +utility at a time. Normally, one sofa utility will send audio to +another sofa utility. The next chapter describes the sending of audio between +&sofaswitch; entities (answering machine and sound card). +</para> + +<para> +Now, you can add to this test. With the <literal>client.py</literal> file +described previously, you can send additional commands to +the sound utility. To see what nodes are connected to the server, +send the command <literal>list</literal>. At this point, you know who you can +send commands to. +</para> +</chapter>

1 0

[commit] r339 - sofaswitch/trunk/get_started
by SofaSWITCH SVN 03 Jul '07

03 Jul '07

Author: derek Date: Tue Jul 3 00:28:10 2007 New Revision: 339 Modified: sofaswitch/trunk/get_started/app1.sgml sofaswitch/trunk/get_started/get_started.xml Log: More docs added. Modified: sofaswitch/trunk/get_started/app1.sgml ============================================================================== --- sofaswitch/trunk/get_started/app1.sgml (original) +++ sofaswitch/trunk/get_started/app1.sgml Tue Jul 3 00:28:10 2007 @@ -43,7 +43,11 @@ </screen> will generate output something like <screen> - +Writing ch01.html for chapter +Writing apa.html for appendix +Writing index.html for book +Writing get_started.hhp +Writing get_started.hhc </screen> Once the actual html is generated, the zip file must be created. This zip file contains the files generated by the <literal>xsltproc</literal> command and the Modified: sofaswitch/trunk/get_started/get_started.xml ============================================================================== --- sofaswitch/trunk/get_started/get_started.xml (original) +++ sofaswitch/trunk/get_started/get_started.xml Tue Jul 3 00:28:10 2007 @@ -3,11 +3,14 @@ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ <!ENTITY callflow "<emphasis>CallFlow</emphasis>"> +<!ENTITY opal "<literal>opal</literal>"> +<!ENTITY pwlib "<literal>pwlib</literal>"> +<!ENTITY python "<literal>Python</literal>"> +<!ENTITY sofa "<literal>sofa</literal>"> <!ENTITY sofaswitch "<emphasis>SofaSwitch</emphasis>"> - -<!ENTITY chap1 SYSTEM "chap1.sgml"> -<!ENTITY chap2 SYSTEM "chap2.sgml"> +<!ENTITY build SYSTEM "build.sgml"> +<!ENTITY server SYSTEM "server.sgml"> <!ENTITY chap3 SYSTEM "chap3.sgml"> <!ENTITY app1 SYSTEM "app1.sgml"> @@ -45,8 +48,8 @@ </bookinfo> - - +&build; +&server; &app1; </book>

1 0

[commit] r338 - in sofaswitch/trunk: . get_started overview
by SofaSWITCH SVN 03 Jul '07

03 Jul '07

Author: derek Date: Mon Jul 2 20:43:19 2007 New Revision: 338 Removed: sofaswitch/trunk/started.cxx Modified: sofaswitch/trunk/get_started/Makefile sofaswitch/trunk/get_started/app1.sgml sofaswitch/trunk/get_started/get_started.xml sofaswitch/trunk/get_started/makedoc.xsl sofaswitch/trunk/overview/app1.sgml Log: Tidy up docs, reorganise, improve, move into directories. Modified: sofaswitch/trunk/get_started/Makefile ============================================================================== --- sofaswitch/trunk/get_started/Makefile (original) +++ sofaswitch/trunk/get_started/Makefile Mon Jul 2 20:43:19 2007 @@ -1,3 +1,12 @@ doc: xsltproc makedoc.xsl get_started.xml + find . -name \*.html -or -name \*.hh\* -or -name \*.png | xargs zip get_started.zip +docs: doc + +clean: + @rm -f *.zip + @rm -f *~ + @rm -f *.html + @rm -f *.hhp + @rm -f *.hhc Modified: sofaswitch/trunk/get_started/app1.sgml ============================================================================== --- sofaswitch/trunk/get_started/app1.sgml (original) +++ sofaswitch/trunk/get_started/app1.sgml Mon Jul 2 20:43:19 2007 @@ -1,7 +1,7 @@ <appendix> <title>Building these docs</title> <para> -The documentation for &callflow; was generated from multiple +The documentation for getting started; was generated from multiple <literal>.sgml</literal> and <literal>.xml</literal> files. The utility <screen> xsltproc @@ -15,10 +15,17 @@ <para> The file <literal>makedoc.xsl</literal> contains the stylesheet commands that -are used when converting the docbook file <literal>callflow.xml</literal> into -html. It is likely that the third line in this file (which specifies the -location of the docbook stylesheet to generate html) will need to be changed -for your particular system. +are used when converting the docbook file <literal>get_started.xml</literal> into +html. It is likely that the file <literal>makedoc.xsl</literal> may need to be +altered, to remove the dependendancy on downloading a style file from the +internet. Full instructions on changing the <literal>makedoc.xsl</literal> file +are contained in this file. +</para> + +<para> +Alternatively, (under unix) you can use the Makefile to build the required +docs. Issue the command <literal>make doc</literal> to build the <literal>get_started.zip</literal> +file. </para> <para> @@ -32,45 +39,20 @@ <para> The unix command <screen> -xsltproc makedoc.xsl callflow.xml +xsltproc makedoc.xsl get_started.xml </screen> will generate output something like <screen> -Writing ch01.html for chapter -Writing ch02s02.html for sect1 -Writing ch02s03.html for sect1 -Writing ch02s04.html for sect1 -Writing ch02s05.html for sect1 -Writing ch02.html for chapter -Writing ch03s02.html for sect1 -Writing ch03s03.html for sect1 -Writing ch03s04.html for sect1 -Writing ch03s05.html for sect1 -Writing ch03s06.html for sect1 -Writing ch03s07.html for sect1 -Writing ch03s08.html for sect1 -Writing ch03s09.html for sect1 -Writing ch03s10.html for sect1 -Writing ch03s11.html for sect1 -Writing ch03s12.html for sect1 -Writing ch03s13.html for sect1 -Writing ch03s14.html for sect1 -Writing ch03s15.html for sect1 -Writing ch03s16.html for sect1 -Writing ch03.html for chapter -Writing apa.html for appendix -Writing index.html for book -Writing callflow.hhp -Writing callflow.hhc + </screen> Once the actual html is generated, the zip file must be created. This zip file contains the files generated by the <literal>xsltproc</literal> command and the image files referenced by the .sgml files. On Unix, the command is <screen> - find . -name \*.html -or -name \*.hh\* -or -name \*.png | xargs zip doc.zip + find . -name \*.html -or -name \*.hh\* -or -name \*.png | xargs zip get_started.zip </screen> -The generated <literal>doc.zip</literal> file must be in the same directory as +The generated <literal>get_started.zip</literal> file must be in the same directory as where the &callflow; executable is run from. </para> Modified: sofaswitch/trunk/get_started/get_started.xml ============================================================================== --- sofaswitch/trunk/get_started/get_started.xml (original) +++ sofaswitch/trunk/get_started/get_started.xml Mon Jul 2 20:43:19 2007 @@ -17,8 +17,8 @@ <book> <bookinfo> <date>2007 - June</date> - <title>&sofaswitch;- voice switching made easy: Design document</title> - <subtitle>Overview of &sofaswitch;</subtitle> + <title>&sofaswitch;- Getting Started</title> + <subtitle>Get started</subtitle> <authorgroup> <author> <firstname>Derek</firstname> @@ -44,9 +44,9 @@ </revhistory> </bookinfo> -&chap1; -&chap2; + + &app1; </book> Modified: sofaswitch/trunk/get_started/makedoc.xsl ============================================================================== --- sofaswitch/trunk/get_started/makedoc.xsl (original) +++ sofaswitch/trunk/get_started/makedoc.xsl Mon Jul 2 20:43:19 2007 @@ -10,10 +10,10 @@ <xsl:param name="htmlhelp.show.favorites" select="1"/> <xsl:param name="htmlhelp.show.advanced.search" select="1"/> <xsl:param name="htmlhelp.show.menu" select="1"/> - <xsl:param name="htmlhelp.hhp" select="'callflow.hhp'"/> - <xsl:param name="htmlhelp.hhc" select="'callflow.hhc'"/> - <xsl:param name="htmlhelp.hhk" select="'callflow.hhk'"/> - <xsl:param name="htmlhelp.chm" select="'callflow.chm'"/> + <xsl:param name="htmlhelp.hhp" select="'get_started.hhp'"/> + <xsl:param name="htmlhelp.hhc" select="'get_started.hhc'"/> + <xsl:param name="htmlhelp.hhk" select="'get_started.hhk'"/> + <xsl:param name="htmlhelp.chm" select="'get_started.chm'"/> <xsl:param name="use.id.as.filename" select="1"/> </xsl:stylesheet> Modified: sofaswitch/trunk/overview/app1.sgml ============================================================================== --- sofaswitch/trunk/overview/app1.sgml (original) +++ sofaswitch/trunk/overview/app1.sgml Mon Jul 2 20:43:19 2007 @@ -1,7 +1,7 @@ <appendix> <title>Building these docs</title> <para> -The documentation for &callflow; was generated from multiple +The documentation for this overview was generated from multiple <literal>.sgml</literal> and <literal>.xml</literal> files. The utility <screen> xsltproc @@ -15,10 +15,17 @@ <para> The file <literal>makedoc.xsl</literal> contains the stylesheet commands that -are used when converting the docbook file <literal>callflow.xml</literal> into -html. It is likely that the third line in this file (which specifies the -location of the docbook stylesheet to generate html) will need to be changed -for your particular system. +are used when converting the docbook file <literal>overview.xml</literal> into +html. It is likely that the file <literal>makedoc.xsl</literal> may need to be +altered, to remove the dependendancy on downloading a style file from the +internet. Full instructions on changing the <literal>makedoc.xsl</literal> file +are contained in this file. +</para> + +<para> +Alternatively, (under unix) you can use the Makefile to build the required +docs. Issue the command <literal>make doc</literal> to build the +<literal>overview.zip</literal> file. </para> <para> @@ -32,45 +39,35 @@ <para> The unix command <screen> -xsltproc makedoc.xsl callflow.xml +xsltproc makedoc.xsl overview.xml </screen> will generate output something like <screen> + +xsltproc makedoc.xsl overview.xml Writing ch01.html for chapter Writing ch02s02.html for sect1 Writing ch02s03.html for sect1 Writing ch02s04.html for sect1 Writing ch02s05.html for sect1 +Writing ch02s06.html for sect1 +Writing ch02s07.html for sect1 +Writing ch02s08.html for sect1 +Writing ch02s09.html for sect1 Writing ch02.html for chapter -Writing ch03s02.html for sect1 -Writing ch03s03.html for sect1 -Writing ch03s04.html for sect1 -Writing ch03s05.html for sect1 -Writing ch03s06.html for sect1 -Writing ch03s07.html for sect1 -Writing ch03s08.html for sect1 -Writing ch03s09.html for sect1 -Writing ch03s10.html for sect1 -Writing ch03s11.html for sect1 -Writing ch03s12.html for sect1 -Writing ch03s13.html for sect1 -Writing ch03s14.html for sect1 -Writing ch03s15.html for sect1 -Writing ch03s16.html for sect1 -Writing ch03.html for chapter Writing apa.html for appendix Writing index.html for book -Writing callflow.hhp -Writing callflow.hhc +Writing overview.hhp +Writing overview.hhc </screen> Once the actual html is generated, the zip file must be created. This zip file contains the files generated by the <literal>xsltproc</literal> command and the image files referenced by the .sgml files. On Unix, the command is <screen> - find . -name \*.html -or -name \*.hh\* -or -name \*.png | xargs zip doc.zip + find . -name \*.html -or -name \*.hh\* -or -name \*.png | xargs zip overview.zip </screen> -The generated <literal>doc.zip</literal> file must be in the same directory as +The generated <literal>overview.zip</literal> file must be in the same directory as where the &callflow; executable is run from. </para>

1 0

[commit] r337 - sofaswitch/trunk/get_started
by SofaSWITCH SVN 03 Jul '07

03 Jul '07

Author: derek Date: Mon Jul 2 20:16:52 2007 New Revision: 337 Added: sofaswitch/trunk/get_started/Makefile sofaswitch/trunk/get_started/app1.sgml sofaswitch/trunk/get_started/get_started.xml sofaswitch/trunk/get_started/makedoc.xsl Log: Add these files. Added: sofaswitch/trunk/get_started/Makefile ============================================================================== --- (empty file) +++ sofaswitch/trunk/get_started/Makefile Mon Jul 2 20:16:52 2007 @@ -0,0 +1,3 @@ +doc: + xsltproc makedoc.xsl get_started.xml + Added: sofaswitch/trunk/get_started/app1.sgml ============================================================================== --- (empty file) +++ sofaswitch/trunk/get_started/app1.sgml Mon Jul 2 20:16:52 2007 @@ -0,0 +1,77 @@ +<appendix> +<title>Building these docs</title> +<para> +The documentation for &callflow; was generated from multiple +<literal>.sgml</literal> and <literal>.xml</literal> files. The utility +<screen> +xsltproc +</screen> +was used to process the supplied files to generate <literal>html</literal> +files and several auxillary help files. The generated files were compressed +into one <literal>.zip</literal> file. When the &callflow; utility runs, the +generated zip file is read in. A <literal>wxWidgets</literal> class is used to +display the html documentation. +</para> + +<para> +The file <literal>makedoc.xsl</literal> contains the stylesheet commands that +are used when converting the docbook file <literal>callflow.xml</literal> into +html. It is likely that the third line in this file (which specifies the +location of the docbook stylesheet to generate html) will need to be changed +for your particular system. +</para> + +<para> +Under windows, you are still going to use docbook to transform the +<literal>.xml</literal> file into html documentation. You will need to follow +similar steps to those described in a +<ulink url="http://www.codeproject.com/winhelp/docbook_howto.asp">windows +guide</ulink>, but you will end up with native windows looking documentation. +</para> + +<para> +The unix command +<screen> +xsltproc makedoc.xsl callflow.xml +</screen> +will generate output something like +<screen> +Writing ch01.html for chapter +Writing ch02s02.html for sect1 +Writing ch02s03.html for sect1 +Writing ch02s04.html for sect1 +Writing ch02s05.html for sect1 +Writing ch02.html for chapter +Writing ch03s02.html for sect1 +Writing ch03s03.html for sect1 +Writing ch03s04.html for sect1 +Writing ch03s05.html for sect1 +Writing ch03s06.html for sect1 +Writing ch03s07.html for sect1 +Writing ch03s08.html for sect1 +Writing ch03s09.html for sect1 +Writing ch03s10.html for sect1 +Writing ch03s11.html for sect1 +Writing ch03s12.html for sect1 +Writing ch03s13.html for sect1 +Writing ch03s14.html for sect1 +Writing ch03s15.html for sect1 +Writing ch03s16.html for sect1 +Writing ch03.html for chapter +Writing apa.html for appendix +Writing index.html for book +Writing callflow.hhp +Writing callflow.hhc +</screen> +Once the actual html is generated, the zip file must be created. This zip file +contains the files generated by the <literal>xsltproc</literal> command and the +image files referenced by the .sgml files. On +Unix, the command is +<screen> + find . -name \*.html -or -name \*.hh\* -or -name \*.png | xargs zip doc.zip +</screen> +The generated <literal>doc.zip</literal> file must be in the same directory as +where the &callflow; executable is run from. +</para> + +</appendix> Added: sofaswitch/trunk/get_started/get_started.xml ============================================================================== --- (empty file) +++ sofaswitch/trunk/get_started/get_started.xml Mon Jul 2 20:16:52 2007 @@ -0,0 +1,53 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + +<!ENTITY callflow "<emphasis>CallFlow</emphasis>"> +<!ENTITY sofaswitch "<emphasis>SofaSwitch</emphasis>"> + + +<!ENTITY chap1 SYSTEM "chap1.sgml"> +<!ENTITY chap2 SYSTEM "chap2.sgml"> +<!ENTITY chap3 SYSTEM "chap3.sgml"> +<!ENTITY app1 SYSTEM "app1.sgml"> + + + +]> +<book> + <bookinfo> + <date>2007 - June</date> + <title>&sofaswitch;- voice switching made easy: Design document</title> + <subtitle>Overview of &sofaswitch;</subtitle> + <authorgroup> + <author> + <firstname>Derek</firstname> + <surname>Smithies</surname> + <affiliation> + <orgname>IndraNet Technoligies Ltd + </orgname> + </affiliation> + + </author></authorgroup> + <address> + <email>derek(a)indranet.co.nz</email> + </address> + <revhistory> + <revision> + <revnumber>0.1</revnumber> + <date>2007 June 31</date> + <authorinitials>djs</authorinitials> + <revremark> + Initial release + </revremark> + </revision> + </revhistory> + </bookinfo> + +&chap1; + +&chap2; + +&app1; +</book> + Added: sofaswitch/trunk/get_started/makedoc.xsl ============================================================================== --- (empty file) +++ sofaswitch/trunk/get_started/makedoc.xsl Mon Jul 2 20:16:52 2007 @@ -0,0 +1,38 @@ +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version="1.0"> + <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/htmlhelp/htmlhelp.xsl"/> + <xsl:param name="htmlhelp.use.hhk" select="1"/> + <xsl:param name="htmlhelp.button.next" select="1"/> + <xsl:param name="htmlhelp.button.previous" select="1"/> + <xsl:param name="htmlhelp.button.back" select="1"/> + <xsl:param name="htmlhelp.button.forward" select="1"/> + <xsl:param name="htmlhelp.hhc.show.root" select="1"/> + <xsl:param name="htmlhelp.show.favorites" select="1"/> + <xsl:param name="htmlhelp.show.advanced.search" select="1"/> + <xsl:param name="htmlhelp.show.menu" select="1"/> + <xsl:param name="htmlhelp.hhp" select="'callflow.hhp'"/> + <xsl:param name="htmlhelp.hhc" select="'callflow.hhc'"/> + <xsl:param name="htmlhelp.hhk" select="'callflow.hhk'"/> + <xsl:param name="htmlhelp.chm" select="'callflow.chm'"/> + <xsl:param name="use.id.as.filename" select="1"/> +</xsl:stylesheet> + + + +  + + + +

1 0

[commit] r336 - sofaswitch/trunk/get_started
by SofaSWITCH SVN 03 Jul '07

03 Jul '07

Author: derek Date: Mon Jul 2 20:12:24 2007 New Revision: 336 Added: sofaswitch/trunk/get_started/started.cxx - copied unchanged from r252, /sofaswitch/trunk/started.cxx Log: Move this file to get_started directory, as part of the move to using sgml for the docs.

1 0

[commit] r335 - sofaswitch/trunk/get_started
by SofaSWITCH SVN 03 Jul '07

03 Jul '07

Author: derek Date: Mon Jul 2 20:11:30 2007 New Revision: 335 Added: sofaswitch/trunk/get_started/ Log: Add this directory, to document the process of getting started.

1 0

[commit] r334 - sofaswitch/trunk/overview
by SofaSWITCH SVN 03 Jul '07

03 Jul '07

Author: derek Date: Mon Jul 2 20:10:32 2007 New Revision: 334 Modified: sofaswitch/trunk/overview/chap2.sgml Log: Fix a sgml issue. (listitem outside of a para box) Modified: sofaswitch/trunk/overview/chap2.sgml ============================================================================== --- sofaswitch/trunk/overview/chap2.sgml (original) +++ sofaswitch/trunk/overview/chap2.sgml Mon Jul 2 20:10:32 2007 @@ -685,6 +685,7 @@ <para> The key events in the above log can be summarized by the list below +<itemizedlist> <listitem><para> The voip node starts, and registers the supervisor with the label <literal>voip</literal>. The voip supervisor then preallocates 10 nodes, ready @@ -696,7 +697,7 @@ other &sofaswitch; entity. </para></listitem> -<itemizedlist><listitem><para> +<listitem><para> The sound node is started, and connects to the server. The server reports that a new node has started, where the new node has identified itself as <literal>sound</literal>.

1 0