← Back to branch summary

~ubuntu-branches/debian/lenny/epydoc/lenny

« back to all changes in this revision

Viewing changes to doc/api/private/epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html

  • Committer: Bazaar Package Importer
  • Author(s): Kenneth J. Pronovici
  • Date: 2008-02-03 13:22:12 UTC
  • mfrom: (1.2.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20080203132212-u2uohl6rswmlz2ra
Tags: 3.0.1-1
* New upstream release.
* Removed #! from top of epydoc/gui.py
* Got rid of version mangling in debian/watch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api/private/epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html
1
 
<?xml version="1.0" encoding="iso-8859-1"?>
2
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
 
          "DTD/xhtml1-transitional.dtd">
4
 
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
 
<head>
6
 
  <title>epydoc.markup.restructuredtext._SplitFieldsTranslator</title>
7
 
  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
8
 
</head>
9
 
<body bgcolor="white" text="black" link="blue" vlink="#204080"
10
 
      alink="#204080">
11
 
 
12
 
<!-- =========== START OF NAVBAR =========== -->
13
 
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
14
 
  <tr valign="center">
15
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="epydoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
16
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
17
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
18
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
19
 
    <th class="navbar" align="right" width="100%">
20
 
      <table border="0" cellpadding="0" cellspacing="0">
21
 
      <tr><th class="navbar" align="center">
22
 
        <p class="nomargin">
23
 
          <a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
24
 
      </p></th></tr></table>
25
 
    </th>
26
 
  </tr>
27
 
</table>
28
 
<table width="100%" cellpadding="0" cellspacing="0">
29
 
  <tr valign="top">
30
 
    <td width="100%">
31
 
      <font size="-1"><b class="breadcrumbs">
32
 
        <a href="epydoc-module.html">Package&nbsp;epydoc</a> ::
33
 
        <a href="epydoc.markup-module.html">Package&nbsp;markup</a> ::
34
 
        <a href="epydoc.markup.restructuredtext-module.html">Module&nbsp;restructuredtext</a> ::
35
 
        Class&nbsp;_SplitFieldsTranslator
36
 
      </b></font></br>
37
 
    </td>
38
 
    <td><table cellpadding="0" cellspacing="0">
39
 
      <tr><td align="right"><font size="-2">[<b>show&nbsp;private</b>&nbsp;|&nbsp;hide&nbsp;private]</font></td></tr>
40
 
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="../private/epydoc.markup.restructuredtext._SplitFieldsTranslator-class.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
41
 
    </table></td>
42
 
</tr></table>
43
 
 
44
 
<!-- =========== START OF CLASS DESCRIPTION =========== -->
45
 
<h2 class="class">Class _SplitFieldsTranslator</h2>
46
 
 
47
 
<pre class="base-tree">
48
 
<a href="docutils.nodes.NodeVisitor-class.html"><code>NodeVisitor</code></a> --+
49
 
              |
50
 
             <b>_SplitFieldsTranslator</b>
51
 
</pre><br />
52
 
 
53
 
<hr/>
54
 
 
55
 
A docutils translator that removes all fields from a document, and 
56
 
collects them into the instance variable <code>fields</code>
57
 
<hr/>
58
 
 
59
 
 
60
 
<!-- =========== START OF METHOD SUMMARY =========== -->
61
 
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
62
 
<tr bgcolor="#70b0f0" class="summary">
63
 
  <th colspan="2">Method Summary</th></tr>
64
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
65
 
  <td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
66
 
          <span class=summary-sig-arg>document</span>,
67
 
          <span class=summary-sig-arg>errors</span>)</span></code>
68
 
</td></tr>
69
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
70
 
  <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>,
71
 
          <span class=summary-sig-arg>tagname</span>,
72
 
          <span class=summary-sig-arg>arg</span>,
73
 
          <span class=summary-sig-arg>fbody</span>)</span></code>
74
 
</td></tr>
75
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
76
 
  <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>,
77
 
          <span class=summary-sig-arg>body</span>,
78
 
          <span class=summary-sig-arg>tagname</span>)</span></code>
79
 
<br />
80
 
Attempt to handle a consolidated section.</td></tr>
81
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
82
 
  <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>,
83
 
          <span class=summary-sig-arg>node</span>)</span></code>
84
 
<br />
85
 
Ignore all unknown nodes</td></tr>
86
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
87
 
  <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>,
88
 
          <span class=summary-sig-arg>node</span>)</span></code>
89
 
</td></tr>
90
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
91
 
  <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>,
