Mercurial > hg > nginx-site
annotate dtd/module.dtd @ 271:4c6d2c614d2c
Cleaned up XML tag mess:
- all of <parameter> and <code>, and some of <dirname>, <value>,
and <command> were replaced by <literal>;
- the rest of <dirname> were replaced by links;
- <argument> were replaced by <value>;
- <value> is now rendered in HTML in italic;
- <literal> and <path> can now contain <value>.
Cleaned up terminology mess:
- directives take "parameters".
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Fri, 23 Dec 2011 17:29:59 +0000 |
parents | 6eeaa9e1f3b5 |
children | 71d99de7ff97 |
rev | line source |
---|---|
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
1 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
2 <!ELEMENT module (section+) > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
3 <!ATTLIST module |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
4 name CDATA #REQUIRED |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
5 link CDATA #REQUIRED |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
6 lang CDATA #REQUIRED |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
7 > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
8 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
9 <!ELEMENT section (directive | para)+ > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
10 <!ATTLIST section |
110
40eec261c2a6
Added proper support for anonymous sections, notably for the summary.
Ruslan Ermilov <ru@nginx.com>
parents:
108
diff
changeset
|
11 id ID #REQUIRED |
40eec261c2a6
Added proper support for anonymous sections, notably for the summary.
Ruslan Ermilov <ru@nginx.com>
parents:
108
diff
changeset
|
12 name CDATA #IMPLIED |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
13 > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
14 |
171
6eeaa9e1f3b5
Made "appeared-in" an element, and added support for
Ruslan Ermilov <ru@nginx.com>
parents:
148
diff
changeset
|
15 <!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
|
16 <!ATTLIST directive |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
17 name ID #REQUIRED |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
18 > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
19 |
271 | 20 <!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
|
21 <!ATTLIST syntax |
72524ae53106
Explicitly marked directives with the block syntax. Such directives will
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
22 block (yes | no) "no" |
72524ae53106
Explicitly marked directives with the block syntax. Such directives will
Ruslan Ermilov <ru@nginx.com>
parents:
102
diff
changeset
|
23 > |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
24 |
101
b8fd014ec712
The <default> doesn't need <code> inside it.
Ruslan Ermilov <ru@nginx.com>
parents:
76
diff
changeset
|
25 <!ELEMENT default (#PCDATA)* > |
55
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 <!ELEMENT context (#PCDATA)* > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
28 |
171
6eeaa9e1f3b5
Made "appeared-in" an element, and added support for
Ruslan Ermilov <ru@nginx.com>
parents:
148
diff
changeset
|
29 <!ELEMENT appeared-in (#PCDATA)* > |
6eeaa9e1f3b5
Made "appeared-in" an element, and added support for
Ruslan Ermilov <ru@nginx.com>
parents:
148
diff
changeset
|
30 |
271 | 31 <!ELEMENT para (#PCDATA | c-def | c-func | command | |
147 | 32 emphasis | example | header | http-status | link | |
271 | 33 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
|
34 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
35 <!ELEMENT c-def (#PCDATA)* > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
36 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
37 <!ELEMENT c-func (#PCDATA)* > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
38 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
39 <!ELEMENT command (#PCDATA)* > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
40 |
76
4a4caa566120
Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
55
diff
changeset
|
41 <!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
|
42 |
76
4a4caa566120
Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
55
diff
changeset
|
43 <!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
|
44 |
271 | 45 <!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
|
46 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
47 <!ELEMENT http-status EMPTY > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
48 <!ATTLIST http-status |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
49 code CDATA #REQUIRED |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
50 text CDATA #IMPLIED |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
51 > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
52 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
53 <!ELEMENT link (#PCDATA)* > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
54 <!ATTLIST link |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
55 doc CDATA #IMPLIED |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
56 id CDATA #IMPLIED |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
57 url CDATA #IMPLIED |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
58 > |
22 | 59 |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
60 <!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
|
61 <!ATTLIST list |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
62 type (bullet | enum | tag) #REQUIRED |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
63 > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
64 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
65 <!ELEMENT listitem ANY > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
66 <!ELEMENT tag-name ANY > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
67 <!ELEMENT tag-desc ANY > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
68 |
271 | 69 <!ELEMENT literal (#PCDATA)* > |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
70 |
271 | 71 <!ELEMENT note ANY > |
55
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
72 |
148
682163f2b298
Unified article/path and module/pathname into a single "path".
Ruslan Ermilov <ru@nginx.com>
parents:
147
diff
changeset
|
73 <!ELEMENT path (#PCDATA)* > |
55
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 value (#PCDATA)* > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
76 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
77 <!ELEMENT var (#PCDATA)* > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
78 |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
79 <!ENTITY nbsp " " > |
8213f3f1c93d
Updated DTD for modules and made modules documentation to be
Ruslan Ermilov <ru@nginx.com>
parents:
22
diff
changeset
|
80 <!ENTITY mdash " - " > |