Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libxml2 / d30be4add765e2c16840c4f2aab25f447384c7b2 / . / doc / xmldtd.html
blob: 817934298c254ad0d2d2b35a8fa728f882fb6ee6 [file] [log] [blame]
Daniel Veillard43d3f612001-11-10 11:57:23 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]2<html>
3<head>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
5<style type="text/css"><!--
Daniel Veillard373a4752002-02-21 14:46:29 +0000[diff] [blame]6TD {font-family: Verdana,Arial,Helvetica}
7BODY {font-family: Verdana,Arial,Helvetica; margin-top: 2em; margin-left: 0em; margin-right: 0em}
8H1 {font-family: Verdana,Arial,Helvetica}
9H2 {font-family: Verdana,Arial,Helvetica}
10H3 {font-family: Verdana,Arial,Helvetica}
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]11A:link, A:visited, A:active { text-decoration: underline }
12--></style>
13<title>Validation &amp; DTDs</title>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]14</head>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]15<body bgcolor="#8b7765" text="#000000" link="#000000" vlink="#000000">
16<table border="0" width="100%" cellpadding="5" cellspacing="0" align="center"><tr>
17<td width="180">
18<a href="http://www.gnome.org/"><img src="smallfootonly.gif" alt="Gnome Logo"></a><a href="http://www.w3.org/Status"><img src="w3c.png" alt="W3C Logo"></a><a href="http://www.redhat.com/"><img src="redhat.gif" alt="Red Hat Logo"></a>
19</td>
20<td><table border="0" width="90%" cellpadding="2" cellspacing="0" align="center" bgcolor="#000000"><tr><td><table width="100%" border="0" cellspacing="1" cellpadding="3" bgcolor="#fffacd"><tr><td align="center">
21<h1>The XML C library for Gnome</h1>
22<h2>Validation &amp; DTDs</h2>
23</td></tr></table></td></tr></table></td>
24</tr></table>
25<table border="0" cellpadding="4" cellspacing="0" width="100%" align="center"><tr><td bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr>
26<td valign="top" width="200" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td>
27<table width="100%" border="0" cellspacing="1" cellpadding="3">
28<tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Main Menu</b></center></td></tr>
Daniel Veillard8acca112002-01-21 09:52:27 +0000[diff] [blame]29<tr><td bgcolor="#fffacd"><ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]30<li><a href="index.html">Home</a></li>
31<li><a href="intro.html">Introduction</a></li>
32<li><a href="FAQ.html">FAQ</a></li>
33<li><a href="docs.html">Documentation</a></li>
34<li><a href="bugs.html">Reporting bugs and getting help</a></li>
35<li><a href="help.html">How to help</a></li>
36<li><a href="downloads.html">Downloads</a></li>
37<li><a href="news.html">News</a></li>
Daniel Veillard7b602b42002-01-08 13:26:00 +0000[diff] [blame]38<li><a href="XMLinfo.html">XML</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]39<li><a href="XSLT.html">XSLT</a></li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]40<li><a href="python.html">Python and bindings</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]41<li><a href="architecture.html">libxml architecture</a></li>
42<li><a href="tree.html">The tree output</a></li>
43<li><a href="interface.html">The SAX interface</a></li>
44<li><a href="xmldtd.html">Validation &amp; DTDs</a></li>
45<li><a href="xmlmem.html">Memory Management</a></li>
46<li><a href="encoding.html">Encodings support</a></li>
47<li><a href="xmlio.html">I/O Interfaces</a></li>
48<li><a href="catalog.html">Catalog support</a></li>
49<li><a href="library.html">The parser interfaces</a></li>
50<li><a href="entities.html">Entities or no entities</a></li>
51<li><a href="namespaces.html">Namespaces</a></li>
52<li><a href="upgrade.html">Upgrading 1.x code</a></li>
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]53<li><a href="threads.html">Thread safety</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]54<li><a href="DOM.html">DOM Principles</a></li>
55<li><a href="example.html">A real example</a></li>
56<li><a href="contribs.html">Contributions</a></li>
57<li>
58<a href="xml.html">flat page</a>, <a href="site.xsl">stylesheet</a>
59</li>
60</ul></td></tr>
61</table>
62<table width="100%" border="0" cellspacing="1" cellpadding="3">
Daniel Veillard3bf65be2002-01-23 12:36:34 +0000[diff] [blame]63<tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>API Indexes</b></center></td></tr>
64<tr><td bgcolor="#fffacd"><ul>
Daniel Veillardf8592562002-01-23 17:58:17 +0000[diff] [blame]65<li><a href="APIchunk0.html">Alphabetic</a></li>
Daniel Veillard3bf65be2002-01-23 12:36:34 +0000[diff] [blame]66<li><a href="APIconstructors.html">Constructors</a></li>
67<li><a href="APIfunctions.html">Functions/Types</a></li>
68<li><a href="APIfiles.html">Modules</a></li>
69<li><a href="APIsymbols.html">Symbols</a></li>
70</ul></td></tr>
71</table>
72<table width="100%" border="0" cellspacing="1" cellpadding="3">
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]73<tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Related links</b></center></td></tr>
Daniel Veillard8acca112002-01-21 09:52:27 +0000[diff] [blame]74<tr><td bgcolor="#fffacd"><ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]75<li><a href="http://mail.gnome.org/archives/xml/">Mail archive</a></li>
76<li><a href="http://xmlsoft.org/XSLT/">XSLT libxslt</a></li>
Daniel Veillard4a859202002-01-08 11:49:22 +0000[diff] [blame]77<li><a href="http://phd.cs.unibo.it/gdome2/">DOM gdome2</a></li>
Daniel Veillard2d347fa2002-03-17 10:34:11 +0000[diff] [blame]78<li><a href="http://www.aleksey.com/xmlsec/">XML-DSig xmlsec</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]79<li><a href="ftp://xmlsoft.org/">FTP</a></li>
80<li><a href="http://www.fh-frankfurt.de/~igor/projects/libxml/">Windows binaries</a></li>
Daniel Veillarddb9dfd92001-11-26 17:25:02 +0000[diff] [blame]81<li><a href="http://garypennington.net/libxml2/">Solaris binaries</a></li>
Daniel Veillard2d347fa2002-03-17 10:34:11 +0000[diff] [blame]82<li><a href="http://bugzilla.gnome.org/buglist.cgi?product=libxml&amp;product=libxml2">Bug Tracker</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]83</ul></td></tr>
84</table>
85</td></tr></table></td>
86<td valign="top" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%"><tr><td><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td><table border="0" cellpadding="3" cellspacing="1" width="100%"><tr><td bgcolor="#fffacd">
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]87<p>Table of Content:</p>
88<ol>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]89<li><a href="#General5">General overview</a></li>
90<li><a href="#definition">The definition</a></li>
91<li>
92<a href="#Simple">Simple rules</a><ol>
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]93<li><a href="#reference">How to reference a DTD from a document</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]94<li><a href="#Declaring">Declaring elements</a></li>
95<li><a href="#Declaring1">Declaring attributes</a></li>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]96</ol>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]97</li>
98<li><a href="#Some">Some examples</a></li>
99<li><a href="#validate">How to validate</a></li>
100<li><a href="#Other">Other resources</a></li>
101</ol>
102<h3><a name="General5">General overview</a></h3>
103<p>Well what is validation and what is a DTD ?</p>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]104<p>DTD is the acronym for Document Type Definition. This is a description of
105the content for a familly of XML files. This is part of the XML 1.0
106specification, and alows to describe and check that a given document instance
Daniel Veillard64e73902000-11-24 13:28:38 +0000[diff] [blame]107conforms to a set of rules detailing its structure and content.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]108<p>Validation is the process of checking a document against a DTD (more
109generally against a set of construction rules).</p>
110<p>The validation process and building DTDs are the two most difficult parts
111of the XML life cycle. Briefly a DTD defines all the possibles element to be
112found within your document, what is the formal shape of your document tree
113(by defining the allowed content of an element, either text, a regular
114expression for the allowed list of children, or mixed content i.e. both text
115and children). The DTD also defines the allowed attributes for all elements
116and the types of the attributes.</p>
117<h3><a name="definition1">The definition</a></h3>
118<p>The <a href="http://www.w3.org/TR/REC-xml">W3C XML Recommendation</a> (<a href="http://www.xml.com/axml/axml.html">Tim Bray's annotated version of
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]119Rev1</a>):</p>
120<ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]121<li><a href="http://www.w3.org/TR/REC-xml#elemdecls">Declaring
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]122 elements</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]123<li><a href="http://www.w3.org/TR/REC-xml#attdecls">Declaring
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]124 attributes</a></li>
125</ul>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]126<p>(unfortunately) all this is inherited from the SGML world, the syntax is
127ancient...</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]128<h3><a name="Simple1">Simple rules</a></h3>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]129<p>Writing DTD can be done in multiple ways, the rules to build them if you
130need something fixed or something which can evolve over time can be radically
131different. Really complex DTD like Docbook ones are flexible but quite harder
132to design. I will just focuse on DTDs for a formats with a fixed simple
133structure. It is just a set of basic rules, and definitely not exhaustive nor
134useable for complex DTD design.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]135<h4>
136<a name="reference1">How to reference a DTD from a document</a>:</h4>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]137<p>Assuming the top element of the document is <code>spec</code> and the dtd
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]138is placed in the file <code>mydtd</code> in the subdirectory
139<code>dtds</code> of the directory from where the document were loaded:</p>
140<p><code>&lt;!DOCTYPE spec SYSTEM &quot;dtds/mydtd&quot;&gt;</code></p>
Daniel Veillard64e73902000-11-24 13:28:38 +0000[diff] [blame]141<p>Notes:</p>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]142<ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]143<li>the system string is actually an URI-Reference (as defined in <a href="http://www.ietf.org/rfc/rfc2396.txt">RFC 2396</a>) so you can use a
Daniel Veillard64e73902000-11-24 13:28:38 +0000[diff] [blame]144 full URL string indicating the location of your DTD on the Web, this is a
145 really good thing to do if you want others to validate your document</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]146<li>it is also possible to associate a <code>PUBLIC</code> identifier (a
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]147 magic string) so that the DTd is looked up in catalogs on the client side
Daniel Veillard64e73902000-11-24 13:28:38 +0000[diff] [blame]148 without having to locate it on the web</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]149<li>a dtd contains a set of elements and attributes declarations, but they
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]150 don't define what the root of the document should be. This is explicitely
151 told to the parser/validator as the first element of the
152 <code>DOCTYPE</code> declaration.</li>
153</ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]154<h4>
155<a name="Declaring2">Declaring elements</a>:</h4>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]156<p>The following declares an element <code>spec</code>:</p>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]157<p><code>&lt;!ELEMENT spec (front, body, back?)&gt;</code></p>
Daniel Veillard64e73902000-11-24 13:28:38 +0000[diff] [blame]158<p>it also expresses that the spec element contains one <code>front</code>,
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]159one <code>body</code> and one optionnal <code>back</code> children elements
160in this order. The declaration of one element of the structure and its
161content are done in a single declaration. Similary the following declares
Daniel Veillard64e73902000-11-24 13:28:38 +0000[diff] [blame]162<code>div1</code> elements:</p>
Daniel Veillard51737272002-01-23 23:10:38 +0000[diff] [blame]163<p><code>&lt;!ELEMENT div1 (head, (p | list | note)*, div2?)&gt;</code></p>
Daniel Veillard64e73902000-11-24 13:28:38 +0000[diff] [blame]164<p>means div1 contains one <code>head</code> then a series of optional
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]165<code>p</code>, <code>list</code>s and <code>note</code>s and then an
166optional <code>div2</code>. And last but not least an element can contain
167text:</p>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]168<p><code>&lt;!ELEMENT b (#PCDATA)&gt;</code></p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]169<p>
170<code>b</code> contains text or being of mixed content (text and elements
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]171in no particular order):</p>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]172<p><code>&lt;!ELEMENT p (#PCDATA|a|ul|b|i|em)*&gt;</code></p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]173<p>
174<code>p </code>can contain text or <code>a</code>, <code>ul</code>,
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]175<code>b</code>, <code>i </code>or <code>em</code> elements in no particular
176order.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]177<h4>
178<a name="Declaring1">Declaring attributes</a>:</h4>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]179<p>again the attributes declaration includes their content definition:</p>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]180<p><code>&lt;!ATTLIST termdef name CDATA #IMPLIED&gt;</code></p>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]181<p>means that the element <code>termdef</code> can have a <code>name</code>
182attribute containing text (<code>CDATA</code>) and which is optionnal
183(<code>#IMPLIED</code>). The attribute value can also be defined within a
184set:</p>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]185<p><code>&lt;!ATTLIST list type (bullets|ordered|glossary)
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]186&quot;ordered&quot;&gt;</code></p>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]187<p>means <code>list</code> element have a <code>type</code> attribute with 3
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]188allowed values &quot;bullets&quot;, &quot;ordered&quot; or &quot;glossary&quot; and which default to
189&quot;ordered&quot; if the attribute is not explicitely specified.</p>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]190<p>The content type of an attribute can be text (<code>CDATA</code>),
191anchor/reference/references
192(<code>ID</code>/<code>IDREF</code>/<code>IDREFS</code>), entity(ies)
193(<code>ENTITY</code>/<code>ENTITIES</code>) or name(s)
194(<code>NMTOKEN</code>/<code>NMTOKENS</code>). The following defines that a
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]195<code>chapter</code> element can have an optional <code>id</code> attribute
196of type <code>ID</code>, usable for reference from attribute of type
197IDREF:</p>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]198<p><code>&lt;!ATTLIST chapter id ID #IMPLIED&gt;</code></p>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]199<p>The last value of an attribute definition can be <code>#REQUIRED
200</code>meaning that the attribute has to be given, <code>#IMPLIED</code>
201meaning that it is optional, or the default value (possibly prefixed by
202<code>#FIXED</code> if it is the only allowed).</p>
Daniel Veillard64e73902000-11-24 13:28:38 +0000[diff] [blame]203<p>Notes:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]204<ul><li>usually the attributes pertaining to a given element are declared in a
Daniel Veillard64e73902000-11-24 13:28:38 +0000[diff] [blame]205 single expression, but it is just a convention adopted by a lot of DTD
206 writers:
207 <pre>&lt;!ATTLIST termdef
208 id ID #REQUIRED
209 name CDATA #IMPLIED&gt;</pre>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]210<p>The previous construct defines both <code>id</code> and
211 <code>name</code> attributes for the element <code>termdef</code>
212</p>
213</li></ul>
214<h3><a name="Some1">Some examples</a></h3>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]215<p>The directory <code>test/valid/dtds/</code> in the libxml distribution
216contains some complex DTD examples. The <code>test/valid/dia.xml</code>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]217example shows an XML file where the simple DTD is directly included within
218the document.</p>
219<h3><a name="validate1">How to validate</a></h3>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]220<p>The simplest is to use the xmllint program comming with libxml. The
221<code>--valid</code> option turn on validation of the files given as input,
222for example the following validates a copy of the first revision of the XML
2231.0 specification:</p>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]224<p><code>xmllint --valid --noout test/valid/REC-xml-19980210.xml</code></p>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]225<p>the -- noout is used to not output the resulting tree.</p>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]226<p>The <code>--dtdvalid dtd</code> allows to validate the document(s) against
227a given DTD.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]228<p>Libxml exports an API to handle DTDs and validation, check the <a href="http://xmlsoft.org/html/libxml-valid.html">associated
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]229description</a>.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]230<h3><a name="Other1">Other resources</a></h3>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]231<p>DTDs are as old as SGML. So there may be a number of examples on-line, I
232will just list one for now, others pointers welcome:</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]233<ul><li><a href="http://www.xml101.com:8081/dtd/">XML-101 DTD</a></li></ul>
234<p>I suggest looking at the examples found under test/valid/dtd and any of
235the large number of books available on XML. The dia example in test/valid
236should be both simple and complete enough to allow you to build your own.</p>
237<p>
Daniel Veillard3f4c40f2002-02-13 09:19:28 +0000[diff] [blame]238<p><a href="bugs.html">Daniel Veillard</a></p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]239</td></tr></table></td></tr></table></td></tr></table></td>
240</tr></table></td></tr></table>
Daniel Veillard300f7d62000-11-24 13:04:04 +0000[diff] [blame]241</body>
242</html>