File: install.xml

package info (click to toggle)
dblatex 0.2.9-3
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 6,412 kB
  • ctags: 399
  • sloc: xml: 94,669; python: 4,185; sh: 379; makefile: 120
file content (230 lines) | stat: -rw-r--r-- 6,252 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
<chapter>
  <title>Installing the Package</title>
  <section>
   <title>Content</title>
  <para>
   The package contains the following:
  </para>
  <variablelist>
   <varlistentry>
   <term>
   docs/
</term><listitem><para>Contains the files of this document.
   </para>
  </listitem>
  </varlistentry>
   <varlistentry>
   <term>
   latex/
</term><listitem><para>Contains all the latex stuff: LaTeX style files, logos, and scripts to compile the LaTeX output.
   </para>
  </listitem>
  </varlistentry>
   <varlistentry>
   <term>scripts/</term>
   <listitem><para>Several scripts, including the main script of the package.
   </para>
  </listitem>
  </varlistentry>
   <varlistentry>
   <term>
   xsl/
</term><listitem><para>XSL stylesheets.
   </para>
  </listitem>
  </varlistentry>
   <varlistentry>
   <term>
   tests/
</term><listitem><para>Test files.
   </para>
  </listitem>
  </varlistentry>
  </variablelist>
  </section>

  <section><title>Installing on Unix Systems</title>
  <section>
   <title>Dependencies</title>
  <para>
   To work, the following items must be available:
  </para>
  <itemizedlist>
   <listitem>
   <para>
   An XSLT. <filename>xsltproc</filename> is the default XSLT used, but one can
   also use <ulink url="http://4suite.org">4suite</ulink>.
   </para>
  </listitem>
   <listitem>
   <para>
   The XML DocBook DTD.
   </para>
  </listitem>
   <listitem>
   <para>
   A recent LaTeX distribution. The configure script checks that the needed latex packages are available.
   </para>
  </listitem>
   <listitem>
   <para>
   Python &gt;= 2.4.
   </para>
  </listitem>
  </itemizedlist>
  </section>
  <section>
   <title>Installation</title>
   <section>
    <title>Installing the dependencies</title>
   <para>
    To use the package, install properly the dependencies:
   </para>
   <orderedlist>
    <listitem>
    <para>
    Install Python if necessary.
    </para>
   </listitem>
    <listitem>
    <para>
    Install LaTeX.
    </para>
   </listitem>
    <listitem>
    <para>
    Install the XSLT. By default <filename>xsltproc</filename> is used.
    </para>
   </listitem>
    <listitem>
    <para>
    Install the XML DocBook DTD.
    </para>
   </listitem>
    <listitem>
    <para>
    Create a catalog file, that defines where to find the DTD. Here is an example:
    </para>
    <programlisting>
<![CDATA[PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
]]><![CDATA[    "file:///usr/local/share/xml/docbook/dtd/4.1.2/docbookx.dtd"
]]>    </programlisting>
    <para>
     If the XML Gnome tools are available, it's a good idea to create an XML catalog by using <filename>xmlcatalog</filename> such like this:
    </para>
    <programlisting>
<![CDATA[% xmlcatalog --noout --create mycatalog
% xmlcatalog --noout --add 'public' '-//OASIS//DTD DocBook XML V4.1.2//EN' \
                           'file://path/to/4.1.2/docbookx.dtd' mycatalog
]]>    </programlisting>
   </listitem>
    <listitem>
    <para>
    Add the catalog path to the SGML_CATALOG_FILES variable:
    </para>
<programlisting><![CDATA[export SGML_CATALOG_FILES=$SGML_CATALOG_FILES:/path/to/mycatalog
]]></programlisting>
   <para>
    You can skip this step if you configure the dblatex installation with the <option>--catalogs</option> option.
   </para>
   </listitem>
   </orderedlist>
   </section>
   <section>
    <title>Installing the tool</title>
   <para>
    The steps to follow are the following:
   </para>
   <orderedlist>
    <listitem>
    <para>
    Untar the ball. For a bzipped release, do as follow:
    </para>
    <programlisting><![CDATA[% tar xvfj dblatex-x.x.x.tar.bz2]]></programlisting>
   <para>
    For a gzipped release, do as follow:
   </para>
    <programlisting><![CDATA[% tar xvfz dblatex-x.x.x.tar.gz]]></programlisting>
   </listitem>
    <listitem>
    <para>
    Install the package. The installation script preliminary checks the dependencies. In the example, the <filename>dblatex</filename> script is installed under <filename>/usr/local/bin</filename> and the other files are installed under <filename>/usr/local/share/dblatex</filename>. Besides, the <option>--catalogs</option> option tells where to find the catalogs.
    </para>
    <programlisting>
<![CDATA[% cd dblatex-x.x.x
% python ./setup.py install --prefix=/usr/local --catalogs=/path/to/mycatalog
]]></programlisting>
   </listitem>
   </orderedlist>
   </section>
  </section>
  </section>

  <section><title>Installing on Windows</title>
  <para>The following packages to install and the procedure is for a native
  Windows installation. If you want to use dblatex via Cygwin instead, you
  should consider it like a unix like install.</para>

  <section><title>Dependencies</title>
  <para>The following applications are required:
  <itemizedlist>
   <listitem>
   <para>
   An XSLT. <filename>xsltproc</filename> is the default XSLT used, but one can
   also use <ulink url="http://4suite.org">4suite</ulink>.
   </para>
  </listitem>
   <listitem>
   <para>The XML DocBook DTD.</para>
  </listitem>
   <listitem>
   <para><ulink url="http://www.miktex.org">MiKTeX</ulink> &gt; 2.5.</para>
  </listitem>
   <listitem>
   <para>
   <ulink url="http://www.python.org">Python</ulink> &gt;= 2.4.
   </para>
  </listitem>
  </itemizedlist>
  </para>
  </section>

  <section><title>Installation</title>
  <section><title>Installing xsltproc</title>
  <para>You can download the binaries and getting the installation instructions
  from: <ulink url="http://www.zlatkovic.com/libxml.en.html"/>.</para>
  </section>
  <section><title>Installing MiKTeX</title>
  <para>Install the minimal distribution, and add the following packages: 
changebar,
colortbl,
fancybox,
fancyhdr,
fancyvrb,
listings,
overpics,
rotating,
subfigure,
titlesec,
bibtopic,
enumitem,
eepic,
lm,
lastpage,
helvetic,
times,
symbol,
courier.
  </para>
  </section>
  <section><title>Installing dblatex</title>
  <para>From the unpacked package directory just type:</para>
  <screen>python setup.py install</screen>
  <para>If the Python directory is <filename>C:\Python25</filename> you can now
  try <command>dblatex</command> by typing:</para>
  <screen>python C:\Python25\Scripts\dblatex file.xml</screen>
  </section>
  
  </section>
  </section>
 </chapter>