|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<chapter id="sec-install">
|
|
Packit Service |
76cb02 |
<title>Installing the Package</title>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<section>
|
|
Packit Service |
76cb02 |
<title>Content</title>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<para>The source package contains the following:</para>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<variablelist>
|
|
Packit Service |
76cb02 |
<varlistentry>
|
|
Packit Service |
76cb02 |
<term>docs/</term>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<listitem>
|
|
Packit Service |
76cb02 |
<para>Contains the files of this document.</para>
|
|
Packit Service |
76cb02 |
</listitem>
|
|
Packit Service |
76cb02 |
</varlistentry>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<varlistentry>
|
|
Packit Service |
76cb02 |
<term>etc/</term>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<listitem>
|
|
Packit Service |
76cb02 |
<para>Contains the XML configuration schemas, to use to validate your
|
|
Packit Service |
76cb02 |
configuration files.</para>
|
|
Packit Service |
76cb02 |
</listitem>
|
|
Packit Service |
76cb02 |
</varlistentry>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<varlistentry>
|
|
Packit Service |
76cb02 |
<term>latex/</term>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<listitem>
|
|
Packit Service |
76cb02 |
<para>Contains all the latex stuff: LaTeX style files, logos, and scripts to
|
|
Packit Service |
76cb02 |
compile the LaTeX output.</para>
|
|
Packit Service |
76cb02 |
</listitem>
|
|
Packit Service |
76cb02 |
</varlistentry>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<varlistentry>
|
|
Packit Service |
76cb02 |
<term>scripts/</term>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<listitem>
|
|
Packit Service |
76cb02 |
<para>Several scripts, including the main script of the package.</para>
|
|
Packit Service |
76cb02 |
</listitem>
|
|
Packit Service |
76cb02 |
</varlistentry>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<varlistentry>
|
|
Packit Service |
76cb02 |
<term>xsl/</term>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<listitem>
|
|
Packit Service |
76cb02 |
<para>XSL stylesheets.</para>
|
|
Packit Service |
76cb02 |
</listitem>
|
|
Packit Service |
76cb02 |
</varlistentry>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<varlistentry>
|
|
Packit Service |
76cb02 |
<term>tests/</term>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<listitem>
|
|
Packit Service |
76cb02 |
<para>Test files.</para>
|
|
Packit Service |
76cb02 |
</listitem>
|
|
Packit Service |
76cb02 |
</varlistentry>
|
|
Packit Service |
76cb02 |
</variablelist>
|
|
Packit Service |
76cb02 |
</section>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<section id="sec-install-unix">
|
|
Packit Service |
76cb02 |
<title>Installing on Unix like Systems</title>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<section>
|
|
Packit Service |
76cb02 |
<title>Dblatex Packages</title>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<para>Dblatex is packaged for these Systems or Distributions:</para>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<itemizedlist>
|
|
Packit Service |
76cb02 |
<listitem>
|
|
Packit Service |
76cb02 |
<para><ulink url="http://packages.debian.org/dblatex">Linux Debian</ulink>,
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
url="http://packages.ubuntu.com/search?keywords=dblatex">Ubuntu</ulink>,</para>
|
|
Packit Service |
76cb02 |
</listitem>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<listitem>
|
|
Packit Service |
76cb02 |
<para>
|
|
Packit Service |
76cb02 |
url="http://download.opensuse.org/repositories/home:/thomas-schraitle">Linux
|
|
Packit Service |
76cb02 |
OpenSUSE (RPM)</ulink>,
|
|
Packit Service |
76cb02 |
url="https://admin.fedoraproject.org/pkgdb/packages/name/dblatex">Linux Fedora
|
|
Packit Service |
76cb02 |
(RPM)</ulink>,</para>
|
|
Packit Service |
76cb02 |
</listitem>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<listitem>
|
|
Packit Service |
76cb02 |
<para><ulink url="http://www.freshports.org/textproc/dblatex">FreeBSD</ulink>,
|
|
Packit Service |
76cb02 |
<ulink url="http://pkgsrc.se/textproc/dblatex">NetBSD</ulink>,</para>
|
|
Packit Service |
76cb02 |
</listitem>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<listitem>
|
|
Packit Service |
76cb02 |
<para><ulink url="http://pdb.finkproject.org/pdb/package.php/dblatex">Mac OS X
|
|
Packit Service |
76cb02 |
(Fink)</ulink>.</para>
|
|
Packit Service |
76cb02 |
</listitem>
|
|
Packit Service |
76cb02 |
</itemizedlist>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<para> If you are installing on one of these distributions, follow their
|
|
Packit Service |
76cb02 |
recommended way of installation, and you can safely ignore the next sections
|
|
Packit Service |
76cb02 |
that give details for installing dblatex from the source tarball.</para>
|
|
Packit Service |
76cb02 |
</section>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<section>
|
|
Packit Service |
76cb02 |
<title>Dependencies</title>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<para>To work, the following items must be available:</para>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<itemizedlist>
|
|
Packit Service |
76cb02 |
<listitem>
|
|
Packit Service |
76cb02 |
<para>An XSLT. <filename>xsltproc</filename> is the default XSLT used, but one
|
|
Packit Service |
76cb02 |
can also use <ulink url="http://4suite.org">4suite</ulink> or <ulink url="http://saxon.sourceforge.net">saxon</ulink>.</para>
|
|
Packit Service |
76cb02 |
</listitem>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<listitem>
|
|
Packit Service |
76cb02 |
<para>The XML DocBook DTD.</para>
|
|
Packit Service |
76cb02 |
</listitem>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<listitem>
|
|
Packit Service |
76cb02 |
<para>A recent LaTeX distribution. The configure script checks that the needed
|
|
Packit Service |
76cb02 |
latex packages are available.</para>
|
|
Packit Service |
76cb02 |
</listitem>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<listitem>
|
|
Packit Service |
76cb02 |
<para>Python >= 2.4.</para>
|
|
Packit Service |
76cb02 |
</listitem>
|
|
Packit Service |
76cb02 |
</itemizedlist>
|
|
Packit Service |
76cb02 |
</section>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<section>
|
|
Packit Service |
76cb02 |
<title>Installation</title>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<section>
|
|
Packit Service |
76cb02 |
<title>Installing the dependencies</title>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<para>To use the package, install properly the dependencies:</para>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<orderedlist>
|
|
Packit Service |
76cb02 |
<listitem>
|
|
Packit Service |
76cb02 |
<para>Install Python if necessary.</para>
|
|
Packit Service |
76cb02 |
</listitem>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<listitem>
|
|
Packit Service |
76cb02 |
<para>Install LaTeX.</para>
|
|
Packit Service |
76cb02 |
</listitem>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<listitem>
|
|
Packit Service |
76cb02 |
<para>Install the XSLT. By default <filename>xsltproc</filename> is
|
|
Packit Service |
76cb02 |
used.</para>
|
|
Packit Service |
76cb02 |
</listitem>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<listitem>
|
|
Packit Service |
76cb02 |
<para>Install the XML DocBook DTD.</para>
|
|
Packit Service |
76cb02 |
</listitem>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<listitem>
|
|
Packit Service |
76cb02 |
<para>Create a catalog file, that defines where to find the DTD. Here is an
|
|
Packit Service |
76cb02 |
example:</para>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<programlisting>
|
|
Packit Service |
76cb02 |
PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
|
Packit Service |
76cb02 |
"file:///usr/local/share/xml/docbook/dtd/4.1.2/docbookx.dtd"
|
|
Packit Service |
76cb02 |
</programlisting>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<para>If the XML Gnome tools are available, it's a good idea to create an XML
|
|
Packit Service |
76cb02 |
catalog by using <filename>xmlcatalog</filename> such like this:</para>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<programlisting>
|
|
Packit Service |
76cb02 |
% xmlcatalog --noout --create mycatalog
|
|
Packit Service |
76cb02 |
% xmlcatalog --noout --add 'public' '-//OASIS//DTD DocBook XML V4.1.2//EN' \
|
|
Packit Service |
76cb02 |
'file://path/to/4.1.2/docbookx.dtd' mycatalog
|
|
Packit Service |
76cb02 |
</programlisting>
|
|
Packit Service |
76cb02 |
</listitem>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<listitem>
|
|
Packit Service |
76cb02 |
<para>Add the catalog path to the SGML_CATALOG_FILES variable:</para>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<programlisting>export SGML_CATALOG_FILES=$SGML_CATALOG_FILES:/path/to/mycatalog
|
|
Packit Service |
76cb02 |
</programlisting>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<para>You can skip this step if you configure the dblatex installation with
|
|
Packit Service |
76cb02 |
the <option>--catalogs</option> option.</para>
|
|
Packit Service |
76cb02 |
</listitem>
|
|
Packit Service |
76cb02 |
</orderedlist>
|
|
Packit Service |
76cb02 |
</section>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<section>
|
|
Packit Service |
76cb02 |
<title>Installing from the source tarball</title>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<para>The steps to follow are the following:</para>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<orderedlist>
|
|
Packit Service |
76cb02 |
<listitem>
|
|
Packit Service |
76cb02 |
<para>Untar the ball. For a bzipped release, do as follow:</para>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<screen>% tar xvfj dblatex-x.x.x.tar.bz2</screen>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<para>For a gzipped release, do as follow:</para>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<screen>% tar xvfz dblatex-x.x.x.tar.gz</screen>
|
|
Packit Service |
76cb02 |
</listitem>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<listitem>
|
|
Packit Service |
76cb02 |
<para>Install the package. The installation script preliminary checks the
|
|
Packit Service |
76cb02 |
dependencies. In the example, the <filename>dblatex</filename> script is
|
|
Packit Service |
76cb02 |
installed under <filename>/usr/local/bin</filename> and the other files are
|
|
Packit Service |
76cb02 |
installed under <filename>/usr/local/share/dblatex</filename>. Besides, the
|
|
Packit Service |
76cb02 |
<option>--catalogs</option> option tells where to find the catalogs.</para>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<programlisting>
|
|
Packit Service |
76cb02 |
% cd dblatex-x.x.x
|
|
Packit Service |
76cb02 |
% python ./setup.py install --prefix=/usr/local --catalogs=/path/to/mycatalog
|
|
Packit Service |
76cb02 |
</programlisting>
|
|
Packit Service |
76cb02 |
</listitem>
|
|
Packit Service |
76cb02 |
</orderedlist>
|
|
Packit Service |
76cb02 |
</section>
|
|
Packit Service |
76cb02 |
<section id="sec-install-pypi">
|
|
Packit Service |
76cb02 |
<title>Installing from the Python Egg</title>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<para>Since version 0.3.2 dblatex is distributed as a Python Egg in the <ulink url="http://pypi.python.org/pypi">Python Package Index (PyPI)</ulink>. It requires to have <command>easy_install</command> installed.</para>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<para>The procedure to follow is:</para>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<orderedlist>
|
|
Packit Service |
76cb02 |
<listitem>
|
|
Packit Service |
76cb02 |
<para>Call simply easy_install:</para>
|
|
Packit Service |
76cb02 |
<screen>
|
|
Packit Service |
76cb02 |
% <userinput>easy_install dblatex</userinput>
|
|
Packit Service |
76cb02 |
Searching for dblatex
|
|
Packit Service |
76cb02 |
Reading http://pypi.python.org/simple/dblatex/
|
|
Packit Service |
76cb02 |
Reading http://dblatex.sf.net
|
|
Packit Service |
76cb02 |
Best match: dblatex 0.3.1.1
|
|
Packit Service |
76cb02 |
Downloading http://pypi.python.org/packages/2.5/d/dblatex/dblatex-0.3.1.1-py2.5.egg#md5=8520d596e473ff544eb9dcdc5175d7ae
|
|
Packit Service |
76cb02 |
Processing dblatex-0.3.1.1-py2.5.egg
|
|
Packit Service |
76cb02 |
creating /path/to/dblatex-0.3.1.1-py2.5.egg
|
|
Packit Service |
76cb02 |
Extracting dblatex-0.3.1.1-py2.5.egg to /path/to
|
|
Packit Service |
76cb02 |
Adding dblatex 0.3.1.1 to easy-install.pth file
|
|
Packit Service |
76cb02 |
Installing dblatex script to /path/to
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
Installed /path/to/dblatex-0.3.1.1-py2.5.egg
|
|
Packit Service |
76cb02 |
</screen>
|
|
Packit Service |
76cb02 |
</listitem>
|
|
Packit Service |
76cb02 |
</orderedlist>
|
|
Packit Service |
76cb02 |
<para>That's it!</para>
|
|
Packit Service |
76cb02 |
</section>
|
|
Packit Service |
76cb02 |
</section>
|
|
Packit Service |
76cb02 |
</section>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<section>
|
|
Packit Service |
76cb02 |
<title>Installing on Windows</title>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<para>The following packages to install and the procedure is for a native
|
|
Packit Service |
76cb02 |
Windows installation. If you want to use dblatex via Cygwin instead, you
|
|
Packit Service |
76cb02 |
should consider it like a unix like install.</para>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<section>
|
|
Packit Service |
76cb02 |
<title>Dependencies</title>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<para>The following applications are required: <itemizedlist>
|
|
Packit Service |
76cb02 |
<listitem>
|
|
Packit Service |
76cb02 |
<para>An XSLT. <filename>xsltproc</filename> is the default XSLT used, but one
|
|
Packit Service |
76cb02 |
can also use <ulink url="http://foursuite.sourceforge.net">4suite</ulink>.</para>
|
|
Packit Service |
76cb02 |
</listitem>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<listitem>
|
|
Packit Service |
76cb02 |
<para>The XML DocBook DTD.</para>
|
|
Packit Service |
76cb02 |
</listitem>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<listitem>
|
|
Packit Service |
76cb02 |
<para><ulink url="http://www.miktex.org">MiKTeX</ulink> > 2.5.</para>
|
|
Packit Service |
76cb02 |
</listitem>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<listitem>
|
|
Packit Service |
76cb02 |
<para><ulink url="http://www.python.org">Python</ulink> >= 2.4.</para>
|
|
Packit Service |
76cb02 |
</listitem>
|
|
Packit Service |
76cb02 |
</itemizedlist></para>
|
|
Packit Service |
76cb02 |
</section>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<section>
|
|
Packit Service |
76cb02 |
<title>Installation</title>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<section>
|
|
Packit Service |
76cb02 |
<title>Installing xsltproc</title>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<para>You can download the binaries and getting the installation instructions
|
|
Packit Service |
76cb02 |
from: <ulink url="http://www.zlatkovic.com/libxml.en.html"></ulink>.</para>
|
|
Packit Service |
76cb02 |
</section>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<section>
|
|
Packit Service |
76cb02 |
<title>Installing MiKTeX</title>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<para>Install the minimal distribution, and add the following packages:
|
|
Packit Service |
76cb02 |
changebar, colortbl, fancybox, fancyhdr, fancyvrb, listings, overpics,
|
|
Packit Service |
76cb02 |
rotating, subfigure, titlesec, bibtopic, enumitem, eepic, lm, lastpage,
|
|
Packit Service |
76cb02 |
helvetic, times, symbol, courier, footmisc, ifxetex, pdfpages, wasysym.</para>
|
|
Packit Service |
76cb02 |
</section>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<section>
|
|
Packit Service |
76cb02 |
<title>Installing dblatex</title>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<para>From the unpacked package directory just type:</para>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<screen>python setup.py install</screen>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<para>If the Python directory is <filename>C:\Python25</filename> you can now
|
|
Packit Service |
76cb02 |
try <command>dblatex</command> by typing:</para>
|
|
Packit Service |
76cb02 |
|
|
Packit Service |
76cb02 |
<screen>python C:\Python25\Scripts\dblatex file.xml</screen>
|
|
Packit Service |
76cb02 |
</section>
|
|
Packit Service |
76cb02 |
</section>
|
|
Packit Service |
76cb02 |
</section>
|
|
Packit Service |
76cb02 |
</chapter>
|