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>