summaryrefslogtreecommitdiffstats
path: root/docs/manual/style/modulesynopsis.dtd
blob: aa3d6ee9d5eba6cd366b96633255b3e4672cbc0c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
<?xml version='1.0' encoding='UTF-8' ?>

<!--
 Licensed to the Apache Software Foundation (ASF) under one or more
 contributor license agreements.  See the NOTICE file distributed with
 this work for additional information regarding copyright ownership.
 The ASF licenses this file to You under the Apache License, Version 2.0
 (the "License"); you may not use this file except in compliance with
 the License.  You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
-->

<!ENTITY % sitemap SYSTEM "sitemap.dtd">
%sitemap;

<!ELEMENT modulesynopsis (name , description, status, hint?, sourcefile?,
identifier? , compatibility? , summary? , seealso* , section*,
directivesynopsis*)>

<!ATTLIST modulesynopsis metafile CDATA  #REQUIRED
                         upgrade  CDATA  #IMPLIED>

<!ELEMENT directivesynopsis (name , description? , syntax? , default?
, contextlist? , override? , modulelist?, status?, compatibility? ,
usage?, seealso*)>

<!ELEMENT name (#PCDATA)>

<!ELEMENT status (#PCDATA)>

<!ELEMENT hint %Inline;>

<!ELEMENT identifier (#PCDATA)>

<!ELEMENT sourcefile (#PCDATA)>

<!ELEMENT compatibility %Inline;>

<!ELEMENT description %Inline;>

<!-- 
 idtype is appended to the directive name when generating links to allow
 a directive of type section to share the name with another directive.
 The attribute type could have been (re)used instead but it would have broken
 pre-existing links.
-->
<!ATTLIST directivesynopsis  type       CDATA  #IMPLIED
                             idtype     CDATA  #IMPLIED
                             location   CDATA  #IMPLIED >

<!ELEMENT syntax %Inline;>

<!ELEMENT default (#PCDATA | directive | br)*>

<!ELEMENT contextlist (context+)+>

<!ELEMENT context (#PCDATA)>

<!ELEMENT override (#PCDATA)>

<!ELEMENT usage %Block;>

<!-- Used in index.xml -->
<!ELEMENT moduleindex (title, summary, seealso*)>

<!ATTLIST moduleindex metafile CDATA  #REQUIRED>

<!-- Used in directive.xml -->
<!ELEMENT directiveindex (title | summary)+>

<!ATTLIST directiveindex metafile CDATA  #REQUIRED>

<!-- Used in quickreference.xml -->
<!ELEMENT quickreference (title | summary | legend)+>
<!ATTLIST quickreference metafile CDATA  #REQUIRED>

<!ELEMENT legend (table, table)>

<!-- Used in overrides.xml -->
<!ELEMENT overrideindex (title | summary | overridesummary)+>
<!ATTLIST overrideindex metafile CDATA #REQUIRED>

<!ELEMENT overridesummary %Block;>
<!ATTLIST overridesummary class    CDATA #IMPLIED
                          fallback CDATA #IMPLIED>