source: pst/xml/docbook-xsl.xml@ 3cb77ad

12.0 12.1 ken/TL2024 ken/tuningfonts lazarus plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18
Last change on this file since 3cb77ad was 9a4c8a4e, checked in by Xi Ruoyao <xry111@…>, 12 months ago

pst: Remove non-exist User Notes link

Part of User Notes removal by
https://www.linuxfromscratch.org/~xry111/remove-nonexist-usernote.sh

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