← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/dev/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
http://bugs.debian.org/377580
Added build dependency on python-central (closes: #377580).

Show diffs side-by-side

added added

removed removed

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