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