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
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Quick reStructuredText</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<style type="text/css"><!--
a.backref { text-decoration: none ; color: black }
div.line-block { display: block }
div.line-block div.line-block { margin-left: 1.5em }
--></style>
</head>
<body>
<h1>Quick <i>re</i><font size="+4"><tt>Structured</tt></font><i>Text</i></h1>
<!-- Caveat: if you're reading the HTML for the examples, -->
<!-- beware that it was hand-generated, not by Docutils/ReST. -->
<p align="right"><em><a href="https://docutils.sourceforge.io/docs/user/rst/quickref.html"
>https://docutils.sourceforge.io/docs/user/rst/quickref.html</a></em>
<br><em>Being a cheat-sheet for reStructuredText</em>
<br><em>Updated $Date: 2022-01-29 23:26:10 +0100 (Sa, 29. Jän 2022) $</em>
<blockquote>
<p>Copyright: This document has been placed in the public domain.
</blockquote>
<p>The full details of the markup may be found on the
<a href="https://docutils.sourceforge.io/rst.html">reStructuredText</a>
page. This document is just intended as a reminder.
<p>Links that look like "(<a href="#details">details</a>)" point
into the HTML version of the full <a
href="../../ref/rst/restructuredtext.html">reStructuredText
specification</a> document. These are relative links; if they
don't work, please use the <a
href="https://docutils.sourceforge.io/docs/user/rst/quickref.html"
>master "Quick reStructuredText"</a> document.
<h2><a name="contents">Contents</a></h2>
<ul>
<li><a href="#inline-markup">Inline Markup</a></li>
<li><a href="#escaping">Escaping with Backslashes</a></li>
<li><a href="#section-structure">Section Structure</a></li>
<li><a href="#paragraphs">Paragraphs</a></li>
<li><a href="#bullet-lists">Bullet Lists</a></li>
<li><a href="#enumerated-lists">Enumerated Lists</a></li>
<li><a href="#definition-lists">Definition Lists</a></li>
<li><a href="#field-lists">Field Lists</a></li>
<li><a href="#option-lists">Option Lists</a></li>
<li><a href="#literal-blocks">Literal Blocks</a></li>
<li><a href="#line-blocks">Line Blocks</a></li>
<li><a href="#block-quotes">Block Quotes</a></li>
<li><a href="#doctest-blocks">Doctest Blocks</a></li>
<li><a href="#tables">Tables</a></li>
<li><a href="#transitions">Transitions</a></li>
<li><a href="#explicit-markup">Explicit Markup</a>
<ul>
<li><a href="#footnotes">Footnotes</a></li>
<li><a href="#citations">Citations</a></li>
<li><a href="#hyperlink-targets">Hyperlink Targets</a>
<ul>
<li><a href="#external-hyperlink-targets">External Hyperlink Targets</a></li>
<li><a href="#internal-hyperlink-targets">Internal Hyperlink Targets</a></li>
<li><a href="#indirect-hyperlink-targets">Indirect Hyperlink Targets</a></li>
<li><a href="#implicit-hyperlink-targets">Implicit Hyperlink Targets</a></li>
</ul></li>
<li><a href="#directives">Directives</a></li>
<li><a href="#substitution-references-and-definitions">Substitution References and Definitions</a></li>
<li><a href="#comments">Comments</a></li>
</ul></li>
<li><a href="#getting-help">Getting Help</a></li>
</ul>
<h2><a href="#contents" name="inline-markup" class="backref"
>Inline Markup</a></h2>
<p>(<a href="../../ref/rst/restructuredtext.html#inline-markup">details</a>)
<p>Inline markup allows words and phrases within text to have
character styles (like italics and boldface) and functionality
(like hyperlinks).
<p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">
<thead>
<tr align="left" bgcolor="#99CCFF">
<th>Plain text
<th>Typical result
<th>Notes
</thead>
<tbody>
<tr valign="top">
<td nowrap><samp>*emphasis*</samp>
<td><em>emphasis</em>
<td>Normally rendered as italics.
<tr valign="top">
<td nowrap><samp>**strong emphasis**</samp>
<td><strong>strong emphasis</strong>
<td>Normally rendered as boldface.
<tr valign="top">
<td nowrap><samp>`interpreted text`</samp>
<td>(see note at right)
<td>The rendering and <em>meaning</em> of interpreted text is
domain- or application-dependent. It can be used for things
like index entries or explicit descriptive markup (like program
identifiers).
<tr valign="top">
<td nowrap><samp>``inline literal``</samp>
<td><code>inline literal</code>
<td>Normally rendered as monospaced text. Spaces should be
preserved, but line breaks will not be.
<tr valign="top">
<td nowrap><samp>reference_</samp>
<td><a href="#hyperlink-targets">reference</a>
<td>A simple, one-word hyperlink reference. See <a
href="#hyperlink-targets">Hyperlink Targets</a>.
<tr valign="top">
<td nowrap><samp>`phrase reference`_</samp>
<td><a href="#hyperlink-targets">phrase reference</a>
<td>A hyperlink reference with spaces or punctuation needs to be
quoted with backquotes. See <a
href="#hyperlink-targets">Hyperlink Targets</a>.
<tr valign="top">
<td nowrap><samp>anonymous__</samp>
<td><a href="#hyperlink-targets">anonymous</a>
<td>With two underscores instead of one, both simple and phrase
references may be anonymous (the reference text is not repeated
at the target). See <a
href="#hyperlink-targets">Hyperlink Targets</a>.
<tr valign="top">
<td nowrap><samp>_`inline internal target`</samp>
<td><a name="inline-internal-target">inline internal target</a>
<td>A cross-reference target within text.
See <a href="#hyperlink-targets">Hyperlink Targets</a>.
<tr valign="top">
<td nowrap><samp>|substitution reference|</samp>
<td>(see note at right)
<td>The result is substituted in from the <a
href="#substitution-references-and-definitions">substitution
definition</a>. It could be text, an image, a hyperlink, or a
combination of these and others.
<tr valign="top">
<td nowrap><samp>footnote reference [1]_</samp>
<td>footnote reference <sup><a href="#footnotes">1</a></sup>
<td>See <a href="#footnotes">Footnotes</a>.
<tr valign="top">
<td nowrap><samp>citation reference [CIT2002]_</samp>
<td>citation reference <a href="#citations">[CIT2002]</a>
<td>See <a href="#citations">Citations</a>.
<tr valign="top">
<td nowrap><samp>https://docutils.sourceforge.io/</samp>
<td><a href="https://docutils.sourceforge.io/">https://docutils.sourceforge.io/</a>
<td>A standalone hyperlink.
</table>
<p>Asterisk, backquote, vertical bar, and underscore are inline
delimiter characters. Asterisk, backquote, and vertical bar act
like quote marks; matching characters surround the marked-up word
or phrase, whitespace or other quoting is required outside them,
and there can't be whitespace just inside them. If you want to use
inline delimiter characters literally, <a href="#escaping">escape
(with backslash)</a> or quote them (with double backquotes; i.e.
use inline literals).
<p>In detail, the reStructuredText specification says that in
inline markup, the following rules apply to start-strings and
end-strings (inline markup delimiters):
<ol>
<li>The start-string must start a text block or be
immediately preceded by whitespace or any of
<samp>' " ( [ {</samp> or <samp><</samp>.
<li>The start-string must be immediately followed by non-whitespace.
<li>The end-string must be immediately preceded by non-whitespace.
<li>The end-string must end a text block (end of document or
followed by a blank line) or be immediately followed by whitespace
or any of <samp>' " . , : ; ! ? - ) ] } / \</samp>
or <samp>></samp>.
<li>If a start-string is immediately preceded by one of
<samp>' " ( [ {</samp> or <samp><</samp>, it must not be
immediately followed by the corresponding character from
<samp>' " ) ] }</samp> or <samp>></samp>.
<li>An end-string must be separated by at least one
character from the start-string.
<li>An <a href="#escaping">unescaped</a> backslash preceding a
start-string or end-string will disable markup recognition, except
for the end-string of inline literals.
</ol>
<p>Also remember that inline markup may not be nested (well,
except that inline literals can contain any of the other inline
markup delimiter characters, but that doesn't count because
nothing is processed).
<h2><a href="#contents" name="escaping" class="backref"
>Escaping with Backslashes</a></h2>
<p>(<a
href="../../ref/rst/restructuredtext.html#escaping-mechanism">details</a>)
<p>reStructuredText uses backslashes ("\") to override the special
meaning given to markup characters and get the literal characters
themselves. To get a literal backslash, use an escaped backslash
("\\"). For example:
<p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">
<thead>
<tr align="left" bgcolor="#99CCFF">
<th width="50%">Raw reStructuredText
<th width="50%">Typical result
</thead>
<tbody>
<tr valign="top"><td>
<samp>*escape* ``with`` "\"</samp>
<td><em>escape</em> <samp>with</samp> ""
<tr valign="top"><td>
<samp>\*escape* \``with`` "\\"</samp>
<td>*escape* ``with`` "\"
</table>
<p>In Python strings it will, of course, be necessary
to escape any backslash characters so that they actually
<em>reach</em> reStructuredText.
The simplest way to do this is to use raw strings:
<p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">
<thead>
<tr align="left" bgcolor="#99CCFF">
<th width="50%">Python string
<th width="50%">Typical result
</thead>
<tbody>
<tr valign="top"><td>
<samp>r"""\*escape* \`with` "\\""""</samp>
<td>*escape* `with` "\"
<tr valign="top"><td>
<samp> """\\*escape* \\`with` "\\\\""""</samp>
<td>*escape* `with` "\"
<tr valign="top"><td>
<samp> """\*escape* \`with` "\\""""</samp>
<td><em>escape</em> with ""
</table>
<h2><a href="#contents" name="section-structure" class="backref"
>Section Structure</a></h2>
<p>(<a href="../../ref/rst/restructuredtext.html#sections">details</a>)
<p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">
<thead>
<tr align="left" bgcolor="#99CCFF">
<th width="50%">Plain text
<th width="50%">Typical result
</thead>
<tbody>
<tr valign="top">
<td>
<samp>=====</samp>
<br><samp>Title</samp>
<br><samp>=====</samp>
<br><samp>Subtitle</samp>
<br><samp>--------</samp>
<br><samp>Titles are underlined (or over-</samp>
<br><samp>and underlined) with a printing</samp>
<br><samp>nonalphanumeric 7-bit ASCII</samp>
<br><samp>character. Recommended choices</samp>
<br><samp>are "``= - ` : ' " ~ ^ _ * + # < >``".</samp>
<br><samp>The underline/overline must be at</samp>
<br><samp>least as long as the title text.</samp>
<br><samp></samp>
<br><samp>A lone top-level (sub)section</samp>
<br><samp>is lifted up to be the document's</samp>
<br><samp>(sub)title.</samp>
<td>
<font size="+2"><strong>Title</strong></font>
<p><font size="+1"><strong>Subtitle</strong></font>
<p>Titles are underlined (or over-
and underlined) with a printing
nonalphanumeric 7-bit ASCII
character. Recommended choices
are "<samp>= - ` : ' " ~ ^ _ * + # < ></samp>".
The underline/overline must be at
least as long as the title text.
<p>A lone top-level (sub)section is
lifted up to be the document's
(sub)title.
</table>
<h2><a href="#contents" name="paragraphs" class="backref"
>Paragraphs</a></h2>
<p>(<a href="../../ref/rst/restructuredtext.html#paragraphs">details</a>)
<p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">
<thead>
<tr align="left" bgcolor="#99CCFF">
<th width="50%">Plain text
<th width="50%">Typical result
</thead>
<tbody>
<tr valign="top">
<td>
<p><samp>This is a paragraph.</samp>
<p><samp>Paragraphs line up at their left</samp>
<br><samp>edges, and are normally separated</samp>
<br><samp>by blank lines.</samp>
<td>
<p>This is a paragraph.
<p>Paragraphs line up at their left edges, and are normally
separated by blank lines.
</table>
<h2><a href="#contents" name="bullet-lists" class="backref"
>Bullet Lists</a></h2>
<p>(<a href="../../ref/rst/restructuredtext.html#bullet-lists">details</a>)
<p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">
<thead>
<tr align="left" bgcolor="#99CCFF">
<th width="50%">Plain text
<th width="50%">Typical result
</thead>
<tbody>
<tr valign="top">
<td>
<samp>Bullet lists:</samp>
<p><samp>- This is item 1</samp>
<br><samp>- This is item 2</samp>
<p><samp>- Bullets are "-", "*" or "+".</samp>
<br><samp> Continuing text must be aligned</samp>
<br><samp> after the bullet and whitespace.</samp>
<p><samp>Note that a blank line is required</samp>
<br><samp>before the first item and after the</samp>
<br><samp>last, but is optional between items.</samp>
<td>Bullet lists:
<ul>
<li>This is item 1
<li>This is item 2
<li>Bullets are "-", "*" or "+".
Continuing text must be aligned
after the bullet and whitespace.
</ul>
<p>Note that a blank line is required before the first
item and after the last, but is optional between items.
</table>
<h2><a href="#contents" name="enumerated-lists" class="backref"
>Enumerated Lists</a></h2>
<p>(<a href="../../ref/rst/restructuredtext.html#enumerated-lists">details</a>)
<p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">
<thead>
<tr align="left" bgcolor="#99CCFF">
<th width="50%">Plain text
<th width="50%">Typical result
</thead>
<tbody>
<tr valign="top">
<td>
<samp>Enumerated lists:</samp>
<p><samp>3. This is the first item</samp>
<br><samp>4. This is the second item</samp>
<br><samp>5. Enumerators are arabic numbers,</samp>
<br><samp> single letters, or roman numerals</samp>
<br><samp>6. List items should be sequentially</samp>
<br><samp> numbered, but need not start at 1</samp>
<br><samp> (although not all formatters will</samp>
<br><samp> honour the first index).</samp>
<br><samp>#. This item is auto-enumerated</samp>
<td>Enumerated lists:
<ol type="1">
<li value="3">This is the first item
<li>This is the second item
<li>Enumerators are arabic numbers, single letters,
or roman numerals
<li>List items should be sequentially numbered,
but need not start at 1 (although not all
formatters will honour the first index).
<li>This item is auto-enumerated
</ol>
</table>
<h2><a href="#contents" name="definition-lists" class="backref"
>Definition Lists</a></h2>
<p>(<a href="../../ref/rst/restructuredtext.html#definition-lists">details</a>)
<p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">
<thead>
<tr align="left" bgcolor="#99CCFF">
<th width="50%">Plain text
<th width="50%">Typical result
</thead>
<tbody>
<tr valign="top">
<td>
<samp>Definition lists:</samp>
<br>
<br><samp>what</samp>
<br><samp> Definition lists associate a term with</samp>
<br><samp> a definition.</samp>
<br>
<br><samp>how</samp>
<br><samp> The term is a one-line phrase, and the</samp>
<br><samp> definition is one or more paragraphs or</samp>
<br><samp> body elements, indented relative to the</samp>
<br><samp> term. Blank lines are not allowed</samp>
<br><samp> between term and definition.</samp>
<td>Definition lists:
<dl>
<dt><strong>what</strong>
<dd>Definition lists associate a term with
a definition.
<dt><strong>how</strong>
<dd>The term is a one-line phrase, and the
definition is one or more paragraphs or
body elements, indented relative to the
term. Blank lines are not allowed
between term and definition.
</dl>
</table>
<h2><a href="#contents" name="field-lists" class="backref"
>Field Lists</a></h2>
<p>(<a href="../../ref/rst/restructuredtext.html#field-lists">details</a>)
<p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">
<thead>
<tr align="left" bgcolor="#99CCFF">
<th width="50%">Plain text
<th width="50%">Typical result
</thead>
<tbody>
<tr valign="top">
<td>
<samp>:Authors:</samp>
<br><samp> Tony J. (Tibs) Ibbs,</samp>
<br><samp> David Goodger</samp>
<p><samp> (and sundry other good-natured folks)</samp>
<p><samp>:Version: 1.0 of 2001/08/08</samp>
<br><samp>:Dedication: To my father.</samp>
<td>
<table>
<tr valign="top">
<td><strong>Authors:</strong>
<td>Tony J. (Tibs) Ibbs,
David Goodger
<tr><td><td>(and sundry other good-natured folks)
<tr><td><strong>Version:</strong><td>1.0 of 2001/08/08
<tr><td><strong>Dedication:</strong><td>To my father.
</table>
</table>
<p>Field lists are used as part of an extension syntax, such as
options for <a href="#directives">directives</a>, or database-like
records meant for further processing. Field lists may also be
used as generic two-column table constructs in documents.
<h2><a href="#contents" name="option-lists" class="backref"
>Option Lists</a></h2>
<p>(<a href="../../ref/rst/restructuredtext.html#option-lists">details</a>)
<p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">
<thead>
<tr align="left" bgcolor="#99CCFF">
<th width="50%">Plain text
<th width="50%">Typical result
</thead>
<tbody>
<tr valign="top">
<td>
<p><samp>
-a command-line option "a"
<br>-b file options can have arguments
<br> and long descriptions
<br>--long options can be long also
<br>--input=file long options can also have
<br> arguments
<br>/V DOS/VMS-style options too
</samp>
<td>
<table border="0" width="100%">
<tbody valign="top">
<tr>
<td width="30%"><samp>-a</samp>
<td>command-line option "a"
<tr>
<td><samp>-b <i>file</i></samp>
<td>options can have arguments and long descriptions
<tr>
<td><samp>--long</samp>
<td>options can be long also
<tr>
<td><samp>--input=<i>file</i></samp>
<td>long options can also have arguments
<tr>
<td><samp>/V</samp>
<td>DOS/VMS-style options too
</table>
</table>
<p>There must be at least two spaces between the option and the
description.
<h2><a href="#contents" name="literal-blocks" class="backref"
>Literal Blocks</a></h2>
<p>(<a href="../../ref/rst/restructuredtext.html#literal-blocks">details</a>)
<p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">
<thead>
<tr align="left" bgcolor="#99CCFF">
<th width="50%">Plain text
<th width="50%">Typical result
</thead>
<tbody>
<tr valign="top">
<td>
<samp>A paragraph containing only two colons</samp>
<br><samp>indicates that the following indented</samp>
<br><samp>or quoted text is a literal block.</samp>
<br>
<br><samp>::</samp>
<br>
<br><samp> Whitespace, newlines, blank lines, and</samp>
<br><samp> all kinds of markup (like *this* or</samp>
<br><samp> \this) is preserved by literal blocks.</samp>
<br>
<br><samp> The paragraph containing only '::'</samp>
<br><samp> will be omitted from the result.</samp>
<br>
<br><samp>The ``::`` may be tacked onto the very</samp>
<br><samp>end of any paragraph. The ``::`` will be</samp>
<br><samp>omitted if it is preceded by whitespace.</samp>
<br><samp>The ``::`` will be converted to a single</samp>
<br><samp>colon if preceded by text, like this::</samp>
<br>
<br><samp> It's very convenient to use this form.</samp>
<br>
<br><samp>Literal blocks end when text returns to</samp>
<br><samp>the preceding paragraph's indentation.</samp>
<br><samp>This means that something like this</samp>
<br><samp>is possible::</samp>
<br>
<br><samp> We start here</samp>
<br><samp> and continue here</samp>
<br><samp> and end here.</samp>
<br>
<br><samp>Per-line quoting can also be used on</samp>
<br><samp>unindented literal blocks::</samp>
<br>
<br><samp>> Useful for quotes from email and</samp>
<br><samp>> for Haskell literate programming.</samp>
<td>
<p>A paragraph containing only two colons
indicates that the following indented or quoted
text is a literal block.
<pre>
Whitespace, newlines, blank lines, and
all kinds of markup (like *this* or
\this) is preserved by literal blocks.
The paragraph containing only '::'
will be omitted from the result.</pre>
<p>The <samp>::</samp> may be tacked onto the very
end of any paragraph. The <samp>::</samp> will be
omitted if it is preceded by whitespace.
The <samp>::</samp> will be converted to a single
colon if preceded by text, like this:
<pre>
It's very convenient to use this form.</pre>
<p>Literal blocks end when text returns to
the preceding paragraph's indentation.
This means that something like this is possible:
<pre>
We start here
and continue here
and end here.</pre>
<p>Per-line quoting can also be used on
unindented literal blocks:
<pre>
> Useful for quotes from email and
> for Haskell literate programming.</pre>
</table>
<h2><a href="#contents" name="line-blocks" class="backref"
>Line Blocks</a></h2>
<p>(<a href="../../ref/rst/restructuredtext.html#line-blocks">details</a>)
<p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">
<thead>
<tr align="left" bgcolor="#99CCFF">
<th width="50%">Plain text
<th width="50%">Typical result
</thead>
<tbody>
<tr valign="top">
<td>
<samp>| Line blocks are useful for addresses,</samp>
<br><samp>| verse, and adornment-free lists.</samp>
<br><samp>|</samp>
<br><samp>| Each new line begins with a</samp>
<br><samp>| vertical bar ("|").</samp>
<br><samp>| Line breaks and initial indents</samp>
<br><samp>| are preserved.</samp>
<br><samp>| Continuation lines are wrapped</samp>
<br><samp> portions of long lines; they begin</samp>
<br><samp> with spaces in place of vertical bars.</samp>
<td>
<div class="line-block">
<div class="line">Line blocks are useful for addresses,</div>
<div class="line">verse, and adornment-free lists.</div>
<div class="line"><br /></div>
<div class="line">Each new line begins with a</div>
<div class="line">vertical bar ("|").</div>
<div class="line-block">
<div class="line">Line breaks and initial indents</div>
<div class="line">are preserved.</div>
</div>
<div class="line">Continuation lines are wrapped portions
of long lines; they begin
with spaces in place of vertical bars.</div>
</div>
</table>
<h2><a href="#contents" name="block-quotes" class="backref"
>Block Quotes</a></h2>
<p>(<a href="../../ref/rst/restructuredtext.html#block-quotes">details</a>)
<p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">
<thead>
<tr align="left" bgcolor="#99CCFF">
<th width="50%">Plain text
<th width="50%">Typical result
</thead>
<tbody>
<tr valign="top">
<td>
<samp>Block quotes are just:</samp>
<p><samp> Indented paragraphs,</samp>
<p><samp> and they may nest.</samp>
<td>
Block quotes are just:
<blockquote>
<p>Indented paragraphs,
<blockquote>
<p>and they may nest.
</blockquote>
</blockquote>
</table>
<p>Use <a href="#comments">empty comments</a> to separate indentation
contexts, such as block quotes and directive contents.</p>
<h2><a href="#contents" name="doctest-blocks" class="backref"
>Doctest Blocks</a></h2>
<p>(<a href="../../ref/rst/restructuredtext.html#doctest-blocks">details</a>)
<p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">
<thead>
<tr align="left" bgcolor="#99CCFF">
<th width="50%">Plain text
<th width="50%">Typical result
</thead>
<tbody>
<tr valign="top">
<td>
<p><samp>Doctest blocks are interactive
<br>Python sessions. They begin with
<br>"``>>>``" and end with a blank line.</samp>
<p><samp>>>> print "This is a doctest block."
<br>This is a doctest block.</samp>
<td>
<p>Doctest blocks are interactive
Python sessions. They begin with
"<samp>>>></samp>" and end with a blank line.
<p><samp>>>> print "This is a doctest block."
<br>This is a doctest block.</samp>
</table>
<p>"The <a
href="https://docs.python.org/3/library/doctest.html">doctest</a>
module searches a module's docstrings for text that looks like an
interactive Python session, then executes all such sessions to
verify they still work exactly as shown." (From the doctest docs.)
<h2><a href="#contents" name="tables" class="backref"
>Tables</a></h2>
<p>(<a href="../../ref/rst/restructuredtext.html#tables">details</a>)
<p>There are two syntaxes for tables in reStructuredText. Grid
tables are complete but cumbersome to create. Simple tables are
easy to create but limited (no row spans, etc.).</p>
<p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">
<thead>
<tr align="left" bgcolor="#99CCFF">
<th width="50%">Plain text
<th width="50%">Typical result
</thead>
<tbody>
<tr valign="top">
<td>
<p><samp>Grid table:</samp></p>
<p><samp>+------------+------------+-----------+</samp>
<br><samp>| Header 1 | Header 2 | Header 3 |</samp>
<br><samp>+============+============+===========+</samp>
<br><samp>| body row 1 | column 2 | column 3 |</samp>
<br><samp>+------------+------------+-----------+</samp>
<br><samp>| body row 2 | Cells may span columns.|</samp>
<br><samp>+------------+------------+-----------+</samp>
<br><samp>| body row 3 | Cells may | - Cells |</samp>
<br><samp>+------------+ span rows. | - contain |</samp>
<br><samp>| body row 4 | | - blocks. |</samp>
<br><samp>+------------+------------+-----------+</samp></p>
<td>
<p>Grid table:</p>
<table border="1">
<thead valign="bottom">
<tr>
<th>Header 1
<th>Header 2
<th>Header 3
</tr>
</thead>
<tbody valign="top">
<tr>
<td>body row 1
<td>column 2
<td>column 3
</tr>
<tr>
<td>body row 2
<td colspan="2">Cells may span columns.
</tr>
<tr>
<td>body row 3
<td rowspan="2">Cells may<br>span rows.
<td rowspan="2">
<ul>
<li>Cells
<li>contain
<li>blocks.
</ul>
</tr>
<tr>
<td>body row 4
</tr>
</table>
<tr valign="top">
<td>
<p><samp>Simple table:</samp></p>
<p><samp>===== ===== ======</samp>
<br><samp> Inputs Output</samp>
<br><samp>------------ ------</samp>
<br><samp> A B A or B</samp>
<br><samp>===== ===== ======</samp>
<br><samp>False False False</samp>
<br><samp>True False True</samp>
<br><samp>False True True</samp>
<br><samp>True True True</samp>
<br><samp>===== ===== ======</samp></p>
<td>
<p>Simple table:</p>
<table border="1">
<colgroup>
<col width="31%">
<col width="31%">
<col width="38%">
</colgroup>
<thead valign="bottom">
<tr>
<th colspan="2">Inputs
<th>Output
<tr>
<th>A
<th>B
<th>A or B
<tbody valign="top">
<tr>
<td>False
<td>False
<td>False
<tr>
<td>True
<td>False
<td>True
<tr>
<td>False
<td>True
<td>True
<tr>
<td>True
<td>True
<td>True
</table>
</table>
<h2><a href="#contents" name="transitions" class="backref"
>Transitions</a></h2>
<p>(<a href="../../ref/rst/restructuredtext.html#transitions">details</a>)
<p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">
<thead>
<tr align="left" bgcolor="#99CCFF">
<th width="50%">Plain text
<th width="50%">Typical result
</thead>
<tbody>
<tr valign="top">
<td>
<p><samp>
A transition marker is a horizontal line
<br>of 4 or more repeated punctuation
<br>characters.</samp>
<p><samp>------------</samp>
<p><samp>A transition should not begin or end a
<br>section or document, nor should two
<br>transitions be immediately adjacent.</samp>
<td>
<p>A transition marker is a horizontal line
of 4 or more repeated punctuation
characters.</p>
<hr>
<p>A transition should not begin or end a
section or document, nor should two
transitions be immediately adjacent.
</table>
<p>Transitions are commonly seen in novels and short fiction, as a
gap spanning one or more lines, marking text divisions or
signaling changes in subject, time, point of view, or emphasis.
<h2><a href="#contents" name="explicit-markup" class="backref"
>Explicit Markup</a></h2>
<p>Explicit markup blocks are used for constructs which float
(footnotes), have no direct paper-document representation
(hyperlink targets, comments), or require specialized processing
(directives). They all begin with two periods and whitespace, the
"explicit markup start".
<h3><a href="#contents" name="footnotes" class="backref"
>Footnotes</a></h3>
<p>(<a href="../../ref/rst/restructuredtext.html#footnotes">details</a>)
<p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">
<thead>
<tr align="left" bgcolor="#99CCFF">
<th width="50%">Plain text
<th width="50%">Typical result
</thead>
<tbody>
<tr valign="top">
<td>
<samp>Footnote references, like [5]_.</samp>
<br><samp>Note that footnotes may get</samp>
<br><samp>rearranged, e.g., to the bottom of</samp>
<br><samp>the "page".</samp>
<p><samp>.. [5] A numerical footnote. Note</samp>
<br><samp> there's no colon after the ``]``.</samp>
<td>
Footnote references, like <sup><a href="#5">5</a></sup>.
Note that footnotes may get rearranged, e.g., to the bottom of
the "page".
<p><table>
<tr><td colspan="2"><hr>
<!-- <tr><td colspan="2">Footnotes: -->
<tr><td><a name="5"><strong>[5]</strong></a><td> A numerical footnote.
Note there's no colon after the <samp>]</samp>.
</table>
<tr valign="top">
<td>
<samp>Autonumbered footnotes are</samp>
<br><samp>possible, like using [#]_ and [#]_.</samp>
<p><samp>.. [#] This is the first one.</samp>
<br><samp>.. [#] This is the second one.</samp>
<p><samp>They may be assigned 'autonumber</samp>
<br><samp>labels' - for instance,
<br>[#fourth]_ and [#third]_.</samp>
<p><samp>.. [#third] a.k.a. third_</samp>
<p><samp>.. [#fourth] a.k.a. fourth_</samp>
<td>
Autonumbered footnotes are possible, like using <sup><a
href="#auto1">1</a></sup> and <sup><a href="#auto2">2</a></sup>.
<p>They may be assigned 'autonumber labels' - for instance,
<sup><a href="#fourth">4</a></sup> and <sup><a
href="#third">3</a></sup>.
<p><table>
<tr><td colspan="2"><hr>
<!-- <tr><td colspan="2">Footnotes: -->
<tr><td><a name="auto1"><strong>[1]</strong></a><td> This is the first one.
<tr><td><a name="auto2"><strong>[2]</strong></a><td> This is the second one.
<tr><td><a name="third"><strong>[3]</strong></a><td> a.k.a. <a href="#third">third</a>
<tr><td><a name="fourth"><strong>[4]</strong></a><td> a.k.a. <a href="#fourth">fourth</a>
</table>
<tr valign="top">
<td>
<samp>Auto-symbol footnotes are also</samp>
<br><samp>possible, like this: [*]_ and [*]_.</samp>
<p><samp>.. [*] This is the first one.</samp>
<br><samp>.. [*] This is the second one.</samp>
<td>
Auto-symbol footnotes are also
possible, like this: <sup><a href="#symbol1">*</a></sup>
and <sup><a href="#symbol2">†</a></sup>.
<p><table>
<tr><td colspan="2"><hr>
<!-- <tr><td colspan="2">Footnotes: -->
<tr><td><a name="symbol1"><strong>[*]</strong></a><td> This is the first symbol footnote
<tr><td><a name="symbol2"><strong>[†]</strong></a><td> This is the second one.
</table>
</table>
<p>The numbering of auto-numbered footnotes is determined by the
order of the footnotes, not of the references. For auto-numbered
footnote references without autonumber labels
("<samp>[#]_</samp>"), the references and footnotes must be in the
same relative order. Similarly for auto-symbol footnotes
("<samp>[*]_</samp>").
<h3><a href="#contents" name="citations" class="backref"
>Citations</a></h3>
<p>(<a href="../../ref/rst/restructuredtext.html#citations">details</a>)
<p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">
<thead>
<tr align="left" bgcolor="#99CCFF">
<th width="50%">Plain text
<th width="50%">Typical result
</thead>
<tbody>
<tr valign="top">
<td>
<samp>Citation references, like [CIT2002]_.</samp>
<br><samp>Note that citations may get</samp>
<br><samp>rearranged, e.g., to the bottom of</samp>
<br><samp>the "page".</samp>
<p><samp>.. [CIT2002] A citation</samp>
<br><samp> (as often used in journals).</samp>
<p><samp>Citation labels contain alphanumerics,</samp>
<br><samp>underlines, hyphens and fullstops.</samp>
<br><samp>Case is not significant.</samp>
<p><samp>Given a citation like [this]_, one</samp>
<br><samp>can also refer to it like this_.</samp>
<p><samp>.. [this] here.</samp>
<td>
Citation references, like <a href="#cit2002">[CIT2002]</a>.
Note that citations may get rearranged, e.g., to the bottom of
the "page".
<p>Citation labels contain alphanumerics, underlines, hyphens
and fullstops. Case is not significant.
<p>Given a citation like <a href="#this">[this]</a>, one
can also refer to it like <a href="#this">this</a>.
<p><table>
<tr><td colspan="2"><hr>
<!-- <tr><td colspan="2">Citations: -->
<tr><td><a name="cit2002"><strong>[CIT2002]</strong></a><td> A citation
(as often used in journals).
<tr><td><a name="this"><strong>[this]</strong></a><td> here.
</table>
</table>
<h3><a href="#contents" name="hyperlink-targets" class="backref"
>Hyperlink Targets</a></h3>
<p>(<a href="../../ref/rst/restructuredtext.html#hyperlink-targets">details</a>)
<h4><a href="#contents" name="external-hyperlink-targets" class="backref"
>External Hyperlink Targets</a></h4>
<p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">
<thead>
<tr align="left" bgcolor="#99CCFF">
<th width="50%">Plain text
<th width="50%">Typical result
</thead>
<tbody>
<tr valign="top">
<td rowspan="2">
<samp>External hyperlinks, like Python_.</samp>
<p><samp>.. _Python: https://www.python.org/</samp>
<td>
<table width="100%">
<tr bgcolor="#99CCFF"><td><em>Fold-in form</em>
<tr><td>External hyperlinks, like
<a href="https://www.python.org/">Python</a>.
</table>
<tr valign="top">
<td>
<table width="100%">
<tr bgcolor="#99CCFF"><td><em>Call-out form</em>
<tr><td>External hyperlinks, like
<a href="#labPython"><i>Python</i></a>.
<p><table>
<tr><td colspan="2"><hr>
<tr><td><a name="labPython"><i>Python:</i></a>
<td> <a href="https://www.python.org/">https://www.python.org/</a>
</table>
</table>
</table>
<p>"<em>Fold-in</em>" is the representation typically used in HTML
documents (think of the indirect hyperlink being "folded in" like
ingredients into a cake), and "<em>call-out</em>" is more suitable for
printed documents, where the link needs to be presented explicitly, for
example as a footnote. You can force usage of the call-out form by
using the
"<a href="../../ref/rst/directives.html#target-notes">target-notes</a>"
directive.
<p>reStructuredText also provides for <b>embedded URIs</b> (<a
href="../../ref/rst/restructuredtext.html#embedded-uris-and-aliases">details</a>),
a convenience at the expense of readability. A hyperlink
reference may directly embed a target URI inline, within angle
brackets. The following is exactly equivalent to the example above:
<p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">
<thead>
<tr align="left" bgcolor="#99CCFF">
<th width="50%">Plain text
<th width="50%">Typical result
</thead>
<tbody>
<tr valign="top">
<td rowspan="2">
<samp>External hyperlinks, like `Python
<br><https://www.python.org/>`_.</samp>
<td>External hyperlinks, like
<a href="https://www.python.org/">Python</a>.
</table>
<h4><a href="#contents" name="internal-hyperlink-targets" class="backref"
>Internal Hyperlink Targets</a></h4>
<p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">
<thead>
<tr align="left" bgcolor="#99CCFF">
<th width="50%">Plain text
<th width="50%">Typical result
</thead>
<tbody>
<tr valign="top">
<td rowspan="2"><samp>Internal cross-references, like example_.</samp>
<p><samp>.. _example:</samp>
<p><samp>This is an example cross-reference target.</samp>
<td>
<table width="100%">
<tr bgcolor="#99CCFF"><td><em>Fold-in form</em>
<!-- Note that some browsers may not like an "a" tag that -->
<!-- does not have any content, so we could arbitrarily -->
<!-- use the first word as content - *or* just trust to -->
<!-- luck! -->
<tr><td>Internal cross-references, like <a href="#example-foldin">example</a>
<p><a name="example-foldin">This</a> is an example
cross-reference target.
</table>
<tr valign="top">
<td>
<table width="100%">
<tr><td bgcolor="#99CCFF"><em>Call-out form</em>
<tr><td>Internal cross-references, like <a href="#example-callout">example</a>
<p><a name="example-callout"><i>example:</i></a>
<br>This is an example cross-reference target.
</table>
</table>
<h4><a href="#contents" name="indirect-hyperlink-targets" class="backref"
>Indirect Hyperlink Targets</a></h4>
<p>(<a href="../../ref/rst/restructuredtext.html#indirect-hyperlink-targets">details</a>)
<p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">
<thead>
<tr align="left" bgcolor="#99CCFF">
<th width="50%">Plain text
<th width="50%">Typical result
</thead>
<tbody>
<tr valign="top">
<td>
<samp>Python_ is `my favourite
<br>programming language`__.</samp>
<p><samp>.. _Python: https://www.python.org/</samp>
<p><samp>__ Python_</samp>
<td>
<p><a href="https://www.python.org/">Python</a> is
<a href="https://www.python.org/">my favourite
programming language</a>.
</table>
<p>The second hyperlink target (the line beginning with
"<samp>__</samp>") is both an indirect hyperlink target
(<i>indirectly</i> pointing at the Python website via the
"<samp>Python_</samp>" reference) and an <b>anonymous hyperlink
target</b>. In the text, a double-underscore suffix is used to
indicate an <b>anonymous hyperlink reference</b>. In an anonymous
hyperlink target, the reference text is not repeated. This is
useful for references with long text or throw-away references, but
the target should be kept close to the reference to prevent them
going out of sync.
<h4><a href="#contents" name="implicit-hyperlink-targets" class="backref"
>Implicit Hyperlink Targets</a></h4>
<p>(<a href="../../ref/rst/restructuredtext.html#implicit-hyperlink-targets">details</a>)
<p>Section titles, footnotes, and citations automatically generate
hyperlink targets (the title text or footnote/citation label is
used as the hyperlink name).
<p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">
<thead><tr align="left" bgcolor="#99CCFF">
<th width="50%">Plain text
<th width="50%">Typical result
</thead>
<tbody>
<tr valign="top">
<td>
<samp>Titles are targets, too</samp>
<br><samp>=======================</samp>
<br><samp>Implicit references, like `Titles are</samp>
<br><samp>targets, too`_.</samp>
<td>
<font size="+2"><strong><a name="title">Titles are targets, too</a></strong></font>
<p>Implicit references, like <a href="#title">Titles are
targets, too</a>.
</table>
<h3><a href="#contents" name="directives" class="backref"
>Directives</a></h3>
<p>(<a href="../../ref/rst/restructuredtext.html#directives">details</a>)
<p>Directives are a general-purpose extension mechanism, a way of
adding support for new constructs without adding new syntax. For
a description of all standard directives, see <a
href="../../ref/rst/directives.html" >reStructuredText
Directives</a>.
<p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">
<thead>
<tr align="left" bgcolor="#99CCFF">
<th width="50%">Plain text
<th width="50%">Typical result
</thead>
<tbody>
<tr valign="top">
<td><samp>For instance:</samp>
<p><samp>.. image:: images/ball1.gif</samp>
<td>
For instance:
<p><img src="images/ball1.gif" alt="ball1">
</table>
<h3><a href="#contents" name="substitution-references-and-definitions"
class="backref" >Substitution References and Definitions</a></h3>
<p>(<a href="../../ref/rst/restructuredtext.html#substitution-definitions">details</a>)
<p>Substitutions are like inline directives, allowing graphics and
arbitrary constructs within text.
<p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">
<thead>
<tr align="left" bgcolor="#99CCFF">
<th width="50%">Plain text
<th width="50%">Typical result
</thead>
<tbody>
<tr valign="top">
<td><samp>
The |biohazard| symbol must be
used on containers used to
dispose of medical waste.</samp>
<p><samp>
.. |biohazard| image:: biohazard.png</samp>
<td>
<p>The <img src="images/biohazard.png" align="bottom" alt="biohazard"> symbol
must be used on containers used to dispose of medical waste.
</table>
<h3><a href="#contents" name="comments" class="backref"
>Comments</a></h3>
<p>(<a href="../../ref/rst/restructuredtext.html#comments">details</a>)
<p>Any text which begins with an explicit markup start but doesn't
use the syntax of any of the constructs above, is a comment.
<p><table border="1" width="100%" bgcolor="#ffffcc" cellpadding="3">
<thead>
<tr align="left" bgcolor="#99CCFF">
<th width="50%">Plain text
<th width="50%">Typical result
</thead>
<tbody>
<tr valign="top">
<td><samp>.. This text will not be shown</samp>
<br><samp> (but, for instance, in HTML might be</samp>
<br><samp> rendered as an HTML comment)</samp>
<td>
<!-- This text will not be shown -->
<!-- (but, for instance in HTML might be -->
<!-- rendered as an HTML comment) -->
<tr valign="top">
<td>
<samp>An "empty comment" does not</samp>
<br><samp>consume following blocks.</samp>
<br><samp>(An empty comment is ".." with</samp>
<br><samp>blank lines before and after.)</samp>
<p><samp>..</samp>
<p><samp> So this block is not "lost",</samp>
<br><samp> despite its indentation.</samp>
<td>
An "empty comment" does not
consume following blocks.
(An empty comment is ".." with
blank lines before and after.)
<blockquote>
So this block is not "lost",
despite its indentation.
</blockquote>
</table>
<h2><a href="#contents" name="getting-help" class="backref"
>Getting Help</a></h2>
<p>Users who have questions or need assistance with Docutils or
reStructuredText should <a
href="mailto:docutils-users@lists.sourceforge.net" >post a
message</a> to the <a
href="https://lists.sourceforge.net/lists/listinfo/docutils-users"
>Docutils-Users mailing list</a>. The <a
href="https://docutils.sourceforge.io/" >Docutils project web
site</a> has more information.
<p><hr>
<address>
<p>Authors:
<a href="http://www.tibsnjoan.co.uk/">Tibs</a>
(<a href="mailto:tibs@tibsnjoan.co.uk"><tt>tibs@tibsnjoan.co.uk</tt></a>)
and David Goodger
(<a href="mailto:goodger@python.org">goodger@python.org</a>)
</address>
<!-- Created: Fri Aug 03 09:11:57 GMT Daylight Time 2001 -->
</body>
</html>
|
