← Back to branch summary

~ubuntu-branches/ubuntu/raring/genshi/raring-proposed

« back to all changes in this revision

Viewing changes to doc/api/genshi.output.XMLSerializer-class.html

  • Committer: Bazaar Package Importer
  • Author(s): Arnaud Fontaine
  • Date: 2007-04-16 17:49:03 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20070416174903-x2p3n9g890v18d0m
Tags: 0.4-1
* New upstream release.
* Remove useless python-markup transition package.
* Add Provides against python-markup.
* Add doc-base.
* Add depends against python-xml.
* Add suggests to python-setuptools.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api/genshi.output.XMLSerializer-class.html
 
1
<?xml version="1.0" encoding="ascii"?>
 
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>genshi.output.XMLSerializer</title>
 
7
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
 
8
  <script type="text/javascript" src="epydoc.js"></script>
 
9
</head>
 
10
 
 
11
<body bgcolor="white" text="black" link="blue" vlink="#204080"
 
12
      alink="#204080">
 
13
<!-- ==================== NAVIGATION BAR ==================== -->
 
14
<table class="navbar" border="0" width="100%" cellpadding="0"
 
15
       bgcolor="#a0c0ff" cellspacing="0">
 
16
  <tr valign="middle">
 
17
  <!-- Home link -->
 
18
      <th>&nbsp;&nbsp;&nbsp;<a
 
19
        href="genshi-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
20
 
 
21
  <!-- Tree link -->
 
22
      <th>&nbsp;&nbsp;&nbsp;<a
 
23
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
24
 
 
25
  <!-- Index link -->
 
26
      <th>&nbsp;&nbsp;&nbsp;<a
 
27
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 
28
 
 
29
  <!-- Help link -->
 
30
      <th>&nbsp;&nbsp;&nbsp;<a
 
31
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
32
 
 
33
  <!-- Project homepage -->
 
34
      <th class="navbar" align="right" width="100%">
 
35
        <table border="0" cellpadding="0" cellspacing="0">
 
36
          <tr><th class="navbar" align="center"
 
37
            ><a class="navbar" target="_top" href="../index.html">Documentation Index</a></th>
 
38
          </tr></table></th>
 
39
  </tr>
 
40
</table>
 
41
<table width="100%" cellpadding="0" cellspacing="0">
 
42
  <tr valign="top">
 
43
    <td width="100%">
 
44
      <span class="breadcrumbs">
 
45
        <a href="genshi-module.html">Package&nbsp;genshi</a> ::
 
46
        <a href="genshi.output-module.html">Module&nbsp;output</a> ::
 
47
        Class&nbsp;XMLSerializer
 
48
      </span>
 
49
    </td>
 
50
    <td>
 
51
      <table cellpadding="0" cellspacing="0">
 
52
        <!-- hide/show private -->
 
53
      </table>
 
54
    </td>
 
55
  </tr>
 
56
</table>
 
57
<!-- ==================== CLASS DESCRIPTION ==================== -->
 
58
<h1 class="epydoc">Class XMLSerializer</h1><br /><br />
 
59
<pre class="base-tree">
 
60
object --+
 
61
         |
 
62
        <strong class="uidshort">XMLSerializer</strong>
 
63
</pre>
 
64
 
 
65
<dl><dt>Known Subclasses:</dt>
 
66
<dd>
 
67
    <a href="genshi.output.XHTMLSerializer-class.html">XHTMLSerializer</a>
 
68
</dd></dl>
 
69
 
 
70
<hr />
 
71
<p>Produces XML text from an event stream.</p>
 
72
<pre class="py-doctest">
 
73
<span class="py-prompt">&gt;&gt;&gt; </span><span class="py-keyword">from</span> genshi.builder <span class="py-keyword">import</span> tag
 
74
<span class="py-prompt">&gt;&gt;&gt; </span>elem = tag.div(tag.a(href=<span class="py-string">'foo'</span>), tag.br, tag.hr(noshade=True))
 
