Commit bf840438 authored by Jason Hudson's avatar Jason Hudson
Browse files

tuXlab Cookbook

First commit.
parents
K 25
svn:wc:ra_dav:version-url
V 30
/techdocs/tuxlab/!svn/ver/122/
END
8
dir
122
https://svn1.cvsdude.com/techdocs/tuxlab
https://svn1.cvsdude.com/techdocs/tuxlab
2007-02-07T06:11:25.034226Z
122
techdocs
svn:special svn:externals svn:needs-lock
9c4ca543-dd12-0410-a26a-3b76ba88126a
trunk
dir
branches
dir
tags
dir
K 25
svn:wc:ra_dav:version-url
V 36
/techdocs/tuxlab/!svn/ver/1/branches
END
8
dir
122
https://svn1.cvsdude.com/techdocs/tuxlab/branches
https://svn1.cvsdude.com/techdocs/tuxlab
2006-05-03T08:05:21.512863Z
1
techdocs
svn:special svn:externals svn:needs-lock
9c4ca543-dd12-0410-a26a-3b76ba88126a
K 25
svn:wc:ra_dav:version-url
V 32
/techdocs/tuxlab/!svn/ver/1/tags
END
8
dir
122
https://svn1.cvsdude.com/techdocs/tuxlab/tags
https://svn1.cvsdude.com/techdocs/tuxlab
2006-05-03T08:05:21.512863Z
1
techdocs
svn:special svn:externals svn:needs-lock
9c4ca543-dd12-0410-a26a-3b76ba88126a
K 25
svn:wc:ra_dav:version-url
V 35
/techdocs/tuxlab/!svn/ver/122/trunk
END
tuxlabv2.xml
K 25
svn:wc:ra_dav:version-url
V 48
/techdocs/tuxlab/!svn/ver/122/trunk/tuxlabv2.xml
END
README
K 25
svn:wc:ra_dav:version-url
V 42
/techdocs/tuxlab/!svn/ver/108/trunk/README
END
build.xml
K 25
svn:wc:ra_dav:version-url
V 45
/techdocs/tuxlab/!svn/ver/108/trunk/build.xml
END
8
dir
122
https://svn1.cvsdude.com/techdocs/tuxlab/trunk
https://svn1.cvsdude.com/techdocs/tuxlab
2007-02-07T06:11:25.034226Z
122
techdocs
svn:special svn:externals svn:needs-lock
9c4ca543-dd12-0410-a26a-3b76ba88126a
infrastructure
dir
introduction
dir
volunteer
dir
common
dir
libs
dir
software
dir
hardware
dir
README
file
2007-06-04T09:02:42.000000Z
9f0e3dbb9d37db9e6ae26478348613db
2007-01-17T09:05:45.888020Z
108
techdocs
build.xml
file
2007-06-04T09:02:42.000000Z
fb4d0c9dc5373aea28ef516575f542ac
2007-01-17T09:05:45.888020Z
108
techdocs
biblio
dir
sustainability
dir
images
dir
tuxlabv2.xml
file
2007-06-04T09:02:42.000000Z
498fbe668a6b14aa364860a5db1a0b69
2007-02-07T06:11:25.034226Z
122
techdocs
content
dir
appendices
dir
training
dir
management
dir
support
dir
The source of the document is in Docbook XML.
To build the document into PDF you need the following:
* Apache Ant 1.6.x >
* xmllint
The rest of the dependancys are satisfied from the libs/ during the build.
With pwd root of trunk, do
$ant
This will build the PDF in pwd.
Support: Sean Wheller <sean@inwords.co.za>
<?xml version="1.0"?>
<project name="Tuxlab" default="all" basedir=".">
<property name="docbook.dir" value="libs/" />
<!-- This is the setting for calling saxon -->
<path id="project.class.path.saxon">
<pathelement location="libs/docbook/xsl/extensions/saxon653.jar.ext"/>
<pathelement location="libs/saxon/saxon.jar"/>
<pathelement location="libs/saxon/saxon_jdom.jar"/>
<pathelement location="libs/docbook/xsl/extensions/resolver.jar"/>
<pathelement location="libs"/>
</path>
<!-- This is the setting for calling fop -->
<path id="project.class.path.fop">
<pathelement location="libs/fop/build/fop.jar"/>
<pathelement location="libs/fop/lib/xml-apis.jar"/>
<pathelement location="libs/fop/lib/xercesImpl-2.2.1.jar"/>
<pathelement location="libs/fop/lib/xalan-2.4.1.jar"/>
<pathelement location="libs/fop/lib/batik.jar"/>
<pathelement location="libs/fop/lib/avalon-framework-cvs-20020806.jar"/>
<pathelement location="libs/Jimi/JimiProClasses.jar"/>
</path>
<!-- This is the setting for calling jai -->
<path id="project.class.path.jai">
<pathelement location="libs/jai/lib/jai_core.jar"/>
<pathelement location="libs/lib/jai_codec.jar"/>
</path>
<!-- Document Targets -->
<target name="tuxlab">
<property name="base.file" value="tuxlabv2"/>
<property name="input.file" value="${base.file}.xml"/>
<property name="output.file" value="temp.xml"/>
<property name="output.html" value="${base.file}.html"/>
<property name="output.fo" value="temp.fo"/>
<property name="output.pdf" value="${base.file}.pdf"/>
<!-- <antcall target="html"/> -->
<antcall target="pdf"/>
<antcall target="clean"/>
</target>
<!-- Generic HTML and PDF Transforms -->
<!--Create html output-->
<target name="html" description="Creates manual.html">
<echo>Creating manual.html</echo>
<exec executable="xmllint" dir=".">
<arg line="--xinclude"/>
<arg line="--noent"/>
<arg line="--nonet"/>
<arg value="${input.file}"/>
<arg line="--output"/>
<arg value="${output.file}"/>
</exec>
<java classname="com.icl.saxon.StyleSheet" classpathref="project.class.path.saxon" output="saxon.log">
<arg line="-o ${output.html}"/>
<arg line="${output.file}"/>
<arg line="${docbook.dir}/html-cust.xsl" />
</java>
</target>
<!--Create pdf output-->
<target name="pdf" description="Creates">
<echo>Creating ${base.file}.pdf</echo>
<exec executable="xmllint" dir=".">
<arg line="--xinclude"/>
<arg line="--noent"/>
<arg line="--nonet"/>
<arg value="${input.file}"/>
<arg line="--output"/>
<arg value="${output.file}"/>
</exec>
<java classname="com.icl.saxon.StyleSheet" classpathref="project.class.path.saxon"
output="saxon.log">
<arg line="-o ${output.fo}"/>
<arg line="${output.file}"/>
<arg line="${docbook.dir}/fo-cust.xsl" />
</java>
<java classname="org.apache.fop.apps.Fop" classpathref="project.class.path.fop" output="fop.log" fork="true">
<jvmarg value="-Xmx256M"/>
<arg line="-fo ${output.fo}"/>
<arg line="-pdf ${output.pdf}"/>
</java>
</target>
<!-- Cleanup temp files -->
<target name="clean">
<delete file="temp.xml"/>
<delete file="temp.fo"/>
</target>
<!--Create the full cookbook document and the individual module documents-->
<target name="all" description="Creates all documents">
<echo>Creating all documents</echo>
<antcall target="tuxlab"/>
</target>
</project>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"http://www.docbook.org/xml/4.4/docbookx.dtd"
[
<!ENTITY % globalents SYSTEM "common/global.ent">
%globalents;
<!ENTITY % xinclude SYSTEM "libs/xinclude.mod">
%xinclude;
]>
<book>
<bookinfo>
<title>&productname; Cookbook</title>
<authorgroup>
<author>
<firstname>Sean</firstname>
<surname>Wheller</surname>
<email>sean@inwords.co.za</email>
</author>
<author>
<firstname>Graham</firstname>
<surname>Goode</surname>
</author>
</authorgroup>
<corpauthor><inlinegraphic fileref="images/tsfandtux.png" format="PNG" width="80mm"/></corpauthor>
<edition>Second</edition>
&licensenotice;
&pubdate;
</bookinfo>
<preface>
<title>Preface</title>
<sect1>
<title>Audience</title>
<para>The subject of a &productname; brings together computers and education. As such the audience for which the
&productname; cookbook is intended includes a diverse spectrum of people with either computing or
educational backgrounds, or both. Hopefully, everyone reading this book shares a common interest in applying
computers in educational environments in order that they may improve learning techniques and provide a place
where computing and information technologies may be taught.</para>
</sect1>
<sect1>
<title>Scope</title>
<para>A &productname; is a challenge - experience has shown that it takes varying degrees of input from people with
different skills in order to make a &productname; successful. Typically, each of the people participating
in a project do what they are good at. Each plays a role, assuming responsibility for one or more functional
perspectives of the project.</para>
<para>The scope of the &productname; cookbook extends to cover all such perspectives so that the collective
experience of many may be distilled and captured in order that such knowledge may be preserved in a manner
that it can be referenced and transferred into the future.</para>
</sect1>
<sect1>
<title>Organisation</title>
<para>The &productname; cookbook is a set of books. Each covers a specific perspective of a &productname; that
requires consideration and attention in the planning and management thereof. While the books are presented and
bound as a single volume of work they are intended to be used as independent pieces. For this reason the
&productname; cookbook is bound in a large lever-arch style file that enables books to be conveniently
stored at the &productname; and, individual books, temporarily removed so that they can be read or
duplicated independently.</para>
<para>Nobody is expected to know or be an expert in everything, it is however useful for everyone involved to have some
degree of overview about what others are doing or what their role involves. Given that people in a project
will bring different skills and have different interests, it is recommended that people read this book and
then those books related to their role or responsibility the project.</para>
<para>Organisation of the books is as follows:</para>
<variablelist>
<varlistentry>
<term>
<emphasis role="bold">Introduction</emphasis>
</term>
<listitem>
<para>The document that you are reading.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">Software Module</emphasis>
</term>
<listitem> &abstract-software; </listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">Hardware Module</emphasis>
</term>
<listitem> &abstract-hardware; </listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">Infrastructure Module</emphasis>
</term>
<listitem> &abstract-infrastructure; </listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">Training Module</emphasis>
</term>
<listitem> &abstract-training; </listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">Management Module</emphasis>
</term>
<listitem> &abstract-management; </listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">Support Module</emphasis>
</term>
<listitem> &abstract-support; </listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">Volunteer Module</emphasis>
</term>
<listitem> &abstract-volunteer; </listitem>
</varlistentry>
<varlistentry>
<term>
<emphasis role="bold">Sustainability Module</emphasis>
</term>
<listitem> &abstract-sustainability; </listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1>
<title>Acknowledgements</title>
<para>A special word of thanks is extended to the organisations and people whose generous contributions and support have
helped make the &productname; Cookbook into the valuable resource it is today.</para>
<para>The information contained in this book comes from many different people. We have used the content of the first
&productname; Cookbook written by Jean Jordaan as a base for many of the modules and have added more
recent information and new content. The illustrations were created by Leonora van Staden. Information was also
provided by Jason Norwood-Young and Hilton Theunissen.</para>
</sect1> &conventions;
</preface>
<xi:include href="introduction/introduction.xml">
<xi:fallback>
<para>FIX ME</para>
</xi:fallback>
</xi:include>
<xi:include href="infrastructure/infrastructure.xml">
<xi:fallback>
<para>FIX ME</para>
</xi:fallback>
</xi:include>
<xi:include href="hardware/hardware.xml">
<xi:fallback>
<para>FIX ME</para>
</xi:fallback>
</xi:include>
<xi:include href="management/management.xml">
<xi:fallback>
<para>FIX ME</para>
</xi:fallback>
</xi:include>
<xi:include href="software/software.xml">
<xi:fallback>
<para>FIX ME</para>
</xi:fallback>
</xi:include>
<xi:include href="support/support.xml">
<xi:fallback>
<para>FIX ME</para>
</xi:fallback>
</xi:include>
<xi:include href="sustainability/sustainability.xml">
<xi:fallback>
<para>FIX ME</para>
</xi:fallback>
</xi:include>
<xi:include href="training/training.xml">
<xi:fallback>
<para>FIX ME</para>
</xi:fallback>
</xi:include>
<xi:include href="volunteer/volunteer.xml">
<xi:fallback>
<para>FIX ME</para>
</xi:fallback>
</xi:include>
<!--<xi:include href="biblio/bibliography.xml">
<xi:fallback>
<para>FIX ME</para>
</xi:fallback>
</xi:include>-->
<xi:include href="appendices/appendix-a.xml">
<xi:fallback>
<para>FIX ME</para>
</xi:fallback>
</xi:include>
<xi:include href="appendices/appendix-b.xml">
<xi:fallback>
<para>FIX ME</para>
</xi:fallback>
</xi:include>
<xi:include href="appendices/appendix-c.xml">
<xi:fallback>
<para>FIX ME</para>
</xi:fallback>
</xi:include>
<xi:include href="appendices/appendix-d.xml">
<xi:fallback>
<para>FIX ME</para>
</xi:fallback>
</xi:include>
<xi:include href="appendices/appendix-e.xml">
<xi:fallback>
<para>FIX ME</para>
</xi:fallback>
</xi:include>
<xi:include href="appendices/appendix-f.xml">
<xi:fallback>
<para>FIX ME</para>
</xi:fallback>
</xi:include>
</book>
\ No newline at end of file
The source of the document is in Docbook XML.
To build the document into PDF you need the following:
* Apache Ant 1.6.x >
* xmllint
The rest of the dependancys are satisfied from the libs/ during the build.
With pwd root of trunk, do
$ant
This will build the PDF in pwd.
Support: Sean Wheller <sean@inwords.co.za>
K 25
svn:wc:ra_dav:version-url
V 46
/techdocs/tuxlab/!svn/ver/103/trunk/appendices
END
appendix-a.xml
K 25
svn:wc:ra_dav:version-url
V 61
/techdocs/tuxlab/!svn/ver/103/trunk/appendices/appendix-a.xml
END
appendix-b.xml
K 25
svn:wc:ra_dav:version-url
V 61
/techdocs/tuxlab/!svn/ver/103/trunk/appendices/appendix-b.xml