1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
2 | <!--
|
---|
3 | This file is part of DocBook V5.0
|
---|
4 |
|
---|
5 | Copyright 1992-2008 HaL Computer Systems, Inc.,
|
---|
6 | O'Reilly & Associates, Inc., ArborText, Inc., Fujitsu Software
|
---|
7 | Corporation, Norman Walsh, Sun Microsystems, Inc., and the
|
---|
8 | Organization for the Advancement of Structured Information
|
---|
9 | Standards (OASIS).
|
---|
10 |
|
---|
11 | Release: $Id: refentry.rnc 8931 2010-10-20 13:29:20Z nwalsh $
|
---|
12 |
|
---|
13 | Permission to use, copy, modify and distribute the DocBook schema
|
---|
14 | and its accompanying documentation for any purpose and without fee
|
---|
15 | is hereby granted in perpetuity, provided that the above copyright
|
---|
16 | notice and this paragraph appear in all copies. The copyright
|
---|
17 | holders make no representation about the suitability of the schema
|
---|
18 | for any purpose. It is provided "as is" without expressed or implied
|
---|
19 | warranty.
|
---|
20 |
|
---|
21 | If you modify the DocBook schema in any way, label your schema as a
|
---|
22 | variant of DocBook. See the reference documentation
|
---|
23 | (http://docbook.org/tdg5/en/html/ch05.html#s-notdocbook)
|
---|
24 | for more information.
|
---|
25 |
|
---|
26 | Please direct all questions, bug reports, or suggestions for changes
|
---|
27 | to the docbook@lists.oasis-open.org mailing list. For more
|
---|
28 | information, see http://www.oasis-open.org/docbook/.
|
---|
29 |
|
---|
30 | ======================================================================
|
---|
31 | -->
|
---|
32 | <grammar ns="http://docbook.org/ns/docbook" xmlns:db="http://docbook.org/ns/docbook" xmlns:s="http://purl.oclc.org/dsdl/schematron" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" xmlns:rng="http://relaxng.org/ns/structure/1.0" xmlns:ctrl="http://nwalsh.com/xmlns/schema-control/" xmlns="http://relaxng.org/ns/structure/1.0">
|
---|
33 | <start combine="choice">
|
---|
34 | <choice>
|
---|
35 | <ref name="db.refentry"/>
|
---|
36 | <ref name="db.refsection"/>
|
---|
37 | <ref name="db.refsynopsisdiv"/>
|
---|
38 | </choice>
|
---|
39 | </start>
|
---|
40 | <define name="db.divisions" combine="choice">
|
---|
41 | <ref name="db.reference"/>
|
---|
42 | </define>
|
---|
43 | <define name="db.part.components" combine="choice">
|
---|
44 | <choice>
|
---|
45 | <ref name="db.refentry"/>
|
---|
46 | <ref name="db.reference"/>
|
---|
47 | </choice>
|
---|
48 | </define>
|
---|
49 | <define name="db.toplevel.sections" combine="choice">
|
---|
50 | <oneOrMore>
|
---|
51 | <ref name="db.refentry"/>
|
---|
52 | </oneOrMore>
|
---|
53 | </define>
|
---|
54 | <define name="db.recursive.sections" combine="choice">
|
---|
55 | <oneOrMore>
|
---|
56 | <ref name="db.refentry"/>
|
---|
57 | </oneOrMore>
|
---|
58 | </define>
|
---|
59 | <define name="db.toplevel.refsection">
|
---|
60 | <oneOrMore>
|
---|
61 | <ref name="db.refsection"/>
|
---|
62 | </oneOrMore>
|
---|
63 | </define>
|
---|
64 | <define name="db.secondlevel.refsection">
|
---|
65 | <oneOrMore>
|
---|
66 | <ref name="db.refsection"/>
|
---|
67 | </oneOrMore>
|
---|
68 | </define>
|
---|
69 | <!-- ====================================================================== -->
|
---|
70 | <define name="db.reference.components">
|
---|
71 | <ref name="db.refentry"/>
|
---|
72 | </define>
|
---|
73 | <!-- ====================================================================== -->
|
---|
74 | <div>
|
---|
75 | <db:refname>reference</db:refname>
|
---|
76 | <db:refpurpose>A collection of reference entries</db:refpurpose>
|
---|
77 | <define name="db.reference.status.attribute">
|
---|
78 | <ref name="db.status.attribute"/>
|
---|
79 | </define>
|
---|
80 | <define name="db.reference.role.attribute">
|
---|
81 | <attribute name="role"/>
|
---|
82 | </define>
|
---|
83 | <define name="db.reference.attlist">
|
---|
84 | <interleave>
|
---|
85 | <optional>
|
---|
86 | <ref name="db.reference.role.attribute"/>
|
---|
87 | </optional>
|
---|
88 | <ref name="db.common.attributes"/>
|
---|
89 | <ref name="db.common.linking.attributes"/>
|
---|
90 | <optional>
|
---|
91 | <ref name="db.reference.status.attribute"/>
|
---|
92 | </optional>
|
---|
93 | <optional>
|
---|
94 | <ref name="db.label.attribute"/>
|
---|
95 | </optional>
|
---|
96 | </interleave>
|
---|
97 | </define>
|
---|
98 | <define name="db.reference.info">
|
---|
99 | <ref name="db._info.title.req"/>
|
---|
100 | </define>
|
---|
101 | <define name="db.reference">
|
---|
102 | <element name="reference">
|
---|
103 | <ref name="db.reference.attlist"/>
|
---|
104 | <ref name="db.reference.info"/>
|
---|
105 | <optional>
|
---|
106 | <ref name="db.partintro"/>
|
---|
107 | </optional>
|
---|
108 | <oneOrMore>
|
---|
109 | <ref name="db.reference.components"/>
|
---|
110 | </oneOrMore>
|
---|
111 | </element>
|
---|
112 | </define>
|
---|
113 | </div>
|
---|
114 | <!-- ====================================================================== -->
|
---|
115 | <div>
|
---|
116 | <db:refname>refentry</db:refname>
|
---|
117 | <db:refpurpose>A reference page (originally a UNIX man-style reference page)</db:refpurpose>
|
---|
118 | <define name="db.refentry.status.attribute">
|
---|
119 | <ref name="db.status.attribute"/>
|
---|
120 | </define>
|
---|
121 | <define name="db.refentry.role.attribute">
|
---|
122 | <attribute name="role"/>
|
---|
123 | </define>
|
---|
124 | <define name="db.refentry.attlist">
|
---|
125 | <interleave>
|
---|
126 | <optional>
|
---|
127 | <ref name="db.refentry.role.attribute"/>
|
---|
128 | </optional>
|
---|
129 | <ref name="db.common.attributes"/>
|
---|
130 | <ref name="db.common.linking.attributes"/>
|
---|
131 | <optional>
|
---|
132 | <ref name="db.refentry.status.attribute"/>
|
---|
133 | </optional>
|
---|
134 | <optional>
|
---|
135 | <ref name="db.label.attribute"/>
|
---|
136 | </optional>
|
---|
137 | </interleave>
|
---|
138 | </define>
|
---|
139 | <define name="db.refentry.info">
|
---|
140 | <ref name="db._info.title.forbidden"/>
|
---|
141 | </define>
|
---|
142 | <define name="db.refentry">
|
---|
143 | <element name="refentry">
|
---|
144 | <ref name="db.refentry.attlist"/>
|
---|
145 | <zeroOrMore>
|
---|
146 | <ref name="db.indexterm"/>
|
---|
147 | </zeroOrMore>
|
---|
148 | <ref name="db.refentry.info"/>
|
---|
149 | <optional>
|
---|
150 | <ref name="db.refmeta"/>
|
---|
151 | </optional>
|
---|
152 | <oneOrMore>
|
---|
153 | <ref name="db.refnamediv"/>
|
---|
154 | </oneOrMore>
|
---|
155 | <optional>
|
---|
156 | <ref name="db.refsynopsisdiv"/>
|
---|
157 | </optional>
|
---|
158 | <ref name="db.toplevel.refsection"/>
|
---|
159 | </element>
|
---|
160 | </define>
|
---|
161 | </div>
|
---|
162 | <!-- ====================================================================== -->
|
---|
163 | <div>
|
---|
164 | <db:refname>refmeta</db:refname>
|
---|
165 | <db:refpurpose>Meta-information for a reference entry</db:refpurpose>
|
---|
166 | <define name="db.refmeta.role.attribute">
|
---|
167 | <attribute name="role"/>
|
---|
168 | </define>
|
---|
169 | <define name="db.refmeta.attlist">
|
---|
170 | <interleave>
|
---|
171 | <optional>
|
---|
172 | <ref name="db.refmeta.role.attribute"/>
|
---|
173 | </optional>
|
---|
174 | <ref name="db.common.attributes"/>
|
---|
175 | <ref name="db.common.linking.attributes"/>
|
---|
176 | </interleave>
|
---|
177 | </define>
|
---|
178 | <define name="db.refmeta">
|
---|
179 | <element name="refmeta">
|
---|
180 | <ref name="db.refmeta.attlist"/>
|
---|
181 | <zeroOrMore>
|
---|
182 | <ref name="db.indexterm"/>
|
---|
183 | </zeroOrMore>
|
---|
184 | <ref name="db.refentrytitle"/>
|
---|
185 | <optional>
|
---|
186 | <ref name="db.manvolnum"/>
|
---|
187 | </optional>
|
---|
188 | <zeroOrMore>
|
---|
189 | <ref name="db.refmiscinfo"/>
|
---|
190 | </zeroOrMore>
|
---|
191 | <zeroOrMore>
|
---|
192 | <ref name="db.indexterm"/>
|
---|
193 | </zeroOrMore>
|
---|
194 | </element>
|
---|
195 | </define>
|
---|
196 | </div>
|
---|
197 | <!-- ====================================================================== -->
|
---|
198 | <ctrl:other-attribute name="db.refmiscinfo.class.attribute" enum-name="db.refmiscinfo.class-enum.attribute" other-name="db.refmiscinfo.class-other.attributes"/>
|
---|
199 | <define name="db.refmiscinfo.class.enumeration">
|
---|
200 | <choice>
|
---|
201 | <value>source</value>
|
---|
202 | <a:documentation>The name of the software product or component to which this topic applies</a:documentation>
|
---|
203 | <value>version</value>
|
---|
204 | <a:documentation>The version of the software product or component to which this topic applies</a:documentation>
|
---|
205 | <value>manual</value>
|
---|
206 | <a:documentation>The section title of the reference page (e.g., User Commands)</a:documentation>
|
---|
207 | <value>sectdesc</value>
|
---|
208 | <a:documentation>The section title of the reference page (believed synonymous with "manual" but in wide use)</a:documentation>
|
---|
209 | <value>software</value>
|
---|
210 | <a:documentation>The name of the software product or component to which this topic applies (e.g., SunOS x.y; believed synonymous with "source" but in wide use)</a:documentation>
|
---|
211 | </choice>
|
---|
212 | </define>
|
---|
213 | <define name="db.refmiscinfo.class-enum.attribute">
|
---|
214 | <optional>
|
---|
215 | <attribute name="class">
|
---|
216 | <db:refpurpose>Identifies the kind of miscellaneous information</db:refpurpose>
|
---|
217 | <ref name="db.refmiscinfo.class.enumeration"/>
|
---|
218 | </attribute>
|
---|
219 | </optional>
|
---|
220 | </define>
|
---|
221 | <define name="db.refmiscinfo.class-other.attribute">
|
---|
222 | <attribute name="otherclass">
|
---|
223 | <db:refpurpose>Identifies the nature of non-standard miscellaneous information</db:refpurpose>
|
---|
224 | </attribute>
|
---|
225 | </define>
|
---|
226 | <define name="db.refmiscinfo.class-other.attributes">
|
---|
227 | <interleave>
|
---|
228 | <attribute name="class">
|
---|
229 | <db:refpurpose>Identifies the kind of miscellaneious information</db:refpurpose>
|
---|
230 | <value>other</value>
|
---|
231 | <a:documentation>Indicates that the information is some 'other' kind.</a:documentation>
|
---|
232 | </attribute>
|
---|
233 | <ref name="db.refmiscinfo.class-other.attribute"/>
|
---|
234 | </interleave>
|
---|
235 | </define>
|
---|
236 | <define name="db.refmiscinfo.class.attribute">
|
---|
237 | <choice>
|
---|
238 | <ref name="db.refmiscinfo.class-enum.attribute"/>
|
---|
239 | <ref name="db.refmiscinfo.class-other.attributes"/>
|
---|
240 | </choice>
|
---|
241 | </define>
|
---|
242 | <!-- ====================================================================== -->
|
---|
243 | <div>
|
---|
244 | <db:refname>refmiscinfo</db:refname>
|
---|
245 | <db:refpurpose>Meta-information for a reference entry other than the title and volume number</db:refpurpose>
|
---|
246 | <define name="db.refmiscinfo.role.attribute">
|
---|
247 | <attribute name="role"/>
|
---|
248 | </define>
|
---|
249 | <define name="db.refmiscinfo.attlist">
|
---|
250 | <interleave>
|
---|
251 | <optional>
|
---|
252 | <ref name="db.refmiscinfo.role.attribute"/>
|
---|
253 | </optional>
|
---|
254 | <ref name="db.common.attributes"/>
|
---|
255 | <ref name="db.common.linking.attributes"/>
|
---|
256 | <optional>
|
---|
257 | <ref name="db.refmiscinfo.class.attribute"/>
|
---|
258 | </optional>
|
---|
259 | </interleave>
|
---|
260 | </define>
|
---|
261 | <define name="db.refmiscinfo">
|
---|
262 | <element name="refmiscinfo">
|
---|
263 | <ref name="db.refmiscinfo.attlist"/>
|
---|
264 | <ref name="db._text"/>
|
---|
265 | </element>
|
---|
266 | </define>
|
---|
267 | </div>
|
---|
268 | <!-- ====================================================================== -->
|
---|
269 | <div>
|
---|
270 | <db:refname>refnamediv</db:refname>
|
---|
271 | <db:refpurpose>The name, purpose, and classification of a reference page</db:refpurpose>
|
---|
272 | <define name="db.refnamediv.role.attribute">
|
---|
273 | <attribute name="role"/>
|
---|
274 | </define>
|
---|
275 | <define name="db.refnamediv.attlist">
|
---|
276 | <interleave>
|
---|
277 | <optional>
|
---|
278 | <ref name="db.refnamediv.role.attribute"/>
|
---|
279 | </optional>
|
---|
280 | <ref name="db.common.attributes"/>
|
---|
281 | <ref name="db.common.linking.attributes"/>
|
---|
282 | </interleave>
|
---|
283 | </define>
|
---|
284 | <define name="db.refnamediv">
|
---|
285 | <element name="refnamediv">
|
---|
286 | <ref name="db.refnamediv.attlist"/>
|
---|
287 | <optional>
|
---|
288 | <ref name="db.refdescriptor"/>
|
---|
289 | </optional>
|
---|
290 | <oneOrMore>
|
---|
291 | <ref name="db.refname"/>
|
---|
292 | </oneOrMore>
|
---|
293 | <ref name="db.refpurpose"/>
|
---|
294 | <zeroOrMore>
|
---|
295 | <ref name="db.refclass"/>
|
---|
296 | </zeroOrMore>
|
---|
297 | </element>
|
---|
298 | </define>
|
---|
299 | </div>
|
---|
300 | <!-- ====================================================================== -->
|
---|
301 | <div>
|
---|
302 | <db:refname>refdescriptor</db:refname>
|
---|
303 | <db:refpurpose>A description of the topic of a reference page</db:refpurpose>
|
---|
304 | <define name="db.refdescriptor.role.attribute">
|
---|
305 | <attribute name="role"/>
|
---|
306 | </define>
|
---|
307 | <define name="db.refdescriptor.attlist">
|
---|
308 | <interleave>
|
---|
309 | <optional>
|
---|
310 | <ref name="db.refdescriptor.role.attribute"/>
|
---|
311 | </optional>
|
---|
312 | <ref name="db.common.attributes"/>
|
---|
313 | <ref name="db.common.linking.attributes"/>
|
---|
314 | </interleave>
|
---|
315 | </define>
|
---|
316 | <define name="db.refdescriptor">
|
---|
317 | <element name="refdescriptor">
|
---|
318 | <ref name="db.refdescriptor.attlist"/>
|
---|
319 | <zeroOrMore>
|
---|
320 | <ref name="db.all.inlines"/>
|
---|
321 | </zeroOrMore>
|
---|
322 | </element>
|
---|
323 | </define>
|
---|
324 | </div>
|
---|
325 | <!-- ====================================================================== -->
|
---|
326 | <div>
|
---|
327 | <db:refname>refname</db:refname>
|
---|
328 | <db:refpurpose>The name of (one of) the subject(s) of a reference page</db:refpurpose>
|
---|
329 | <define name="db.refname.role.attribute">
|
---|
330 | <attribute name="role"/>
|
---|
331 | </define>
|
---|
332 | <define name="db.refname.attlist">
|
---|
333 | <interleave>
|
---|
334 | <optional>
|
---|
335 | <ref name="db.refname.role.attribute"/>
|
---|
336 | </optional>
|
---|
337 | <ref name="db.common.attributes"/>
|
---|
338 | <ref name="db.common.linking.attributes"/>
|
---|
339 | </interleave>
|
---|
340 | </define>
|
---|
341 | <define name="db.refname">
|
---|
342 | <element name="refname">
|
---|
343 | <ref name="db.refname.attlist"/>
|
---|
344 | <zeroOrMore>
|
---|
345 | <ref name="db.all.inlines"/>
|
---|
346 | </zeroOrMore>
|
---|
347 | </element>
|
---|
348 | </define>
|
---|
349 | </div>
|
---|
350 | <!-- ====================================================================== -->
|
---|
351 | <div>
|
---|
352 | <db:refname>refpurpose</db:refname>
|
---|
353 | <db:refpurpose>A short (one sentence) synopsis of the topic of a reference page</db:refpurpose>
|
---|
354 | <define name="db.refpurpose.role.attribute">
|
---|
355 | <attribute name="role"/>
|
---|
356 | </define>
|
---|
357 | <define name="db.refpurpose.attlist">
|
---|
358 | <interleave>
|
---|
359 | <optional>
|
---|
360 | <ref name="db.refpurpose.role.attribute"/>
|
---|
361 | </optional>
|
---|
362 | <ref name="db.common.attributes"/>
|
---|
363 | <ref name="db.common.linking.attributes"/>
|
---|
364 | </interleave>
|
---|
365 | </define>
|
---|
366 | <define name="db.refpurpose">
|
---|
367 | <element name="refpurpose">
|
---|
368 | <ref name="db.refpurpose.attlist"/>
|
---|
369 | <zeroOrMore>
|
---|
370 | <ref name="db.all.inlines"/>
|
---|
371 | </zeroOrMore>
|
---|
372 | </element>
|
---|
373 | </define>
|
---|
374 | </div>
|
---|
375 | <!-- ====================================================================== -->
|
---|
376 | <div>
|
---|
377 | <db:refname>refclass</db:refname>
|
---|
378 | <db:refpurpose>The scope or other indication of applicability of a reference entry</db:refpurpose>
|
---|
379 | <define name="db.refclass.role.attribute">
|
---|
380 | <attribute name="role"/>
|
---|
381 | </define>
|
---|
382 | <define name="db.refclass.attlist">
|
---|
383 | <interleave>
|
---|
384 | <optional>
|
---|
385 | <ref name="db.refclass.role.attribute"/>
|
---|
386 | </optional>
|
---|
387 | <ref name="db.common.attributes"/>
|
---|
388 | <ref name="db.common.linking.attributes"/>
|
---|
389 | </interleave>
|
---|
390 | </define>
|
---|
391 | <define name="db.refclass">
|
---|
392 | <element name="refclass">
|
---|
393 | <ref name="db.refclass.attlist"/>
|
---|
394 | <zeroOrMore>
|
---|
395 | <choice>
|
---|
396 | <text/>
|
---|
397 | <ref name="db.application"/>
|
---|
398 | </choice>
|
---|
399 | </zeroOrMore>
|
---|
400 | </element>
|
---|
401 | </define>
|
---|
402 | </div>
|
---|
403 | <!-- ====================================================================== -->
|
---|
404 | <div>
|
---|
405 | <db:refname>refsynopsisdiv</db:refname>
|
---|
406 | <db:refpurpose>A syntactic synopsis of the subject of the reference page</db:refpurpose>
|
---|
407 | <define name="db.refsynopsisdiv.role.attribute">
|
---|
408 | <attribute name="role"/>
|
---|
409 | </define>
|
---|
410 | <define name="db.refsynopsisdiv.attlist">
|
---|
411 | <interleave>
|
---|
412 | <optional>
|
---|
413 | <ref name="db.refsynopsisdiv.role.attribute"/>
|
---|
414 | </optional>
|
---|
415 | <ref name="db.common.attributes"/>
|
---|
416 | <ref name="db.common.linking.attributes"/>
|
---|
417 | </interleave>
|
---|
418 | </define>
|
---|
419 | <define name="db.refsynopsisdiv.info">
|
---|
420 | <ref name="db._info"/>
|
---|
421 | </define>
|
---|
422 | <define name="db.refsynopsisdiv">
|
---|
423 | <element name="refsynopsisdiv">
|
---|
424 | <ref name="db.refsynopsisdiv.attlist"/>
|
---|
425 | <ref name="db.refsynopsisdiv.info"/>
|
---|
426 | <choice>
|
---|
427 | <group>
|
---|
428 | <oneOrMore>
|
---|
429 | <ref name="db.all.blocks"/>
|
---|
430 | </oneOrMore>
|
---|
431 | <optional>
|
---|
432 | <ref name="db.secondlevel.refsection"/>
|
---|
433 | </optional>
|
---|
434 | </group>
|
---|
435 | <ref name="db.secondlevel.refsection"/>
|
---|
436 | </choice>
|
---|
437 | </element>
|
---|
438 | </define>
|
---|
439 | </div>
|
---|
440 | <!-- ====================================================================== -->
|
---|
441 | <div>
|
---|
442 | <db:refname>refsection</db:refname>
|
---|
443 | <db:refpurpose>A recursive section in a refentry</db:refpurpose>
|
---|
444 | <define name="db.refsection.status.attribute">
|
---|
445 | <ref name="db.status.attribute"/>
|
---|
446 | </define>
|
---|
447 | <define name="db.refsection.role.attribute">
|
---|
448 | <attribute name="role"/>
|
---|
449 | </define>
|
---|
450 | <define name="db.refsection.attlist">
|
---|
451 | <interleave>
|
---|
452 | <optional>
|
---|
453 | <ref name="db.refsection.role.attribute"/>
|
---|
454 | </optional>
|
---|
455 | <ref name="db.common.attributes"/>
|
---|
456 | <ref name="db.common.linking.attributes"/>
|
---|
457 | <optional>
|
---|
458 | <ref name="db.refsection.status.attribute"/>
|
---|
459 | </optional>
|
---|
460 | <optional>
|
---|
461 | <ref name="db.label.attribute"/>
|
---|
462 | </optional>
|
---|
463 | </interleave>
|
---|
464 | </define>
|
---|
465 | <define name="db.refsection.info">
|
---|
466 | <ref name="db._info.title.req"/>
|
---|
467 | </define>
|
---|
468 | <define name="db.refsection">
|
---|
469 | <element name="refsection">
|
---|
470 | <ref name="db.refsection.attlist"/>
|
---|
471 | <ref name="db.refsection.info"/>
|
---|
472 | <choice>
|
---|
473 | <group>
|
---|
474 | <oneOrMore>
|
---|
475 | <ref name="db.all.blocks"/>
|
---|
476 | </oneOrMore>
|
---|
477 | <zeroOrMore>
|
---|
478 | <ref name="db.refsection"/>
|
---|
479 | </zeroOrMore>
|
---|
480 | </group>
|
---|
481 | <oneOrMore>
|
---|
482 | <ref name="db.refsection"/>
|
---|
483 | </oneOrMore>
|
---|
484 | </choice>
|
---|
485 | </element>
|
---|
486 | </define>
|
---|
487 | </div>
|
---|
488 | </grammar>
|
---|