92
 
          <span class=summary-sig-arg>node</span>)</span></code>
93
 
</td></tr>
94
 
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
95
 
  <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>,
96
 
          <span class=summary-sig-arg>node</span>)</span></code>
97
 
</td></tr>
98
 
  <tr><td colspan="2">
99
 
    <b>Inherited from <a href="docutils.nodes.NodeVisitor-class.html"><code>NodeVisitor</code></a>:</b>
100
 
      <a href="docutils.nodes.NodeVisitor-class.html#unknown_departure"><code>unknown_departure</code></a>
101
 
    </td></tr>
102
 
</table><br />
103
 
 
104
 
 
105
 
<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== -->
106
 
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
107
 
<tr bgcolor="#70b0f0" class="summary">
108
 
  <th colspan="2">Instance Variable Summary</th></tr>
109
 
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code> of <a 
110
 
          href="epydoc.markup.Field-class.html" 
111
 
          class="link"><code>Field</code></a></font></td>
112
 
<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>
113
 
</table><br />
114
 
 
115
 
 
116
 
<!-- =========== START OF METHOD DETAILS =========== -->
117
 
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
118
 
<tr bgcolor="#70b0f0" class="details">
119
 
  <th colspan="2">Method Details</th></tr>
120
 
</table>
121
 
 
122
 
<a name="handle_consolidated_field"></a>
123
 
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
124
 
  <h3><span class="sig"><span class="sig-name">handle_consolidated_field</span>(<span class=sig-arg>self</span>,
125
 
          <span class=sig-arg>body</span>,
126
 
          <span class=sig-arg>tagname</span>)</span>
127
 
  </h3>
128
 
  Attempt to handle a consolidated section.
129
 
  <dl><dt></dt><dd>
130
 
  </dd></dl>
131
 
</td></tr></table>
132
 
 
133
 
<a name="unknown_visit"></a>
134
 
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
135
 
  <h3><span class="sig"><span class="sig-name">unknown_visit</span>(<span class=sig-arg>self</span>,
136
 
          <span class=sig-arg>node</span>)</span>
137
 
  </h3>
138
 
  Ignore all unknown nodes
139
 
  <dl><dt></dt><dd>
140
 
    <dl><dt><b>Overrides:</b></dt>
141
 
      <dd><a href="docutils.nodes.NodeVisitor-class.html#unknown_visit"><code>docutils.nodes.NodeVisitor.unknown_visit</code></a></dd>
142
 
    </dl>
143
 
  </dd></dl>
144
 
</td></tr></table>
145
 
<br />
146
 
 
147
 
 
148
 
<!-- =========== START OF INSTANCE VARIABLE DETAILS =========== -->
149
 
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
150
 
<tr bgcolor="#70b0f0" class="details">
151
 
  <th colspan="2">Instance Variable Details</th></tr>
152
 
</table>
153
 
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
154
 
<a name="fields"></a>
155
 
<h3>fields</h3>
156
 
The fields of the most recently walked document.
157
 
<dl>
158
 
  <dt></dt>
159
 
  <dd>
160
 
    <dl>
161
 
      <dt><b>Type:</b></dt>
162
 
      <dd>
163
 
          <code>list</code> of <a 
164
 
          href="epydoc.markup.Field-class.html" 
165
 
          class="link"><code>Field</code></a>
166
 
 
167
 
      </dd>
168
 
    </dl>
169
 
  </dd>
170
 
</dl></td></tr></table>
171
 
<br />
172
 
 
173
 
 
174
 
<!-- =========== START OF NAVBAR =========== -->
175
 
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
176
 
  <tr valign="center">
177
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="epydoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
178
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
179
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
180
 
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
181
 
    <th class="navbar" align="right" width="100%">
182
 
      <table border="0" cellpadding="0" cellspacing="0">
183
 
      <tr><th class="navbar" align="center">
184
 
        <p class="nomargin">
185
 
          <a class="navbar" target="_top" href="http://epydoc.sourceforge.net">epydoc 2.0</a>
186
 
      </p></th></tr></table>
187
 
    </th>
188
 
  </tr>
189
 
</table>
190
 
 
191
 
<table border="0" cellpadding="0" cellspacing="0" width="100%">
192
 
  <tr>
193
 
    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sat Mar 20 17:46:13 2004</font></td>
194
 
    <td align="right"><a href="http://epydoc.sourceforge.net"
195
 
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
196
 
  </tr>
197
 
</table>
198
 
</body>
199
 
</html>