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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html40/loose.dtd">
<html>
<head>
<title>Module: ClassicStructuredText</title>
</head>
<body bgcolor="#ffffff">
<p><i><a href="../../../../index.html">Table of Contents</a></i></p>
<table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th rowspan="2"
valign="top"
align="left"
width="10%"
bgcolor="#88bbee"><font color="#000000">Module: ClassicStructuredText</font>
</th>
<th bgcolor="#88bbee"
width="90%"
align="right"><font color="#000000">../HappyDoc-r2_1/happydoclib/docstring/StructuredText/ClassicStructuredText.py</font>
</th>
</tr>
<tr>
<td>
<p>Structured Text Manipulation</p>
<p>Parse a structured text string into a form that can be used with
structured formats, like html.</p>
<p>Structured text is text that uses indentation and simple
symbology to indicate the structure of a document. </p>
<p>A structured string consists of a sequence of paragraphs separated by
one or more blank lines. Each paragraph has a level which is defined
as the minimum indentation of the paragraph. A paragraph is a
sub-paragraph of another paragraph if the other paragraph is the last
preceding paragraph that has a lower level.</p>
<p>Special symbology is used to indicate special constructs:</p>
<ul><li><p>A single-line paragraph whose immediately succeeding paragraphs are lower
level is treated as a header.</p>
</li>
<li><p>A paragraph that begins with a <code>-</code>, <code>*</code>, or <code>o</code> is treated as an
unordered list (bullet) element.</p>
</li>
<li><p>A paragraph that begins with a sequence of digits followed by a
white-space character is treated as an ordered list element.</p>
</li>
<li><p>A paragraph that begins with a sequence of sequences, where each
sequence is a sequence of digits or a sequence of letters followed
by a period, is treated as an ordered list element.</p>
</li>
<li><p>A paragraph with a first line that contains some text, followed by
some white-space and <code>--</code> is treated as
a descriptive list element. The leading text is treated as the
element title.</p>
</li>
<li><p>Sub-paragraphs of a paragraph that ends in the word <code>example</code> or the
word <code>examples</code>, or <code>::</code> is treated as example code and is output as is.</p>
</li>
<li><p>Text enclosed single quotes (with white-space to the left of the
first quote and whitespace or punctuation to the right of the second quote)
is treated as example code.</p>
</li>
<li><p>Text surrounded by <code>*</code> characters (with white-space to the left of the
first <code>*</code> and whitespace or punctuation to the right of the second <code>*</code>)
is emphasized.</p>
</li>
<li><p>Text surrounded by <code>**</code> characters (with white-space to the left of the
first <code>**</code> and whitespace or punctuation to the right of the second <code>**</code>)
is made strong.</p>
</li>
<li><p>Text surrounded by <code>_</code> underscore characters (with whitespace to the left
and whitespace or punctuation to the right) is made underlined.</p>
</li>
<li><p>Text encloded by double quotes followed by a colon, a URL, and concluded
by punctuation plus white space, <em>or</em> just white space, is treated as a
hyper link. For example:</p>
<p> "Zope":http://www.zope.org/ is ...</p>
<p> Is interpreted as <code><a href="http://www.zope.org/">Zope</a> is ....</code>
Note: This works for relative as well as absolute URLs.</p>
</li>
<li><p>Text enclosed by double quotes followed by a comma, one or more spaces,
an absolute URL and concluded by punctuation plus white space, or just
white space, is treated as a hyper link. For example:</p>
<p> "mail me", mailto:amos@digicool.com.</p>
<p> Is interpreted as <code><a href="mailto:amos@digicool.com">mail me</a>.</code> </p>
</li>
<li><p>Text enclosed in brackets which consists only of letters, digits,
underscores and dashes is treated as hyper links within the document.
For example:</p>
<p> As demonstrated by Smith <a href="#12">[12]</a> this technique is quite effective.</p>
<p> Is interpreted as <code>... by Smith <a href="#12">[12]</a> this ...</code>. Together
with the next rule this allows easy coding of references or end notes.</p>
</li>
<li><p>Text enclosed in brackets which is preceded by the start of a line, two
periods and a space is treated as a named link. For example:</p>
<p> .. <a href="#12">[12]</a> "Effective Techniques" Smith, Joe ... </p>
<p> Is interpreted as <code><a name="12">[12]</a> "Effective Techniques" ...</code>.
Together with the previous rule this allows easy coding of references or
end notes. </p>
</li>
<li><p>A paragraph that has blocks of text enclosed in <code>||</code> is treated as a
table. The text blocks correspond to table cells and table rows are
denoted by newlines. By default the cells are center aligned. A cell
can span more than one column by preceding a block of text with an
equivalent number of cell separators <code>||</code>. Newlines and <code>|</code> cannot
be a part of the cell text. For example:</p>
<p>
<TABLE BORDER=1 CELLPADDING=2>
<TR>
<TD ALIGN=CENTER COLSPAN=2> <strong>Ingredients</strong> </TD>
</TR>
<TR>
<TD ALIGN=CENTER COLSPAN=1> <em>Name</em> </TD>
<TD ALIGN=CENTER COLSPAN=1> <em>Amount</em> </TD>
</TR>
<TR>
<TD ALIGN=CENTER COLSPAN=1>Spam</TD>
<TD ALIGN=CENTER COLSPAN=1>10</TD>
</TR>
<TR>
<TD ALIGN=CENTER COLSPAN=1>Eggs</TD>
<TD ALIGN=CENTER COLSPAN=1>3</TD>
</TR>
</TABLE></p>
<p> is interpreted as:</p>
<PRE>
&lt;TABLE BORDER=1 CELLPADDING=2&gt;
&lt;TR&gt;
&lt;TD ALIGN=CENTER COLSPAN=2&gt; &lt;strong&gt;Ingredients&lt;/strong&gt; &lt;/TD&gt;
&lt;/TR&gt;
&lt;TR&gt;
&lt;TD ALIGN=CENTER COLSPAN=1&gt; &lt;em&gt;Name&lt;/em&gt; &lt;/TD&gt;
&lt;TD ALIGN=CENTER COLSPAN=1&gt; &lt;em&gt;Amount&lt;/em&gt; &lt;/TD&gt;
&lt;/TR&gt;
&lt;TR&gt;
&lt;TD ALIGN=CENTER COLSPAN=1&gt;Spam&lt;/TD&gt;
&lt;TD ALIGN=CENTER COLSPAN=1&gt;10&lt;/TD&gt;
&lt;/TR&gt;
&lt;TR&gt;
&lt;TD ALIGN=CENTER COLSPAN=1&gt;Eggs&lt;/TD&gt;
&lt;TD ALIGN=CENTER COLSPAN=1&gt;3&lt;/TD&gt;
&lt;/TR&gt;
&lt;/TABLE&gt;
</PRE>
<p>
<TABLE BORDER=1 CELLPADDING=2>
</TABLE></p>
</li></ul>
<table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="Imported modules">Imported modules</a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000"> </font>
</th>
</tr>
<tr>
<td>
<b>import</b> <a href="http://www.python.org/doc/current/lib/module-re.html">re</a><br>
<b>import</b> <a href="http://www.python.org/doc/current/lib/module-regex.html">regex</a><br>
<b>import</b> <a href="http://www.python.org/doc/current/lib/module-string.html">string</a><br>
<b>from</b> <a href="http://www.python.org/doc/current/lib/module-string.html">string</a> <b>import</b> split, join, strip, find<br>
<b>import</b> <a href="ts_regex.html">ts_regex</a><br>
<b>from</b> <a href="ts_regex.html">ts_regex</a> <b>import</b> gsub<br>
</td></tr>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="Functions">Functions</a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000"> </font>
</th>
</tr>
<tr>
<td>
<table border="0" cellspacing="2" cellpadding="2" width="100%">
<tr>
<td align="LEFT" valign="TOP">
<a href="#ctag">ctag</a><br>
<a href="#html_quote">html_quote</a><br>
<a href="#html_with_references">html_with_references</a><br>
<a href="#indent">indent</a><br>
<a href="#indent_level">indent_level</a><br>
</td>
<td align="LEFT" valign="TOP">
<a href="#main">main</a><br>
<a href="#paragraphs">paragraphs</a><br>
<a href="#reindent">reindent</a><br>
<a href="#structure">structure</a><br>
<a href="#untabify">untabify</a><br>
</td>
</tr>
</table>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="ctag"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">ctag </font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
ctag (
s,
em=re.compile( ctag_prefix +(ctag_middle %(( "*", ) * 6 ) ) + ctag_suffix ),
strong=re.compile( ctag_prefix +(ctag_middl2 %(( "*", ) * 8 ) ) + ctag_suffix ),
under=re.compile( ctag_prefix +(ctag_middle %(( "_", ) * 6 ) ) + ctag_suffix ),
code=re.compile( ctag_prefix +(ctag_middle %(( "\'", ) * 6 ) ) + ctag_suffix ),
)
</pre></font>
<p>
<TABLE BORDER=1 CELLPADDING=2>
</TABLE></p>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="html_quote"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">html_quote </font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
html_quote ( v, character_entities=(( re.compile( '&' ), '&amp;' ), ( re.compile( "<" ), '&lt;' ), ( re.compile( ">" ), '&gt;' ), ( re.compile( '"' ), '&quot;' ) ) )
</pre></font>
<p>
<TABLE BORDER=1 CELLPADDING=2>
</TABLE></p>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="html_with_references"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">html_with_references </font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
html_with_references ( text, level=1 )
</pre></font>
<p>
<TABLE BORDER=1 CELLPADDING=2>
</TABLE></p>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="indent"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">indent </font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
indent ( aString, indent=2 )
</pre></font>
<p>Indent a string the given number of spaces</p>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="indent_level"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">indent_level </font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
indent_level ( aString, indent_space=ts_regex.compile( '\n\( *\)' ).search_group )
</pre></font>
<p>Find the minimum indentation for a string, not counting blank lines.</p>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="main"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">main </font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
main ()
</pre></font>
<p>
<TABLE BORDER=1 CELLPADDING=2>
</TABLE></p>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="paragraphs"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">paragraphs </font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
paragraphs ( list, start )
</pre></font>
<p>
<TABLE BORDER=1 CELLPADDING=2>
</TABLE></p>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="reindent"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">reindent </font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
reindent (
aString,
indent=2,
already_untabified=0,
)
</pre></font>
<p>reindent a block of text, so that the minimum indent is as given</p>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="structure"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">structure </font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
structure ( list )
</pre></font>
<p>
<TABLE BORDER=1 CELLPADDING=2>
</TABLE></p>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="untabify"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">untabify </font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
untabify ( aString, indent_tab=ts_regex.compile( '\(\n\|^\)\( *\)\t' ).search_group )
</pre></font>
<p>Convert indentation tabs to spaces.</p>
</td></tr>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="Classes">Classes</a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000"> </font>
</th>
</tr>
<tr>
<td>
<table border="0" cellpadding="3" cellspacing="0">
<tr><td valign="top" align="left"><p><a href="ClassicStructuredText/HTML.html">HTML</a></p></td><td valign="top" align="left"><p>An HTML structured text formatter.</p>
</td></tr>
<tr><td valign="top" align="left"><p><a href="ClassicStructuredText/StructuredText.html">StructuredText</a></p></td><td valign="top" align="left"><p>Model text as structured collection of paragraphs.</p>
</td></tr>
<tr><td valign="top" align="left"><p><a href="ClassicStructuredText/Table.html">Table</a></p></td><td valign="top" align="left"></td></tr>
</table>
</td></tr>
</td></tr>
</table>
</td>
</tr>
</table>
<hr>
<p><i><a href="../../../../index.html">Table of Contents</a></i></p>
<font size="-2"><i>This document was automatically generated
on Sat Aug 24 16:57:29 2002 by
<a href="http://happydoc.sourceforge.net">HappyDoc</a> version
2.1</i></font>
</body>
</html>
|
