source: pst/xml/docbook-xsl.xml

trunk
Last change on this file was 3f2db3a6, checked in by Pierre Labastie <pierre.labastie@…>, 2 months ago

Remove sect1info tags

They only contain a date tag that is nowhere used.

  • Property mode set to 100644
File size: 11.3 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY path "https://github.com/docbook/xslt10-stylesheets/releases/download/release">
8
9 <!ENTITY docbook-xsl-download-http "&path;/&docbook-xsl-version;/docbook-xsl-nons-&docbook-xsl-version;.tar.bz2">
10 <!ENTITY docbook-xsl-download-ftp " ">
11 <!ENTITY docbook-xsl-md5sum "2666d1488d6ced1551d15f31d7ed8c38">
12 <!ENTITY docbook-xsl-size "22 MB">
13 <!ENTITY docbook-xsl-buildsize "58 MB (includes installing optional documentation)">
14 <!ENTITY docbook-xsl-time "less than 0.1 SBU">
15
16 <!ENTITY docbook-xsl-doc-download "&path;/&docbook-xsl-version;/docbook-xsl-doc-&docbook-xsl-version;.tar.bz2">
17 <!ENTITY docbook-xsl-doc-md5sum "62375ca864fc198cb2b17d98209d0b8c">
18 <!ENTITY docbook-xsl-doc-size "522 KB">
19]>
20
21<sect1 id="docbook-xsl"
22xreflabel="docbook-xsl-nons-&docbook-xsl-version;">
23 <?dbhtml filename="docbook-xsl.html"?>
24
25
26 <title>docbook-xsl-nons-&docbook-xsl-version;</title>
27
28 <indexterm zone="docbook-xsl">
29 <primary sortas="a-DocBook-XSL-Stylesheets">DocBook XSL
30 Stylesheets</primary>
31 </indexterm>
32
33 <sect2 role="package">
34 <title>Introduction to DocBook XSL Stylesheets</title>
35
36 <para>
37 The <application>DocBook XSL Stylesheets</application>
38 package contains XSL stylesheets. These are useful for
39 performing transformations on XML DocBook files.
40 </para>
41
42 &lfs112_checked;
43
44 <bridgehead renderas="sect3">Package Information</bridgehead>
45 <itemizedlist spacing="compact">
46 <listitem>
47 <para>
48 Download (HTTP): <ulink url="&docbook-xsl-download-http;"/>
49 </para>
50 </listitem>
51 <listitem>
52 <para>
53 Download (FTP): <ulink url="&docbook-xsl-download-ftp;"/>
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 Download MD5 sum: &docbook-xsl-md5sum;
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Download size: &docbook-xsl-size;
64 </para>
65 </listitem>
66 <listitem>
67 <para>
68 Estimated disk space required: &docbook-xsl-buildsize;
69 </para>
70 </listitem>
71 <listitem>
72 <para>
73 Estimated build time: &docbook-xsl-time;
74 </para>
75 </listitem>
76 </itemizedlist>
77
78 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
79 <itemizedlist spacing='compact'>
80 <listitem>
81 <para>
82 Required patch: <ulink url=
83 "&patch-root;/docbook-xsl-nons-&docbook-xsl-version;-stack_fix-1.patch"/>
84 </para>
85 </listitem>
86 </itemizedlist>
87
88 <itemizedlist spacing="compact">
89 <title>Optional documentation</title>
90 <listitem>
91 <para>
92 Download (HTTP): <ulink url="&docbook-xsl-doc-download;"/>
93 </para>
94 </listitem>
95 <listitem>
96 <para>
97 Download MD5 sum: &docbook-xsl-doc-md5sum;
98 </para>
99 </listitem>
100 <listitem>
101 <para>
102 Download size: &docbook-xsl-doc-size;
103 </para>
104 </listitem>
105 </itemizedlist>
106
107 <bridgehead renderas="sect3">DocBook XSL Stylesheets Dependencies</bridgehead>
108
109 <bridgehead renderas="sect4">Recommended (at runtime)</bridgehead>
110 <para role="recommended">
111 <xref role="runtime" linkend="libxml2"/>
112 </para>
113
114 <bridgehead renderas="sect4">Optional (all used at runtime)</bridgehead>
115 <para role="optional">
116 <xref role="runtime" linkend="apache-ant"/>
117 (to produce <quote>webhelp</quote> documents),
118 <xref role="runtime" linkend="libxslt"/>
119 (or any other XSLT processor), to process
120 Docbook documents - the <application>Python2</application> modules
121 libxml2 and libxslt can be used,
122 <xref role="runtime" linkend="python2"/> (at runtime),
123 <xref role="runtime" linkend="ruby"/>
124 (to utilize the <quote>epub</quote> stylesheets),
125 <xref role="runtime" linkend="zip"/>
126 (to produce <quote>epub3</quote> documents), and
127 <ulink url="https://sourceforge.net/projects/saxon/files/saxon6/">
128 Saxon6
129 </ulink> and
130 <ulink url="http://xerces.apache.org/xerces2-j/">Xerces2 Java</ulink>
131 (used with <xref role="runtime" linkend="apache-ant"/>
132 to produce <quote>webhelp</quote> documents)
133 </para>
134
135 <para condition="html" role="usernotes">User Notes:
136 <ulink url="&blfs-wiki;/docbook-xsl"/></para>
137
138 </sect2>
139
140 <sect2 role="installation">
141 <title>Installation of DocBook XSL Stylesheets</title>
142
143 <para>
144 First, fix a problem that causes stack overflows when doing recursion:
145 </para>
146
147<screen><userinput>patch -Np1 -i ../docbook-xsl-nons-&docbook-xsl-version;-stack_fix-1.patch</userinput></screen>
148
149 <para>
150 If you downloaded the optional documentation tarball, unpack it
151 with the following command:
152 </para>
153
154<screen><userinput>tar -xf ../docbook-xsl-doc-&docbook-xsl-version;.tar.bz2 --strip-components=1</userinput></screen>
155
156 <para>
157 BLFS does not install the required packages to run the test suite
158 and provide meaningful results.
159 </para>
160
161 <para>
162 Install <application>DocBook XSL Stylesheets</application>
163 by running the following commands as the
164 <systemitem class="username">root</systemitem> user:
165 </para>
166
167<screen role="root"><userinput>install -v -m755 -d /usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version; &amp;&amp;
168
169cp -v -R VERSION assembly common eclipse epub epub3 extensions fo \
170 highlighting html htmlhelp images javahelp lib manpages params \
171 profiling roundtrip slides template tests tools webhelp website \
172 xhtml xhtml-1_1 xhtml5 \
173 /usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version; &amp;&amp;
174
175ln -s VERSION /usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version;/VERSION.xsl &amp;&amp;
176
177install -v -m644 -D README \
178 /usr/share/doc/docbook-xsl-nons-&docbook-xsl-version;/README.txt &amp;&amp;
179install -v -m644 RELEASE-NOTES* NEWS* \
180 /usr/share/doc/docbook-xsl-nons-&docbook-xsl-version;</userinput></screen>
181
182 <para>
183 If you downloaded the optional documentation tarball, install the
184 documentation by issuing the following command as the
185 <systemitem class="username">root</systemitem> user:
186 </para>
187
188<screen role="root"><userinput>cp -v -R doc/* /usr/share/doc/docbook-xsl-nons-&docbook-xsl-version;</userinput></screen>
189
190 </sect2>
191
192 <sect2 role="configuration">
193 <title>Configuring DocBook XSL Stylesheets</title>
194
195 <sect3 id="docbook-xsl-config">
196 <title>Config Files</title>
197
198 <para>
199 <filename>/etc/xml/catalog</filename>
200 </para>
201
202 <indexterm zone="docbook-xsl docbook-xsl-config">
203 <primary sortas="e-etc-xml-catalog">/etc/xml/catalog</primary>
204 </indexterm>
205
206 </sect3>
207
208 <sect3>
209 <title>Configuration Information</title>
210
211 <note>
212 <para>
213 If you are installing the current version of docbook-xsl-nons
214 over a previous version of docbook-xsl, then remove the old
215 rewrite entries in the catalog as the <systemitem
216 class="username">root</systemitem> user:
217 </para>
218
219<screen role="nodump"><userinput>sed -i '/rewrite/d' /etc/xml/catalog</userinput></screen>
220 </note>
221
222 <para>
223 Create (or append) and populate the XML catalog file using the
224 following commands as the <systemitem
225 class="username">root</systemitem> user:
226 </para>
227
228<screen role="root"><userinput>if [ ! -d /etc/xml ]; then install -v -m755 -d /etc/xml; fi &amp;&amp;
229if [ ! -f /etc/xml/catalog ]; then
230 xmlcatalog --noout --create /etc/xml/catalog
231fi &amp;&amp;
232
233xmlcatalog --noout --add "rewriteSystem" \
234 "https://cdn.docbook.org/release/xsl-nons/&docbook-xsl-version;" \
235 "/usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version;" \
236 /etc/xml/catalog &amp;&amp;
237
238xmlcatalog --noout --add "rewriteURI" \
239 "https://cdn.docbook.org/release/xsl-nons/&docbook-xsl-version;" \
240 "/usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version;" \
241 /etc/xml/catalog &amp;&amp;
242
243xmlcatalog --noout --add "rewriteSystem" \
244 "https://cdn.docbook.org/release/xsl-nons/current" \
245 "/usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version;" \
246 /etc/xml/catalog &amp;&amp;
247
248xmlcatalog --noout --add "rewriteURI" \
249 "https://cdn.docbook.org/release/xsl-nons/current" \
250 "/usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version;" \
251 /etc/xml/catalog &amp;&amp;
252
253xmlcatalog --noout --add "rewriteSystem" \
254 "http://docbook.sourceforge.net/release/xsl/current" \
255 "/usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version;" \
256 /etc/xml/catalog &amp;&amp;
257
258xmlcatalog --noout --add "rewriteURI" \
259 "http://docbook.sourceforge.net/release/xsl/current" \
260 "/usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version;" \
261 /etc/xml/catalog</userinput></screen>
262
263 <para>
264 Occasionally, you may find the need to install other versions of the
265 XSL stylesheets as some projects reference a specific version. One
266 example is BLFS-6.0, which required the 1.67.2 version. In these
267 instances you should install any other required version in its own
268 versioned directory and create catalog entries as follows (substitute
269 the desired version number for
270 <replaceable>&lt;version&gt;</replaceable>):
271 </para>
272
273<screen role="nodump"><userinput>xmlcatalog --noout --add "rewriteSystem" \
274 "http://docbook.sourceforge.net/release/xsl/<replaceable>&lt;version&gt;</replaceable>" \
275 "/usr/share/xml/docbook/xsl-stylesheets-<replaceable>&lt;version&gt;</replaceable>" \
276 /etc/xml/catalog &amp;&amp;
277
278xmlcatalog --noout --add "rewriteURI" \
279 "http://docbook.sourceforge.net/release/xsl/<replaceable>&lt;version&gt;</replaceable>" \
280 "/usr/share/xml/docbook/xsl-stylesheets-<replaceable>&lt;version&gt;</replaceable>" \
281 /etc/xml/catalog</userinput></screen>
282
283 </sect3>
284
285 </sect2>
286
287 <sect2 role="content">
288 <title>Contents</title>
289
290 <segmentedlist>
291 <segtitle>Installed Files</segtitle>
292 <segtitle>Installed Directories</segtitle>
293
294 <seglistitem>
295 <seg>/usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version;/*/*.xsl</seg>
296 <seg>/usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version; and
297 /usr/share/doc/docbook-xsl-nons-&docbook-xsl-version;</seg>
298 </seglistitem>
299 </segmentedlist>
300
301 <variablelist>
302 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
303 <?dbfo list-presentation="list"?>
304 <?dbhtml list-presentation="table"?>
305
306 <varlistentry id="xsl-stylesheets">
307 <term><filename>XSL Stylesheets</filename></term>
308 <listitem>
309 <para>
310 are used for performing transformations on XML files
311 </para>
312 <indexterm zone="docbook-xsl xsl-stylesheets">
313 <primary sortas="g-XSL-Stylesheets">XSL Stylesheets</primary>
314 </indexterm>
315 </listitem>
316 </varlistentry>
317
318 </variablelist>
319
320 </sect2>
321
322</sect1>
Note: See TracBrowser for help on using the repository browser.