annotate docs/dtd/module.dtd @ 4081:deab88e4c35a

Basic inter-document and external linking support.
author Ruslan Ermilov <ru@nginx.com>
date Thu, 08 Sep 2011 13:26:06 +0000
parents 24f511e94057
children db565f0198f5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3996
fc808f006ff4 skeleton for documentation processing
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
1
4066
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
2 <!ELEMENT module (section+) >
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
3 <!ATTLIST module
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
4 name CDATA #REQUIRED
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
5 id ID #REQUIRED
3996
fc808f006ff4 skeleton for documentation processing
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
6 >
fc808f006ff4 skeleton for documentation processing
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
7
4077
24f511e94057 New elements: "dq", "pathname"; new list type: "tag".
Ruslan Ermilov <ru@nginx.com>
parents: 4066
diff changeset
8 <!ELEMENT section (directive | para)+ >
4066
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
9 <!ATTLIST section
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
10 name CDATA #REQUIRED
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
11 id ID #IMPLIED
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
12 >
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
13
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
14 <!ELEMENT directive (syntax+, default, context+, para+) >
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
15 <!ATTLIST directive
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
16 name ID #REQUIRED
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
17 appeared-in CDATA #IMPLIED
3996
fc808f006ff4 skeleton for documentation processing
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
18 >
fc808f006ff4 skeleton for documentation processing
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
19
4066
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
20 <!ELEMENT syntax (#PCDATA | argument | code | parameter | value)* >
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
21
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
22 <!ELEMENT default (#PCDATA | code)* >
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
23
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
24 <!ELEMENT context (#PCDATA)* >
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
25
4077
24f511e94057 New elements: "dq", "pathname"; new list type: "tag".
Ruslan Ermilov <ru@nginx.com>
parents: 4066
diff changeset
26 <!ELEMENT para (#PCDATA | argument | c-def | c-func | code | command |
24f511e94057 New elements: "dq", "pathname"; new list type: "tag".
Ruslan Ermilov <ru@nginx.com>
parents: 4066
diff changeset
27 dq | emphasis | example | header | http-error | link |
24f511e94057 New elements: "dq", "pathname"; new list type: "tag".
Ruslan Ermilov <ru@nginx.com>
parents: 4066
diff changeset
28 list | note | parameter | pathname | value | var)* >
4066
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
29
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
30 <!ELEMENT argument (#PCDATA)* >
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
31
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
32 <!ELEMENT c-def (#PCDATA)* >
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
33
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
34 <!ELEMENT c-func (#PCDATA)* >
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
35
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
36 <!ELEMENT code (#PCDATA | value)* >
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
37
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
38 <!ELEMENT command (#PCDATA)* >
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
39
4077
24f511e94057 New elements: "dq", "pathname"; new list type: "tag".
Ruslan Ermilov <ru@nginx.com>
parents: 4066
diff changeset
40 <!ELEMENT dq ANY >
24f511e94057 New elements: "dq", "pathname"; new list type: "tag".
Ruslan Ermilov <ru@nginx.com>
parents: 4066
diff changeset
41
4066
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
42 <!ELEMENT emphasis (#PCDATA)* >
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
43
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
44 <!ELEMENT example (#PCDATA)* >
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
45
4077
24f511e94057 New elements: "dq", "pathname"; new list type: "tag".
Ruslan Ermilov <ru@nginx.com>
parents: 4066
diff changeset
46 <!ELEMENT header (#PCDATA | argument)* >
3996
fc808f006ff4 skeleton for documentation processing
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
47
4066
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
48 <!ELEMENT http-error EMPTY >
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
49 <!ATTLIST http-error
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
50 code CDATA #REQUIRED
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
51 text CDATA #IMPLIED
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
52 >
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
53
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
54 <!ELEMENT link (#PCDATA)* >
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
55 <!ATTLIST link
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
56 doc CDATA #IMPLIED
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
57 id CDATA #IMPLIED
4081
deab88e4c35a Basic inter-document and external linking support.
Ruslan Ermilov <ru@nginx.com>
parents: 4077
diff changeset
58 url CDATA #IMPLIED
4066
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
59 >
3996
fc808f006ff4 skeleton for documentation processing
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
60
4077
24f511e94057 New elements: "dq", "pathname"; new list type: "tag".
Ruslan Ermilov <ru@nginx.com>
parents: 4066
diff changeset
61 <!ELEMENT list (listitem+ | (tag-name | tag-desc)+) >
4066
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
62 <!ATTLIST list
4077
24f511e94057 New elements: "dq", "pathname"; new list type: "tag".
Ruslan Ermilov <ru@nginx.com>
parents: 4066
diff changeset
63 type (bullet | enum | tag) #REQUIRED
4066
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
64 >
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
65
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
66 <!ELEMENT listitem ANY >
4077
24f511e94057 New elements: "dq", "pathname"; new list type: "tag".
Ruslan Ermilov <ru@nginx.com>
parents: 4066
diff changeset
67 <!ELEMENT tag-name ANY >
24f511e94057 New elements: "dq", "pathname"; new list type: "tag".
Ruslan Ermilov <ru@nginx.com>
parents: 4066
diff changeset
68 <!ELEMENT tag-desc ANY >
4066
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
69
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
70 <!ELEMENT note ANY >
3996
fc808f006ff4 skeleton for documentation processing
Igor Sysoev <igor@sysoev.ru>
parents:
diff changeset
71
4066
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
72 <!ELEMENT parameter (#PCDATA)* >
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
73
4077
24f511e94057 New elements: "dq", "pathname"; new list type: "tag".
Ruslan Ermilov <ru@nginx.com>
parents: 4066
diff changeset
74 <!ELEMENT pathname (#PCDATA)* >
24f511e94057 New elements: "dq", "pathname"; new list type: "tag".
Ruslan Ermilov <ru@nginx.com>
parents: 4066
diff changeset
75
4066
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
76 <!ELEMENT value (#PCDATA)* >
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
77
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
78 <!ELEMENT var (#PCDATA)* >
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
79
ac19e755a132 DTD and XSLS changes for modules.
Ruslan Ermilov <ru@nginx.com>
parents: 3996
diff changeset
80 <!ENTITY nbsp "&#xA0;" >
4077
24f511e94057 New elements: "dq", "pathname"; new list type: "tag".
Ruslan Ermilov <ru@nginx.com>
parents: 4066
diff changeset
81 <!ENTITY mdash "&nbsp;- " >