source: pst/xml/docbook-xsl.xml

trunk
Last change on this file was b9874725, checked in by Bruce Dubbs <bdubbs@…>, 2 months ago

Many tags.

Mostly Programming and Xorg sections and dependencies.

  • Property mode set to 100644
File size: 12.1 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
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 &lfs121_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,
121 <xref role="runtime" linkend="ruby"/>
122 (to utilize the <quote>epub</quote> stylesheets),
123 <xref role="runtime" linkend="zip"/>
124 (to produce <quote>epub3</quote> documents), and
125 <ulink url="https://sourceforge.net/projects/saxon/files/saxon6/">
126 Saxon6
127 </ulink> and
128 <ulink url="http://xerces.apache.org/xerces2-j/">Xerces2 Java</ulink>
129 (used with <xref role="runtime" linkend="apache-ant"/>
130 to produce <quote>webhelp</quote> documents)
131 </para>
132
133
134 </sect2>
135
136 <sect2 role="installation">
137 <title>Installation of DocBook XSL Stylesheets</title>
138
139 <para>
140 First, fix a problem that causes stack overflows when doing recursion:
141 </para>
142
143<screen><userinput>patch -Np1 -i ../docbook-xsl-nons-&docbook-xsl-version;-stack_fix-1.patch</userinput></screen>
144
145 <para>
146 If you downloaded the optional documentation tarball, unpack it
147 with the following command:
148 </para>
149
150<screen><userinput>tar -xf ../docbook-xsl-doc-&docbook-xsl-version;.tar.bz2 --strip-components=1</userinput></screen>
151
152 <para>
153 BLFS does not install the required packages to run the test suite
154 and provide meaningful results.
155 </para>
156
157 <para>
158 Install <application>DocBook XSL Stylesheets</application>
159 by running the following commands as the
160 <systemitem class="username">root</systemitem> user:
161 </para>
162
163<screen role="root"><userinput>install -v -m755 -d /usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version; &amp;&amp;
164
165cp -v -R VERSION assembly common eclipse epub epub3 extensions fo \
166 highlighting html htmlhelp images javahelp lib manpages params \
167 profiling roundtrip slides template tests tools webhelp website \
168 xhtml xhtml-1_1 xhtml5 \
169 /usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version; &amp;&amp;
170
171ln -s VERSION /usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version;/VERSION.xsl &amp;&amp;
172
173install -v -m644 -D README \
174 /usr/share/doc/docbook-xsl-nons-&docbook-xsl-version;/README.txt &amp;&amp;
175install -v -m644 RELEASE-NOTES* NEWS* \
176 /usr/share/doc/docbook-xsl-nons-&docbook-xsl-version;</userinput></screen>
177
178 <para>
179 If you downloaded the optional documentation tarball, install the
180 documentation by issuing the following command as the
181 <systemitem class="username">root</systemitem> user:
182 </para>
183
184<screen role="root"><userinput>cp -v -R doc/* /usr/share/doc/docbook-xsl-nons-&docbook-xsl-version;</userinput></screen>
185
186 </sect2>
187
188 <sect2 role="configuration">
189 <title>Configuring DocBook XSL Stylesheets</title>
190
191 <sect3 id="docbook-xsl-config">
192 <title>Config Files</title>
193
194 <para>
195 <filename>/etc/xml/catalog</filename>
196 </para>
197
198 <indexterm zone="docbook-xsl docbook-xsl-config">
199 <primary sortas="e-etc-xml-catalog">/etc/xml/catalog</primary>
200 </indexterm>
201
202 </sect3>
203
204 <sect3>
205 <title>Configuration Information</title>
206
207 <note>
208 <para>
209 If you are installing the current version of docbook-xsl-nons
210 over a previous version of docbook-xsl, then remove the old
211 rewrite entries in the catalog as the <systemitem
212 class="username">root</systemitem> user:
213 </para>
214
215<screen role="nodump"><userinput>sed -i '/rewrite/d' /etc/xml/catalog</userinput></screen>
216 </note>
217
218 <para>
219 Create (or append) and populate the XML catalog file using the
220 following commands as the <systemitem
221 class="username">root</systemitem> user (both <emphasis>http</emphasis>
222 and <emphasis>https</emphasis> forms are used because upstream
223 have had both in their documentation):
224 </para>
225
226<screen role="root"><userinput>if [ ! -d /etc/xml ]; then install -v -m755 -d /etc/xml; fi &amp;&amp;
227if [ ! -f /etc/xml/catalog ]; then
228 xmlcatalog --noout --create /etc/xml/catalog
229fi &amp;&amp;
230
231xmlcatalog --noout --add "rewriteSystem" \
232 "http://cdn.docbook.org/release/xsl-nons/&docbook-xsl-version;" \
233 "/usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version;" \
234 /etc/xml/catalog &amp;&amp;
235
236xmlcatalog --noout --add "rewriteSystem" \
237 "https://cdn.docbook.org/release/xsl-nons/&docbook-xsl-version;" \
238 "/usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version;" \
239 /etc/xml/catalog &amp;&amp;
240
241xmlcatalog --noout --add "rewriteURI" \
242 "http://cdn.docbook.org/release/xsl-nons/&docbook-xsl-version;" \
243 "/usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version;" \
244 /etc/xml/catalog &amp;&amp;
245
246xmlcatalog --noout --add "rewriteURI" \
247 "https://cdn.docbook.org/release/xsl-nons/&docbook-xsl-version;" \
248 "/usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version;" \
249 /etc/xml/catalog &amp;&amp;
250
251xmlcatalog --noout --add "rewriteSystem" \
252 "http://cdn.docbook.org/release/xsl-nons/current" \
253 "/usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version;" \
254 /etc/xml/catalog &amp;&amp;
255
256xmlcatalog --noout --add "rewriteSystem" \
257 "https://cdn.docbook.org/release/xsl-nons/current" \
258 "/usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version;" \
259 /etc/xml/catalog &amp;&amp;
260
261xmlcatalog --noout --add "rewriteURI" \
262 "http://cdn.docbook.org/release/xsl-nons/current" \
263 "/usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version;" \
264 /etc/xml/catalog &amp;&amp;
265
266xmlcatalog --noout --add "rewriteURI" \
267 "https://cdn.docbook.org/release/xsl-nons/current" \
268 "/usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version;" \
269 /etc/xml/catalog &amp;&amp;
270
271xmlcatalog --noout --add "rewriteSystem" \
272 "http://docbook.sourceforge.net/release/xsl/current" \
273 "/usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version;" \
274 /etc/xml/catalog &amp;&amp;
275
276xmlcatalog --noout --add "rewriteURI" \
277 "http://docbook.sourceforge.net/release/xsl/current" \
278 "/usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version;" \
279 /etc/xml/catalog</userinput></screen>
280
281 <para>
282 Occasionally, you may find the need to install other versions of the
283 XSL stylesheets as some projects reference a specific version. One
284 example is BLFS-6.0, which required the 1.67.2 version. In these
285 instances you should install any other required version in its own
286 versioned directory and create catalog entries as follows (substitute
287 the desired version number for
288 <replaceable>&lt;version&gt;</replaceable>):
289 </para>
290
291<screen role="nodump"><userinput>xmlcatalog --noout --add "rewriteSystem" \
292 "http://docbook.sourceforge.net/release/xsl/<replaceable>&lt;version&gt;</replaceable>" \
293 "/usr/share/xml/docbook/xsl-stylesheets-<replaceable>&lt;version&gt;</replaceable>" \
294 /etc/xml/catalog &amp;&amp;
295
296xmlcatalog --noout --add "rewriteURI" \
297 "http://docbook.sourceforge.net/release/xsl/<replaceable>&lt;version&gt;</replaceable>" \
298 "/usr/share/xml/docbook/xsl-stylesheets-<replaceable>&lt;version&gt;</replaceable>" \
299 /etc/xml/catalog</userinput></screen>
300
301 </sect3>
302
303 </sect2>
304
305 <sect2 role="content">
306 <title>Contents</title>
307
308 <segmentedlist>
309 <segtitle>Installed Files</segtitle>
310 <segtitle>Installed Directories</segtitle>
311
312 <seglistitem>
313 <seg>/usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version;/*/*.xsl</seg>
314 <seg>/usr/share/xml/docbook/xsl-stylesheets-nons-&docbook-xsl-version; and
315 /usr/share/doc/docbook-xsl-nons-&docbook-xsl-version;</seg>
316 </seglistitem>
317 </segmentedlist>
318
319 <variablelist>
320 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
321 <?dbfo list-presentation="list"?>
322 <?dbhtml list-presentation="table"?>
323
324 <varlistentry id="xsl-stylesheets">
325 <term><filename>XSL Stylesheets</filename></term>
326 <listitem>
327 <para>
328 are used for performing transformations on XML files
329 </para>
330 <indexterm zone="docbook-xsl xsl-stylesheets">
331 <primary sortas="g-XSL-Stylesheets">XSL Stylesheets</primary>
332 </indexterm>
333 </listitem>
334 </varlistentry>
335
336 </variablelist>
337
338 </sect2>
339
340</sect1>
Note: See TracBrowser for help on using the repository browser.