75
<span class="py-prompt">&gt;&gt;&gt; </span><span class="py-keyword">print</span> <span class="py-string">''</span>.join(XMLSerializer()(elem.generate()))
 
76
<span class="py-output">&lt;div&gt;&lt;a href=&quot;foo&quot;/&gt;&lt;br/&gt;&lt;hr noshade=&quot;True&quot;/&gt;&lt;/div&gt;</span></pre><br /><br />
 
77
 
 
78
<!-- ==================== INSTANCE METHODS ==================== -->
 
79
<a name="section-InstanceMethods"></a>
 
80
<table class="summary" border="1" cellpadding="3"
 
81
       cellspacing="0" width="100%" bgcolor="white">
 
82
<tr bgcolor="#70b0f0" class="table-header">
 
83
  <td align="left" colspan="2" class="table-header">
 
84
    <span class="table-header">Instance Methods</span></td>
 
85
</tr>
 
86
<tr>
 
87
    <td width="15%" align="right" valign="top" class="summary">
 
88
      <span class="summary-type">&nbsp;</span>
 
89
    </td><td class="summary">
 
90
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
91
        <tr>
 
92
          <td><span class="summary-sig"><a href="genshi.output.XMLSerializer-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
 
93
        <span class="summary-sig-arg">doctype</span>=<span class="summary-sig-default">None</span>,
 
94
        <span class="summary-sig-arg">strip_whitespace</span>=<span class="summary-sig-default">True</span>,
 
95
        <span class="summary-sig-arg">namespace_prefixes</span>=<span class="summary-sig-default">None</span>)</span><br />
 
96
      Initialize the XML serializer.</td>
 
97
          <td align="right" valign="top">
 
98
            
 
99
            
 
100
          </td>
 
101
        </tr>
 
102
      </table>
 
103
      
 
104
    </td>
 
105
  </tr>
 
106
<tr>
 
107
    <td width="15%" align="right" valign="top" class="summary">
 
108
      <span class="summary-type">&nbsp;</span>
 
109
    </td><td class="summary">
 
110
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
111
        <tr>
 
112
          <td><span class="summary-sig"><a name="__call__"></a><span class="summary-sig-name">__call__</span>(<span class="summary-sig-arg">self</span>,
 
113
        <span class="summary-sig-arg">stream</span>)</span></td>
 
114
          <td align="right" valign="top">
 
115
            
 
116
            
 
117
          </td>
 
118
        </tr>
 
119
      </table>
 
120
      
 
121
    </td>
 
122
  </tr>
 
123
  <tr>
 
124
    <td colspan="2" class="summary">
 
125
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 
126
      <code>__delattr__</code>,
 
127
      <code>__getattribute__</code>,
 
128
      <code>__hash__</code>,
 
129
      <code>__new__</code>,
 
130
      <code>__reduce__</code>,
 
131
      <code>__reduce_ex__</code>,
 
132
      <code>__repr__</code>,
 
133
      <code>__setattr__</code>,
 
134
      <code>__str__</code>
 
135
      </p>
 
136
    </td>
 
137
  </tr>
 
138
</table>
 
139
<!-- ==================== PROPERTIES ==================== -->
 
140
<a name="section-Properties"></a>
 
141
<table class="summary" border="1" cellpadding="3"
 
142
       cellspacing="0" width="100%" bgcolor="white">
 
143
<tr bgcolor="#70b0f0" class="table-header">
 
144
  <td align="left" colspan="2" class="table-header">
 
145
    <span class="table-header">Properties</span></td>
 
146
</tr>
 
147
  <tr>
 
148
    <td colspan="2" class="summary">
 
149
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
 
150
      <code>__class__</code>
 
151
      </p>
 
152
    </td>
 
153
  </tr>
 
154
</table>
 
155
<!-- ==================== METHOD DETAILS ==================== -->
 
156
<a name="section-MethodDetails"></a>
 
157
<table class="details" border="1" cellpadding="3"
 
