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