Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/tools/boostbook/dtd/boostbook.dtd @ 12

Last change on this file since 12 was 12, checked in by landauf, 17 years ago

added boost
File size: 11.8 KB
Line 
1<!--
2   BoostBook DTD version 1.0
3
4   For further information, see: http://www.crystalclearsoftware.com/cgi-bin/boost_wiki/wiki.pl?Boost_Documentation_Format
5
6   Copyright (c) 2002 by Peter Simons <simons@computer.org>.
7   All Rights Reserved.
8
9   This DTD module is identified by the PUBLIC and SYSTEM identifiers:
10
11   PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
12   SYSTEM "http://cryp.to/boost-sandbox/libs/documentation/dtd/boostbook.dtd"
13
14   $Revision: 1.11 $
15   $Date: 2004/09/27 05:13:05 $
16-->
17
18<!--========== Define XInclude features. ==========-->
19<!-- This is not really integrated into the DTD yet. Needs more
20     research. -->
21<!--
22<!ELEMENT xi:include (xi:fallback)?>
23<!ATTLIST xi:include
24    xmlns:xi   CDATA       #FIXED    "http://www.w3.org/2001/XInclude"
25    href       CDATA       #REQUIRED
26    parse      (xml|text)  "xml"
27    encoding   CDATA       #IMPLIED>
28
29<!ELEMENT xi:fallback ANY>
30<!ATTLIST xi:fallback
31    xmlns:xi   CDATA   #FIXED   "http://www.w3.org/2001/XInclude">
32 -->
33
34<!ENTITY % local.common.attrib "last-revision CDATA  #IMPLIED">
35
36<!--========== Define the BoostBook extensions ==========-->
37<!ENTITY % boost.common.attrib "%local.common.attrib;
38                                id            CDATA  #IMPLIED">
39
40<!ENTITY % boost.namespace.mix 
41        "class|class-specialization|struct|struct-specialization|
42         union|union-specialization|typedef|enum|
43         free-function-group|function|overloaded-function|
44         namespace">
45
46<!ENTITY % boost.template.mix
47        "template-type-parameter|template-nontype-parameter|template-varargs">
48
49<!ENTITY % boost.class.mix
50        "static-constant|typedef|enum|
51         copy-assignment|constructor|destructor|method-group|
52         free-function-group|function|method|overloaded-function|
53         overloaded-method|data-member|class|class-specialization|struct|
54         struct-specialization|union|union-specialization">
55
56<!ENTITY % boost.class.content
57             "template?, inherit*, purpose?, description?,
58              (%boost.class.mix;)*">
59
60<!ENTITY % boost.class-specialization.content
61             "template?, specialization?, inherit?, purpose?, description?,
62              (%boost.class.mix;)*">
63
64<!ENTITY % boost.function.semantics
65        "purpose?, description?, requires?, effects?, postconditions?,
66         returns?, throws?, complexity?, notes?, rationale?">
67
68<!ENTITY % library.content
69        "libraryinfo, (title, ((section|library-reference|testsuite))+)?">
70
71<!ELEMENT library (%library.content;)>
72<!ATTLIST library
73    name      CDATA   #REQUIRED
74    dirname   CDATA   #REQUIRED
75    html-only CDATA   #IMPLIED
76    url       CDATA   #IMPLIED
77    %boost.common.attrib;>
78
79<!ELEMENT boostbook (title, (chapter|library)*)>
80<!ATTLIST boostbook %boost.common.attrib;>
81
82<!ELEMENT libraryinfo (author+, copyright*, legalnotice*, librarypurpose, librarycategory*)>
83<!ATTLIST libraryinfo %boost.common.attrib;>
84
85<!ELEMENT librarypurpose (#PCDATA|code|ulink|functionname|methodname|classname|macroname|headername|enumname)*>
86<!ATTLIST librarypurpose %boost.common.attrib;>
87
88<!ELEMENT librarycategory (#PCDATA)>
89<!ATTLIST librarycategory
90    name  CDATA  #REQUIRED
91    %boost.common.attrib;>
92
93<!ELEMENT libraryname  (#PCDATA)>
94<!ATTLIST libraryname %boost.common.attrib;>
95
96<!ELEMENT library-reference ANY>
97<!ATTLIST library-reference
98    %boost.common.attrib;>
99
100<!ELEMENT librarylist EMPTY>
101<!ATTLIST librarylist %boost.common.attrib;>
102
103<!ELEMENT librarycategorylist (librarycategorydef)*>
104<!ATTLIST librarycategorylist %boost.common.attrib;>
105
106<!ELEMENT librarycategorydef (#PCDATA)>
107<!ATTLIST librarycategorydef 
108         name   CDATA   #REQUIRED
109         %boost.common.attrib;>
110
111<!ELEMENT header ANY>
112<!ATTLIST header
113    name  CDATA  #REQUIRED
114    %boost.common.attrib;>
115
116<!ELEMENT namespace (%boost.namespace.mix;)*>
117<!ATTLIST namespace
118    name  CDATA  #REQUIRED
119    %boost.common.attrib;>
120
121<!ELEMENT class (%boost.class.content;)>
122<!ATTLIST class
123    name  CDATA  #REQUIRED
124    %boost.common.attrib;>
125
126<!ELEMENT struct (%boost.class.content;)>
127<!ATTLIST struct
128    name  CDATA  #REQUIRED
129    %boost.common.attrib;>
130
131<!ELEMENT union (%boost.class.content;)>
132<!ATTLIST union
133    name  CDATA  #REQUIRED
134    %boost.common.attrib;>
135
136<!ELEMENT class-specialization (%boost.class-specialization.content;)>
137<!ATTLIST class-specialization
138    name  CDATA  #REQUIRED
139    %boost.common.attrib;>
140
141<!ELEMENT struct-specialization (%boost.class-specialization.content;)>
142<!ATTLIST struct-specialization
143    name  CDATA  #REQUIRED
144    %boost.common.attrib;>
145
146<!ELEMENT union-specialization (%boost.class-specialization.content;)>
147<!ATTLIST union-specialization
148    name  CDATA  #REQUIRED
149    %boost.common.attrib;>
150
151<!--========= C++ Templates =========-->
152<!ELEMENT template (%boost.template.mix;)*>
153<!ATTLIST template %boost.common.attrib;>
154
155<!ELEMENT template-type-parameter (default?, purpose?)>
156<!ATTLIST template-type-parameter
157    name                     CDATA  #REQUIRED
158    %boost.common.attrib;>
159
160<!ELEMENT template-nontype-parameter (type, default?, purpose?)>
161<!ATTLIST template-nontype-parameter
162    name                     CDATA  #REQUIRED
163    %boost.common.attrib;>
164
165<!ELEMENT template-varargs EMPTY>
166<!ATTLIST template-varargs %boost.common.attrib;>
167
168<!ELEMENT specialization (template-arg)*>
169<!ATTLIST specialization %boost.common.attrib;>
170
171<!ELEMENT template-arg ANY>
172<!ATTLIST template-arg %boost.common.attrib;>
173
174<!ELEMENT default ANY>
175<!ATTLIST default %boost.common.attrib;>
176
177<!ELEMENT inherit (type, purpose?)>
178<!ATTLIST inherit
179    access  CDATA  #IMPLIED
180    %boost.common.attrib;>
181
182<!ELEMENT purpose ANY>
183<!ATTLIST purpose %boost.common.attrib;>
184
185<!ELEMENT description ANY>
186<!ATTLIST description %boost.common.attrib;>
187
188<!ELEMENT type ANY>
189<!ATTLIST type %boost.common.attrib;>
190
191<!ELEMENT typedef (type, purpose?, description?)>
192<!ATTLIST typedef
193    name     CDATA  #REQUIRED
194    %boost.common.attrib;>
195
196<!ELEMENT enum (enumvalue*, purpose?, description?)>
197<!ATTLIST enum
198    name     CDATA  #REQUIRED
199    %boost.common.attrib;>
200
201<!ELEMENT enumvalue (default?)>
202<!ATTLIST enumvalue
203    name     CDATA  #REQUIRED
204    %boost.common.attrib;>
205
206<!ELEMENT static-constant (type, default, purpose?, description?)>
207<!ATTLIST static-constant
208    name   CDATA  #REQUIRED
209    %boost.common.attrib;>
210
211<!ELEMENT data-member (type, purpose?, description?)>
212<!ATTLIST data-member 
213    name         CDATA  #REQUIRED
214    specifiers   CDATA  #IMPLIED
215    %boost.common.attrib;>
216
217<!ELEMENT paramtype ANY>
218<!ATTLIST paramtype %boost.common.attrib;>
219
220<!ELEMENT effects ANY>
221<!ATTLIST effects %boost.common.attrib;>
222
223<!ELEMENT postconditions ANY>
224<!ATTLIST postconditions %boost.common.attrib;>
225
226<!ELEMENT method-group (method|overloaded-method)*>
227<!ATTLIST method-group
228    name  CDATA  #REQUIRED
229    %boost.common.attrib;>
230
231<!ELEMENT constructor (template?, parameter*, %boost.function.semantics;)>
232<!ATTLIST constructor 
233    specifiers   CDATA  #IMPLIED
234    %boost.common.attrib;>
235
236<!ELEMENT destructor (%boost.function.semantics;)>
237<!ATTLIST destructor 
238    specifiers   CDATA  #IMPLIED
239    %boost.common.attrib;>
240
241<!ELEMENT method (template?, type, parameter*, %boost.function.semantics;)>
242<!ATTLIST method
243    name         CDATA  #REQUIRED
244    cv           CDATA  #IMPLIED
245    specifiers   CDATA  #IMPLIED
246    %boost.common.attrib;>
247
248<!ELEMENT function (template?, type, parameter*, %boost.function.semantics;)>
249<!ATTLIST function
250    name         CDATA  #REQUIRED
251    specifiers   CDATA  #IMPLIED
252    %boost.common.attrib;>
253
254<!ELEMENT overloaded-method (signature*, %boost.function.semantics;)>
255<!ATTLIST overloaded-method 
256    name  CDATA  #REQUIRED
257    %boost.common.attrib;>
258
259<!ELEMENT overloaded-function (signature*, %boost.function.semantics;)>
260<!ATTLIST overloaded-function 
261    name  CDATA  #REQUIRED
262    %boost.common.attrib;>
263
264<!ELEMENT signature (template?, type, parameter*)>
265<!ATTLIST signature
266    cv           CDATA  #IMPLIED
267    specifiers   CDATA  #IMPLIED
268    %boost.common.attrib;>
269
270<!ELEMENT requires ANY>
271<!ATTLIST requires %boost.common.attrib;>
272
273<!ELEMENT returns ANY>
274<!ATTLIST returns %boost.common.attrib;>
275
276<!ELEMENT throws ANY>
277<!ATTLIST throws %boost.common.attrib;>
278
279<!ELEMENT complexity ANY>
280<!ATTLIST complexity %boost.common.attrib;>
281
282<!ELEMENT notes ANY>
283<!ATTLIST notes %boost.common.attrib;>
284
285<!ELEMENT rationale ANY>
286<!ATTLIST rationale %boost.common.attrib;>
287
288<!ELEMENT functionname (#PCDATA)>
289<!ATTLIST functionname 
290    alt          CDATA  #IMPLIED
291    %boost.common.attrib;>
292
293<!ELEMENT enumname (#PCDATA)>
294<!ATTLIST enumname 
295    alt          CDATA  #IMPLIED
296    %boost.common.attrib;>
297
298<!ELEMENT macroname (#PCDATA)>
299<!ATTLIST macroname %boost.common.attrib;>
300
301<!ELEMENT headername (#PCDATA)>
302<!ATTLIST headername %boost.common.attrib;>
303
304<!ELEMENT copy-assignment 
305    (template?, type?, parameter*, %boost.function.semantics;)>
306<!ATTLIST copy-assignment 
307    cv           CDATA  #IMPLIED
308    specifiers   CDATA  #IMPLIED
309    %boost.common.attrib;>
310
311<!ELEMENT free-function-group (function|overloaded-function)*>
312<!ATTLIST free-function-group
313    name  CDATA  #REQUIRED
314    %boost.common.attrib;>
315
316<!ELEMENT precondition ANY>
317<!ATTLIST precondition %boost.common.attrib;>
318
319<!ELEMENT code ANY>
320<!ATTLIST code %boost.common.attrib;>
321
322<!ELEMENT using-namespace EMPTY>
323<!ATTLIST using-namespace
324    name   CDATA  #REQUIRED
325    %boost.common.attrib;>
326
327<!ELEMENT using-class EMPTY>
328<!ATTLIST using-class
329     name        CDATA #REQUIRED
330     %boost.common.attrib;>
331
332<!--========== Boost Testsuite Extensions ==========-->
333<!ENTITY % boost.testsuite.tests 
334        "compile-test|link-test|run-test|
335         compile-fail-test|link-fail-test|run-fail-test">
336<!ENTITY % boost.testsuite.test.content
337        "source*, lib*, requirement*, purpose, if-fails?">
338
339<!ELEMENT testsuite ((%boost.testsuite.tests;)+)>
340<!ATTLIST testsuite %boost.common.attrib;>
341
342<!ELEMENT compile-test (%boost.testsuite.test.content;)>
343<!ATTLIST compile-test
344     filename CDATA #REQUIRED
345     name     CDATA #IMPLIED>
346
347<!ELEMENT link-test (%boost.testsuite.test.content;)>
348<!ATTLIST link-test 
349     filename CDATA #REQUIRED
350     name     CDATA #IMPLIED>
351
352<!ELEMENT run-test (%boost.testsuite.test.content;)>
353<!ATTLIST run-test 
354     filename CDATA #REQUIRED
355     name     CDATA #IMPLIED>
356
357<!ELEMENT compile-fail-test (%boost.testsuite.test.content;)>
358<!ATTLIST compile-fail-test
359     filename CDATA #REQUIRED
360     name     CDATA #IMPLIED>
361
362<!ELEMENT link-fail-test (%boost.testsuite.test.content;)>
363<!ATTLIST link-fail-test 
364     filename CDATA #REQUIRED
365     name     CDATA #IMPLIED>
366
367<!ELEMENT run-fail-test (%boost.testsuite.test.content;)>
368<!ATTLIST run-fail-test 
369     filename CDATA #REQUIRED
370     name     CDATA #IMPLIED>
371
372<!ELEMENT source (#PCDATA|snippet)*>
373
374<!ELEMENT snippet EMPTY>
375<!ATTLIST snippet
376     name CDATA #REQUIRED>
377
378<!ELEMENT lib (#PCDATA)>
379
380<!ELEMENT requirement (#PCDATA)>
381<!ATTLIST requirement 
382     name CDATA #REQUIRED>
383
384<!ELEMENT if-fails ANY>
385
386<!ELEMENT parameter (paramtype, default?, description?)>
387<!ATTLIST parameter 
388     name CDATA #IMPLIED>
389
390<!ELEMENT programlisting ANY>
391<!ATTLIST programlisting
392     name        CDATA #IMPLIED>
393
394<!--========== Customize the DocBook DTD ==========-->
395<!ENTITY % local.tech.char.class "|functionname|libraryname|enumname|code">
396<!ENTITY % local.para.class 
397        "|using-namespace|using-class|librarylist|librarycategorylist">
398<!ENTITY % local.descobj.class "|libraryinfo">
399<!ENTITY % local.classname.attrib "alt CDATA #IMPLIED">
400<!ENTITY % local.methodname.attrib "alt CDATA #IMPLIED">
401<!ENTITY % local.refentry.class "|library-reference|testsuite">
402<!ENTITY % local.title.char.mix "">
403<!ENTITY % programlisting.module "IGNORE">
404<!ENTITY % parameter.module      "IGNORE">
405<!ENTITY % function.module       "IGNORE">
406<!ENTITY % type.module           "IGNORE">
407
408<!--========== Import DocBook DTD ==========-->
409<!ENTITY % DocBook PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
410           "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
411 
412%DocBook;
Note: See TracBrowser for help on using the repository browser.