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