1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
docbook-simple for Debian
-----------------------------
The Simplified DocBook XML DTD is a small subset of the DocBook XML DTD
having only ~100 elements. The full version has >350 elements.
Online documentation of the content models for this dtd is here:
http://www.oasis-open.org/docbook/xml/simple/
This DTD only supports simple documents, e.g. 'article' or 'refentry', rather
than the more complex documents like 'book' or 'set' which is supported by the
full docbook DTD.
I. How to write an article that uses the Simplified Docbook DTDs:
==================================================================
Use one of the following two prologs in your XML file to use
the Simplified DocBook Document Type in your document prolog:
EITHER --------------------------------------------------------------
<?xml version="1.0"?>
<!DOCTYPE article PUBLIC
"-//OASIS//DTD Simplified DocBook XML V1.1//EN"
"http://www.oasis-open.org/docbook/xml/simple/1.1/sdocbook.dtd">
<article>
...
</article>
OR ------------------------------------------------------------------
if you wish to customize the Simplified DocBook DTD...
<?xml version="1.0"?>
<!DOCTYPE article PUBLIC
"-//OASIS//DTD Simplified DocBook XML Customization V1.1//EN"
"http://www.oasis-open.org/docbook/xml/simple/1.1/sdocbook-custom.dtd">
<article>
...
</article>
II. How to write a manual page that uses the Simplified DocBook DTDs:
======================================================================
The sdocbookref.dtd (and sdocbookref-custom.dtd) provide a simplified subset
of DocBook to support writing manual pages.
Use one of the following two prologs in your XML file to use
the Simplified DocBook Document Type in your document prolog:
EITHER --------------------------------------------------------------
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC
"-//OASIS//DTD Simplified DocBook RefEntry XML V1.1//EN"
"http://www.oasis-open.org/docbook/xml/simple/1.1/sdocbookref.dtd">
<refentry>
...
</refentry>
OR ------------------------------------------------------------------
if wish to customize the Simplified Refentry DTD...
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC
"-//OASIS//DTD Simplified DocBook RefEntry XML Customization V1.1//EN"
"http://www.oasis-open.org/docbook/xml/simple/1.1/sdocbookref-custom.dtd">
<refentry>
...
</refentry>
III. How to validate a document that uses the Simplified Docbook DTD:
======================================================================
If you have the libxml2 package installed, then you can use the
command 'xmllint' to validate a document.
The following is the contents of a file named "simple.xml":
<?xml version="1.0"?>
<!DOCTYPE article PUBLIC
"-//OASIS//DTD Simplified DocBook XML V1.0//EN"
"http://www.oasis-open.org/docbook/xml/simple/1.0/sdocbook.dtd">
<article>
<para>This is a test.</para>
</article>
Then this document can be validated using:
SGML_CATALOG_FILES=/etc/sgml/catalog xmllint --valid --catalogs simple.xml
See also the Makefile and examples in /usr/share/doc/docbook-simple/examples/.
Acknowledgement: This is revision of an extensive README originally written by
Susan Kleinmann <sgk@debian.org>. The revision was written by
Mark Johnson and edited by Daniel Leidert.
-- Daniel Leidert <daniel.leidert@wgdd.de>, Sun, 15 Apr 2007 02:01:35 +0200
|