158
       cellspacing="0" width="100%" bgcolor="white">
 
159
<tr bgcolor="#70b0f0" class="table-header">
 
160
  <td align="left" colspan="2" class="table-header">
 
161
    <span class="table-header">Method Details</span></td>
 
162
</tr>
 
163
</table>
 
164
<a name="__init__"></a>
 
165
<div>
 
166
<table class="details" border="1" cellpadding="3"
 
167
       cellspacing="0" width="100%" bgcolor="white">
 
168
<tr><td>
 
169
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
170
  <tr valign="top"><td>
 
171
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 
172
        <span class="sig-arg">doctype</span>=<span class="sig-default">None</span>,
 
173
        <span class="sig-arg">strip_whitespace</span>=<span class="sig-default">True</span>,
 
174
        <span class="sig-arg">namespace_prefixes</span>=<span class="sig-default">None</span>)</span>
 
175
    <br /><em class="fname">(Constructor)</em>
 
176
  </h3>
 
177
  </td><td align="right" valign="top"
 
178
    >&nbsp;
 
179
    </td>
 
180
  </table>
 
181
  
 
182
  Initialize the XML serializer.
 
183
  <dl class="fields">
 
184
    <dt>Parameters:</dt>
 
185
    <dd><ul class="nomargin-top">
 
186
        <li><strong class="pname"><code>doctype</code></strong> - a <tt class="rst-docutils literal"><span class="pre">(name,</span> <span class="pre">pubid,</span> <span class="pre">sysid)</span></tt> tuple that represents the
 
187
DOCTYPE declaration that should be included at the top
 
188
of the generated output</li>
 
189
        <li><strong class="pname"><code>strip_whitespace</code></strong> - whether extraneous whitespace should be
 
190
stripped from the output</li>
 
191
    </ul></dd>
 
192
    <dt>Overrides:
 
193
      object.__init__
 
194
    </dt>
 
195
  </dl>
 
196
</td></tr></table>
 
197
</div>
 
198
<br />
 
199
<!-- ==================== NAVIGATION BAR ==================== -->
 
200
<table class="navbar" border="0" width="100%" cellpadding="0"
 
201
       bgcolor="#a0c0ff" cellspacing="0">
 
202
  <tr valign="middle">
 
203
  <!-- Home link -->
 
204
      <th>&nbsp;&nbsp;&nbsp;<a
 
205
        href="genshi-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
206
 
 
207
  <!-- Tree link -->
 
208
      <th>&nbsp;&nbsp;&nbsp;<a
 
209
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
210
 
 
211
  <!-- Index link -->
 
212
      <th>&nbsp;&nbsp;&nbsp;<a
 
213
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 
214
 
 
215
  <!-- Help link -->
 
216
      <th>&nbsp;&nbsp;&nbsp;<a
 
217
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
218
 
 
219
  <!-- Project homepage -->
 
220
      <th class="navbar" align="right" width="100%">
 
221
        <table border="0" cellpadding="0" cellspacing="0">
 
222
          <tr><th class="navbar" align="center"
 
223
            ><a class="navbar" target="_top" href="../index.html">Documentation Index</a></th>
 
224
          </tr></table></th>
 
225
  </tr>
 
226
</table>
 
227
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
 
228
  <tr>
 
229
    <td align="left" class="footer">
 
230
    Generated by Epydoc 3.0beta1 on Mon Apr 16 16:02:14 2007
 
231
    </td>
 
232
    <td align="right" class="footer">
 
233
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
 
234
    </td>
 
235
  </tr>
 
236
</table>
 
237
 
 
238
<script type="text/javascript">
 
239
  <!--
 
240
  // Private objects are initially displayed (because if
 
241
  // javascript is turned off then we want them to be
 
242
  // visible); but by default, we want to hide them.  So hide
 
243
  // them unless we have a cookie that says to show them.
 
244
  checkCookie()
 
245
  // -->
 
246
</script>
 
247
  
 
248
</body>
 
249
</html>