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
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
|
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE document PUBLIC "+//IDN docutils.sourceforge.net//DTD Docutils Generic//EN//XML" "http://docutils.sourceforge.net/docs/ref/docutils.dtd">
<!-- Generated by Docutils 0.18.1b.dev -->
<document ids="restructuredtext-test-document doctitle" names="restructuredtext\ test\ document doctitle" source="functional/input/standalone_rst_docutils_xml.txt" title="reStructuredText Test Document">
<title>reStructuredText Test Document</title>
<subtitle ids="examples-of-syntax-constructs subtitle" names="examples\ of\ syntax\ constructs subtitle">Examples of Syntax Constructs</subtitle>
<meta content="reStructuredText, test, parser" name="keywords">
</meta>
<meta content="A test document, containing at least one example of each reStructuredText construct." lang="en" name="description">
</meta>
<decoration>
<header>
<paragraph>Document header</paragraph>
</header>
<footer>
<paragraph>Document footer</paragraph>
</footer>
</decoration>
<docinfo>
<author>David Goodger</author>
<address xml:space="preserve">123 Example Street
Example, EX Canada
A1B 2C3</address>
<contact><reference refuri="mailto:goodger@python.org">goodger@python.org</reference></contact>
<authors>
<author>Me</author>
<author>Myself</author>
<author>I</author>
</authors>
<organization>humankind</organization>
<date>Now, or yesterday. Or maybe even <emphasis>before</emphasis> yesterday.</date>
<status>This is a "work in progress"</status>
<revision>is managed by a version control system.</revision>
<version>1</version>
<copyright>This document has been placed in the public domain. You
may do with it as you wish. You may copy, modify,
redistribute, reattribute, sell, buy, rent, lease,
destroy, or improve it, quote it at length, excerpt,
incorporate, collate, fold, staple, or mutilate it, or do
anything else to it that your or anyone else's heart
desires.</copyright>
<field classes="field-name">
<field_name>field name</field_name>
<field_body>
<paragraph>This is a "generic bibliographic field".</paragraph>
</field_body>
</field>
<field classes="field-name-2">
<field_name>field name "2"</field_name>
<field_body>
<paragraph>Generic bibliographic fields may contain multiple body elements.</paragraph>
<paragraph>Like this.</paragraph>
</field_body>
</field>
</docinfo>
<topic classes="dedication">
<title>Dedication</title>
<paragraph>For Docutils users & co-developers.</paragraph>
</topic>
<topic classes="abstract">
<title>Abstract</title>
<paragraph>This is a test document, containing at least one example of each
reStructuredText construct.</paragraph>
</topic>
<comment xml:space="preserve">This is a comment. Note how any initial comments are moved by
transforms to after the document title, subtitle, and docinfo.</comment>
<target refid="doctitle"></target>
<comment xml:space="preserve">Above is the document title, and below is the subtitle.
They are transformed from section titles after parsing.</comment>
<target refid="subtitle"></target>
<comment xml:space="preserve">bibliographic fields (which also require a transform):</comment>
<raw format="latex" xml:space="preserve">\pagebreak[4] % start ToC on new page</raw>
<topic classes="contents" ids="table-of-contents" names="table\ of\ contents">
<title>Table of Contents</title>
<bullet_list classes="auto-toc">
<list_item>
<paragraph><reference ids="toc-entry-1" refid="structural-elements"><generated classes="sectnum">1 </generated>Structural Elements</reference></paragraph>
<bullet_list classes="auto-toc">
<list_item>
<paragraph><reference ids="toc-entry-2" refid="section-title"><generated classes="sectnum">1.1 </generated>Section Title</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-3" refid="empty-section"><generated classes="sectnum">1.2 </generated>Empty Section</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-4" refid="transitions"><generated classes="sectnum">1.3 </generated>Transitions</reference></paragraph>
</list_item>
</bullet_list>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-5" refid="body-elements"><generated classes="sectnum">2 </generated>Body Elements</reference></paragraph>
<bullet_list classes="auto-toc">
<list_item>
<paragraph><reference ids="toc-entry-6" refid="paragraphs"><generated classes="sectnum">2.1 </generated>Paragraphs</reference></paragraph>
<bullet_list classes="auto-toc">
<list_item>
<paragraph><reference ids="toc-entry-7" refid="inline-markup"><generated classes="sectnum">2.1.1 </generated>Inline Markup</reference></paragraph>
</list_item>
</bullet_list>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-8" refid="bullet-lists"><generated classes="sectnum">2.2 </generated>Bullet Lists</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-9" refid="enumerated-lists"><generated classes="sectnum">2.3 </generated>Enumerated Lists</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-10" refid="definition-lists"><generated classes="sectnum">2.4 </generated>Definition Lists</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-11" refid="field-lists"><generated classes="sectnum">2.5 </generated>Field Lists</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-12" refid="option-lists"><generated classes="sectnum">2.6 </generated>Option Lists</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-13" refid="literal-blocks"><generated classes="sectnum">2.7 </generated>Literal Blocks</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-14" refid="line-blocks"><generated classes="sectnum">2.8 </generated>Line Blocks</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-15" refid="block-quotes"><generated classes="sectnum">2.9 </generated>Block Quotes</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-16" refid="doctest-blocks"><generated classes="sectnum">2.10 </generated>Doctest Blocks</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-17" refid="footnotes"><generated classes="sectnum">2.11 </generated>Footnotes</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-18" refid="citations"><generated classes="sectnum">2.12 </generated>Citations</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-19" refid="targets"><generated classes="sectnum">2.13 </generated>Targets</reference></paragraph>
<bullet_list classes="auto-toc">
<list_item>
<paragraph><reference ids="toc-entry-20" refid="duplicate-target-names"><generated classes="sectnum">2.13.1 </generated>Duplicate Target Names</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-21" refid="duplicate-target-names-1"><generated classes="sectnum">2.13.2 </generated>Duplicate Target Names</reference></paragraph>
</list_item>
</bullet_list>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-22" refid="directives"><generated classes="sectnum">2.14 </generated>Directives</reference></paragraph>
<bullet_list classes="auto-toc">
<list_item>
<paragraph><reference ids="toc-entry-23" refid="document-parts"><generated classes="sectnum">2.14.1 </generated>Document Parts</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-24" refid="images-and-figures"><generated classes="sectnum">2.14.2 </generated>Images and Figures</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-25" refid="tables"><generated classes="sectnum">2.14.3 </generated>Tables</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-26" refid="admonitions"><generated classes="sectnum">2.14.4 </generated>Admonitions</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-27" refid="topics-sidebars-and-rubrics"><generated classes="sectnum">2.14.5 </generated>Topics, Sidebars, and Rubrics</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-28" refid="target-footnotes"><generated classes="sectnum">2.14.6 </generated>Target Footnotes</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-29" refid="replacement-text"><generated classes="sectnum">2.14.7 </generated>Replacement Text</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-30" refid="compound-paragraph"><generated classes="sectnum">2.14.8 </generated>Compound Paragraph</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-31" refid="parsed-literal-blocks"><generated classes="sectnum">2.14.9 </generated>Parsed Literal Blocks</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-32" refid="code"><generated classes="sectnum">2.14.10 </generated>Code</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-33" refid="meta"><generated classes="sectnum">2.14.11 </generated>Meta</reference></paragraph>
</list_item>
</bullet_list>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-34" refid="substitution-definitions"><generated classes="sectnum">2.15 </generated>Substitution Definitions</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-35" refid="comments"><generated classes="sectnum">2.16 </generated>Comments</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-36" refid="raw-text"><generated classes="sectnum">2.17 </generated>Raw text</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-37" refid="container"><generated classes="sectnum">2.18 </generated>Container</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-38" refid="colspanning-tables"><generated classes="sectnum">2.19 </generated>Colspanning tables</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-39" refid="rowspanning-tables"><generated classes="sectnum">2.20 </generated>Rowspanning tables</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-40" refid="complex-tables"><generated classes="sectnum">2.21 </generated>Complex tables</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-41" refid="list-tables"><generated classes="sectnum">2.22 </generated>List Tables</reference></paragraph>
</list_item>
</bullet_list>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-42" refid="error-handling"><generated classes="sectnum">3 </generated>Error Handling</reference></paragraph>
</list_item>
</bullet_list>
</topic>
<section ids="structural-elements" names="structural\ elements">
<title auto="1" refid="toc-entry-1"><generated classes="sectnum">1 </generated>Structural Elements</title>
<section ids="section-title" names="section\ title">
<title auto="1" refid="toc-entry-2"><generated classes="sectnum">1.1 </generated>Section Title</title>
<subtitle ids="section-subtitle" names="section\ subtitle">Section Subtitle</subtitle>
<paragraph>Lone subsections are converted to a section subtitle by a transform
activated with the <literal>--section-subtitles</literal> command line option or the
<literal>sectsubtitle-xform</literal> configuration value.</paragraph>
</section>
<section ids="empty-section" names="empty\ section">
<title auto="1" refid="toc-entry-3"><generated classes="sectnum">1.2 </generated>Empty Section</title>
</section>
<section ids="transitions" names="transitions">
<title auto="1" refid="toc-entry-4"><generated classes="sectnum">1.3 </generated>Transitions</title>
<paragraph>Here's a transition:</paragraph>
<transition></transition>
<paragraph>It divides the section. Transitions may also occur between sections:</paragraph>
</section>
</section>
<transition></transition>
<section ids="body-elements" names="body\ elements">
<title auto="1" refid="toc-entry-5"><generated classes="sectnum">2 </generated>Body Elements</title>
<section ids="paragraphs" names="paragraphs">
<title auto="1" refid="toc-entry-6"><generated classes="sectnum">2.1 </generated>Paragraphs</title>
<paragraph>A paragraph.</paragraph>
<section ids="inline-markup" names="inline\ markup">
<title auto="1" refid="toc-entry-7"><generated classes="sectnum">2.1.1 </generated>Inline Markup</title>
<paragraph>Paragraphs contain text and may contain inline markup: <emphasis>emphasis</emphasis>,
<strong>strong emphasis</strong>, <literal>inline literals</literal>, standalone hyperlinks
(<reference refuri="http://www.python.org">http://www.python.org</reference>), external hyperlinks (<reference name="Python" refuri="http://www.python.org/">Python</reference> <footnote_reference auto="1" ids="footnote-reference-10" refid="footnote-6">5</footnote_reference>), internal
cross-references (<reference name="example" refid="example">example</reference>), external hyperlinks with embedded URIs
(<reference name="Python web site" refuri="http://www.python.org">Python web site</reference>), <reference anonymous="1" name="anonymous hyperlink references" refuri="http://www.python.org/">anonymous hyperlink
references</reference> <footnote_reference auto="1" ids="footnote-reference-14" refid="footnote-6">5</footnote_reference> (<reference anonymous="1" name="a second reference" refuri="https://docutils.sourceforge.io/">a second reference</reference> <footnote_reference auto="1" ids="footnote-reference-15" refid="footnote-8">7</footnote_reference>), footnote references (manually
numbered <footnote_reference ids="footnote-reference-1" refid="footnote-1">1</footnote_reference>, anonymous auto-numbered <footnote_reference auto="1" ids="footnote-reference-2" refid="footnote-2">3</footnote_reference>, labeled auto-numbered
<footnote_reference auto="1" ids="footnote-reference-3" refid="label">2</footnote_reference>, or symbolic <footnote_reference auto="*" ids="footnote-reference-4" refid="footnote-3">*</footnote_reference>), citation references (see <citation_reference ids="citation-reference-1" refid="cit2002">CIT2002</citation_reference>),
substitution references (<image alt="EXAMPLE" uri="../../../docs/user/rst/images/biohazard.png"></image> &
a <emphasis>trimmed heart</emphasis> <literal>(U+2665):</literal>♥), and <target ids="inline-hyperlink-targets" names="inline\ hyperlink\ targets">inline hyperlink targets</target>
(see <reference name="Targets" refid="targets">Targets</reference> below for a reference back to here). Character-level
inline markup is also possible (although exceedingly ugly!) in <emphasis>re</emphasis><literal>Structured</literal><emphasis>Text</emphasis>. Problems are indicated by <problematic ids="problematic-1" refid="system-message-1">|problematic|</problematic> text
(generated by processing errors; this one is intentional). Here is a
reference to the <reference name="doctitle" refid="doctitle">doctitle</reference> and the <reference name="subtitle" refid="subtitle">subtitle</reference>.</paragraph>
<target anonymous="1" ids="target-1" refuri="http://www.python.org/"></target>
<target anonymous="1" ids="target-2" refuri="https://docutils.sourceforge.io/"></target>
<paragraph>The default role for interpreted text is <title_reference>Title Reference</title_reference>. Here are
some explicit interpreted text roles: a PEP reference (<reference refuri="http://www.python.org/dev/peps/pep-0287">PEP 287</reference>); an
RFC reference (<reference refuri="http://tools.ietf.org/html/rfc2822.html">RFC 2822</reference>); an abbreviation (<abbreviation>abb.</abbreviation>), an acronym
(<acronym>reST</acronym>), code (<literal classes="code">print "hello world"</literal>); a <subscript>subscript</subscript>;
a <superscript>superscript</superscript> and explicit roles for <title_reference>Docutils</title_reference>'
<emphasis>standard</emphasis> <strong>inline</strong> <literal>markup</literal>.</paragraph>
<comment xml:space="preserve">DO NOT RE-WRAP THE FOLLOWING PARAGRAPH!</comment>
<paragraph>Let's test wrapping and whitespace significance in inline literals:
<literal>This is an example of --inline-literal --text, --including some--
strangely--hyphenated-words. Adjust-the-width-of-your-browser-window
to see how the text is wrapped. -- ---- -------- Now note the
spacing between the words of this sentence (words
should be grouped in pairs).</literal></paragraph>
<paragraph>If the <literal>--pep-references</literal> option was supplied, there should be a
live link to PEP 258 here.</paragraph>
</section>
</section>
<section ids="bullet-lists" names="bullet\ lists">
<title auto="1" refid="toc-entry-8"><generated classes="sectnum">2.2 </generated>Bullet Lists</title>
<bullet_list bullet="-">
<list_item>
<paragraph>A bullet list</paragraph>
<bullet_list bullet="+">
<list_item>
<paragraph>Nested bullet list.</paragraph>
</list_item>
<list_item>
<paragraph>Nested item 2.</paragraph>
</list_item>
</bullet_list>
</list_item>
<list_item>
<paragraph>Item 2.</paragraph>
<paragraph>Paragraph 2 of item 2.</paragraph>
<bullet_list bullet="*">
<list_item>
<paragraph>Nested bullet list.</paragraph>
</list_item>
<list_item>
<paragraph>Nested item 2.</paragraph>
<bullet_list bullet="-">
<list_item>
<paragraph>Third level.</paragraph>
</list_item>
<list_item>
<paragraph>Item 2.</paragraph>
</list_item>
</bullet_list>
</list_item>
<list_item>
<paragraph>Nested item 3.</paragraph>
</list_item>
<list_item>
<paragraph>This nested list should be compacted by the HTML writer.</paragraph>
<target ids="target" names="target"></target>
<comment xml:space="preserve">Even if this item contains a target and a comment.</comment>
</list_item>
</bullet_list>
</list_item>
</bullet_list>
</section>
<section ids="enumerated-lists" names="enumerated\ lists">
<title auto="1" refid="toc-entry-9"><generated classes="sectnum">2.3 </generated>Enumerated Lists</title>
<enumerated_list enumtype="arabic" prefix="" suffix=".">
<list_item>
<paragraph>Arabic numerals.</paragraph>
<enumerated_list enumtype="loweralpha" prefix="" suffix=")">
<list_item>
<paragraph>lower alpha)</paragraph>
<enumerated_list enumtype="lowerroman" prefix="(" suffix=")">
<list_item>
<paragraph>(lower roman)</paragraph>
<enumerated_list enumtype="upperalpha" prefix="" suffix=".">
<list_item>
<paragraph>upper alpha.</paragraph>
<enumerated_list enumtype="upperroman" prefix="" suffix=")">
<list_item>
<paragraph>upper roman)</paragraph>
</list_item>
</enumerated_list>
</list_item>
</enumerated_list>
</list_item>
</enumerated_list>
</list_item>
</enumerated_list>
</list_item>
<list_item>
<paragraph>Lists that don't start at 1:</paragraph>
<enumerated_list enumtype="arabic" prefix="" start="3" suffix=".">
<list_item>
<paragraph>Three</paragraph>
</list_item>
<list_item>
<paragraph>Four</paragraph>
</list_item>
</enumerated_list>
<system_message level="1" line="8" source="functional/input/data/standard.txt" type="INFO">
<paragraph>Enumerated list start value not ordinal-1: "3" (ordinal 3)</paragraph>
</system_message>
<enumerated_list enumtype="upperalpha" prefix="" start="3" suffix=".">
<list_item>
<paragraph>C</paragraph>
</list_item>
<list_item>
<paragraph>D</paragraph>
</list_item>
</enumerated_list>
<system_message level="1" line="8" source="functional/input/data/standard.txt" type="INFO">
<paragraph>Enumerated list start value not ordinal-1: "C" (ordinal 3)</paragraph>
</system_message>
<enumerated_list enumtype="lowerroman" prefix="" start="3" suffix=".">
<list_item>
<paragraph>iii</paragraph>
</list_item>
<list_item>
<paragraph>iv</paragraph>
</list_item>
</enumerated_list>
<system_message level="1" line="8" source="functional/input/data/standard.txt" type="INFO">
<paragraph>Enumerated list start value not ordinal-1: "iii" (ordinal 3)</paragraph>
</system_message>
</list_item>
</enumerated_list>
</section>
<section ids="definition-lists" names="definition\ lists">
<title auto="1" refid="toc-entry-10"><generated classes="sectnum">2.4 </generated>Definition Lists</title>
<definition_list>
<definition_list_item>
<term>Term</term>
<definition>
<paragraph>Definition</paragraph>
</definition>
</definition_list_item>
<definition_list_item>
<term>Term</term>
<classifier>classifier</classifier>
<definition>
<paragraph>Definition paragraph 1.</paragraph>
<paragraph>Definition paragraph 2.</paragraph>
</definition>
</definition_list_item>
<definition_list_item>
<term>Term</term>
<definition>
<paragraph>Definition</paragraph>
</definition>
</definition_list_item>
<definition_list_item>
<term>Term</term>
<classifier>classifier one</classifier>
<classifier>classifier two</classifier>
<definition>
<paragraph>Definition</paragraph>
</definition>
</definition_list_item>
</definition_list>
</section>
<section ids="field-lists" names="field\ lists">
<title auto="1" refid="toc-entry-11"><generated classes="sectnum">2.5 </generated>Field Lists</title>
<field_list>
<field>
<field_name>what</field_name>
<field_body>
<paragraph>Field lists map field names to field bodies, like database
records. They are often part of an extension syntax. They are
an unambiguous variant of RFC 2822 fields.</paragraph>
</field_body>
</field>
<field>
<field_name>how arg1 arg2</field_name>
<field_body>
<paragraph>The field marker is a colon, the field name, and a colon.</paragraph>
<paragraph>The field body may contain one or more body elements, indented
relative to the field marker.</paragraph>
</field_body>
</field>
<field>
<field_name>credits</field_name>
<field_body>
<paragraph classes="credits">This paragraph has the <title_reference>credits</title_reference> class set. (This is actually not
about credits but just for ensuring that the class attribute
doesn't get stripped away.)</paragraph>
</field_body>
</field>
</field_list>
</section>
<section ids="option-lists" names="option\ lists">
<title auto="1" refid="toc-entry-12"><generated classes="sectnum">2.6 </generated>Option Lists</title>
<paragraph>For listing command-line options:</paragraph>
<option_list>
<option_list_item>
<option_group>
<option>
<option_string>-a</option_string>
</option>
</option_group>
<description>
<paragraph>command-line option "a"</paragraph>
</description>
</option_list_item>
<option_list_item>
<option_group>
<option>
<option_string>-b</option_string>
<option_argument delimiter=" ">file</option_argument>
</option>
</option_group>
<description>
<paragraph>options can have arguments
and long descriptions</paragraph>
</description>
</option_list_item>
<option_list_item>
<option_group>
<option>
<option_string>--long</option_string>
</option>
</option_group>
<description>
<paragraph>options can be long also</paragraph>
</description>
</option_list_item>
<option_list_item>
<option_group>
<option>
<option_string>--input</option_string>
<option_argument delimiter="=">file</option_argument>
</option>
</option_group>
<description>
<paragraph>long options can also have
arguments</paragraph>
</description>
</option_list_item>
<option_list_item>
<option_group>
<option>
<option_string>--very-long-option</option_string>
</option>
</option_group>
<description>
<paragraph>The description can also start on the next line.</paragraph>
<paragraph>The description may contain multiple body elements,
regardless of where it starts.</paragraph>
</description>
</option_list_item>
<option_list_item>
<option_group>
<option>
<option_string>-x</option_string>
</option>
<option>
<option_string>-y</option_string>
</option>
<option>
<option_string>-z</option_string>
</option>
</option_group>
<description>
<paragraph>Multiple options are an "option group".</paragraph>
</description>
</option_list_item>
<option_list_item>
<option_group>
<option>
<option_string>-v</option_string>
</option>
<option>
<option_string>--verbose</option_string>
</option>
</option_group>
<description>
<paragraph>Commonly-seen: short & long options.</paragraph>
</description>
</option_list_item>
<option_list_item>
<option_group>
<option>
<option_string>-1</option_string>
<option_argument delimiter=" ">file</option_argument>
</option>
<option>
<option_string>--one</option_string>
<option_argument delimiter="=">file</option_argument>
</option>
<option>
<option_string>--two</option_string>
<option_argument delimiter=" ">file</option_argument>
</option>
</option_group>
<description>
<paragraph>Multiple options with arguments.</paragraph>
</description>
</option_list_item>
<option_list_item>
<option_group>
<option>
<option_string>/V</option_string>
</option>
</option_group>
<description>
<paragraph>DOS/VMS-style options too</paragraph>
</description>
</option_list_item>
</option_list>
<paragraph>There must be at least two spaces between the option and the
description.</paragraph>
</section>
<section ids="literal-blocks" names="literal\ blocks">
<title auto="1" refid="toc-entry-13"><generated classes="sectnum">2.7 </generated>Literal Blocks</title>
<paragraph>Literal blocks are indicated with a double-colon ("::") at the end of
the preceding paragraph (over there <literal>--></literal>). They can be indented:</paragraph>
<literal_block xml:space="preserve">if literal_block:
text = 'is left as-is'
spaces_and_linebreaks = 'are preserved'
markup_processing = None</literal_block>
<paragraph>Or they can be quoted without indentation:</paragraph>
<literal_block xml:space="preserve">>> Great idea!
>
> Why didn't I think of that?</literal_block>
</section>
<section ids="line-blocks" names="line\ blocks">
<title auto="1" refid="toc-entry-14"><generated classes="sectnum">2.8 </generated>Line Blocks</title>
<paragraph>This section tests line blocks. Line blocks are body elements which
consist of lines and other line blocks. Nested line blocks cause
indentation.</paragraph>
<line_block>
<line>This is a line block. It ends with a blank line.</line>
<line_block>
<line>New lines begin with a vertical bar ("|").</line>
<line>Line breaks and initial indent are significant, and preserved.</line>
<line_block>
<line>Continuation lines are also possible. A long line that is intended
to wrap should begin with a space in place of the vertical bar.</line>
</line_block>
<line>The left edge of a continuation line need not be aligned with
the left edge of the text above it.</line>
</line_block>
</line_block>
<line_block>
<line>This is a second line block.</line>
<line></line>
<line>Blank lines are permitted internally, but they must begin with a "|".</line>
</line_block>
<paragraph>Another line block, surrounded by paragraphs:</paragraph>
<line_block>
<line>And it's no good waiting by the window</line>
<line>It's no good waiting for the sun</line>
<line>Please believe me, the things you dream of</line>
<line>They don't fall in the lap of no-one</line>
</line_block>
<paragraph>Take it away, Eric the Orchestra Leader!</paragraph>
<block_quote>
<line_block>
<line>A one, two, a one two three four</line>
<line></line>
<line>Half a bee, philosophically,</line>
<line_block>
<line>must, <emphasis>ipso facto</emphasis>, half not be.</line>
</line_block>
<line>But half the bee has got to be,</line>
<line_block>
<line><emphasis>vis a vis</emphasis> its entity. D'you see?</line>
<line></line>
</line_block>
<line>But can a bee be said to be</line>
<line_block>
<line>or not to be an entire bee,</line>
<line_block>
<line>when half the bee is not a bee,</line>
<line_block>
<line>due to some ancient injury?</line>
<line></line>
</line_block>
</line_block>
</line_block>
<line>Singing...</line>
</line_block>
</block_quote>
<paragraph>A line block, like the following poem by Christian Morgenstern, can
also be centre-aligned:</paragraph>
<line_block classes="language-de align-center">
<line><strong>Die Trichter</strong></line>
<line></line>
<line>Zwei Trichter wandeln durch die Nacht.</line>
<line>Durch ihres Rumpfs verengten Schacht</line>
<line>fließt weißes Mondlicht</line>
<line>still und heiter</line>
<line>auf ihren</line>
<line>Waldweg</line>
<line>u. s.</line>
<line>w.</line>
<line></line>
</line_block>
</section>
<section ids="block-quotes" names="block\ quotes">
<title auto="1" refid="toc-entry-15"><generated classes="sectnum">2.9 </generated>Block Quotes</title>
<paragraph>Block quotes consist of indented body elements:</paragraph>
<block_quote>
<paragraph>My theory by A. Elk. Brackets Miss, brackets. This theory goes
as follows and begins now. All brontosauruses are thin at one
end, much much thicker in the middle and then thin again at the
far end. That is my theory, it is mine, and belongs to me and I
own it, and what it is too.</paragraph>
<attribution>Anne Elk (Miss)</attribution>
</block_quote>
<paragraph>The language of a quote (like any other object) can be specified by
a class attribute:</paragraph>
<comment xml:space="preserve"></comment>
<block_quote classes="language-fr">
<paragraph>ReStructuredText est un langage de balisage léger utilisé
notamment dans la documentation du langage Python.</paragraph>
</block_quote>
</section>
<section ids="doctest-blocks" names="doctest\ blocks">
<title auto="1" refid="toc-entry-16"><generated classes="sectnum">2.10 </generated>Doctest Blocks</title>
<doctest_block xml:space="preserve">>>> print 'Python-specific usage examples; begun with ">>>"'
Python-specific usage examples; begun with ">>>"
>>> print '(cut and pasted from interactive Python sessions)'
(cut and pasted from interactive Python sessions)</doctest_block>
</section>
<section ids="footnotes" names="footnotes">
<title auto="1" refid="toc-entry-17"><generated classes="sectnum">2.11 </generated>Footnotes</title>
<footnote backrefs="footnote-reference-1 footnote-reference-5 footnote-reference-9" ids="footnote-1" names="1">
<label>1</label>
<paragraph>A footnote contains body elements, consistently indented by at
least 3 spaces.</paragraph>
<paragraph>This is the footnote's second paragraph.</paragraph>
</footnote>
<footnote auto="1" backrefs="footnote-reference-3 footnote-reference-6" ids="label" names="label">
<label>2</label>
<paragraph>Footnotes may be numbered, either manually (as in <footnote_reference ids="footnote-reference-5" refid="footnote-1">1</footnote_reference>) or
automatically using a "#"-prefixed label. This footnote has a
label so it can be referred to from multiple places, both as a
footnote reference (<footnote_reference auto="1" ids="footnote-reference-6" refid="label">2</footnote_reference>) and as a <reference anonymous="1" name="hyperlink reference" refid="label">hyperlink reference</reference>.</paragraph>
<target anonymous="1" ids="target-3" refid="label"></target>
</footnote>
<footnote auto="1" backrefs="footnote-reference-2" ids="footnote-2" names="3">
<label>3</label>
<paragraph>This footnote is numbered automatically and anonymously using a
label of "#" only.</paragraph>
<paragraph>This is the second paragraph.</paragraph>
<paragraph>And this is the third paragraph.</paragraph>
</footnote>
<footnote auto="*" backrefs="footnote-reference-4" ids="footnote-3">
<label>*</label>
<paragraph>Footnotes may also use symbols, specified with a "*" label.
Here's a reference to the next footnote: <footnote_reference auto="*" ids="footnote-reference-7" refid="footnote-4">†</footnote_reference>.</paragraph>
</footnote>
<footnote auto="*" backrefs="footnote-reference-7" ids="footnote-4">
<label>†</label>
<paragraph>This footnote shows the next symbol in the sequence.</paragraph>
</footnote>
<footnote ids="footnote-5" names="4">
<label>4</label>
<paragraph>Here's an unreferenced footnote, with a reference to a
nonexistent footnote: <problematic ids="footnote-reference-8" refid="system-message-2">[5]_</problematic>.</paragraph>
</footnote>
</section>
<section ids="citations" names="citations">
<title auto="1" refid="toc-entry-18"><generated classes="sectnum">2.12 </generated>Citations</title>
<citation backrefs="citation-reference-1 citation-reference-2" ids="cit2002" names="cit2002">
<label>CIT2002</label>
<paragraph>Citations are text-labeled footnotes. They may be
rendered separately and differently from footnotes.</paragraph>
</citation>
<paragraph>Here's a reference to the above, <citation_reference ids="citation-reference-2" refid="cit2002">CIT2002</citation_reference>, and a <problematic ids="citation-reference-3" refid="system-message-3">[nonexistent]_</problematic>
citation.</paragraph>
<target refid="another-target"></target>
</section>
<section ids="targets another-target" names="targets another\ target">
<title auto="1" refid="toc-entry-19"><generated classes="sectnum">2.13 </generated>Targets</title>
<target refid="example"></target>
<paragraph ids="example" names="example">This paragraph is pointed to by the explicit "example" target. A
reference can be found under <reference name="Inline Markup" refid="inline-markup">Inline Markup</reference>, above. <reference name="Inline hyperlink targets" refid="inline-hyperlink-targets">Inline
hyperlink targets</reference> are also possible.</paragraph>
<paragraph>Section headers are implicit targets, referred to by name. See
<reference name="Targets" refid="targets">Targets</reference>, which is a subsection of <reference name="Body Elements" refid="body-elements">Body Elements</reference>.</paragraph>
<paragraph>Explicit external targets are interpolated into references such as
"<reference name="Python" refuri="http://www.python.org/">Python</reference> <footnote_reference auto="1" ids="footnote-reference-11" refid="footnote-6">5</footnote_reference>".</paragraph>
<target ids="python" names="python" refuri="http://www.python.org/"></target>
<paragraph>Targets may be indirect and anonymous. Thus <reference anonymous="1" name="this phrase" refid="targets">this phrase</reference> may also
refer to the <reference name="Targets" refid="targets">Targets</reference> section.</paragraph>
<target anonymous="1" ids="target-4" refid="targets"></target>
<paragraph>Here's a <problematic ids="problematic-2" refid="system-message-4">`hyperlink reference without a target`_</problematic>, which generates an
error.</paragraph>
<section dupnames="duplicate\ target\ names" ids="duplicate-target-names">
<title auto="1" refid="toc-entry-20"><generated classes="sectnum">2.13.1 </generated>Duplicate Target Names</title>
<paragraph>Duplicate names in section headers or other implicit targets will
generate "info" (level-1) system messages. Duplicate names in
explicit targets will generate "warning" (level-2) system messages.</paragraph>
</section>
<section dupnames="duplicate\ target\ names" ids="duplicate-target-names-1">
<title auto="1" refid="toc-entry-21"><generated classes="sectnum">2.13.2 </generated>Duplicate Target Names</title>
<system_message backrefs="duplicate-target-names-1" level="1" line="434" source="functional/input/data/standard.txt" type="INFO">
<paragraph>Duplicate implicit target name: "duplicate target names".</paragraph>
</system_message>
<paragraph>Since there are two "Duplicate Target Names" section headers, we
cannot uniquely refer to either of them by name. If we try to (like
this: <problematic ids="problematic-3" refid="system-message-5">`Duplicate Target Names`_</problematic>), an error is generated.</paragraph>
</section>
</section>
<section ids="directives" names="directives">
<title auto="1" refid="toc-entry-22"><generated classes="sectnum">2.14 </generated>Directives</title>
<topic classes="contents local" ids="contents" names="contents">
<bullet_list classes="auto-toc">
<list_item>
<paragraph><reference ids="toc-entry-43" refid="document-parts"><generated classes="sectnum">2.14.1 </generated>Document Parts</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-44" refid="images-and-figures"><generated classes="sectnum">2.14.2 </generated>Images and Figures</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-45" refid="tables"><generated classes="sectnum">2.14.3 </generated>Tables</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-46" refid="admonitions"><generated classes="sectnum">2.14.4 </generated>Admonitions</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-47" refid="topics-sidebars-and-rubrics"><generated classes="sectnum">2.14.5 </generated>Topics, Sidebars, and Rubrics</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-48" refid="target-footnotes"><generated classes="sectnum">2.14.6 </generated>Target Footnotes</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-49" refid="replacement-text"><generated classes="sectnum">2.14.7 </generated>Replacement Text</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-50" refid="compound-paragraph"><generated classes="sectnum">2.14.8 </generated>Compound Paragraph</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-51" refid="parsed-literal-blocks"><generated classes="sectnum">2.14.9 </generated>Parsed Literal Blocks</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-52" refid="code"><generated classes="sectnum">2.14.10 </generated>Code</reference></paragraph>
</list_item>
<list_item>
<paragraph><reference ids="toc-entry-53" refid="meta"><generated classes="sectnum">2.14.11 </generated>Meta</reference></paragraph>
</list_item>
</bullet_list>
</topic>
<paragraph>These are just a sample of the many reStructuredText Directives. For
others, please see <reference anonymous="1" name="reStructuredText Directives" refuri="https://docutils.sourceforge.io/docs/ref/rst/directives.html">reStructuredText Directives</reference> <footnote_reference auto="1" ids="footnote-reference-16" refid="footnote-9">8</footnote_reference>.</paragraph>
<target anonymous="1" ids="target-5" refuri="https://docutils.sourceforge.io/docs/ref/rst/directives.html"></target>
<section ids="document-parts" names="document\ parts">
<title auto="1" refid="toc-entry-43"><generated classes="sectnum">2.14.1 </generated>Document Parts</title>
<paragraph>An example of the "contents" directive can be seen above this section
(a local, untitled table of <reference name="contents" refid="contents">contents</reference>) and at the beginning of the
document (a document-wide <reference name="table of contents" refid="table-of-contents">table of contents</reference>).</paragraph>
</section>
<section ids="images-and-figures" names="images\ and\ figures">
<title auto="1" refid="toc-entry-44"><generated classes="sectnum">2.14.2 </generated>Images and Figures</title>
<paragraph>An image directive (also clickable -- a hyperlink reference):</paragraph>
<reference name="directives" refid="directives"><image classes="class1 class2" uri="../../../docs/user/rst/images/title.png" width="70%"></image></reference>
<paragraph>Image with multiple IDs:</paragraph>
<target refid="image-target-1"></target>
<target refid="image-target-2"></target>
<target refid="image-target-3"></target>
<image ids="image-target-3 image-target-2 image-target-1" names="image\ target\ 3 image\ target\ 2 image\ target\ 1" uri="../../../docs/user/rst/images/biohazard.png"></image>
<paragraph>A centered image:</paragraph>
<image align="center" uri="../../../docs/user/rst/images/biohazard.png"></image>
<paragraph>A left-aligned image:</paragraph>
<image align="left" uri="../../../docs/user/rst/images/biohazard.png"></image>
<paragraph>This paragraph might flow around the image.
The specific behavior depends upon the style sheet and
the browser or rendering software used.</paragraph>
<paragraph>A right-aligned image:</paragraph>
<image align="right" uri="../../../docs/user/rst/images/biohazard.png"></image>
<paragraph>This paragraph might flow around the image.
The specific behavior depends upon the style sheet and
the browser or rendering software used.</paragraph>
<paragraph>For inline images see <reference name="Substitution Definitions" refid="substitution-definitions">Substitution Definitions</reference>.</paragraph>
<paragraph>Image size:</paragraph>
<paragraph>An image 2 em wide:</paragraph>
<image uri="../../../docs/user/rst/images/biohazard.png" width="2em"></image>
<paragraph>An image 2 cm wide and 15 pixel high:</paragraph>
<image height="15px" uri="../../../docs/user/rst/images/biohazard.png" width="2cm"></image>
<paragraph>Relative units allow adaption of the image to the screen or paper size.
An image occupying 50% of the line width:</paragraph>
<image uri="../../../docs/user/rst/images/title.png" width="50%"></image>
<paragraph>A <emphasis>figure</emphasis> is an image with a caption and/or a legend. With page-based output
media, figures might float to a different position if this helps the page
layout.</paragraph>
<figure classes="figclass1 figclass2">
<image alt="reStructuredText, the markup syntax" classes="class1 class2" uri="../../../docs/user/rst/images/title.png" width="258"></image>
<caption>Plaintext markup syntax and parser system.</caption>
<legend>
<table>
<tgroup cols="2">
<colspec colwidth="12"></colspec>
<colspec colwidth="47"></colspec>
<tbody>
<row>
<entry>
<paragraph>re</paragraph>
</entry>
<entry>
<paragraph>Revised, revisited, based on 're' module.</paragraph>
</entry>
</row>
<row>
<entry>
<paragraph>Structured</paragraph>
</entry>
<entry>
<paragraph>Structure-enhanced text, structuredtext.</paragraph>
</entry>
</row>
<row>
<entry>
<paragraph>Text</paragraph>
</entry>
<entry>
<paragraph>Well it is, isn't it?</paragraph>
</entry>
</row>
</tbody>
</tgroup>
</table>
<paragraph>This paragraph is also part of the legend.</paragraph>
</legend>
</figure>
<paragraph>A left-aligned figure, 70% wide:</paragraph>
<figure align="left" classes="figclass1 figclass2" width="70%">
<image alt="reStructuredText, the markup syntax" classes="class1 class2" uri="../../../docs/user/rst/images/biohazard.png" width="40px"></image>
<caption>This is the caption.</caption>
<legend>
<paragraph>This is the legend.</paragraph>
<paragraph>The legend may consist of several paragraphs.</paragraph>
</legend>
</figure>
<paragraph>This paragraph might flow around the figure.</paragraph>
<paragraph>The specific behavior depends upon the style sheet and the browser or
rendering software used.</paragraph>
<paragraph>A centered figure:</paragraph>
<figure align="center">
<image uri="../../../docs/user/rst/images/biohazard.png" width="40px"></image>
<caption>This is the caption.</caption>
<legend>
<paragraph>This is the legend.</paragraph>
<paragraph>The legend may consist of several paragraphs.</paragraph>
</legend>
</figure>
<paragraph>This paragraph might flow around the figure.</paragraph>
<paragraph>The specific behavior depends upon the style sheet and the browser or
rendering software used.</paragraph>
<paragraph>A right-aligned figure:</paragraph>
<figure align="right">
<image uri="../../../docs/user/rst/images/biohazard.png" width="40px"></image>
<caption>This is the caption.</caption>
<legend>
<paragraph>This is the legend.</paragraph>
<paragraph>The legend may consist of several paragraphs.</paragraph>
</legend>
</figure>
<paragraph>This paragraph might flow around the figure. The specific behavior depends
upon the style sheet and the browser or rendering software used.</paragraph>
</section>
<section ids="tables" names="tables">
<title auto="1" refid="toc-entry-45"><generated classes="sectnum">2.14.3 </generated>Tables</title>
<paragraph>Tables may be given titles and additional arguments with the <emphasis>table</emphasis>
directive:</paragraph>
<table align="left">
<title>left-aligned table</title>
<tgroup cols="2">
<colspec colwidth="5"></colspec>
<colspec colwidth="5"></colspec>
<thead>
<row>
<entry>
<paragraph>A</paragraph>
</entry>
<entry>
<paragraph>not A</paragraph>
</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<paragraph>False</paragraph>
</entry>
<entry>
<paragraph>True</paragraph>
</entry>
</row>
<row>
<entry>
<paragraph>True</paragraph>
</entry>
<entry>
<paragraph>False</paragraph>
</entry>
</row>
</tbody>
</tgroup>
</table>
<table align="center">
<title>center-aligned table</title>
<tgroup cols="2">
<colspec colwidth="5"></colspec>
<colspec colwidth="5"></colspec>
<thead>
<row>
<entry>
<paragraph>A</paragraph>
</entry>
<entry>
<paragraph>not A</paragraph>
</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<paragraph>False</paragraph>
</entry>
<entry>
<paragraph>True</paragraph>
</entry>
</row>
<row>
<entry>
<paragraph>True</paragraph>
</entry>
<entry>
<paragraph>False</paragraph>
</entry>
</row>
</tbody>
</tgroup>
</table>
<table align="right">
<title>right-aligned table</title>
<tgroup cols="2">
<colspec colwidth="5"></colspec>
<colspec colwidth="5"></colspec>
<thead>
<row>
<entry>
<paragraph>A</paragraph>
</entry>
<entry>
<paragraph>not A</paragraph>
</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<paragraph>False</paragraph>
</entry>
<entry>
<paragraph>True</paragraph>
</entry>
</row>
<row>
<entry>
<paragraph>True</paragraph>
</entry>
<entry>
<paragraph>False</paragraph>
</entry>
</row>
</tbody>
</tgroup>
</table>
<paragraph>With the "widths" argument "auto" (or "class" value "colwidths-auto"),
column widths are determined by the backend (if supported by the
writer/backend).</paragraph>
<target refid="target1"></target>
<target refid="target2"></target>
<table classes="colwidths-auto" ids="target2 target1" names="target2 target1">
<tgroup cols="3">
<colspec colwidth="7"></colspec>
<colspec colwidth="7"></colspec>
<colspec colwidth="10"></colspec>
<thead>
<row>
<entry>
<paragraph>A</paragraph>
</entry>
<entry>
<paragraph>B</paragraph>
</entry>
<entry>
<paragraph>A or B</paragraph>
</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<paragraph>False</paragraph>
</entry>
<entry>
<paragraph>False</paragraph>
</entry>
<entry>
<paragraph>False</paragraph>
</entry>
</row>
<row>
<entry>
<paragraph>True</paragraph>
</entry>
<entry>
<paragraph>False</paragraph>
</entry>
<entry>
<paragraph>True</paragraph>
</entry>
</row>
<row>
<entry>
<paragraph>False</paragraph>
</entry>
<entry>
<paragraph>True</paragraph>
</entry>
<entry>
<paragraph>True</paragraph>
</entry>
</row>
<row>
<entry>
<paragraph>True</paragraph>
</entry>
<entry>
<paragraph>True</paragraph>
</entry>
<entry>
<paragraph>True</paragraph>
</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
<section ids="admonitions" names="admonitions">
<title auto="1" refid="toc-entry-46"><generated classes="sectnum">2.14.4 </generated>Admonitions</title>
<attention>
<paragraph>Directives at large.</paragraph>
</attention>
<caution>
<paragraph>Don't take any wooden nickels.</paragraph>
</caution>
<danger>
<paragraph>Mad scientist at work!</paragraph>
</danger>
<error>
<paragraph>Does not compute.</paragraph>
</error>
<hint>
<paragraph>It's bigger than a bread box.</paragraph>
</hint>
<important>
<bullet_list bullet="-">
<list_item>
<paragraph>Wash behind your ears.</paragraph>
</list_item>
<list_item>
<paragraph>Clean up your room.</paragraph>
</list_item>
<list_item>
<paragraph>Call your mother.</paragraph>
</list_item>
<list_item>
<paragraph>Back up your data.</paragraph>
</list_item>
</bullet_list>
</important>
<note>
<paragraph>This is a note.</paragraph>
</note>
<tip>
<paragraph>15% if the service is good.</paragraph>
</tip>
<warning>
<paragraph>Strong prose may provoke extreme mental exertion.
Reader discretion is strongly advised.</paragraph>
</warning>
<admonition classes="admonition-and-by-the-way">
<title>And, by the way...</title>
<paragraph>You can make up your own admonition too.</paragraph>
<target ids="docutils" names="docutils" refuri="https://docutils.sourceforge.io/"></target>
</admonition>
</section>
<section ids="topics-sidebars-and-rubrics" names="topics,\ sidebars,\ and\ rubrics">
<title auto="1" refid="toc-entry-47"><generated classes="sectnum">2.14.5 </generated>Topics, Sidebars, and Rubrics</title>
<paragraph><emphasis>Sidebars</emphasis> are like miniature, parallel documents.</paragraph>
<sidebar>
<title>Optional Sidebar Title</title>
<subtitle>Optional Subtitle</subtitle>
<paragraph>This is a sidebar. It is for text outside the flow of the main
text.</paragraph>
<rubric>This is a rubric inside a sidebar</rubric>
<paragraph>Sidebars often appear beside the main text with a border and a different
background or font color.</paragraph>
</sidebar>
<paragraph>A <emphasis>topic</emphasis> is like a block quote with a title, or a self-contained section
with no subsections.</paragraph>
<topic>
<title>Topic Title</title>
<paragraph>This is a topic.</paragraph>
</topic>
<paragraph>A <emphasis>rubric</emphasis> is like an informal heading that doesn't correspond to the
document's structure. It is typically highlighted in red (hence the name).</paragraph>
<rubric>This is a rubric</rubric>
<paragraph>Topics and rubrics can be used at places where a <reference name="section title" refid="section-title">section title</reference> is not
allowed (e.g. inside a directive).</paragraph>
</section>
<section ids="target-footnotes" names="target\ footnotes">
<title auto="1" refid="toc-entry-48"><generated classes="sectnum">2.14.6 </generated>Target Footnotes</title>
<footnote auto="1" backrefs="footnote-reference-10 footnote-reference-11 footnote-reference-12 footnote-reference-14" ids="footnote-6" names="TARGET_NOTE:\ footnote-6">
<label>5</label>
<paragraph><reference refuri="http://www.python.org/">http://www.python.org/</reference></paragraph>
</footnote>
<footnote auto="1" backrefs="footnote-reference-13" ids="footnote-7" names="TARGET_NOTE:\ footnote-7">
<label>6</label>
<paragraph><reference refuri="http://pygments.org/">http://pygments.org/</reference></paragraph>
</footnote>
<footnote auto="1" backrefs="footnote-reference-15" ids="footnote-8" names="TARGET_NOTE:\ footnote-8">
<label>7</label>
<paragraph><reference refuri="https://docutils.sourceforge.io/">https://docutils.sourceforge.io/</reference></paragraph>
</footnote>
<footnote auto="1" backrefs="footnote-reference-16" ids="footnote-9" names="TARGET_NOTE:\ footnote-9">
<label>8</label>
<paragraph><reference refuri="https://docutils.sourceforge.io/docs/ref/rst/directives.html">https://docutils.sourceforge.io/docs/ref/rst/directives.html</reference></paragraph>
</footnote>
<footnote auto="1" backrefs="footnote-reference-17" ids="footnote-10" names="TARGET_NOTE:\ footnote-10">
<label>9</label>
<paragraph><reference refuri="https://docutils.sourceforge.io/docs/ref/rst/directives.html#metadata">https://docutils.sourceforge.io/docs/ref/rst/directives.html#metadata</reference></paragraph>
</footnote>
</section>
<section ids="replacement-text" names="replacement\ text">
<title auto="1" refid="toc-entry-49"><generated classes="sectnum">2.14.7 </generated>Replacement Text</title>
<paragraph>I recommend you try <reference refuri="http://www.python.org/">Python, <emphasis>the</emphasis> best language around</reference> <footnote_reference auto="1" ids="footnote-reference-12" refid="footnote-6">5</footnote_reference>.</paragraph>
<substitution_definition names="Python">Python, <emphasis>the</emphasis> best language around</substitution_definition>
</section>
<section ids="compound-paragraph" names="compound\ paragraph">
<title auto="1" refid="toc-entry-50"><generated classes="sectnum">2.14.8 </generated>Compound Paragraph</title>
<paragraph>The <emphasis>compound</emphasis> directive is used to create a "compound paragraph", which
is a single logical paragraph containing multiple physical body
elements. For example:</paragraph>
<compound>
<paragraph>The 'rm' command is very dangerous. If you are logged
in as root and enter</paragraph>
<literal_block xml:space="preserve">cd /
rm -rf *</literal_block>
<paragraph>you will erase the entire contents of your file system.</paragraph>
</compound>
<paragraph>Test the handling and display of compound paragraphs:</paragraph>
<compound classes="some-class">
<paragraph>Compound 2, paragraph 1,</paragraph>
<paragraph>compound 2, paragraph 2,</paragraph>
<bullet_list bullet="*">
<list_item>
<paragraph>list item 1,</paragraph>
</list_item>
<list_item>
<paragraph>list item 2,</paragraph>
</list_item>
</bullet_list>
<paragraph>compound 2, paragraph 3.</paragraph>
</compound>
<compound>
<paragraph>Compound 3, only consisting of one paragraph.</paragraph>
</compound>
<compound>
<literal_block xml:space="preserve">Compound 4.
This one starts with a literal block.</literal_block>
<paragraph>Compound 4, paragraph following the literal block.</paragraph>
</compound>
<paragraph>Now something <emphasis>really</emphasis> perverted -- a nested compound block. This is
just to test that it works at all; the results don't have to be
meaningful.</paragraph>
<compound>
<paragraph>Compound 5, block 1 (a paragraph).</paragraph>
<compound>
<paragraph>Compound 6 is block 2 in compound 5.</paragraph>
<paragraph>Compound 6, another paragraph.</paragraph>
</compound>
<paragraph>Compound 5, block 3 (a paragraph).</paragraph>
</compound>
<compound>
<paragraph>Compound 7, tests the inclusion of various block-level
elements in one logical paragraph. First a table,</paragraph>
<table>
<tgroup cols="3">
<colspec colwidth="20"></colspec>
<colspec colwidth="20"></colspec>
<colspec colwidth="20"></colspec>
<tbody>
<row>
<entry>
<paragraph>Left cell, first
paragraph.</paragraph>
<paragraph>Left cell, second
paragraph.</paragraph>
</entry>
<entry>
<paragraph>Middle cell,
consisting of
exactly one
paragraph.</paragraph>
</entry>
<entry>
<paragraph>Right cell.</paragraph>
<paragraph>Paragraph 2.</paragraph>
<paragraph>Paragraph 3.</paragraph>
</entry>
</row>
</tbody>
</tgroup>
</table>
<paragraph>followed by a paragraph. This physical paragraph is
actually a continuation of the paragraph before the table. It is followed
by</paragraph>
<block_quote>
<paragraph>a quote and</paragraph>
</block_quote>
<enumerated_list enumtype="arabic" prefix="" suffix=".">
<list_item>
<paragraph>an enumerated list,</paragraph>
</list_item>
</enumerated_list>
<paragraph>a paragraph,</paragraph>
<option_list>
<option_list_item>
<option_group>
<option>
<option_string>--an</option_string>
</option>
</option_group>
<description>
<paragraph>option list,</paragraph>
</description>
</option_list_item>
</option_list>
<paragraph>a paragraph,</paragraph>
<field_list>
<field>
<field_name>a field</field_name>
<field_body>
<paragraph>list,</paragraph>
</field_body>
</field>
</field_list>
<paragraph>a paragraph,</paragraph>
<definition_list>
<definition_list_item>
<term>a definition</term>
<definition>
<paragraph>list,</paragraph>
</definition>
</definition_list_item>
</definition_list>
<paragraph>a paragraph, an image:</paragraph>
<image uri="../../../docs/user/rst/images/biohazard.png"></image>
<paragraph>a paragraph,</paragraph>
<line_block>
<line>a line</line>
<line>block,</line>
</line_block>
<paragraph>a paragraph followed by a comment,</paragraph>
<comment xml:space="preserve">this is a comment</comment>
<paragraph>a paragraph, a</paragraph>
<note>
<paragraph>with content</paragraph>
</note>
<paragraph>and the final paragraph of the compound 7.</paragraph>
</compound>
</section>
<section ids="parsed-literal-blocks" names="parsed\ literal\ blocks">
<title auto="1" refid="toc-entry-51"><generated classes="sectnum">2.14.9 </generated>Parsed Literal Blocks</title>
<literal_block xml:space="preserve">This is a parsed literal block.
This line is indented. The next line is blank.
Inline markup is supported, e.g. <emphasis>emphasis</emphasis>, <strong>strong</strong>, <literal>literal
text</literal>, <subscript>sub-</subscript> and <superscript>super</superscript>scripts,
inline formulas: <math>A = 2 \pi r^2</math>,
footnotes <footnote_reference ids="footnote-reference-9" refid="footnote-1">1</footnote_reference>, <target ids="hyperlink-targets" names="hyperlink\ targets">hyperlink targets</target>, and <reference name="references" refuri="http://www.python.org/">references</reference><target ids="references" names="references" refuri="http://www.python.org/"></target>.</literal_block>
</section>
<section ids="code" names="code">
<title auto="1" refid="toc-entry-52"><generated classes="sectnum">2.14.10 </generated>Code</title>
<paragraph>Blocks of source code can be set with the <title_reference>code</title_reference> directive. If the code
language is specified, the content is parsed and tagged by the <reference name="Pygments" refuri="http://pygments.org/">Pygments</reference> <footnote_reference auto="1" ids="footnote-reference-13" refid="footnote-7">6</footnote_reference>
syntax highlighter and can be formatted with a style sheet. (Code parsing
is turned off using the <literal>syntax-highlight</literal> config setting in the test
conversions in order to get identical results with/without installed
Pygments highlighter.)</paragraph>
<literal_block classes="code python" xml:space="preserve">print 'This is Python code.'</literal_block>
<paragraph>The <literal>:number-lines:</literal> option (with optional start value) generates line
numbers:</paragraph>
<literal_block classes="code python" xml:space="preserve"><inline classes="ln"> 8 </inline># print integers from 0 to 9:
<inline classes="ln"> 9 </inline>for i in range(10):
<inline classes="ln">10 </inline> print i</literal_block>
<paragraph>For inline code snippets, there is the <title_reference>code</title_reference> role, which can be used
directly (the code will not be parsed/tagged, as the language is not known)
or as base for special code roles, e.g. the LaTeX code in the next
paragraph.</paragraph>
<paragraph>Docutils uses LaTeX syntax for math directives and roles:
<literal classes="code tex">\alpha = f(x)</literal> prints <math>\alpha = f(x)</math>.</paragraph>
<paragraph>The <literal>:code:</literal> option of the <title_reference>include</title_reference> directive sets the included content
as a code block, here the rst file <literal>header_footer.txt</literal> with line numbers:</paragraph>
<literal_block classes="code rst" source="functional/input/data/header_footer.txt" xml:space="preserve"><inline classes="ln">1 </inline>.. header:: Document header
<inline classes="ln">2 </inline>.. footer:: Document footer</literal_block>
<target ids="pygments" names="pygments" refuri="http://pygments.org/"></target>
</section>
<section ids="meta" names="meta">
<title auto="1" refid="toc-entry-53"><generated classes="sectnum">2.14.11 </generated>Meta</title>
<paragraph>The <reference anonymous="1" name="“meta” directive" refuri="https://docutils.sourceforge.io/docs/ref/rst/directives.html#metadata">“meta” directive</reference> <footnote_reference auto="1" ids="footnote-reference-17" refid="footnote-10">9</footnote_reference> is used to specify metadata to be stored in,
e.g., HTML META tags or ODT file properties.</paragraph>
<target anonymous="1" ids="target-6" refuri="https://docutils.sourceforge.io/docs/ref/rst/directives.html#metadata"></target>
</section>
</section>
<section ids="substitution-definitions" names="substitution\ definitions">
<title auto="1" refid="toc-entry-34"><generated classes="sectnum">2.15 </generated>Substitution Definitions</title>
<paragraph>An inline image (<image alt="EXAMPLE" uri="../../../docs/user/rst/images/biohazard.png"></image>) example:</paragraph>
<substitution_definition names="EXAMPLE"><image alt="EXAMPLE" uri="../../../docs/user/rst/images/biohazard.png"></image></substitution_definition>
<paragraph>A Unicode example:</paragraph>
<substitution_definition ltrim="1" names="heart" rtrim="1">♥</substitution_definition>
<paragraph>(Substitution definitions are not visible in the HTML source.)</paragraph>
</section>
<section ids="comments" names="comments">
<title auto="1" refid="toc-entry-35"><generated classes="sectnum">2.16 </generated>Comments</title>
<paragraph>Here's one:</paragraph>
<comment xml:space="preserve">Comments begin with two dots and a space. Anything may
follow, except for the syntax of footnotes, hyperlink
targets, directives, or substitution definitions.
Double-dashes -- "--" -- must be escaped somehow in HTML output.
Comments may contain non-ASCII characters: ä ö ü æ ø å</comment>
<paragraph>(View the HTML source to see the comment.)</paragraph>
</section>
<section ids="raw-text" names="raw\ text">
<title auto="1" refid="toc-entry-36"><generated classes="sectnum">2.17 </generated>Raw text</title>
<paragraph>This does not necessarily look nice, because there may be missing white space.</paragraph>
<paragraph>It's just there to freeze the behavior.</paragraph>
<raw format="html latex" xml:space="preserve">A test.</raw>
<raw format="html latex" xml:space="preserve">Second test.</raw>
<raw classes="myclass" format="html latex" xml:space="preserve">Another test with myclass set.</raw>
<paragraph>This is the <raw classes="myrawroleclass" format="html latex" xml:space="preserve">fourth test</raw> with myrawroleclass set.</paragraph>
<raw format="html" xml:space="preserve">Fifth test in HTML.<br />Line two.</raw>
<raw format="latex" xml:space="preserve">Fifth test in LaTeX.\\Line two.</raw>
</section>
<section ids="container" names="container">
<title auto="1" refid="toc-entry-37"><generated classes="sectnum">2.18 </generated>Container</title>
<container classes="custom">
<paragraph>paragraph 1</paragraph>
<paragraph>paragraph 2</paragraph>
</container>
</section>
<section ids="colspanning-tables" names="colspanning\ tables">
<title auto="1" refid="toc-entry-38"><generated classes="sectnum">2.19 </generated>Colspanning tables</title>
<paragraph>This table has a cell spanning two columns:</paragraph>
<table>
<tgroup cols="3">
<colspec colwidth="5"></colspec>
<colspec colwidth="5"></colspec>
<colspec colwidth="6"></colspec>
<thead>
<row>
<entry morecols="1">
<paragraph>Inputs</paragraph>
</entry>
<entry>
<paragraph>Output</paragraph>
</entry>
</row>
<row>
<entry>
<paragraph>A</paragraph>
</entry>
<entry>
<paragraph>B</paragraph>
</entry>
<entry>
<paragraph>A or B</paragraph>
</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<paragraph>False</paragraph>
</entry>
<entry>
<paragraph>False</paragraph>
</entry>
<entry>
<paragraph>False</paragraph>
</entry>
</row>
<row>
<entry>
<paragraph>True</paragraph>
</entry>
<entry>
<paragraph>False</paragraph>
</entry>
<entry>
<paragraph>True</paragraph>
</entry>
</row>
<row>
<entry>
<paragraph>False</paragraph>
</entry>
<entry>
<paragraph>True</paragraph>
</entry>
<entry>
<paragraph>True</paragraph>
</entry>
</row>
<row>
<entry>
<paragraph>True</paragraph>
</entry>
<entry>
<paragraph>True</paragraph>
</entry>
<entry>
<paragraph>True</paragraph>
</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
<section ids="rowspanning-tables" names="rowspanning\ tables">
<title auto="1" refid="toc-entry-39"><generated classes="sectnum">2.20 </generated>Rowspanning tables</title>
<paragraph>Here's a table with cells spanning several rows:</paragraph>
<table>
<tgroup cols="3">
<colspec colwidth="24"></colspec>
<colspec colwidth="12"></colspec>
<colspec colwidth="18"></colspec>
<thead>
<row>
<entry>
<paragraph>Header row, column 1
(header rows optional)</paragraph>
</entry>
<entry>
<paragraph>Header 2</paragraph>
</entry>
<entry>
<paragraph>Header 3</paragraph>
</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<paragraph>body row 1, column 1</paragraph>
</entry>
<entry>
<paragraph>column 2</paragraph>
</entry>
<entry>
<paragraph>column 3</paragraph>
</entry>
</row>
<row>
<entry>
<paragraph>body row 2</paragraph>
</entry>
<entry morerows="1">
<paragraph>Cells may
span rows.</paragraph>
</entry>
<entry morerows="1">
<paragraph>Another
rowspanning
cell.</paragraph>
</entry>
</row>
<row>
<entry>
<paragraph>body row 3</paragraph>
</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
<section ids="complex-tables" names="complex\ tables">
<title auto="1" refid="toc-entry-40"><generated classes="sectnum">2.21 </generated>Complex tables</title>
<paragraph>Here's a complex table, which should test all features.</paragraph>
<table>
<tgroup cols="4">
<colspec colwidth="24"></colspec>
<colspec colwidth="12"></colspec>
<colspec colwidth="10"></colspec>
<colspec colwidth="10"></colspec>
<thead>
<row>
<entry>
<paragraph>Header row, column 1
(header rows optional)</paragraph>
</entry>
<entry>
<paragraph>Header 2</paragraph>
</entry>
<entry>
<paragraph>Header 3</paragraph>
</entry>
<entry>
<paragraph>Header 4</paragraph>
</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<paragraph>body row 1, column 1</paragraph>
</entry>
<entry>
<paragraph>column 2</paragraph>
</entry>
<entry>
<paragraph>column 3</paragraph>
</entry>
<entry>
<paragraph>column 4</paragraph>
</entry>
</row>
<row>
<entry>
<paragraph>body row 2</paragraph>
</entry>
<entry morecols="2">
<paragraph>Cells may span columns.</paragraph>
</entry>
</row>
<row>
<entry>
<paragraph>body row 3</paragraph>
</entry>
<entry morerows="1">
<paragraph>Cells may
span rows.</paragraph>
<paragraph>Paragraph.</paragraph>
</entry>
<entry morecols="1" morerows="1">
<bullet_list bullet="-">
<list_item>
<paragraph>Table cells</paragraph>
</list_item>
<list_item>
<paragraph>contain</paragraph>
</list_item>
<list_item>
<paragraph>body elements.</paragraph>
</list_item>
</bullet_list>
</entry>
</row>
<row>
<entry>
<paragraph>body row 4</paragraph>
</entry>
</row>
<row>
<entry>
<paragraph>body row 5</paragraph>
</entry>
<entry morecols="1">
<paragraph>Cells may also be
empty: <literal>--></literal></paragraph>
</entry>
<entry>
</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
<section ids="list-tables" names="list\ tables">
<title auto="1" refid="toc-entry-41"><generated classes="sectnum">2.22 </generated>List Tables</title>
<paragraph>Here's a list table exercising all features:</paragraph>
<table classes="colwidths-given test" width="95%">
<title>list table with integral header</title>
<tgroup cols="3">
<colspec colwidth="10" stub="1"></colspec>
<colspec colwidth="8"></colspec>
<colspec colwidth="20"></colspec>
<thead>
<row>
<entry>
<paragraph>Treat</paragraph>
</entry>
<entry>
<paragraph>Quantity</paragraph>
</entry>
<entry>
<paragraph>Description</paragraph>
</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<paragraph>Albatross</paragraph>
</entry>
<entry>
<paragraph>2.99</paragraph>
</entry>
<entry>
<paragraph>On a stick!</paragraph>
</entry>
</row>
<row>
<entry>
<paragraph>Crunchy Frog</paragraph>
</entry>
<entry>
<paragraph>1.49</paragraph>
</entry>
<entry>
<paragraph>If we took the bones out, it wouldn't be
crunchy, now would it?</paragraph>
</entry>
</row>
<row>
<entry>
<paragraph>Gannet Ripple</paragraph>
</entry>
<entry>
<paragraph>1.99</paragraph>
</entry>
<entry>
<paragraph>On a stick!</paragraph>
</entry>
</row>
</tbody>
</tgroup>
</table>
<table align="center" classes="colwidths-auto">
<title>center aligned list table</title>
<tgroup cols="2">
<colspec colwidth="50"></colspec>
<colspec colwidth="50"></colspec>
<tbody>
<row>
<entry>
<paragraph>Albatross</paragraph>
</entry>
<entry>
<paragraph>2.99</paragraph>
</entry>
</row>
<row>
<entry>
<paragraph>Crunchy Frog</paragraph>
</entry>
<entry>
<paragraph>1.49</paragraph>
</entry>
</row>
<row>
<entry>
<paragraph>Gannet Ripple</paragraph>
</entry>
<entry>
<paragraph>1.99</paragraph>
</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
</section>
<section ids="error-handling" names="error\ handling">
<title auto="1" refid="toc-entry-42"><generated classes="sectnum">3 </generated>Error Handling</title>
<paragraph>Any errors caught during processing will generate system messages.</paragraph>
<paragraph>There should be five messages in the following, auto-generated
section, "Docutils System Messages":</paragraph>
<comment xml:space="preserve">section should be added by Docutils automatically</comment>
</section>
<section classes="system-messages">
<title>Docutils System Messages</title>
<system_message backrefs="problematic-1" ids="system-message-1" level="3" line="99" source="functional/input/data/standard.txt" type="ERROR">
<paragraph>Undefined substitution referenced: "problematic".</paragraph>
</system_message>
<system_message backrefs="footnote-reference-8" ids="system-message-2" level="3" line="387" source="functional/input/data/standard.txt" type="ERROR">
<paragraph>Unknown target name: "5".</paragraph>
</system_message>
<system_message backrefs="citation-reference-3" ids="system-message-3" level="3" line="396" source="functional/input/data/standard.txt" type="ERROR">
<paragraph>Unknown target name: "nonexistent".</paragraph>
</system_message>
<system_message backrefs="problematic-2" ids="system-message-4" level="3" line="423" source="functional/input/data/standard.txt" type="ERROR">
<paragraph>Unknown target name: "hyperlink reference without a target".</paragraph>
</system_message>
<system_message backrefs="problematic-3" ids="system-message-5" level="3" line="436" source="functional/input/data/standard.txt" type="ERROR">
<paragraph>Duplicate target name, cannot be used as a unique reference: "duplicate target names".</paragraph>
</system_message>
<system_message level="1" line="159" source="functional/input/data/standard.txt" type="INFO">
<paragraph>Hyperlink target "target" is not referenced.</paragraph>
</system_message>
<system_message level="1" line="401" source="functional/input/data/standard.txt" type="INFO">
<paragraph>Hyperlink target "another-target" is not referenced.</paragraph>
</system_message>
<system_message level="1" line="471" source="functional/input/data/standard.txt" type="INFO">
<paragraph>Hyperlink target "image-target-1" is not referenced.</paragraph>
</system_message>
<system_message level="1" line="472" source="functional/input/data/standard.txt" type="INFO">
<paragraph>Hyperlink target "image-target-2" is not referenced.</paragraph>
</system_message>
<system_message level="1" line="473" source="functional/input/data/standard.txt" type="INFO">
<paragraph>Hyperlink target "image-target-3" is not referenced.</paragraph>
</system_message>
<system_message level="1" line="636" source="functional/input/data/standard.txt" type="INFO">
<paragraph>Hyperlink target "target1" is not referenced.</paragraph>
</system_message>
<system_message level="1" line="637" source="functional/input/data/standard.txt" type="INFO">
<paragraph>Hyperlink target "target2" is not referenced.</paragraph>
</system_message>
<system_message level="1" line="682" source="functional/input/data/standard.txt" type="INFO">
<paragraph>Hyperlink target "docutils" is not referenced.</paragraph>
</system_message>
<system_message level="1" line="848" source="functional/input/data/standard.txt" type="INFO">
<paragraph>Hyperlink target "hyperlink targets" is not referenced.</paragraph>
</system_message>
</section>
</document>
|