source: pst/xml/docbook.xml@ 2c1ff38

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 6.2 6.2.0 6.2.0-rc1 6.2.0-rc2 6.3 6.3-rc1 6.3-rc2 6.3-rc3 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts krejzi/svn lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 2c1ff38 was 0aeb696, checked in by Randy McMurchy <randy@…>, 18 years ago

Added a comment to each file that may need a mention of a test suite added to it, this allows closing of bug #1697

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@5951 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 11.6 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!-- Inserted as a reminder to do this. The mention of a test suite
8 is usually right before the root user installation commands. Please
9 delete these 12 (including one blank) lines after you are done.-->
10
11 <!-- Use one of the two mentions below about a test suite,
12 delete the line that is not applicable. Of course, if the
13 test suite uses syntax other than "make check", revise the
14 line to reflect the actual syntax to run the test suite -->
15
16 <!-- <para>This package does not come with a test suite.</para> -->
17 <!-- <para>To test the results, issue: <command>make check</command>.</para> -->
18
19 <!ENTITY DocBook-download-http "http://www.docbook.org/xml/&DocBook-version;/docbook-xml-&DocBook-version;.zip">
20 <!ENTITY DocBook-download-ftp "ftp://ftp.fu-berlin.de/unix/linux/mirrors/gentoo/distfiles/docbook-xml-&DocBook-version;.zip">
21 <!ENTITY DocBook-md5sum "cbb04e9a700955d88c50962ef22c1634">
22 <!ENTITY DocBook-size "96 KB">
23 <!ENTITY DocBook-buildsize "1.2 MB">
24 <!ENTITY DocBook-time "less than 0.1 SBU">
25]>
26
27<sect1 id="DocBook" xreflabel="DocBook XML DTD-&DocBook-version;">
28 <?dbhtml filename="DocBook.html"?>
29
30 <sect1info>
31 <othername>$LastChangedBy$</othername>
32 <date>$Date$</date>
33 <keywordset>
34 <keyword role="package">docbook-xml-&DocBook-version;.zip</keyword>
35 <keyword role="ftpdir">docbook-xml</keyword>
36 </keywordset>
37 </sect1info>
38
39 <title>DocBook XML DTD-&DocBook-version;</title>
40
41 <indexterm zone="DocBook">
42 <primary sortas="a-DocBook-XML-DTD">DocBook XML DTD</primary>
43 </indexterm>
44
45 <sect2 role="package">
46 <title>Introduction to DocBook XML DTD</title>
47
48 <para>The <application>DocBook XML DTD</application>-&DocBook-version;
49 package contains document type definitions for verification of XML data
50 files against the DocBook rule set. These are useful for structuring books
51 and software documentation to a standard allowing you to utilize
52 transformations already written for that standard.</para>
53
54 <bridgehead renderas="sect3">Package Information</bridgehead>
55 <itemizedlist spacing="compact">
56 <listitem>
57 <para>Download (HTTP): <ulink url="&DocBook-download-http;"/></para>
58 </listitem>
59 <listitem>
60 <para>Download (FTP): <ulink url="&DocBook-download-ftp;"/></para>
61 </listitem>
62 <listitem>
63 <para>Download MD5 sum: &DocBook-md5sum;</para>
64 </listitem>
65 <listitem>
66 <para>Download size: &DocBook-size;</para>
67 </listitem>
68 <listitem>
69 <para>Estimated disk space required: &DocBook-buildsize;</para>
70 </listitem>
71 <listitem>
72 <para>Estimated build time: &DocBook-time;</para>
73 </listitem>
74 </itemizedlist>
75
76 <bridgehead renderas="sect3">DocBook XML DTD Dependencies</bridgehead>
77
78 <bridgehead renderas="sect4">Required</bridgehead>
79 <para role="required"><xref linkend="libxml2"/> and
80 <xref linkend="unzip"/></para>
81
82 <para condition="html" role="usernotes">User Notes:
83 <ulink url="&blfs-wiki;/docbook"/></para>
84
85 </sect2>
86
87 <sect2 role="installation">
88 <title>Installation of DocBook XML DTD</title>
89
90 <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
91 href="../../use-unzip.xml"/>
92
93 <para>Install <application>DocBook XML DTD</application> by running the
94 following commands as the <systemitem class="username">root</systemitem>
95 user:</para>
96
97<screen role="root"><userinput>install -v -d -m755 /usr/share/xml/docbook/xml-dtd-&DocBook-version; &amp;&amp;
98install -v -d -m755 /etc/xml &amp;&amp;
99chown -R root:root . &amp;&amp;
100cp -v -af docbook.cat *.dtd ent/ *.mod \
101 /usr/share/xml/docbook/xml-dtd-&DocBook-version;</userinput></screen>
102
103 <para>Create (or update) and populate the
104 <filename>/etc/xml/docbook</filename> catalog file by running the following
105 commands as the <systemitem class="username">root</systemitem> user:</para>
106
107<screen role="root"><userinput>if [ ! -e /etc/xml/docbook ]; then
108 xmlcatalog --noout --create /etc/xml/docbook
109fi &amp;&amp;
110xmlcatalog --noout --add "public" \
111 "-//OASIS//DTD DocBook XML V&DocBook-version;//EN" \
112 "http://www.oasis-open.org/docbook/xml/&DocBook-version;/docbookx.dtd" \
113 /etc/xml/docbook &amp;&amp;
114xmlcatalog --noout --add "public" \
115 "-//OASIS//DTD DocBook XML CALS Table Model V&DocBook-version;//EN" \
116 "file:///usr/share/xml/docbook/xml-dtd-&DocBook-version;/calstblx.dtd" \
117 /etc/xml/docbook &amp;&amp;
118xmlcatalog --noout --add "public" \
119 "-//OASIS//DTD XML Exchange Table Model 19990315//EN" \
120 "file:///usr/share/xml/docbook/xml-dtd-&DocBook-version;/soextblx.dtd" \
121 /etc/xml/docbook &amp;&amp;
122xmlcatalog --noout --add "public" \
123 "-//OASIS//ELEMENTS DocBook XML Information Pool V&DocBook-version;//EN" \
124 "file:///usr/share/xml/docbook/xml-dtd-&DocBook-version;/dbpoolx.mod" \
125 /etc/xml/docbook &amp;&amp;
126xmlcatalog --noout --add "public" \
127 "-//OASIS//ELEMENTS DocBook XML Document Hierarchy V&DocBook-version;//EN" \
128 "file:///usr/share/xml/docbook/xml-dtd-&DocBook-version;/dbhierx.mod" \
129 /etc/xml/docbook &amp;&amp;
130xmlcatalog --noout --add "public" \
131 "-//OASIS//ELEMENTS DocBook XML HTML Tables V&DocBook-version;//EN" \
132 "file:///usr/share/xml/docbook/xml-dtd-&DocBook-version;/htmltblx.mod" \
133 /etc/xml/docbook
134xmlcatalog --noout --add "public" \
135 "-//OASIS//ENTITIES DocBook XML Notations V&DocBook-version;//EN" \
136 "file:///usr/share/xml/docbook/xml-dtd-&DocBook-version;/dbnotnx.mod" \
137 /etc/xml/docbook &amp;&amp;
138xmlcatalog --noout --add "public" \
139 "-//OASIS//ENTITIES DocBook XML Character Entities V&DocBook-version;//EN" \
140 "file:///usr/share/xml/docbook/xml-dtd-&DocBook-version;/dbcentx.mod" \
141 /etc/xml/docbook &amp;&amp;
142xmlcatalog --noout --add "public" \
143 "-//OASIS//ENTITIES DocBook XML Additional General Entities V&DocBook-version;//EN" \
144 "file:///usr/share/xml/docbook/xml-dtd-&DocBook-version;/dbgenent.mod" \
145 /etc/xml/docbook &amp;&amp;
146xmlcatalog --noout --add "rewriteSystem" \
147 "http://www.oasis-open.org/docbook/xml/&DocBook-version;" \
148 "file:///usr/share/xml/docbook/xml-dtd-&DocBook-version;" \
149 /etc/xml/docbook &amp;&amp;
150xmlcatalog --noout --add "rewriteURI" \
151 "http://www.oasis-open.org/docbook/xml/&DocBook-version;" \
152 "file:///usr/share/xml/docbook/xml-dtd-&DocBook-version;" \
153 /etc/xml/docbook</userinput></screen>
154
155 <para>Create (or update) and populate the
156 <filename>/etc/xml/catalog</filename> catalog file by running the following
157 commands as the <systemitem class="username">root</systemitem> user:</para>
158
159<screen role="root"><userinput>if [ ! -e /etc/xml/catalog ]; then
160 xmlcatalog --noout --create /etc/xml/catalog
161fi &amp;&amp;
162xmlcatalog --noout --add "delegatePublic" \
163 "-//OASIS//ENTITIES DocBook XML" \
164 "file:///etc/xml/docbook" \
165 /etc/xml/catalog &amp;&amp;
166xmlcatalog --noout --add "delegatePublic" \
167 "-//OASIS//DTD DocBook XML" \
168 "file:///etc/xml/docbook" \
169 /etc/xml/catalog &amp;&amp;
170xmlcatalog --noout --add "delegateSystem" \
171 "http://www.oasis-open.org/docbook/" \
172 "file:///etc/xml/docbook" \
173 /etc/xml/catalog &amp;&amp;
174xmlcatalog --noout --add "delegateURI" \
175 "http://www.oasis-open.org/docbook/" \
176 "file:///etc/xml/docbook" \
177 /etc/xml/catalog</userinput></screen>
178
179 </sect2>
180
181 <sect2 role="configuration">
182 <title>Configuring DocBook XML DTD</title>
183
184 <sect3 id="docbook-config">
185 <title>Config Files</title>
186
187 <para><filename>/etc/xml/catalog</filename>,
188 <filename>/etc/xml/docbook</filename></para>
189
190 <indexterm zone="DocBook docbook-config">
191 <primary sortas="e-etc-xml-docbook">/etc/xml/docbook</primary>
192 </indexterm>
193
194 <indexterm zone="DocBook docbook-config">
195 <primary sortas="e-etc-xml-catalog">/etc/xml/catalog</primary>
196 </indexterm>
197
198 </sect3>
199
200 <sect3>
201 <title>Configuration Information</title>
202
203 <para>The above installation creates the files and updates the catalogs.
204 In order to install <application>ScrollKeeper</application> or to
205 utilize <application>DocBook XML DTD</application> V&DocBook-version;
206 when any version 4.x is requested in the System Identifier, you need to
207 add additional statements to the catalog files. If you have any of the
208 <application>DocBook XML DTD</application>'s referenced below already
209 installed on your system, remove those entries from the
210 <command>for</command> command below (issue the commands as the
211 <systemitem class="username">root</systemitem> user):</para>
212
213<screen role="root"><userinput>for DTDVERSION in 4.1.2 4.2 4.3
214do
215 xmlcatalog --noout --add "public" \
216 "-//OASIS//DTD DocBook XML V$DTDVERSION//EN" \
217 "http://www.oasis-open.org/docbook/xml/$DTDVERSION/docbookx.dtd" \
218 /etc/xml/docbook
219 xmlcatalog --noout --add "rewriteSystem" \
220 "http://www.oasis-open.org/docbook/xml/$DTDVERSION" \
221 "file:///usr/share/xml/docbook/xml-dtd-&DocBook-version;" \
222 /etc/xml/docbook
223 xmlcatalog --noout --add "rewriteURI" \
224 "http://www.oasis-open.org/docbook/xml/$DTDVERSION" \
225 "file:///usr/share/xml/docbook/xml-dtd-&DocBook-version;" \
226 /etc/xml/docbook
227 xmlcatalog --noout --add "delegateSystem" \
228 "http://www.oasis-open.org/docbook/xml/$DTDVERSION/" \
229 "file:///etc/xml/docbook" \
230 /etc/xml/catalog
231 xmlcatalog --noout --add "delegateURI" \
232 "http://www.oasis-open.org/docbook/xml/$DTDVERSION/" \
233 "file:///etc/xml/docbook" \
234 /etc/xml/catalog
235done</userinput></screen>
236
237 </sect3>
238
239 </sect2>
240
241 <sect2 role="content">
242 <title>Contents</title>
243
244 <segmentedlist>
245 <segtitle>Installed Programs</segtitle>
246 <segtitle>Installed Libraries</segtitle>
247 <segtitle>Installed Files</segtitle>
248 <segtitle>Installed Directories</segtitle>
249
250 <seglistitem>
251 <seg>None</seg>
252 <seg>None</seg>
253 <seg>DTD, MOD and ENT files</seg>
254 <seg>/etc/xml and /usr/share/xml/docbook/xml-dtd-&DocBook-version;</seg>
255 </seglistitem>
256 </segmentedlist>
257
258 <variablelist>
259 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
260 <?dbfo list-presentation="list"?>
261 <?dbhtml list-presentation="table"?>
262
263 <varlistentry id="DTD-files">
264 <term><filename>DTD files</filename></term>
265 <listitem>
266 <para>contain a document type definition which defines the element
267 types and the attribute lists that can be used in the corresponding
268 <filename>XML</filename> files.</para>
269 <indexterm zone="DocBook DTD-files">
270 <primary sortas="g-DTD-files">DTD Files</primary>
271 </indexterm>
272 </listitem>
273 </varlistentry>
274
275 <varlistentry id="MOD-files">
276 <term><filename>MOD files</filename></term>
277 <listitem>
278 <para>files contain components of the document type definition that
279 are sourced into the <filename>DTD</filename> files.</para>
280 <indexterm zone="DocBook MOD-files">
281 <primary sortas="g-MOD-files">MOD files</primary>
282 </indexterm>
283 </listitem>
284 </varlistentry>
285
286 <varlistentry id="ENT-files">
287 <term><filename>ENT files</filename></term>
288 <listitem>
289 <para>files contain lists of named character entities allowed in
290 HTML.</para>
291 <indexterm zone="DocBook ENT-files">
292 <primary sortas="g-ENT-files">ENT-files</primary>
293 </indexterm>
294 </listitem>
295 </varlistentry>
296
297 </variablelist>
298
299 </sect2>
300
301</sect1>
Note: See TracBrowser for help on using the repository browser.