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
|
<?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>epydoc.markup.restructuredtext._SplitFieldsTranslator</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">
<a href="epydoc-module.html">Package epydoc</a> ::
<a href="epydoc.markup-module.html">Package markup</a> ::
<a href="epydoc.markup.restructuredtext-module.html">Module restructuredtext</a> ::
Class _SplitFieldsTranslator
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<b>show private</b> | hide private]</font></td></tr>
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="../private/epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class _SplitFieldsTranslator</h2>
<pre class="base-tree">
<a href="docutils.nodes.NodeVisitor-class.html"><code>NodeVisitor</code></a> --+
|
<b>_SplitFieldsTranslator</b>
</pre><br />
<hr/>
A docutils translator that removes all fields from a document, and
collects them into the instance variable <code>fields</code>
<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><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>document</span>,
<span class=summary-sig-arg>errors</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_add_field"></a><span class="summary-sig"><span class="summary-sig-name">_add_field</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>tagname</span>,
<span class=summary-sig-arg>arg</span>,
<span class=summary-sig-arg>fbody</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="../private/epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html#handle_consolidated_field" class="summary-sig-name"><code>handle_consolidated_field</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>body</span>,
<span class=summary-sig-arg>tagname</span>)</span></code>
<br />
Attempt to handle a consolidated section.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="../private/epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html#unknown_visit" class="summary-sig-name"><code>unknown_visit</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>node</span>)</span></code>
<br />
Ignore all unknown nodes</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="visit_document"></a><span class="summary-sig"><span class="summary-sig-name">visit_document</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>node</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="visit_field"></a><span class="summary-sig"><span class="summary-sig-name">visit_field</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>node</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="visit_field_list"></a><span class="summary-sig"><span class="summary-sig-name">visit_field_list</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>node</span>)</span></code>
</td></tr>
<tr><td colspan="2">
<b>Inherited from <a href="docutils.nodes.NodeVisitor-class.html"><code>NodeVisitor</code></a>:</b>
<a href="docutils.nodes.NodeVisitor-class.html#unknown_departure"><code>unknown_departure</code></a>
</td></tr>
</table><br />
<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Instance Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code> of <a
href="epydoc.markup.Field-class.html"
class="link"><code>Field</code></a></font></td>
<td><b><a href="../private/epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html#fields"><code>fields</code></a></b>: The fields of the most recently walked document.</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="handle_consolidated_field"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">handle_consolidated_field</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>body</span>,
<span class=sig-arg>tagname</span>)</span>
</h3>
Attempt to handle a consolidated section.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="unknown_visit"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">unknown_visit</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>node</span>)</span>
</h3>
Ignore all unknown nodes
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="docutils.nodes.NodeVisitor-class.html#unknown_visit"><code>docutils.nodes.NodeVisitor.unknown_visit</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF INSTANCE VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Instance Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="fields"></a>
<h3>fields</h3>
The fields of the most recently walked document.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>list</code> of <a
href="epydoc.markup.Field-class.html"
class="link"><code>Field</code></a>
</dd>
</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:13 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>
|
