~ubuntu-branches/ubuntu/jaunty/python-docutils/jaunty

« back to all changes in this revision

Viewing changes to spec/pysource.dtd

  • Committer: Bazaar Package Importer
  • Author(s): martin f. krafft
  • Date: 2006-07-10 11:45:05 UTC
  • mfrom: (2.1.4 edgy)
  • Revision ID: james.westby@ubuntu.com-20060710114505-otkhqcslevewxmz5
Tags: 0.4-3
Added build dependency on python-central (closes: #377580).

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<!--
2
 
======================================================================
3
 
    Docutils Python Source DTD
4
 
======================================================================
5
 
:Author: David Goodger
6
 
:Contact: goodger@users.sourceforge.net
7
 
:Revision: $Revision: 1.8 $
8
 
:Date: $Date: 2002/11/28 03:43:57 $
9
 
:Copyright: This DTD has been placed in the public domain.
10
 
:Filename: pysource.dtd
11
 
 
12
 
This DTD (document type definition) extends the Generic DTD (see
13
 
below).
14
 
 
15
 
More information about this DTD and the Docutils project can be found
16
 
at http://docutils.sourceforge.net/.  The latest version of this DTD
17
 
is available from http://docutils.sourceforge.net/spec/pysource.dtd.
18
 
 
19
 
The formal public identifier for this DTD is::
20
 
 
21
 
    +//IDN docutils.sourceforge.net//DTD Docutils Python Source//EN//XML
22
 
-->
23
 
 
24
 
<!--
25
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26
 
    Parameter Entity Overrides
27
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
28
 
-->
29
 
 
30
 
<!ENTITY % additional.section.elements
31
 
  " | package_section | module_section | class_section
32
 
    | method_section | function_section
33
 
    | module_attribute_section | function_attribute_section
34
 
    | class_attribute_section | instance_attribute_section ">
35
 
 
36
 
<!ENTITY % additional.inline.elements
37
 
  " | package | module | class | method | function
38
 
    | variable | parameter | type | attribute
39
 
    | module_attribute | class_attribute | instance_attribute
40
 
    | exception_class | warning_class ">
41
 
 
42
 
<!--
43
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
44
 
    Generic DTD
45
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
46
 
 
47
 
This DTD extends the Docutils Generic DTD, available from
48
 
http://docutils.sourceforge.net/spec/docutils.dtd.
49
 
-->
50
 
 
51
 
<!ENTITY % docutils PUBLIC
52
 
    "+//IDN python.org//DTD Docutils Generic//EN//XML"
53
 
    "docutils.dtd">
54
 
%docutils;
55
 
 
56
 
<!--
57
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
58
 
    Additional Section Elements
59
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
60
 
-->
61
 
 
62
 
<!ELEMENT package_section
63
 
    (package, fullname?, import_list?, %structure.model;)>
64
 
<!ATTLIST package_section %basic.atts;>
65
 
 
66
 
<!ELEMENT module_section
67
 
    (module, fullname?, import_list?, %structure.model;)>
68
 
<!ATTLIST module_section %basic.atts;>
69
 
 
70
 
<!ELEMENT class_section
71
 
    (class, inheritance_list?, fullname?, subclasses?,
72
 
     %structure.model;)>
73
 
<!ATTLIST class_section %basic.atts;>
74
 
 
75
 
<!ELEMENT method_section
76
 
    (method, parameter_list?, fullname?, overrides?,
77
 
     %structure.model;)>
78
 
<!ATTLIST method_section %basic.atts;>
79
 
 
80
 
<!ELEMENT function_section
81
 
    (function, parameter_list?, fullname?, %structure.model;)>
82
 
<!ATTLIST function_section %basic.atts;>
83
 
 
84
 
<!ELEMENT module_attribute_section
85
 
    (attribute, initial_value?, fullname?, %structure.model;)>
86
 
<!ATTLIST module_attribute_section %basic.atts;>
87
 
 
88
 
<!ELEMENT function_attribute_section
89
 
    (attribute, initial_value?, fullname?, %structure.model;)>
90
 
<!ATTLIST function_attribute_section %basic.atts;>
91
 
 
92
 
<!ELEMENT class_attribute_section
93
 
    (attribute, initial_value?, fullname?, overrides?,
94
 
     %structure.model;)>
95
 
<!ATTLIST class_attribute_section %basic.atts;>
96
 
 
97
 
<!ELEMENT instance_attribute_section
98
 
    (attribute, initial_value?, fullname?, overrides?,
99
 
     %structure.model;)>
100
 
<!ATTLIST instance_attribute_section %basic.atts;>
101
 
 
102
 
<!--
103
 
    Section Subelements
104
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
105
 
-->
106
 
 
107
 
<!ELEMENT fullname
108
 
    (package | module | class | method | function | attribute)+>
109
 
<!ATTLIST fullname %basic.atts;>
110
 
 
111
 
<!ELEMENT import_list (import_item+)>
112
 
<!ATTLIST import_list %basic.atts;>
113
 
 
114
 
<!--
115
 
Support ``import module``, ``import module as alias``, ``from module
116
 
import identifier``, and ``from module import identifier as alias``.
117
 
-->
118
 
<!ELEMENT import_item (fullname, identifier?, alias?)>
119
 
<!ATTLIST import_item %basic.atts;>
120
 
 
121
 
<!ELEMENT inheritance_list (class+)>
122
 
<!ATTLIST inheritance_list %basic.atts;>
123
 
 
124
 
<!ELEMENT subclasses (class+)>
125
 
<!ATTLIST subclasses %basic.atts;>
126
 
 
127
 
<!ELEMENT parameter_list
128
 
    ((parameter_item+, optional_parameters*) | optional_parameters+)>
129
 
<!ATTLIST parameter_list %basic.atts;>
130
 
 
131
 
<!ELEMENT parameter_item
132
 
    ((parameter | parameter_tuple), parameter_default?)>
133
 
<!ATTLIST parameter_item %basic.atts;>
134
 
 
135
 
<!ELEMENT optional_parameters (parameter_item+, optional_parameters*)>
136
 
<!ATTLIST optional_parameters %basic.atts;>
137
 
 
138
 
<!ELEMENT parameter_tuple (parameter | parameter_tuple)+>
139
 
<!ATTLIST parameter_tuple %basic.atts;>
140
 
 
141
 
<!ELEMENT parameter_default (#PCDATA)>
142
 
<!ATTLIST parameter_default %basic.atts;>
143
 
 
144
 
<!ELEMENT overrides (fullname+)>
145
 
<!ATTLIST overrides %basic.atts;>
146
 
 
147
 
<!ELEMENT initial_value (#PCDATA)>
148
 
<!ATTLIST initial_value %basic.atts;>
149
 
 
150
 
<!--
151
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
152
 
    Additional Inline Elements
153
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
154
 
-->
155
 
 
156
 
<!-- Also used as the `package_section` identifier/title. -->
157
 
<!ELEMENT package (#PCDATA)>
158
 
<!ATTLIST package
159
 
    %basic.atts;
160
 
    %reference.atts;>
161
 
 
162
 
<!-- Also used as the `module_section` identifier/title. -->
163
 
<!ELEMENT module (#PCDATA)>
164
 
<!ATTLIST module
165
 
    %basic.atts;
166
 
    %reference.atts;>
167
 
 
168
 
<!--
169
 
Also used as the `class_section` identifier/title, and in the
170
 
`inheritance` element.
171
 
-->
172
 
<!ELEMENT class (#PCDATA)>
173
 
<!ATTLIST class
174
 
    %basic.atts;
175
 
    %reference.atts;>
176
 
 
177
 
<!-- Also used as the `method_section` identifier/title. -->
178
 
<!ELEMENT method (#PCDATA)>
179
 
<!ATTLIST method
180
 
    %basic.atts;
181
 
    %reference.atts;>
182
 
 
183
 
<!-- Also used as the `function_section` identifier/title. -->
184
 
<!ELEMENT function (#PCDATA)>
185
 
<!ATTLIST function
186
 
    %basic.atts;
187
 
    %reference.atts;>
188
 
 
189
 
<!--
190
 
??? Use this instead of the ``*_attribute`` elements below?  Add a
191
 
"type" attribute to differentiate?
192
 
 
193
 
Also used as the identifier/title for `module_attribute_section`,
194
 
`class_attribute_section`, and `instance_attribute_section`.
195
 
-->
196
 
<!ELEMENT attribute (#PCDATA)>
197
 
<!ATTLIST attribute
198
 
    %basic.atts;
199
 
    %reference.atts;>
200
 
 
201
 
<!--
202
 
Also used as the `module_attribute_section` identifier/title. A module
203
 
attribute is an exported module-level global variable.
204
 
-->
205
 
<!ELEMENT module_attribute (#PCDATA)>
206
 
<!ATTLIST module_attribute
207
 
    %basic.atts;
208
 
    %reference.atts;>
209
 
 
210
 
<!-- Also used as the `class_attribute_section` identifier/title. -->
211
 
<!ELEMENT class_attribute (#PCDATA)>
212
 
<!ATTLIST class_attribute
213
 
    %basic.atts;
214
 
    %reference.atts;>
215
 
 
216
 
<!--
217
 
Also used as the `instance_attribute_section` identifier/title.
218
 
-->
219
 
<!ELEMENT instance_attribute (#PCDATA)>
220
 
<!ATTLIST instance_attribute
221
 
    %basic.atts;
222
 
    %reference.atts;>
223
 
 
224
 
<!ELEMENT variable (#PCDATA)>
225
 
<!ATTLIST variable
226
 
    %basic.atts;
227
 
    %reference.atts;>
228
 
 
229
 
<!-- Also used in `parameter_list`. -->
230
 
<!ELEMENT parameter (#PCDATA)>
231
 
<!ATTLIST parameter
232
 
    %basic.atts;
233
 
    %reference.atts;
234
 
    excess_positional  %yesorno;  #IMPLIED
235
 
    excess_keyword     %yesorno;  #IMPLIED>
236
 
 
237
 
<!ELEMENT type (#PCDATA)>
238
 
<!ATTLIST type
239
 
    %basic.atts;
240
 
    %reference.atts;>
241
 
 
242
 
<!ELEMENT exception_class (#PCDATA)>
243
 
<!ATTLIST exception_class
244
 
    %basic.atts;
245
 
    %reference.atts;>
246
 
 
247
 
<!ELEMENT warning_class (#PCDATA)>
248
 
<!ATTLIST warning_class
249
 
    %basic.atts;
250
 
    %reference.atts;>
251
 
 
252
 
<!--
253
 
Local Variables:
254
 
mode: sgml
255
 
indent-tabs-mode: nil
256
 
fill-column: 70
257
 
End:
258
 
-->