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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>docutils.readers.Reader</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="epydoc-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
Package docutils ::
Package readers ::
Class Reader
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[show private | <a href="../public/docutils.readers.Reader-class.html">hide private</a>]</font></td></tr>
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="docutils.readers.Reader-class.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class Reader</h2>
<pre class="base-tree">
<a href="docutils.SettingsSpec-class.html"><code>SettingsSpec</code></a> --+
|
<a href="docutils.TransformSpec-class.html"><code>TransformSpec</code></a> --+
|
<a href="docutils.Component-class.html"><code>Component</code></a> --+
|
<b>Reader</b>
</pre><br />
<dl><dt><b>Known Subclasses:</b></dt>
<dd>
<a href="docutils.readers.standalone.Reader-class.html"><code>Reader</code></a></dd></dl>
<hr/>
<p>Abstract base class for docutils Readers.</p>
<p>Each reader module or package must export a subclass also called 'Reader'.</p>
<p>The three steps of a Reader's responsibility are defined: <code>scan()</code>,
<a href="docutils.readers.Reader-class.html#parse" class="link"><code>parse()</code></a>, and <code>transform()</code>. Call <a href="docutils.readers.Reader-class.html#read" class="link"><code>read()</code></a> to process a document.</p>
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="docutils.readers.Reader-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>parser</span>,
<span class=summary-sig-arg>parser_name</span>)</span></code>
<br />
Initialize the Reader instance.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="docutils.readers.Reader-class.html#new_document" class="summary-sig-name"><code>new_document</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Create and return a new empty document tree (root node).</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="docutils.readers.Reader-class.html#parse" class="summary-sig-name"><code>parse</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Parse <code>self.input</code> into a document tree.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="read"></a><span class="summary-sig"><span class="summary-sig-name">read</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>source</span>,
<span class=summary-sig-arg>parser</span>,
<span class=summary-sig-arg>settings</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="docutils.readers.Reader-class.html#set_parser" class="summary-sig-name"><code>set_parser</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>parser_name</span>)</span></code>
<br />
Set <code>self.parser</code> by name.</td></tr>
<tr><td colspan="2">
<b>Inherited from <a href="docutils.Component-class.html"><code>Component</code></a>:</b>
<a href="docutils.Component-class.html#supports"><code>supports</code></a>
</td></tr>
</table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="docutils.readers.Reader-class.html#component_type"><code>component_type</code></a></b> = <span title="'reader'"><code><span class="variable-quote">'</span>reader<span class="variable-quote">'</span> </code>
</span></td></tr>
<tr><td colspan="2">
<b>Inherited from <a href="docutils.Component-class.html"><code>Component</code></a>:</b>
<a href="docutils.Component-class.html#supported"><code>supported</code></a>
<br />
<b>Inherited from <a href="docutils.SettingsSpec-class.html"><code>SettingsSpec</code></a>:</b>
<a href="docutils.SettingsSpec-class.html#relative_path_settings"><code>relative_path_settings</code></a>,
<a href="docutils.SettingsSpec-class.html#settings_default_overrides"><code>settings_default_overrides</code></a>,
<a href="docutils.SettingsSpec-class.html#settings_defaults"><code>settings_defaults</code></a>,
<a href="docutils.SettingsSpec-class.html#settings_spec"><code>settings_spec</code></a>
<br />
<b>Inherited from <a href="docutils.TransformSpec-class.html"><code>TransformSpec</code></a>:</b>
<a href="docutils.TransformSpec-class.html#default_transforms"><code>default_transforms</code></a>
</td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="__init__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>parser</span>=<span class=sig-default>None</span>,
<span class=sig-arg>parser_name</span>=<span class=sig-default>'restructuredtext'</span>)</span>
<br /><i>(Constructor)</i>
</h3>
<p>Initialize the Reader instance.</p>
<p>Several instance attributes are defined with dummy initial values.
Subclasses may use these attributes as they wish.</p>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="new_document"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">new_document</span>(<span class=sig-arg>self</span>)</span>
</h3>
Create and return a new empty document tree (root node). <dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="parse"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">parse</span>(<span class=sig-arg>self</span>)</span>
</h3>
Parse <code>self.input</code> into a document tree. <dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="set_parser"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">set_parser</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>parser_name</span>)</span>
</h3>
Set <code>self.parser</code> by name. <dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="component_type"></a>
<h3>component_type</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'reader'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>reader<span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="epydoc-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Mar 20 17:46:16 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>
|
