source: pst/xml/docbook51.xml

trunk
Last change on this file was 3c9ec7c, checked in by Bruce Dubbs <bdubbs@…>, 5 weeks ago

Add kirigami-addons-1.0.1
  • Property mode set to 100644
File size: 11.7 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
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 docbook51-download-http "https://docbook.org/xml/5.1/docbook-v5.1-os.zip">
8 <!ENTITY docbook51-download-ftp " ">
9 <!ENTITY docbook51-md5sum "d8bea8ddfc5743578a31cb18f9ae1f5a">
10 <!ENTITY docbook51-size "752 KB">
11 <!ENTITY docbook51-buildsize "8.5 MB">
12 <!ENTITY docbook51-time "less than 0.1 SBU">
13]>
14
15<sect1 id="docbook51" xreflabel="docbook-xml-5.1">
16 <?dbhtml filename="docbook51.html"?>
17
18
19 <title>docbook-xml-5.1</title>
20
21 <indexterm zone="docbook51">
22 <primary sortas="a-DocBook51-XML-DTD">DocBook XML Schemas 5.1</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to DocBook XML Schemas 5.1</title>
27
28 <para>
29 The <application>DocBook XML Schemas</application>-5.1 package
30 contains schema files and Schematron rules for verification of XML 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.
34 </para>
35
36 &lfs121_checked;
37
38 <bridgehead renderas="sect3">Package Information</bridgehead>
39 <itemizedlist spacing="compact">
40 <listitem>
41 <para>
42 Download (HTTP): <ulink url="&docbook51-download-http;"/>
43 </para>
44 </listitem>
45 <listitem>
46 <para>
47 Download (FTP): <ulink url="&docbook51-download-ftp;"/>
48 </para>
49 </listitem>
50 <listitem>
51 <para>
52 Download MD5 sum: &docbook51-md5sum;
53 </para>
54 </listitem>
55 <listitem>
56 <para>
57 Download size: &docbook51-size;
58 </para>
59 </listitem>
60 <listitem>
61 <para>
62 Estimated disk space required: &docbook51-buildsize;
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Estimated build time: &docbook51-time;
68 </para>
69 </listitem>
70 </itemizedlist>
71
72 <bridgehead renderas="sect3">DocBook XML Schemas 5.1 Dependencies</bridgehead>
73
74 <bridgehead renderas="sect4">Required</bridgehead>
75 <para role="required">
76 <xref linkend="libxml2"/>,
77 <xref linkend="sgml-common"/>, and
78 <xref linkend="unzip"/> (or <xref role='nodep' linkend='libarchive'/>)
79 </para>
80
81
82 </sect2>
83
84 <sect2 role="installation">
85 <title>Installation of DocBook XML Schemas 5.1</title>
86
87 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
88 href="../../xincludes/use-unzip.xml"/>
89
90 <para>
91 Install <application>DocBook XML Schemas</application>
92 by running the following commands as the
93 <systemitem class="username">root</systemitem> user:
94 </para>
95
96<screen role="root"><userinput>install -vdm755 /usr/share/xml/docbook/schema/{rng,sch}/5.1 &amp;&amp;
97install -m644 schemas/rng/* /usr/share/xml/docbook/schema/rng/5.1 &amp;&amp;
98install -m644 schemas/sch/* /usr/share/xml/docbook/schema/sch/5.1 &amp;&amp;
99install -m755 tools/db4-entities.pl /usr/bin &amp;&amp;
100install -vdm755 /usr/share/xml/docbook/stylesheet/docbook5 &amp;&amp;
101install -m644 tools/db4-upgrade.xsl \
102 /usr/share/xml/docbook/stylesheet/docbook5</userinput></screen>
103
104 <para>
105 Create (or update) and populate the
106 <filename>/etc/xml/docbook-5.1</filename> catalog file by running the
107 following commands as the <systemitem class="username">root</systemitem>
108 user:
109 </para>
110
111<screen role="root"><?dbfo keep-together="auto"?><userinput>if [ ! -e /etc/xml/docbook-5.1 ]; then
112 xmlcatalog --noout --create /etc/xml/docbook-5.1
113fi &amp;&amp;
114
115xmlcatalog --noout --add "uri" \
116 "http://www.oasis-open.org/docbook/xml/5.1/rng/docbook.rng" \
117 "file:///usr/share/xml/docbook/schema/rng/5.1/docbook.rng" \
118 /etc/xml/docbook-5.1 &amp;&amp;
119xmlcatalog --noout --add "uri" \
120 "http://docbook.org/xml/5.1/rng/docbook.rng" \
121 "file:///usr/share/xml/docbook/schema/rng/5.1/docbook.rng" \
122 /etc/xml/docbook-5.1 &amp;&amp;
123xmlcatalog --noout --add "uri" \
124 "http://www.oasis-open.org/docbook/xml/5.1/rng/docbookxi.rng" \
125 "file:///usr/share/xml/docbook/schema/rng/5.1/docbookxi.rng" \
126 /etc/xml/docbook-5.1 &amp;&amp;
127xmlcatalog --noout --add "uri" \
128 "http://docbook.org/xml/5.1/rng/docbookxi.rng" \
129 "file:///usr/share/xml/docbook/schema/rng/5.1/docbookxi.rng" \
130 /etc/xml/docbook-5.1 &amp;&amp;
131xmlcatalog --noout --add "uri" \
132 "http://www.oasis-open.org/docbook/xml/5.1/rnc/docbook.rnc" \
133 "file:///usr/share/xml/docbook/schema/rng/5.1/docbook.rnc" \
134 /etc/xml/docbook-5.1 &amp;&amp;
135xmlcatalog --noout --add "uri" \
136 "http://docbook.org/xml/5.1/rng/docbook.rnc" \
137 "file:///usr/share/xml/docbook/schema/rng/5.1/docbook.rnc" \
138 /etc/xml/docbook-5.1 &amp;&amp;
139xmlcatalog --noout --add "uri" \
140 "http://www.oasis-open.org/docbook/xml/5.1/rnc/docbookxi.rnc" \
141 "file:///usr/share/xml/docbook/schema/rng/5.1/docbookxi.rnc" \
142 /etc/xml/docbook-5.1 &amp;&amp;
143xmlcatalog --noout --add "uri" \
144 "http://docbook.org/xml/5.1/rng/docbookxi.rnc" \
145 "file:///usr/share/xml/docbook/schema/rng/5.1/docbookxi.rnc" \
146 /etc/xml/docbook-5.1 &amp;&amp;
147
148xmlcatalog --noout --add "uri" \
149 "http://www.oasis-open.org/docbook/xml/5.1/sch/docbook.sch" \
150 "file:///usr/share/xml/docbook/schema/sch/5.1/docbook.sch" \
151 /etc/xml/docbook-5.1 &amp;&amp;
152xmlcatalog --noout --add "uri" \
153 "http://docbook.org/xml/5.1/sch/docbook.sch" \
154 "file:///usr/share/xml/docbook/schema/sch/5.1/docbook.sch" \
155 /etc/xml/docbook-5.1</userinput></screen>
156
157
158 <para>
159 While again as the <systemitem class="username">root</systemitem> user,
160 create the individual catalogs:
161 </para>
162
163<screen role="root"><userinput>xmlcatalog --noout --create /usr/share/xml/docbook/schema/rng/5.1/catalog.xml &amp;&amp;
164
165xmlcatalog --noout --add "uri" \
166 "http://docbook.org/xml/5.1/schemas/rng/docbook.schemas/rng" \
167 "docbook.schemas/rng" /usr/share/xml/docbook/schema/rng/5.1/catalog.xml &amp;&amp;
168xmlcatalog --noout --add "uri" \
169 "http://www.oasis-open.org/docbook/xml/5.1/schemas/rng/docbook.schemas/rng" \
170 "docbook.schemas/rng" /usr/share/xml/docbook/schema/rng/5.1/catalog.xml &amp;&amp;
171xmlcatalog --noout --add "uri" \
172 "http://docbook.org/xml/5.1/schemas/rng/docbookxi.schemas/rng" \
173 "docbookxi.schemas/rng" /usr/share/xml/docbook/schema/rng/5.1/catalog.xml &amp;&amp;
174xmlcatalog --noout --add "uri" \
175 "http://www.oasis-open.org/docbook/xml/5.1/schemas/rng/docbookxi.schemas/rng" \
176 "docbookxi.schemas/rng" /usr/share/xml/docbook/schema/rng/5.1/catalog.xml &amp;&amp;
177xmlcatalog --noout --add "uri" \
178 "http://docbook.org/xml/5.1/schemas/rng/docbook.rnc" \
179 "docbook.rnc" /usr/share/xml/docbook/schema/rng/5.1/catalog.xml &amp;&amp;
180xmlcatalog --noout --add "uri" \
181 "http://www.oasis-open.org/docbook/xml/5.1/schemas/rng/docbook.rnc" \
182 "docbook.rnc" /usr/share/xml/docbook/schema/rng/5.1/catalog.xml &amp;&amp;
183xmlcatalog --noout --add "uri" \
184 "http://docbook.org/xml/5.1/schemas/rng/docbookxi.rnc" \
185 "docbookxi.rnc" /usr/share/xml/docbook/schema/rng/5.1/catalog.xml &amp;&amp;
186xmlcatalog --noout --add "uri" \
187 "http://www.oasis-open.org/docbook/xml/5.1/schemas/rng/docbookxi.rnc" \
188 "docbookxi.rnc" /usr/share/xml/docbook/schema/rng/5.1/catalog.xml
189xmlcatalog --noout --create /usr/share/xml/docbook/schema/sch/5.1/catalog.xml &amp;&amp;
190
191xmlcatalog --noout --add "uri" \
192 "http://docbook.org/xml/5.1/schemas/sch/docbook.schemas/sch" \
193 "docbook.schemas/sch" /usr/share/xml/docbook/schema/sch/5.1/catalog.xml &amp;&amp;
194xmlcatalog --noout --add "uri" \
195 "http://www.oasis-open.org/docbook/xml/5.1/schemas/sch/docbook.schemas/sch" \
196 "docbook.schemas/sch" /usr/share/xml/docbook/schema/sch/5.1/catalog.xml</userinput></screen>
197
198 <para>
199 Create (or update) and populate the system XML catalog
200 (<filename>/etc/xml/catalog</filename>) by running the
201 following commands as the <systemitem class="username">root</systemitem>
202 user:
203 </para>
204
205<screen role="root"><userinput>if [ ! -e /etc/xml/catalog ]; then
206 xmlcatalog --noout --create /etc/xml/catalog
207fi &amp;&amp;
208xmlcatalog --noout --add "delegatePublic" \
209 "-//OASIS//DTD DocBook XML 5.1//EN" \
210 "file:///usr/share/xml/docbook/schema/dtd/5.1/catalog.xml" \
211 /etc/xml/catalog &amp;&amp;
212xmlcatalog --noout --add "delegateSystem" \
213 "http://docbook.org/xml/5.1/dtd/" \
214 "file:///usr/share/xml/docbook/schema/dtd/5.1/catalog.xml" \
215 /etc/xml/catalog &amp;&amp;
216xmlcatalog --noout --add "delegateURI" \
217 "http://docbook.org/xml/5.1/dtd/" \
218 "file:///usr/share/xml/docbook/schema/dtd/5.1/catalog.xml" \
219 /etc/xml/catalog &amp;&amp;
220xmlcatalog --noout --add "delegateURI" \
221 "http://docbook.org/xml/5.1/rng/" \
222 "file:///usr/share/xml/docbook/schema/rng/5.1/catalog.xml" \
223 /etc/xml/catalog &amp;&amp;
224xmlcatalog --noout --add "delegateURI" \
225 "http://docbook.org/xml/5.1/sch/" \
226 "file:///usr/share/xml/docbook/schema/sch/5.1/catalog.xml" \
227 /etc/xml/catalog &amp;&amp;
228xmlcatalog --noout --add "delegateURI" \
229 "http://docbook.org/xml/5.1/xsd/" \
230 "file:///usr/share/xml/docbook/schema/xsd/5.1/catalog.xml" \
231 /etc/xml/catalog</userinput></screen>
232
233 </sect2>
234
235 <sect2 role="configuration">
236 <title>Configuring DocBook XML Schemas 5.1</title>
237
238 <sect3 id="docbook51-config">
239 <title>Config Files</title>
240
241 <para>
242 <filename>/etc/xml/catalog</filename> and
243 <filename>/etc/xml/docbook-5.1</filename>
244 </para>
245
246 <indexterm zone="docbook51 docbook-config">
247 <primary sortas="e-etc-xml-docbook51">/etc/xml/docbook-5.1</primary>
248 </indexterm>
249
250 <indexterm zone="docbook51 docbook-config">
251 <primary sortas="e-etc-xml-catalog51">/etc/xml/catalog</primary>
252 </indexterm>
253
254 </sect3>
255
256 </sect2>
257
258 <sect2 role="content">
259 <title>Contents</title>
260
261 <segmentedlist>
262 <segtitle>Installed Programs</segtitle>
263 <segtitle>Installed Files</segtitle>
264 <segtitle>Installed Directories</segtitle>
265
266 <seglistitem>
267 <seg>db4-entities.pl</seg>
268 <seg>RNC, RNG, SCH, and XSL files</seg>
269 <seg>/etc/xml, /usr/share/xml/docbook/stylesheets, and
270 /usr/share/xml/docbook/schema/{rng,sch}/5.1</seg>
271 </seglistitem>
272 </segmentedlist>
273
274 <variablelist>
275 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
276 <?dbfo list-presentation="list"?>
277 <?dbhtml list-presentation="table"?>
278
279 <varlistentry id="db4-entries-pl">
280 <term><filename>db4-entities.pl</filename></term>
281 <listitem>
282 <para>
283 is a script to convert DocBook 4.x files to DocBook 5.1
284 </para>
285 <indexterm zone="docbook51 db4-entries-pl">
286 <primary sortas="b-db4-entries-pl">db4-entities.pl</primary>
287 </indexterm>
288 </listitem>
289 </varlistentry>
290
291 <varlistentry id="Schema51-files">
292 <term><filename>RNC, RNG, and SCH files</filename></term>
293 <listitem>
294 <para>
295 contain the Docbook 5.1 RelaxNG, RelaxNG Compact, and Schematron
296 schema definitions
297 </para>
298 <indexterm zone="docbook51 Schema51-files">
299 <primary sortas="g-XML-Schema-files">XML Schema files</primary>
300 </indexterm>
301 </listitem>
302 </varlistentry>
303
304 <varlistentry id="db4-upgrade-xsl">
305 <term><filename>db4-upgrade.xsl</filename></term>
306 <listitem>
307 <para>
308 is an XSL stylesheet to assist in conversion from DocBook 4.x files
309 to DocBook 5.1
310 </para>
311 <indexterm zone="docbook51 db4-upgrade-xsl">
312 <primary sortas="g-XSL-Stylesheets">XSL Stylesheets</primary>
313 </indexterm>
314 </listitem>
315 </varlistentry>
316
317 </variablelist>
318
319 </sect2>
320
321</sect1>
Note: See TracBrowser for help on using the repository browser.