July 2007 - Sofaswitch-svn - FreeSWITCH Mailing Lists

[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