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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
|
<?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.epytext</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> ::
Module epytext
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="../private/epydoc.markup.epytext-module.html">show private</a> | hide private]</font></td></tr>
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="epydoc.markup.epytext-module.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module epydoc.markup.epytext</h2>
Parser for epytext strings. Epytext is a lightweight markup whose
primary intended application is Python documentation strings. This parser
converts Epytext strings to a XML/DOM representation. Epytext strings can
contain the following <a name="index-structural_blocks"></a><i
class="indexterm">structural blocks</i>:
<ul>
<li>
<a name="index-epytext"></a><i class="indexterm">epytext</i>: The
top-level element of the DOM tree.
</li>
<li>
<a name="index-para"></a><i class="indexterm">para</i>: A
paragraph of text. Paragraphs contain no newlines, and all spaces are
soft.
</li>
<li>
<a name="index-section"></a><i class="indexterm">section</i>: A
section or subsection.
</li>
<li>
<a name="index-field"></a><i class="indexterm">field</i>: A tagged
field. These fields provide information about specific aspects of a
Python object, such as the description of a function's parameter, or
the author of a module.
</li>
<li>
<a name="index-literalblock"></a><i
class="indexterm">literalblock</i>: A block of literal text. This
text should be displayed as it would be displayed in plaintext. The
parser removes the appropriate amount of leading whitespace from each
line in the literal block.
</li>
<li>
<a name="index-doctestblock"></a><i
class="indexterm">doctestblock</i>: A block containing sample python
code, formatted according to the specifications of the
<code>doctest</code> module.
</li>
<li>
<a name="index-ulist"></a><i class="indexterm">ulist</i>: An
unordered list.
</li>
<li>
<a name="index-olist"></a><i class="indexterm">olist</i>: An
ordered list.
</li>
<li>
<a name="index-li"></a><i class="indexterm">li</i>: A list item.
This tag is used both for unordered list items and for ordered list
items.
</li>
</ul>
Additionally, the following <a name="index-inline_regions"></a><i
class="indexterm">inline regions</i> may be used within <code>para</code>
blocks:
<ul>
<li>
<a name="index-code"></a><i class="indexterm">code</i>: Source
code and identifiers.
</li>
<li>
<a name="index-math"></a><i class="indexterm">math</i>:
Mathematical expressions.
</li>
<li>
<a name="index-index"></a><i class="indexterm">index</i>: A term
which should be included in an index, if one is generated.
</li>
<li>
<a name="index-italic"></a><i class="indexterm">italic</i>:
Italicized text.
</li>
<li>
<a name="index-bold"></a><i class="indexterm">bold</i>: Bold-faced
text.
</li>
<li>
<a name="index-uri"></a><i class="indexterm">uri</i>: A Universal
Resource Indicator (URI) or Universal Resource Locator (URL)
</li>
<li>
<a name="index-link"></a><i class="indexterm">link</i>: A Python
identifier which should be hyperlinked to the named object's
documentation, when possible.
</li>
</ul>
The returned DOM tree will conform to the the following Document Type
Description:
<pre class="literalblock">
<!ENTITY % colorized '(code | math | index | italic |
bold | uri | link | symbol)*'>
<!ELEMENT epytext ((para | literalblock | doctestblock |
section | ulist | olist)*, fieldlist?)>
<!ELEMENT para (#PCDATA | %colorized;)*>
<!ELEMENT section (para | listblock | doctestblock |
section | ulist | olist)+>
<!ELEMENT fieldlist (field+)>
<!ELEMENT field (tag, arg?, (para | listblock | doctestblock)
ulist | olist)+)>
<!ELEMENT tag (#PCDATA)>
<!ELEMENT arg (#PCDATA)>
<!ELEMENT literalblock (#PCDATA)>
<!ELEMENT doctestblock (#PCDATA)>
<!ELEMENT ulist (li+)>
<!ELEMENT olist (li+)>
<!ELEMENT li (para | literalblock | doctestblock | ulist | olist)+>
<!ATTLIST li bullet NMTOKEN #IMPLIED>
<!ATTLIST olist start NMTOKEN #IMPLIED>
<!ELEMENT uri (name, target)>
<!ELEMENT link (name, target)>
<!ELEMENT name (#PCDATA | %colorized;)*>
<!ELEMENT target (#PCDATA)>
<!ELEMENT code (#PCDATA | %colorized;)*>
<!ELEMENT math (#PCDATA | %colorized;)*>
<!ELEMENT italic (#PCDATA | %colorized;)*>
<!ELEMENT bold (#PCDATA | %colorized;)*>
<!ELEMENT indexed (#PCDATA | %colorized;)>
<!ELEMENT symbol (#PCDATA)>
</pre>
<hr/>
<!-- =========== START OF CLASSES =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Classes</th></tr>
<tr><td width="15%">
<b><a href="epydoc.markup.epytext.ParsedEpytextDocstring-class.html"><code>ParsedEpytextDocstring</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="epydoc.markup.epytext.Token-class.html"><code>Token</code></a></b></td>
<td><code>Token</code>s are an intermediate data structure used while
constructing the structuring DOM tree for a formatted docstring.</td></tr>
</table><br />
<!-- =========== START OF EXCEPTIONS =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Exceptions</th></tr>
<tr><td width="15%">
<b><a href="epydoc.markup.epytext.ColorizingError-class.html"><code>ColorizingError</code></a></b></td>
<td>An error generated while colorizing a paragraph.</td></tr>
<tr><td width="15%">
<b><a href="epydoc.markup.epytext.StructuringError-class.html"><code>StructuringError</code></a></b></td>
<td>An error generated while structuring a formatted documentation
string.</td></tr>
<tr><td width="15%">
<b><a href="epydoc.markup.epytext.TokenizationError-class.html"><code>TokenizationError</code></a></b></td>
<td>An error generated while tokenizing a formatted documentation
string.</td></tr>
</table><br />
<!-- =========== START OF FUNCTION SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Function Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>xml.dom.minidom.Document</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#parse" class="summary-sig-name"><code>parse</code></a>(<span class=summary-sig-arg>str</span>,
<span class=summary-sig-arg>errors</span>)</span></code>
<br />
Return a DOM tree encoding the contents of an epytext string.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>xml.dom.minidom.Document</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#parse_as_literal" class="summary-sig-name"><code>parse_as_literal</code></a>(<span class=summary-sig-arg>str</span>)</span></code>
<br />
Return a DOM document matching the epytext DTD, containing a single
literal block.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>xml.dom.minidom.Document</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#parse_as_para" class="summary-sig-name"><code>parse_as_para</code></a>(<span class=summary-sig-arg>str</span>)</span></code>
<br />
Return a DOM document matching the epytext DTD, containing a single
paragraph.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="epydoc.markup.ParsedDocstring-class.html"
class="link"><code>ParsedDocstring</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#parse_docstring" class="summary-sig-name"><code>parse_docstring</code></a>(<span class=summary-sig-arg>docstring</span>,
<span class=summary-sig-arg>errors</span>,
<span class="summary-sig-kwarg">**options</span>)</span></code>
<br />
Parse the given docstring, which is formatted using epytext; and
return a <code>ParsedDocstring</code> representation of its contents.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>xml.dom.minidom.Document</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#pparse" class="summary-sig-name"><code>pparse</code></a>(<span class=summary-sig-arg>str</span>,
<span class=summary-sig-arg>show_warnings</span>,
<span class=summary-sig-arg>show_errors</span>,
<span class=summary-sig-arg>stream</span>)</span></code>
<br />
Pretty-parse the string.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>string</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#to_debug" class="summary-sig-name"><code>to_debug</code></a>(<span class=summary-sig-arg>tree</span>,
<span class=summary-sig-arg>indent</span>,
<span class=summary-sig-arg>seclevel</span>)</span></code>
<br />
Convert a DOM document encoding epytext back to an epytext string,
annotated with extra debugging information.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>string</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#to_epytext" class="summary-sig-name"><code>to_epytext</code></a>(<span class=summary-sig-arg>tree</span>,
<span class=summary-sig-arg>indent</span>,
<span class=summary-sig-arg>seclevel</span>)</span></code>
<br />
Convert a DOM document encoding epytext back to an epytext string.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>string</code>
</font></td>
<td><code><span class="summary-sig"><a href="epydoc.markup.epytext-module.html#to_plaintext" class="summary-sig-name"><code>to_plaintext</code></a>(<span class=summary-sig-arg>tree</span>,
<span class=summary-sig-arg>indent</span>,
<span class=summary-sig-arg>seclevel</span>)</span></code>
<br />
Convert a DOM document encoding epytext to a string
representation.</td></tr>
</table><br />
<!-- =========== START OF VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
<td><b><a href="epydoc.markup.epytext-module.html#SYMBOLS"><code>SYMBOLS</code></a></b>: A list of the of escape symbols that are supported by epydoc.</td></tr>
</table><br />
<!-- =========== START OF FUNCTION DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Function Details</th></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>str</span>,
<span class=sig-arg>errors</span>=<span class=sig-default>None</span>)</span>
</h3>
Return a DOM tree encoding the contents of an epytext string. Any
errors generated during parsing will be stored in
<code>errors</code>.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>str</b></code> -
The epytext string to parse.
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>errors</b></code> -
A list where any errors generated during parsing will be
stored. If no list is specified, then fatal errors will generate
exceptions, and non-fatal errors will be ignored.
<br /><i>
(type=<code>list</code> of <a
href="epydoc.markup.ParseError-class.html"
class="link"><code>ParseError</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
a DOM tree encoding the contents of an epytext string.
<br /><i>
(type=<code>xml.dom.minidom.Document</code>)</i>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>ParseError</b></code> -
If <code>errors</code> is <code>None</code> and an error is
encountered while parsing.
</dl>
</dd></dl>
</td></tr></table>
<a name="parse_as_literal"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">parse_as_literal</span>(<span class=sig-arg>str</span>)</span>
</h3>
Return a DOM document matching the epytext DTD, containing a single
literal block. That literal block will include the contents of the
given string. This method is typically used as a fall-back when the
parser fails.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>str</b></code> -
The string which should be enclosed in a literal block.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A DOM document containing <code>str</code> in a single literal
block.
<br /><i>
(type=<code>xml.dom.minidom.Document</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="parse_as_para"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">parse_as_para</span>(<span class=sig-arg>str</span>)</span>
</h3>
Return a DOM document matching the epytext DTD, containing a single
paragraph. That paragraph will include the contents of the given
string. This can be used to wrap some forms of automatically generated
information (such as type names) in paragraphs.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>str</b></code> -
The string which should be enclosed in a paragraph.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A DOM document containing <code>str</code> in a single
paragraph.
<br /><i>
(type=<code>xml.dom.minidom.Document</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="parse_docstring"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">parse_docstring</span>(<span class=sig-arg>docstring</span>,
<span class=sig-arg>errors</span>,
<span class="sig-kwarg">**options</span>)</span>
</h3>
Parse the given docstring, which is formatted using epytext; and
return a <code>ParsedDocstring</code> representation of its
contents.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>docstring</b></code> -
The docstring to parse
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>errors</b></code> -
A list where any errors generated during parsing will be
stored.
<br /><i>
(type=<code>list</code> of <a
href="epydoc.markup.ParseError-class.html"
class="link"><code>ParseError</code></a>)</i>
<dd><code><b>options</b></code> -
Extra options. Unknown options are ignored. Currently, no
extra options are defined.
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<a href="epydoc.markup.ParsedDocstring-class.html"
class="link"><code>ParsedDocstring</code></a>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="pparse"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">pparse</span>(<span class=sig-arg>str</span>,
<span class=sig-arg>show_warnings</span>=<span class=sig-default>1</span>,
<span class=sig-arg>show_errors</span>=<span class=sig-default>1</span>,
<span class=sig-arg>stream</span>=<span class=sig-default><cStringIO.StringO object at 0x8504f68></span>)</span>
</h3>
Pretty-parse the string. This parses the string, and catches any
warnings or errors produced. Any warnings and errors are displayed, and
the resulting DOM parse structure is returned.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>str</b></code> -
The string to parse.
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>show_warnings</b></code> -
Whether or not to display non-fatal errors generated by
parsing <code>str</code>.
<br /><i>
(type=<code>boolean</code>)</i>
<dd><code><b>show_errors</b></code> -
Whether or not to display fatal errors generated by parsing
<code>str</code>.
<br /><i>
(type=<code>boolean</code>)</i>
<dd><code><b>stream</b></code> -
The stream that warnings and errors should be written to.
<br /><i>
(type=<code>stream</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
a DOM document encoding the contents of <code>str</code>.
<br /><i>
(type=<code>xml.dom.minidom.Document</code>)</i>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>SyntaxError</b></code> -
If any fatal errors were encountered.
</dl>
</dd></dl>
</td></tr></table>
<a name="to_debug"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">to_debug</span>(<span class=sig-arg>tree</span>,
<span class=sig-arg>indent</span>=<span class=sig-default>4</span>,
<span class=sig-arg>seclevel</span>=<span class=sig-default>0</span>)</span>
</h3>
Convert a DOM document encoding epytext back to an epytext string,
annotated with extra debugging information. This function is similar to
<a href="epydoc.markup.epytext-module.html#to_epytext"
class="link"><code>to_epytext</code></a>, but it adds explicit
information about where different blocks begin, along the left
margin.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>tree</b></code> -
A DOM document encoding of an epytext string.
<br /><i>
(type=<code>xml.dom.minidom.Document</code>)</i>
<dd><code><b>indent</b></code> -
The indentation for the string representation of
<code>tree</code>. Each line of the returned string will begin
with <code>indent</code> space characters.
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>seclevel</b></code> -
The section level that <code>tree</code> appears at. This is
used to generate section headings.
<br /><i>
(type=<code>int</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The epytext string corresponding to <code>tree</code>.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="to_epytext"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">to_epytext</span>(<span class=sig-arg>tree</span>,
<span class=sig-arg>indent</span>=<span class=sig-default>0</span>,
<span class=sig-arg>seclevel</span>=<span class=sig-default>0</span>)</span>
</h3>
Convert a DOM document encoding epytext back to an epytext string.
This is the inverse operation from <a
href="epydoc.markup.epytext-module.html#parse"
class="link"><code>parse</code></a>. I.e., assuming there are no
errors, the following is true:
<ul>
<li>
<code>parse(to_epytext(tree)) == tree</code>
</li>
</ul>
The inverse is true, except that whitespace, line wrapping, and
character escaping may be done differently.
<ul>
<li>
<code>to_epytext(parse(str)) == str</code> (approximately)
</li>
</ul>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>tree</b></code> -
A DOM document encoding of an epytext string.
<br /><i>
(type=<code>xml.dom.minidom.Document</code>)</i>
<dd><code><b>indent</b></code> -
The indentation for the string representation of
<code>tree</code>. Each line of the returned string will begin
with <code>indent</code> space characters.
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>seclevel</b></code> -
The section level that <code>tree</code> appears at. This is
used to generate section headings.
<br /><i>
(type=<code>int</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The epytext string corresponding to <code>tree</code>.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="to_plaintext"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">to_plaintext</span>(<span class=sig-arg>tree</span>,
<span class=sig-arg>indent</span>=<span class=sig-default>0</span>,
<span class=sig-arg>seclevel</span>=<span class=sig-default>0</span>)</span>
</h3>
Convert a DOM document encoding epytext to a string representation.
This representation is similar to the string generated by
<code>to_epytext</code>, but <code>to_plaintext</code> removes inline
markup, prints escaped characters in unescaped form, etc.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>tree</b></code> -
A DOM document encoding of an epytext string.
<br /><i>
(type=<code>xml.dom.minidom.Document</code>)</i>
<dd><code><b>indent</b></code> -
The indentation for the string representation of
<code>tree</code>. Each line of the returned string will begin
with <code>indent</code> space characters.
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>seclevel</b></code> -
The section level that <code>tree</code> appears at. This is
used to generate section headings.
<br /><i>
(type=<code>int</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The epytext string corresponding to <code>tree</code>.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="SYMBOLS"></a>
<h3>SYMBOLS</h3>
A list of the of escape symbols that are supported by epydoc.
Currently the following symbols are supported:
<code>S{<-}</code>=←; <code>S{->}</code>=→;
<code>S{^}</code>=↑; <code>S{v}</code>=↓;
<code>S{alpha}</code>=α; <code>S{beta}</code>=β;
<code>S{gamma}</code>=γ; <code>S{delta}</code>=δ;
<code>S{epsilon}</code>=ε; <code>S{zeta}</code>=ζ;
<code>S{eta}</code>=η; <code>S{theta}</code>=θ;
<code>S{iota}</code>=ι; <code>S{kappa}</code>=κ;
<code>S{lambda}</code>=λ; <code>S{mu}</code>=μ;
<code>S{nu}</code>=ν; <code>S{xi}</code>=ξ;
<code>S{omicron}</code>=ο; <code>S{pi}</code>=π;
<code>S{rho}</code>=ρ; <code>S{sigma}</code>=σ;
<code>S{tau}</code>=τ; <code>S{upsilon}</code>=υ;
<code>S{phi}</code>=φ; <code>S{chi}</code>=χ;
<code>S{psi}</code>=ψ; <code>S{omega}</code>=ω;
<code>S{Alpha}</code>=Α; <code>S{Beta}</code>=Β;
<code>S{Gamma}</code>=Γ; <code>S{Delta}</code>=Δ;
<code>S{Epsilon}</code>=Ε; <code>S{Zeta}</code>=Ζ;
<code>S{Eta}</code>=Η; <code>S{Theta}</code>=Θ;
<code>S{Iota}</code>=Ι; <code>S{Kappa}</code>=Κ;
<code>S{Lambda}</code>=Λ; <code>S{Mu}</code>=Μ;
<code>S{Nu}</code>=Ν; <code>S{Xi}</code>=Ξ;
<code>S{Omicron}</code>=Ο; <code>S{Pi}</code>=Π;
<code>S{Rho}</code>=Ρ; <code>S{Sigma}</code>=Σ;
<code>S{Tau}</code>=Τ; <code>S{Upsilon}</code>=Υ;
<code>S{Phi}</code>=Φ; <code>S{Chi}</code>=Χ;
<code>S{Psi}</code>=Ψ; <code>S{Omega}</code>=Ω;
<code>S{larr}</code>=←; <code>S{rarr}</code>=→;
<code>S{uarr}</code>=↑; <code>S{darr}</code>=↓;
<code>S{harr}</code>=↔; <code>S{crarr}</code>=↵;
<code>S{lArr}</code>=⇐; <code>S{rArr}</code>=⇒;
<code>S{uArr}</code>=⇑; <code>S{dArr}</code>=⇓;
<code>S{hArr}</code>=⇔; <code>S{copy}</code>=©;
<code>S{times}</code>=×; <code>S{forall}</code>=∀;
<code>S{exist}</code>=∃; <code>S{part}</code>=∂;
<code>S{empty}</code>=∅; <code>S{isin}</code>=∈;
<code>S{notin}</code>=∉; <code>S{ni}</code>=∋;
<code>S{prod}</code>=∏; <code>S{sum}</code>=∑;
<code>S{prop}</code>=∝; <code>S{infin}</code>=∞;
<code>S{ang}</code>=∠; <code>S{and}</code>=∧;
<code>S{or}</code>=∨; <code>S{cap}</code>=∩;
<code>S{cup}</code>=∪; <code>S{int}</code>=∫;
<code>S{there4}</code>=∴; <code>S{sim}</code>=∼;
<code>S{cong}</code>=≅; <code>S{asymp}</code>=≈;
<code>S{ne}</code>=≠; <code>S{equiv}</code>=≡;
<code>S{le}</code>=≤; <code>S{ge}</code>=≥;
<code>S{sub}</code>=⊂; <code>S{sup}</code>=⊃;
<code>S{nsub}</code>=⊄; <code>S{sube}</code>=⊆;
<code>S{supe}</code>=⊇; <code>S{oplus}</code>=⊕;
<code>S{otimes}</code>=⊗; <code>S{perp}</code>=⊥;
<code>S{infinity}</code>=∞; <code>S{integral}</code>=∫;
<code>S{product}</code>=∏; <code>S{>=}</code>=≥;
<code>S{<=}</code>=≤
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>list</code>
</dd>
<span title="['<-', '->', '^', 'v', 'alpha', 'beta', 'gamma', 'delta', 'epsilon', 'zeta', 'eta', 'theta', 'iota', 'kappa', 'lambda', 'mu', 'nu', 'xi', 'omicron', 'pi', 'rho', 'sigma', 'tau', 'upsilon', 'phi', 'chi', 'psi', 'omega', 'Alpha', 'Beta', 'Gamma', 'Delta', 'Epsilon', 'Zeta', 'Eta', 'Theta', 'Iota', 'Kappa', 'Lambda', 'Mu', 'Nu', 'Xi', 'Omicron', 'Pi', 'Rho', 'Sigma', 'Tau', 'Upsilon', 'Phi', 'Chi', 'Psi', 'Omega', 'larr', 'rarr', 'uarr', 'darr', 'harr', 'crarr', 'lArr', 'rArr', 'uArr', 'dArr', 'hArr', 'copy', 'times', 'forall', 'exist', 'part', 'empty', 'isin', 'notin', 'ni', 'prod', 'sum', 'p..."> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
['<-', '->', '^', 'v', 'alpha', 'beta', 'gamma', 'delta', 'epsilon'] </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:14 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>
|
