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@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> + + + + <!-- +The third line of the above file is such that everytime you run xsltproc with this file, it goes to the web to get +the .xsl file from sourceforge. If you don't have net access, you can use a different command. +Below are two equivalent commands. One is from a suse 10.2 box, the other from a suse 10.1 box. +If you use the command below, you may have to modify it according to your system. + + Make certain you have xsltproc installed. + + + <xsl:import href="/usr/share/xml/docbook/stylesheet/nwalsh/1.69.1/htmlhelp/htmlhelp.xsl"/> + + <xsl:import href="/usr/share/xml/docbook/stylesheet/nwalsh/1.71.1/htmlhelp/htmlhelp.xsl"/> +--> + + + +