Mercurial > hg > nginx-site
annotate dtd/module.dtd @ 1571:ad1e00b7b1c4
Donor added.
author | Maxim Konovalov <maxim@nginx.com> |
---|---|
date | Mon, 21 Sep 2015 08:52:43 +0000 |
parents | 1594ed379f1f |
children | ac9fa096b685 |
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 |
598
1902d38f0b05
"editor" and "translator" in articles are now output regardless of
Ruslan Ermilov <ru@nginx.com>
parents:
590
diff
changeset
|
13 translator CDATA #IMPLIED |
590
05761a8e38f6
Added an option to disable generation of TOC.
Ruslan Ermilov <ru@nginx.com>
parents:
588
diff
changeset
|
14 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
|
15 > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
16 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
17 <!ELEMENT section (directive | para)+ > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
18 <!ATTLIST section |
110
40eec261c2a6
Added proper support for anonymous sections, notably for the summary.
Ruslan Ermilov <ru@nginx.com>
parents:
108
diff
changeset
|
19 id ID #REQUIRED |
40eec261c2a6
Added proper support for anonymous sections, notably for the summary.
Ruslan Ermilov <ru@nginx.com>
parents:
108
diff
changeset
|
20 name CDATA #IMPLIED |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
21 > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
22 |
631
9015b4a0df44
All directives have configuration context; require that.
Ruslan Ermilov <ru@nginx.com>
parents:
598
diff
changeset
|
23 <!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
|
24 <!ATTLIST directive |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
25 name ID #REQUIRED |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
26 > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
27 |
271 | 28 <!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
|
29 <!ATTLIST syntax |
72524ae53106
Explicitly marked directives with the block syntax. Such directives will
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
30 block (yes | no) "no" |
72524ae53106
Explicitly marked directives with the block syntax. Such directives will
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
31 > |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
32 |
101
b8fd014ec712
The <default> doesn't need <code> inside it.
Ruslan Ermilov <ru@nginx.com>
parents:
76
diff
changeset
|
33 <!ELEMENT default (#PCDATA)* > |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
34 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
35 <!ELEMENT context (#PCDATA)* > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
36 |
171
6eeaa9e1f3b5
Made "appeared-in" an element, and added support for
Ruslan Ermilov <ru@nginx.com>
parents:
148
diff
changeset
|
37 <!ELEMENT appeared-in (#PCDATA)* > |
6eeaa9e1f3b5
Made "appeared-in" an element, and added support for
Ruslan Ermilov <ru@nginx.com>
parents:
148
diff
changeset
|
38 |
271 | 39 <!ELEMENT para (#PCDATA | c-def | c-func | command | |
147 | 40 emphasis | example | header | http-status | link | |
953
aded7086e84f
Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
758
diff
changeset
|
41 list | literal | note | path | value | var | |
aded7086e84f
Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
758
diff
changeset
|
42 mainline_version | stable_version | commercial_version)* > |
55
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-def (#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 c-func (#PCDATA)* > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
47 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
48 <!ELEMENT command (#PCDATA)* > |
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 emphasis (#PCDATA | value)* > |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
51 |
76
4a4caa566120
Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
55
diff
changeset
|
52 <!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
|
53 |
271 | 54 <!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
|
55 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
56 <!ELEMENT http-status EMPTY > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
57 <!ATTLIST http-status |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
58 code CDATA #REQUIRED |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
59 text CDATA #IMPLIED |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
60 > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
61 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
62 <!ELEMENT link (#PCDATA)* > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
63 <!ATTLIST link |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
64 doc CDATA #IMPLIED |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
65 id CDATA #IMPLIED |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
66 url CDATA #IMPLIED |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
67 > |
22 | 68 |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
69 <!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
|
70 <!ATTLIST list |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
71 type (bullet | enum | tag) #REQUIRED |
473
cac48e2d0d9b
Added the "compact" attribute to the "list" element.
Ruslan Ermilov <ru@nginx.com>
parents:
414
diff
changeset
|
72 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
|
73 > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
74 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
75 <!ELEMENT listitem ANY > |
758
9155b937f8c1
Allow to create anchors in list items of module-type documents.
Ruslan Ermilov <ru@nginx.com>
parents:
631
diff
changeset
|
76 <!ATTLIST listitem |
9155b937f8c1
Allow to create anchors in list items of module-type documents.
Ruslan Ermilov <ru@nginx.com>
parents:
631
diff
changeset
|
77 id ID #IMPLIED |
9155b937f8c1
Allow to create anchors in list items of module-type documents.
Ruslan Ermilov <ru@nginx.com>
parents:
631
diff
changeset
|
78 > |
9155b937f8c1
Allow to create anchors in list items of module-type documents.
Ruslan Ermilov <ru@nginx.com>
parents:
631
diff
changeset
|
79 |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
80 <!ELEMENT tag-name ANY > |
758
9155b937f8c1
Allow to create anchors in list items of module-type documents.
Ruslan Ermilov <ru@nginx.com>
parents:
631
diff
changeset
|
81 <!ATTLIST tag-name |
9155b937f8c1
Allow to create anchors in list items of module-type documents.
Ruslan Ermilov <ru@nginx.com>
parents:
631
diff
changeset
|
82 id ID #IMPLIED |
9155b937f8c1
Allow to create anchors in list items of module-type documents.
Ruslan Ermilov <ru@nginx.com>
parents:
631
diff
changeset
|
83 > |
9155b937f8c1
Allow to create anchors in list items of module-type documents.
Ruslan Ermilov <ru@nginx.com>
parents:
631
diff
changeset
|
84 |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
85 <!ELEMENT tag-desc ANY > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
86 |
414
71d99de7ff97
Allow "value" inside "literal".
Ruslan Ermilov <ru@nginx.com>
parents:
271
diff
changeset
|
87 <!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
|
88 |
271 | 89 <!ELEMENT note ANY > |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
90 |
148
682163f2b298
Unified article/path and module/pathname into a single "path".
Ruslan Ermilov <ru@nginx.com>
parents:
147
diff
changeset
|
91 <!ELEMENT path (#PCDATA)* > |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
92 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
93 <!ELEMENT value (#PCDATA)* > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
94 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
95 <!ELEMENT var (#PCDATA)* > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
96 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
97 <!ENTITY nbsp " " > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
98 <!ENTITY mdash " - " > |
953
aded7086e84f
Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
758
diff
changeset
|
99 |
aded7086e84f
Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
758
diff
changeset
|
100 <!ELEMENT mainline_version EMPTY > |
aded7086e84f
Commercial version documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
758
diff
changeset
|
101 <!ELEMENT stable_version EMPTY > |
1128
1594ed379f1f
De-i18n'ed <commercial_version/>.
Ruslan Ermilov <ru@nginx.com>
parents:
953
diff
changeset
|
102 <!ELEMENT commercial_version (#PCDATA) > |