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