Mercurial > hg > nginx-site
annotate dtd/module.dtd @ 590:05761a8e38f6
Added an option to disable generation of TOC.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Thu, 19 Jul 2012 04:56:13 +0000 |
parents | 23b4435dd0f3 |
children | 1902d38f0b05 |
rev | line source |
---|---|
580
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
473
diff
changeset
|
1 <!-- |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
473
diff
changeset
|
2 Copyright (C) Igor Sysoev |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
473
diff
changeset
|
3 Copyright (C) Nginx, Inc. |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
473
diff
changeset
|
4 --> |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
473
diff
changeset
|
5 |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
6 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
7 <!ELEMENT module (section+) > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
8 <!ATTLIST module |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
9 name CDATA #REQUIRED |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
10 link CDATA #REQUIRED |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
11 lang CDATA #REQUIRED |
588
23b4435dd0f3
Added revision attribute to "article" and "module".
Ruslan Ermilov <ru@nginx.com>
parents:
580
diff
changeset
|
12 rev CDATA #IMPLIED |
590
05761a8e38f6
Added an option to disable generation of TOC.
Ruslan Ermilov <ru@nginx.com>
parents:
588
diff
changeset
|
13 toc (yes | no) "yes" |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
14 > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
15 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
16 <!ELEMENT section (directive | para)+ > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
17 <!ATTLIST section |
110
40eec261c2a6
Added proper support for anonymous sections, notably for the summary.
Ruslan Ermilov <ru@nginx.com>
parents:
108
diff
changeset
|
18 id ID #REQUIRED |
40eec261c2a6
Added proper support for anonymous sections, notably for the summary.
Ruslan Ermilov <ru@nginx.com>
parents:
108
diff
changeset
|
19 name CDATA #IMPLIED |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
20 > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
21 |
171
6eeaa9e1f3b5
Made "appeared-in" an element, and added support for
Ruslan Ermilov <ru@nginx.com>
parents:
148
diff
changeset
|
22 <!ELEMENT directive (syntax+, default+, context*, appeared-in*, para+) > |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
23 <!ATTLIST directive |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
24 name ID #REQUIRED |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
25 > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
26 |
271 | 27 <!ELEMENT syntax (#PCDATA | literal | value)* > |
108
72524ae53106
Explicitly marked directives with the block syntax. Such directives will
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
28 <!ATTLIST syntax |
72524ae53106
Explicitly marked directives with the block syntax. Such directives will
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
29 block (yes | no) "no" |
72524ae53106
Explicitly marked directives with the block syntax. Such directives will
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
30 > |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
31 |
101
b8fd014ec712
The <default> doesn't need <code> inside it.
Ruslan Ermilov <ru@nginx.com>
parents:
76
diff
changeset
|
32 <!ELEMENT default (#PCDATA)* > |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
33 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
34 <!ELEMENT context (#PCDATA)* > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
35 |
171
6eeaa9e1f3b5
Made "appeared-in" an element, and added support for
Ruslan Ermilov <ru@nginx.com>
parents:
148
diff
changeset
|
36 <!ELEMENT appeared-in (#PCDATA)* > |
6eeaa9e1f3b5
Made "appeared-in" an element, and added support for
Ruslan Ermilov <ru@nginx.com>
parents:
148
diff
changeset
|
37 |
271 | 38 <!ELEMENT para (#PCDATA | c-def | c-func | command | |
147 | 39 emphasis | example | header | http-status | link | |
271 | 40 list | literal | note | path | value | var)* > |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
41 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
42 <!ELEMENT c-def (#PCDATA)* > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
43 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
44 <!ELEMENT c-func (#PCDATA)* > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
45 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
46 <!ELEMENT command (#PCDATA)* > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
47 |
76
4a4caa566120
Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
55
diff
changeset
|
48 <!ELEMENT emphasis (#PCDATA | value)* > |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
49 |
76
4a4caa566120
Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
55
diff
changeset
|
50 <!ELEMENT example (#PCDATA | value | emphasis)* > |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
51 |
271 | 52 <!ELEMENT header (#PCDATA | value)* > |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
53 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
54 <!ELEMENT http-status EMPTY > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
55 <!ATTLIST http-status |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
56 code CDATA #REQUIRED |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
57 text CDATA #IMPLIED |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
58 > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
59 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
60 <!ELEMENT link (#PCDATA)* > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
61 <!ATTLIST link |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
62 doc CDATA #IMPLIED |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
63 id CDATA #IMPLIED |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
64 url CDATA #IMPLIED |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
65 > |
22 | 66 |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
67 <!ELEMENT list (listitem+ | (tag-name | tag-desc)+) > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
68 <!ATTLIST list |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
69 type (bullet | enum | tag) #REQUIRED |
473
cac48e2d0d9b
Added the "compact" attribute to the "list" element.
Ruslan Ermilov <ru@nginx.com>
parents:
414
diff
changeset
|
70 compact (yes | no) "yes" |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
71 > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
72 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
73 <!ELEMENT listitem ANY > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
74 <!ELEMENT tag-name ANY > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
75 <!ELEMENT tag-desc ANY > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
76 |
414
71d99de7ff97
Allow "value" inside "literal".
Ruslan Ermilov <ru@nginx.com>
parents:
271
diff
changeset
|
77 <!ELEMENT literal (#PCDATA | value)* > |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
78 |
271 | 79 <!ELEMENT note ANY > |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
80 |
148
682163f2b298
Unified article/path and module/pathname into a single "path".
Ruslan Ermilov <ru@nginx.com>
parents:
147
diff
changeset
|
81 <!ELEMENT path (#PCDATA)* > |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
82 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
83 <!ELEMENT value (#PCDATA)* > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
84 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
85 <!ELEMENT var (#PCDATA)* > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
86 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
87 <!ENTITY nbsp " " > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
88 <!ENTITY mdash " - " > |