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
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
|
.. include:: ../../header2.txt
=============================
reStructuredText Directives
=============================
:Author: David Goodger
:Contact: docutils-develop@lists.sourceforge.net
:Revision: $Revision$
:Date: $Date$
:Copyright: This document has been placed in the public domain.
.. contents::
:depth: 2
This document describes the directives implemented in the reference
reStructuredText parser.
Directives have the following syntax::
+-------+-------------------------------+
| ".. " | directive type "::" directive |
+-------+ block |
| |
+-------------------------------+
Directives begin with an explicit markup start (two periods and a
space), followed by the directive type and two colons (collectively,
the "directive marker"). The directive block begins immediately after
the directive marker, and includes all subsequent indented lines. The
directive block is divided into arguments, options (a field list), and
content (in that order), any of which may appear. See the Directives_
section in the `reStructuredText Markup Specification`_ for syntax
details.
Descriptions below list "doctree elements" (document tree element
names; XML DTD generic identifiers) corresponding to individual
directives. For details on the hierarchy of elements, please see `The
Docutils Document Tree`_ and the `Docutils Generic DTD`_ XML document
type definition. For directive implementation details, see `Creating
reStructuredText Directives`_.
.. _Directives: restructuredtext.html#directives
.. _reStructuredText Markup Specification: restructuredtext.html
.. _The Docutils Document Tree: ../doctree.html
.. _Docutils Generic DTD: ../docutils.dtd
.. _Creating reStructuredText Directives:
../../howto/rst-directives.html
-------------
Admonitions
-------------
Admonitions ("safety messages" or "hazard statements") can appear anywhere
an ordinary body element can. They contain arbitrary body elements.
Typically, an admonition is rendered as an offset block in a document,
sometimes outlined or shaded.
Docutils defines a `generic admonition`_ as well as a set of
`specific admonitions`_.
.. _attention:
.. _caution:
.. _danger:
.. _error:
.. _hint:
.. _important:
.. _note:
.. _tip:
.. _warning:
Specific Admonitions
====================
:Directive Types: "attention", "caution", "danger", "error", "hint",
"important", "note", "tip", "warning"
:Doctree Elements: `attention <../doctree.html#attention>`__,
`caution <../doctree.html#caution>`__ ,
`danger <../doctree.html#danger>`__,
`error <../doctree.html#error>`__,
`hint <../doctree.html#hint>`__,
`important <../doctree.html#important>`__,
`note <../doctree.html#note>`__,
`tip <../doctree.html#tip>`__,
`warning <../doctree.html#warning>`__
:Directive Arguments: None.
:Directive Options: class_, name_
:Directive Content: Interpreted as body elements.
Specific admontions are rendered with a title matching the admonition type.
For example::
.. DANGER::
Beware killer rabbits!
This directive might be rendered something like this::
+------------------------+
| !DANGER! |
| |
| Beware killer rabbits! |
+------------------------+
Any text immediately following the directive indicator (on the same
line and/or indented on following lines) is interpreted as a directive
block and is parsed for normal body elements. For example, the
following "note" admonition directive contains one paragraph and a
bullet list consisting of two list items::
.. note:: This is a note admonition.
This is the second line of the first paragraph.
- The note contains all indented body elements
following.
- It includes this bullet list.
.. _admonition:
Generic Admonition
==================
:Directive Type: "admonition"
:Doctree Elements: `admonition <../doctree.html#admonition>`__,
`title <../doctree.html#title>`__
:Directive Arguments: One, required (admonition title)
:Directive Options: class_, name_
:Directive Content: Interpreted as body elements.
This is a generic, titled admonition. The title may be anything the
author desires.
The author-supplied title is also used as a `"classes"`_ attribute value
after `identifier normalization`_ and adding the prefix "admonition-".
For example, this admonition::
.. admonition:: And, by the way...
You can make up your own admonition too.
becomes the following document tree (pseudo-XML)::
<document source="test data">
<admonition classes="admonition-and-by-the-way">
<title>
And, by the way...
<paragraph>
You can make up your own admonition too.
The class_ option overrides the generated `"classes"`_ attribute value.
--------
Images
--------
There are two image directives: image_ and figure_.
.. attention::
It is up to the author to ensure compatibility of the image data format
with the output format or user agent (LaTeX engine, `HTML browser`__).
The following, non exhaustive table provides an overview:
=========== ====== ====== ===== ===== ===== ===== ===== ===== ===== =====
.. vector image raster image moving image [#]_
----------- ------------- ----------------------------- -----------------
.. SVG PDF PNG JPG GIF APNG AVIF WebM MP4 OGG
=========== ====== ====== ===== ===== ===== ===== ===== ===== ===== =====
HTML4_ ✓ [#]_ ✓ ✓ ✓ (✓) (✓)
HTML5_ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
LaTeX_ [#]_ ✓ ✓ ✓
ODT_ ✓ ✓ ✓ ✓ ✓
=========== ====== ====== ===== ===== ===== ===== ===== ===== ===== =====
.. [#] The `html5 writer`_ uses the ``<video>`` tag if the image URI
ends with an extension matching one of the listed video formats
(since Docutils 0.17).
.. [#] The html4 writer uses an ``<object>`` tag for SVG images
for better compatibility with older browsers.
.. [#] When compiling with ``pdflatex``, ``xelatex``, or ``lualatex``.
The original ``latex`` engine supports only the EPS image format.
Some build systems, e.g. rubber_ support additional formats
via on-the-fly image conversion.
__ https://developer.mozilla.org/en-US/docs/Web/Media/Formats/Image_types
.. _HTML4:
.. _html4 writer: ../../user/html.html#html4css1
.. _HTML5:
.. _html5 writer: ../../user/html.html#html5-polyglot
.. _LaTeX: ../../user/latex.html#image-inclusion
.. _ODT: ../../user/odt.html
.. _rubber: https://github.com/petrhosek/rubber
Image
=====
:Directive Type: "image"
:Doctree Element: `image <../doctree.html#image>`__
:Directive Arguments: One, required (image URI).
:Directive Options: Possible (see below).
:Directive Content: None.
An "image" is a simple picture::
.. image:: picture.png
Inline images can be defined with an "image" directive in a `substitution
definition`_
The URI for the image source file is specified in the directive
argument. As with hyperlink targets, the image URI may begin on the
same line as the explicit markup start and target name, or it may
begin in an indented text block immediately following, with no
intervening blank lines. If there are multiple lines in the link
block, they are stripped of leading and trailing whitespace and joined
together.
Optionally, the image link block may contain a flat field list, the
_`image options`. For example::
.. image:: picture.jpeg
:height: 100px
:width: 200 px
:scale: 50 %
:alt: alternate text
:align: right
The following options are recognized:
``alt`` : text
Alternate text: a short description of the image, displayed by
applications that cannot display images, or spoken by applications
for visually impaired users.
``height`` : `length`_
The desired height of the image.
Used to reserve space or scale the image vertically. When the "scale"
option is also specified, they are combined. For example, a height of
200px and a scale of 50 is equivalent to a height of 100px with no scale.
``width`` : `length`_ or `percentage`_ of the current line width
The width of the image.
Used to reserve space or scale the image horizontally. As with "height"
above, when the "scale" option is also specified, they are combined.
``scale`` : integer percentage (the "%" symbol is optional)
The uniform scaling factor of the image. The default is "100 %", i.e.
no scaling.
If no "height" or "width" options are specified, the `Python
Imaging Library` (PIL/Pillow_) may be used to determine them, if
it is installed and the image file is available.
``align`` : "top", "middle", "bottom", "left", "center", or "right"
The alignment of the image, equivalent to the HTML ``<img>`` tag's
deprecated "align" attribute or the corresponding "vertical-align" and
"text-align" CSS properties.
The values "top", "middle", and "bottom"
control an image's vertical alignment (relative to the text
baseline); they are only useful for inline images (substitutions).
The values "left", "center", and "right" control an image's
horizontal alignment, allowing the image to float and have the
text flow around it. The specific behavior depends upon the
browser or rendering software used.
``target`` : text (URI or reference name)
Makes the image into a hyperlink reference ("clickable"). The
option argument may be a URI (relative or absolute), or a
`reference name`_ with underscore suffix (e.g. ```a name`_``).
and the common options class_ and name_.
Figure
======
:Directive Type: "figure"
:Doctree Elements: figure_, image_, caption_, legend_
:Directive Arguments: One, required (image URI).
:Directive Options: Possible (see below).
:Directive Content: Interpreted as the figure caption and an optional
legend.
A "figure" consists of image_ data (including `image options`_), an optional
caption (a single paragraph), and an optional legend (arbitrary body
elements). For page-based output media, figures might float to a different
position if this helps the page layout.
::
.. figure:: picture.png
:scale: 50 %
:alt: map to buried treasure
This is the caption of the figure (a simple paragraph).
The legend consists of all elements after the caption. In this
case, the legend consists of this paragraph and the following
table:
+-----------------------+-----------------------+
| Symbol | Meaning |
+=======================+=======================+
| .. image:: tent.png | Campground |
+-----------------------+-----------------------+
| .. image:: waves.png | Lake |
+-----------------------+-----------------------+
| .. image:: peak.png | Mountain |
+-----------------------+-----------------------+
There must be blank lines before the caption paragraph and before the
legend. To specify a legend without a caption, use an empty comment
("..") in place of the caption.
The "figure" directive supports all of the options of the "image"
directive (see `image options`_ above). These options (except
"align") are passed on to the contained image.
``align`` : "left", "center", or "right"
The horizontal alignment of the figure, allowing the image to
float and have the text flow around it. The specific behavior
depends upon the browser or rendering software used.
In addition, the following options are recognized:
``figwidth`` : "image", length_, or percentage_ of current line width
The width of the figure.
Limits the horizontal space used by the figure.
A special value of "image" is allowed, in which case the
included image's actual width is used (requires the `Python Imaging
Library`_). If the image file is not found or the required software is
unavailable, this option is ignored.
Sets the "width" attribute of the "figure" doctree element.
This option does not scale the included image; use the "width"
`image`_ option for that. ::
+---------------------------+
| figure |
| |
|<------ figwidth --------->|
| |
| +---------------------+ |
| | image | |
| | | |
| |<--- width --------->| |
| +---------------------+ |
| |
|The figure's caption should|
|wrap at this width. |
+---------------------------+
``figclass`` : text
Set a `"classes"`_ attribute value on the figure element. See the
class_ directive below.
.. _Python Imaging Library:
.. _Pillow: https://pypi.org/project/Pillow/
---------------
Body Elements
---------------
Topic
=====
:Directive Type: "topic"
:Doctree Element: topic_
:Directive Arguments: One, required (topic title).
:Directive Options: class_, name_
:Directive Content: Interpreted as the topic body.
A topic is like a block quote with a title, or a self-contained
section with no subsections. Use the "topic" directive to indicate a
self-contained idea that is separate from the flow of the document.
Topics may occur anywhere a section or transition may occur. Body
elements and topics may not contain nested topics.
The directive's sole argument is interpreted as the topic title; the
next line must be blank. All subsequent lines make up the topic body,
interpreted as body elements. For example::
.. topic:: Topic Title
Subsequent indented lines comprise
the body of the topic, and are
interpreted as body elements.
Sidebar
=======
:Directive Type: "sidebar"
:Doctree Element: sidebar_
:Directive Arguments: One, optional (sidebar title).
:Directive Options: Possible (see below).
:Directive Content: Interpreted as the sidebar body.
Sidebars are like miniature, parallel documents that occur inside
other documents, providing related or reference material. A sidebar
is typically offset by a border and "floats" to the side of the page;
the document's main text may flow around it. Sidebars can also be
likened to super-footnotes; their content is outside of the flow of
the document's main text.
Sidebars may occur anywhere a section or transition may occur. Body
elements (including sidebars) may not contain nested sidebars.
The directive's sole argument is interpreted as the sidebar title,
which may be followed by a subtitle option (see below); the next line
must be blank. All subsequent lines make up the sidebar body,
interpreted as body elements. For example::
.. sidebar:: Optional Sidebar Title
:subtitle: Optional Sidebar Subtitle
Subsequent indented lines comprise
the body of the sidebar, and are
interpreted as body elements.
The following options are recognized:
``subtitle`` : text
The sidebar's subtitle.
and the common options class_ and name_.
Line Block
==========
.. admonition:: Deprecated
The "line-block" directive is deprecated. Use the `line block
syntax`_ instead.
.. _line block syntax: restructuredtext.html#line-blocks
:Directive Type: "line-block"
:Doctree Element: line_block_
:Directive Arguments: None.
:Directive Options: class_, name_
:Directive Content: Becomes the body of the line block.
The "line-block" directive constructs an element where line breaks and
initial indentation is significant and inline markup is supported. It
is equivalent to a `parsed literal block`_ with different rendering:
typically in an ordinary serif typeface instead of a
typewriter/monospaced face, and not automatically indented. (Have the
line-block directive begin a block quote to get an indented line
block.) Line blocks are useful for address blocks and verse (poetry,
song lyrics), where the structure of lines is significant. For
example, here's a classic::
"To Ma Own Beloved Lassie: A Poem on her 17th Birthday", by
Ewan McTeagle (for Lassie O'Shea):
.. line-block::
Lend us a couple of bob till Thursday.
I'm absolutely skint.
But I'm expecting a postal order and I can pay you back
as soon as it comes.
Love, Ewan.
.. _parsed-literal:
Parsed Literal Block
====================
:Directive Type: "parsed-literal"
:Doctree Element: literal_block_
:Directive Arguments: None.
:Directive Options: class_, name_
:Directive Content: Becomes the body of the literal block.
Unlike an ordinary literal block, the "parsed-literal" directive
constructs a literal block where the text is parsed for inline markup.
It is equivalent to a `line block`_ with different rendering:
typically in a typewriter/monospaced typeface, like an ordinary
literal block. Parsed literal blocks are useful for adding hyperlinks
to code examples.
However, care must be taken with the text, because inline markup is
recognized and there is no protection from parsing. Backslash-escapes
may be necessary to prevent unintended parsing. And because the
markup characters are removed by the parser, care must also be taken
with vertical alignment. Parsed "ASCII art" is tricky, and extra
whitespace may be necessary.
For example, all the element names in this content model are links::
.. parsed-literal::
( (title_, subtitle_?)?,
decoration_?,
(docinfo_, transition_?)?,
`%structure.model;`_ )
Code
====
:Directive Type: "code"
:Doctree Element: literal_block_, `inline elements`_
:Directive Arguments: One, optional (formal language).
:Directive Options: name, class, number-lines.
:Directive Content: Becomes the body of the literal block.
:Configuration Setting: syntax_highlight_.
The "code" directive constructs a literal block. If the code language is
specified, the content is parsed by the Pygments_ syntax highlighter and
tokens are stored in nested `inline elements`_ with class arguments
according to their syntactic category. The actual highlighting requires
a style-sheet (e.g. one `generated by Pygments`__, see the
`sandbox/stylesheets`__ for examples).
The parsing can be turned off with the syntax_highlight_ configuration
setting and command line option or by specifying the language as class_
option instead of directive argument. This also avoids warnings
when Pygments_ is not installed or the language is not in the
`supported languages and markup formats`_.
For inline code, use the `"code" role`_.
__ https://pygments.org/docs/cmdline/#generating-styles
__ https://docutils.sourceforge.io/sandbox/stylesheets/
.. _Pygments: https://pygments.org/
.. _syntax_highlight: ../../user/config.html#syntax-highlight
.. _supported languages and markup formats: https://pygments.org/languages/
.. _"code" role: roles.html#code
The following options are recognized:
``number-lines`` : [integer] (start line number)
Precede every line with a line number.
The optional argument is the number of the first line (default 1).
and the common options class_ and name_.
Example::
The content of the following directive ::
.. code:: python
def my_function():
"just a test"
print 8/2
is parsed and marked up as Python source code.
Math
====
:Directive Type: "math"
:Doctree Element: math_block_
:Directive Arguments: None.
:Directive Options: class_, name_
:Directive Content: Becomes the body of the math block.
(Content blocks separated by a blank line are put in
adjacent math blocks.)
:Configuration Setting: math_output_
The "math" directive inserts blocks with mathematical content
(display formulas, equations) into the document. The input format is
`LaTeX math syntax`_ with support for Unicode symbols, for example::
.. math::
α_t(i) = P(O_1, O_2, … O_t, q_t = S_i λ)
Support is limited to a subset of *LaTeX math* by the conversion
required for many output formats. For HTML, the `math_output`_
configuration setting (or the corresponding ``--math-output``
command line option) select between alternative output formats with
different subsets of supported elements. If a writer does not
support math typesetting, the content is inserted verbatim.
For inline formulas, use the `"math" role`_.
.. _LaTeX math syntax: ../../ref/rst/mathematics.html
.. _"math" role: roles.html#math
.. _math_output: ../../user/config.html#math-output
Rubric
======
:Directive Type: "rubric"
:Doctree Element: rubric_
:Directive Arguments: One, required (rubric text).
:Directive Options: class_, name_
:Directive Content: None.
..
rubric n. 1. a title, heading, or the like, in a manuscript,
book, statute, etc., written or printed in red or otherwise
distinguished from the rest of the text. ...
-- Random House Webster's College Dictionary, 1991
The "rubric" directive inserts a "rubric" element into the document
tree. A rubric is like an informal heading that doesn't correspond to
the document's structure.
Epigraph
========
:Directive Type: "epigraph"
:Doctree Element: block_quote_
:Directive Arguments: None.
:Directive Options: None.
:Directive Content: Interpreted as the body of the block quote.
An epigraph is an apposite (suitable, apt, or pertinent) short
inscription, often a quotation or poem, at the beginning of a document
or section.
The "epigraph" directive produces an "epigraph"-class block quote.
For example, this input::
.. epigraph::
No matter where you go, there you are.
-- Buckaroo Banzai
becomes this document tree fragment::
<block_quote classes="epigraph">
<paragraph>
No matter where you go, there you are.
<attribution>
Buckaroo Banzai
Highlights
==========
:Directive Type: "highlights"
:Doctree Element: block_quote_
:Directive Arguments: None.
:Directive Options: None.
:Directive Content: Interpreted as the body of the block quote.
Highlights summarize the main points of a document or section, often
consisting of a list.
The "highlights" directive produces a "highlights"-class block quote.
See Epigraph_ above for an analogous example.
Pull-Quote
==========
:Directive Type: "pull-quote"
:Doctree Element: block_quote_
:Directive Arguments: None.
:Directive Options: None.
:Directive Content: Interpreted as the body of the block quote.
A pull-quote is a small selection of text "pulled out and quoted",
typically in a larger typeface. Pull-quotes are used to attract
attention, especially in long articles.
The "pull-quote" directive produces a "pull-quote"-class block quote.
See Epigraph_ above for an analogous example.
.. compound:
Compound Paragraph
==================
:Directive Type: "compound"
:Doctree Element: `compound <../doctree.html#compound>`__
:Directive Arguments: None.
:Directive Options: class_, name_
:Directive Content: Interpreted as body elements.
The "compound" directive is used to create a compound paragraph, which
is a single logical paragraph containing multiple physical body
elements such as simple paragraphs, literal blocks, tables, lists,
etc., instead of directly containing text and inline elements. For
example::
.. compound::
The 'rm' command is very dangerous. If you are logged
in as root and enter ::
cd /
rm -rf *
you will erase the entire contents of your file system.
In the example above, a literal block is "embedded" within a sentence
that begins in one physical paragraph and ends in another.
.. note::
The "compound" directive is *not* a generic block-level container
like HTML's ``<div>`` element. Do not use it only to group a
sequence of elements, or you may get unexpected results.
If you need a generic block-level container, please use the
container_ directive, described below.
Compound paragraphs are typically rendered as multiple distinct text
blocks, with the possibility of variations to emphasize their logical
unity:
* If paragraphs are rendered with a first-line indent, only the first
physical paragraph of a compound paragraph should have that indent
-- second and further physical paragraphs should omit the indents;
* vertical spacing between physical elements may be reduced;
* and so on.
Container
=========
:Directive Type: "container"
:Doctree Element: `container <container element_>`__
:Directive Arguments: One or more, optional (class names).
:Directive Options: name_
:Directive Content: Interpreted as body elements.
The "container" directive surrounds its contents (arbitrary body
elements) with a generic block-level "container" element. Combined
with the optional "classes_" attribute argument(s), this is an
extension mechanism for users & applications. For example::
.. container:: custom
This paragraph might be rendered in a custom way.
Parsing the above results in the following pseudo-XML::
<container classes="custom">
<paragraph>
This paragraph might be rendered in a custom way.
The "container" directive is the equivalent of HTML's ``<div>``
element. It may be used to group a sequence of elements for user- or
application-specific purposes.
--------
Tables
--------
Formal tables need more structure than the reStructuredText syntax
supplies. Tables may be given titles with the table_ directive.
Sometimes reStructuredText tables are inconvenient to write, or table
data in a standard format is readily available. The csv-table_
directive supports CSV data.
Table
=====
:Directive Type: "table"
:Doctree Element: `table <../doctree.html#table>`__
:Directive Arguments: One, optional (table title).
:Directive Options: Possible (see below).
:Directive Content: A normal `reStructuredText table`_.
The "table" directive is used to associate a
title with a table or specify options, e.g.::
.. table:: Truth table for "not"
:widths: auto
===== =====
A not A
===== =====
False True
True False
===== =====
The following options are recognized:
``align`` : "left", "center", or "right"
The horizontal alignment of the table (new in Docutils 0.13).
``width`` : `length`_ or `percentage`_
Sets the width of the table to the specified length or percentage
of the line width. If omitted, the renderer determines the width
of the table based on its contents or the column ``widths``.
.. _column-widths:
``widths`` : "auto", "grid", or a list of integers
Explicitly set column widths.
Specifies relative widths if used with the ``width`` option.
Overrides a `table_style`_ setting or class value "colwidths-auto".
The default depends on the `table_style`_ configuration setting.
*"auto"* delegates the determination of column widths to the backend
(LaTeX, the HTML browser, ...).
Default for the `html5 writer`_
*"grid"* determines column widths from the widths of the input columns
(in characters).
Default for most writers.
A *list of integers* is used instead of the input column widths.
Implies *"grid"*.
Plus the common options class_ and name_.
.. _reStructuredText table: restructuredtext.html#tables
.. _table_style: ../../user/config.html#table-style
.. _csv-table:
CSV Table
=========
:Directive Type: "csv-table"
:Doctree Element: table_
:Directive Arguments: One, optional (table title).
:Directive Options: Possible (see below).
:Directive Content: A CSV (comma-separated values) table
or (with the `:file:`_ or `:url:`_ options) None
.. WARNING::
The "csv-table" directive's `:file:`_ and `:url:`_ options represent
potential security holes. They can be disabled with the
"file_insertion_enabled_" runtime setting.
The "csv-table" directive is used to create a table from CSV
(comma-separated values) data. CSV is a common data format generated
by spreadsheet applications and commercial databases. The data may be
internal (an integral part of the document) or external (a separate
file).
* Block markup and inline markup within cells is supported. Line ends
are recognized within quoted cells.
* There is no support for checking that the number of columns in each
row is the same. The directive automatically adds empty entries at
the end of short rows.
.. Add "strict" option to verify input?
Example::
.. csv-table:: Frozen Delights!
:header: "Treat", "Quantity", "Description"
:widths: 15, 10, 30
"Albatross", 2.99, "On a stick!"
"Crunchy Frog", 1.49, "If we took the bones out,
it wouldn't be crunchy, now would it?"
"Gannet Ripple", 1.99, "On a stick!"
The following options are recognized:
``align`` : "left", "center", or "right"
The horizontal alignment of the table. (New in Docutils 0.13)
.. _delimiter:
``delim`` : char | "tab" | "space"
A one-character string [#char-or-uni]_ used to separate data fields.
The special values "tab" and "space" are converted to the respective
whitespace characters. [#tab-expansion]_
Defaults to ``,`` (comma).
``encoding`` : string
The text encoding of the external CSV data (file or URL).
Defaults to the document's `input_encoding`_.
``escape`` : char
A one-character string [#char-or-uni]_ used to escape the delimiter_
or quote_ characters from the CSV parser.
The default is no CSV-escape character --
quote data fields containing the delimiter and double-up the quote
character, e.g. ``"He said, ""Hi!"""``.
The reStructuredText `escaping mechanism`_ is applied
after CSV parsing as part of parsing the field content for
reStructuredText markup.
.. _`:file:`:
``file`` : string (newlines removed)
The local filesystem path to a CSV data file.
``header`` : CSV data
Supplemental data for the table header, added independently of and
before any ``header-rows`` from the main CSV data. Must use the
same CSV format as the main CSV data.
.. note:: Currently, the header option uses a hard-coded
CSV dialect variant with the backslash as escape character.
This will change to the documented behaviour in Docutils 0.21.
``header-rows`` : integer
The number of rows of CSV data to use in the table header.
Defaults to 0.
``keepspace`` : flag (empty)
Treat whitespace immediately following the delimiter as
significant. The default is to ignore such whitespace.
.. _quote:
``quote`` : char
A one-character string [#char-or-uni]_ used to quote fields
containing special characters, such as the delimiter, quote,
or new-line characters.
Defaults to ``"`` (quote).
``stub-columns`` : integer
The number of table columns to use as stubs (row titles, on the left).
Defaults to 0.
.. _`:url:`:
``url`` : string (whitespace removed)
An Internet URL reference to a CSV data file.
``widths`` : integer [integer...] or "auto"
A list of relative column widths.
The default is equal-width columns (100%/#columns).
"auto" delegates the determination of column widths to the backend
(LaTeX, the HTML browser, ...).
``width`` : `length`_ or `percentage`_
Sets the width of the table to the specified length or percentage
of the line width. If omitted, the renderer determines the width
of the table based on its contents or the column ``widths``.
and the common options class_ and name_.
.. [#char-or-uni] May be specified as a *Unicode character code*;
see the unicode_ directive for syntax details.
.. [#tab-expansion] Note, that tabs can be used as separator only in
external files because all hard `tabs in rST sources are converted to
spaces`__.
__ restructuredtext.html#whitespace
.. _escaping mechanism: restructuredtext.html#escaping-mechanism
List Table
==========
:Directive Type: "list-table"
:Doctree Element: table_
:Directive Arguments: One, optional (table title).
:Directive Options: Possible (see below).
:Directive Content: A uniform two-level bullet list.
(This is an initial implementation; `further ideas`__ may be implemented
in the future.)
__ ../../dev/rst/alternatives.html#list-driven-tables
The "list-table" directive is used to create a table from data in a
uniform two-level bullet list. "Uniform" means that each sublist
(second-level list) must contain the same number of list items.
Example::
.. list-table:: Frozen Delights!
:widths: 15 10 30
:header-rows: 1
* - Treat
- Quantity
- Description
* - Albatross
- 2.99
- On a stick!
* - Crunchy Frog
- 1.49
- If we took the bones out, it wouldn't be
crunchy, now would it?
* - Gannet Ripple
- 1.99
- On a stick!
The following options are recognized:
``align`` : "left", "center", or "right"
The horizontal alignment of the table.
(New in Docutils 0.13)
``header-rows`` : integer
The number of rows of list data to use in the table header.
Defaults to 0.
``stub-columns`` : integer
The number of table columns to use as stubs (row titles, on the
left). Defaults to 0.
.. _table width:
``width`` : `length`_ or `percentage`_
Sets the width of the table to the specified length or percentage
of the line width. If omitted, the renderer determines the width
of the table based on its contents or the column ``widths``.
.. _column widths:
``widths`` : integer [integer...] or "auto"
A list of relative column widths.
The default is equal-width columns (100%/#columns).
"auto" delegates the determination of column widths to the backend
(LaTeX, the HTML browser, ...).
and the common options class_ and name_.
----------------
Document Parts
----------------
.. _contents:
Table of Contents
=================
:Directive Type: "contents"
:Doctree Elements: pending_, topic_
:Directive Arguments: One, optional: title.
:Directive Options: Possible (see below).
:Directive Content: None.
The "contents" directive generates a table of contents (TOC) in a
topic_. Topics, and therefore tables of contents, may occur anywhere
a section or transition may occur. Body elements and topics may not
contain tables of contents.
Here's the directive in its simplest form::
.. contents::
Language-dependent boilerplate text will be used for the title. The
English default title text is "Contents".
An explicit title may be specified::
.. contents:: Table of Contents
The title may span lines, although it is not recommended::
.. contents:: Here's a very long Table of
Contents title
Options may be specified for the directive, using a field list::
.. contents:: Table of Contents
:depth: 2
If the default title is to be used, the options field list may begin
on the same line as the directive marker::
.. contents:: :depth: 2
The following options are recognized:
``depth`` : integer
The number of section levels that are collected in the table of
contents. The default is unlimited depth.
``local`` : flag (empty)
Generate a local table of contents. Entries will only include
subsections of the section in which the directive is given. If no
explicit title is given, the table of contents will not be titled.
``backlinks`` : "entry" or "top" or "none"
Generate links from section headers back to the table of contents
entries, the table of contents itself, or generate no back-links.
``class`` : text
Set a `"classes"`_ attribute value on the topic element. See the
class_ directive below.
.. _sectnum:
.. _section-numbering:
Automatic Section Numbering
===========================
:Directive Type: "sectnum" or "section-numbering" (synonyms)
:Doctree Elements: pending_, generated_
:Directive Arguments: None.
:Directive Options: Possible (see below).
:Directive Content: None.
:Configuration Setting: sectnum_xform_
The "sectnum" (or "section-numbering") directive automatically numbers
sections and subsections in a document (if not disabled by the
``--no-section-numbering`` command line option or the `sectnum_xform`_
configuration setting).
Section numbers are of the "multiple enumeration" form, where each
level has a number, separated by periods. For example, the title of section
1, subsection 2, subsubsection 3 would have "1.2.3" prefixed.
The "sectnum" directive does its work in two passes: the initial parse
and a transform. During the initial parse, a "pending" element is
generated which acts as a placeholder, storing any options internally.
At a later stage in the processing, the "pending" element triggers a
transform, which adds section numbers to titles. Section numbers are
enclosed in a "generated" element, and titles have their "auto"
attribute set to "1".
The following options are recognized:
``depth`` : integer
The number of section levels that are numbered by this directive.
The default is unlimited depth.
``prefix`` : string
An arbitrary string that is prefixed to the automatically
generated section numbers. It may be something like "3.2.", which
will produce "3.2.1", "3.2.2", "3.2.2.1", and so on. Note that
any separating punctuation (in the example, a period, ".") must be
explicitly provided. The default is no prefix.
``suffix`` : string
An arbitrary string that is appended to the automatically
generated section numbers. The default is no suffix.
``start`` : integer
The value that will be used for the first section number.
Combined with ``prefix``, this may be used to force the right
numbering for a document split over several source files. The
default is 1.
.. _sectnum_xform: ../../user/config.html#sectnum-xform
.. _header:
.. _footer:
Document Header & Footer
========================
:Directive Types: "header" and "footer"
:Doctree Elements: decoration_, header, footer
:Directive Arguments: None.
:Directive Options: None.
:Directive Content: Interpreted as body elements.
The "header" and "footer" directives create document decorations,
useful for page navigation, notes, time/datestamp, etc. For example::
.. header:: This space for rent.
This will add a paragraph to the document header, which will appear at
the top of the generated web page or at the top of every printed page.
These directives may be used multiple times, cumulatively. There is
currently support for only one header and footer.
.. note::
While it is possible to use the "header" and "footer" directives to
create navigational elements for web pages, you should be aware
that Docutils is meant to be used for *document* processing, and
that a navigation bar is not typically part of a document.
Thus, you may soon find Docutils' abilities to be insufficient for
these purposes. At that time, you should consider using a
documentation generator like Sphinx_ rather than the "header" and
"footer" directives.
.. _Sphinx: http://sphinx-doc.org/
In addition to the use of these directives to populate header and
footer content, content may also be added automatically by the
processing system. For example, if certain runtime settings are
enabled, the document footer is populated with processing information
such as a datestamp, a link to `the Docutils website`_, etc.
.. _the Docutils website: https://docutils.sourceforge.io
------------
References
------------
.. _target-notes:
Target Footnotes
================
:Directive Type: "target-notes"
:Doctree Elements: pending_, footnote_, footnote_reference_
:Directive Arguments: None.
:Directive Options: class_, name_
:Directive Options: Possible (see below).
:Directive Content: None.
The "target-notes" directive creates a footnote for each external
target in the text, and corresponding footnote references after each
reference. For every explicit target (of the form, ``.. _target name:
URL``) in the text, a footnote will be generated containing the
visible URL as content.
Footnotes
=========
**NOT IMPLEMENTED YET**
:Directive Type: "footnotes"
:Doctree Elements: pending_, topic_
:Directive Arguments: None?
:Directive Options: Possible?
:Directive Content: None.
@@@
Citations
=========
**NOT IMPLEMENTED YET**
:Directive Type: "citations"
:Doctree Elements: pending_, topic_
:Directive Arguments: None?
:Directive Options: Possible?
:Directive Content: None.
@@@
.. ---------------
HTML-Specific
---------------
Imagemap
========
**NOT IMPLEMENTED YET**
Non-standard element: imagemap.
-----------------------------------------
Directives for Substitution Definitions
-----------------------------------------
The directives in this section may only be used in `substitution
definitions`_. They may not be used directly, in standalone context.
The `image`_ directive may be used both in substitution definitions
and in the standalone context.
.. _substitution definitions:
.. _substitution definition: restructuredtext.html#substitution-definitions
.. _replace:
Replacement Text
================
:Directive Type: "replace"
:Doctree Element: Text & `inline elements`_
:Directive Arguments: None.
:Directive Options: None.
:Directive Content: A single paragraph; may contain inline markup.
The "replace" directive is used to indicate replacement text for a
substitution reference. It may be used within `substitution
definitions`_ only. For example, this directive can be used to expand
abbreviations::
.. |reST| replace:: reStructuredText
Yes, |reST| is a long word, so I can't blame anyone for wanting to
abbreviate it.
As reStructuredText doesn't support nested inline markup, the only way
to create a reference with styled text is to use substitutions with
the "replace" directive::
I recommend you try |Python|_.
.. |Python| replace:: Python, *the* best language around
.. _Python: https://www.python.org/
.. _unicode:
Unicode Character Codes
=======================
:Directive Type: "unicode"
:Doctree Element: Text
:Directive Arguments: One or more, required (Unicode character codes,
optional text, and comments).
:Directive Options: Possible (see below).
:Directive Content: None.
The "unicode" directive converts Unicode character codes (numerical
values) to characters, and may be used in `substitution definitions`_
only.
The arguments, separated by spaces, can be:
* **character codes** as
- decimal numbers or
- hexadecimal numbers, prefixed by ``0x``, ``x``, ``\x``, ``U+``,
``u``, or ``\u`` or as XML-style hexadecimal character entities,
e.g. ``ᨫ``
* **text**, which is used as-is.
Text following " .. " is a comment and is ignored. The spaces between
the arguments are ignored and thus do not appear in the output.
Hexadecimal codes are case-insensitive.
For example, the following text::
Copyright |copy| 2003, |BogusMegaCorp (TM)| |---|
all rights reserved.
.. |copy| unicode:: 0xA9 .. copyright sign
.. |BogusMegaCorp (TM)| unicode:: BogusMegaCorp U+2122
.. with trademark sign
.. |---| unicode:: U+02014 .. em dash
:trim:
results in:
Copyright |copy| 2003, |BogusMegaCorp (TM)| |---|
all rights reserved.
.. |copy| unicode:: 0xA9 .. copyright sign
.. |BogusMegaCorp (TM)| unicode:: BogusMegaCorp U+2122
.. with trademark sign
.. |---| unicode:: U+02014 .. em dash
:trim:
The following options are recognized:
``ltrim`` : flag (empty)
Whitespace to the left of the substitution reference is removed.
``rtrim`` : flag (empty)
Whitespace to the right of the substitution reference is removed.
``trim`` : flag (empty)
Equivalent to ``ltrim`` plus ``rtrim``; whitespace on both sides
of the substitution reference is removed.
Date
====
:Directive Type: "date"
:Doctree Element: Text
:Directive Arguments: One, optional (date format).
:Directive Options: None.
:Directive Content: None.
The "date" directive generates the current local date and inserts it
into the document as text. This directive may be used in substitution
definitions only.
The optional directive content is interpreted as the desired date
format, using the same codes as Python's `time.strftime()`__ function. The
default format is "%Y-%m-%d" (ISO 8601 date), but time fields can also
be used. Examples::
.. |date| date::
.. |time| date:: %H:%M
Today's date is |date|.
This document was generated on |date| at |time|.
__ https://docs.python.org/3/library/time.html#time.strftime
---------------
Miscellaneous
---------------
.. _include:
Including an External Document Fragment
=======================================
:Directive Type: "include"
:Doctree Elements: Depend on data being included
(literal_block_ with ``code`` or ``literal`` option).
:Directive Arguments: One, required (path to the file to include).
:Directive Options: Possible (see below).
:Directive Content: None.
:Configuration Setting: file_insertion_enabled_
.. WARNING::
The "include" directive represents a potential security hole. It
can be disabled with the "file_insertion_enabled_" runtime setting.
.. _file_insertion_enabled: ../../user/config.html#file-insertion-enabled
The "include" directive reads a text file. The directive argument is
the path to the file to be included, relative to the document containing
the directive. Unless the options ``literal``, ``code``, or ``parser``
are given, the file is parsed in the current document's context at the
point of the directive. For example::
This first example will be parsed at the document level, and can
thus contain any construct, including section headers.
.. include:: inclusion.txt
Back in the main document.
This second example will be parsed in a block quote context.
Therefore it may only contain body elements. It may not
contain section headers.
.. include:: inclusion.txt
If an included document fragment contains section structure, the title
adornments must match those of the master document.
Standard data files intended for inclusion in reStructuredText
documents are distributed with the Docutils source code, located in
the "docutils" package in the ``docutils/parsers/rst/include``
directory. To access these files, use the special syntax for standard
"include" data files, angle brackets around the file name::
.. include:: <isonum.txt>
The current set of standard "include" data files consists of sets of
substitution definitions. See `reStructuredText Standard Definition
Files`__ for details.
__ definitions.html
The following options are recognized:
``start-line`` : integer
Only the content starting from this line will be included.
(As usual in Python, the first line has index 0 and negative values
count from the end.)
``end-line`` : integer
Only the content up to (but excluding) this line will be included.
``start-after`` : text to find in the external data file
Only the content after the first occurrence of the specified text
will be included.
``end-before`` : text to find in the external data file
Only the content before the first occurrence of the specified text
(but after any ``after`` text) will be included.
``parser`` : parser name
Parse the included content with the specified parser.
(New in Docutils 0.17)
``literal`` : flag (empty)
The entire included text is inserted into the document as a single
literal block.
``code`` : [string] (formal language)
The argument and the included content are passed to
the code_ directive (useful for program listings).
``number-lines`` : [integer] (start line number)
Precede every code line with a line number.
The optional argument is the number of the first line (default 1).
Works only with ``code`` or ``literal``.
``encoding`` : string
The text encoding of the external file.
Defaults to the document's input_encoding_.
.. _input_encoding: ../../user/config.html#input-encoding
``tab-width`` : integer
Number of spaces for hard tab expansion.
A negative value prevents expansion of hard tabs. Defaults to the
tab_width_ configuration setting.
.. _tab_width: ../../user/config.html#tab-width
With ``code`` or ``literal`` the common options class_ and
name_ are recognized as well.
Combining ``start/end-line`` and ``start-after/end-before`` is possible. The
text markers will be searched in the specified lines (further limiting the
included content).
.. _raw:
Raw Data Pass-Through
=====================
:Directive Type: "raw"
:Doctree Element: `raw <../doctree.html#raw>`__
:Directive Arguments: One or more, required (output format types).
:Directive Options: Possible (see below).
:Directive Content: Stored verbatim, uninterpreted. None (empty) if a
"file" or "url" option given.
:Configuration Setting: raw_enabled_
.. WARNING::
The "raw" directive represents a potential security hole. It can
be disabled with the "raw_enabled_" runtime setting.
Insertion of external files can be disabled with the
"file_insertion_enabled_" runtime setting.
.. _raw_enabled: ../../user/config.html#raw-enabled
.. Caution::
The "raw" directive is a stop-gap measure allowing the author to
bypass reStructuredText's markup. It is a "power-user" feature
that should not be overused or abused. The use of "raw" ties
documents to specific output formats and makes them less portable.
If you often need to use the "raw" directive or a "raw"-derived
interpreted text role, that is a sign either of overuse/abuse or
that functionality may be missing from reStructuredText. Please
describe your situation in a message to the Docutils-users_ mailing
list.
.. _Docutils-users: ../../user/mailing-lists.html#docutils-users
The "raw" directive indicates non-reStructuredText data that is to be
passed untouched to the Writer. The names of the output formats are
given in the directive arguments. The interpretation of the raw data
is up to the Writer. A Writer may ignore any raw output not matching
its format.
For example, the following input would be passed untouched by an HTML
writer::
.. raw:: html
<hr width=50 size=10>
A LaTeX Writer could insert the following raw content into its
output stream::
.. raw:: latex
\setlength{\parindent}{0pt}
Raw data can also be read from an external file, specified in a
directive option. In this case, the content block must be empty. For
example::
.. raw:: html
:file: inclusion.html
Inline equivalents of the "raw" directive can be defined via
`custom interpreted text roles`_ derived from the `"raw" role`_.
The following options are recognized:
``file`` : string (newlines removed)
The local filesystem path of a raw data file to be included.
``url`` : string (whitespace removed)
An Internet URL reference to a raw data file to be included.
``encoding`` : string
The text encoding of the external raw data (file or URL).
Defaults to the document's `input_encoding`_ (if specified).
and the common option class_.
.. _"raw" role: roles.html#raw
Class
=====
:Directive Type: "class"
:Doctree Element: pending_
:Directive Arguments: One or more, required (class names / attribute
values).
:Directive Options: None.
:Directive Content: Optional. If present, it is interpreted as body
elements.
The "class" directive sets the `"classes"`_ attribute value on its content
or on the first immediately following [#]_ non-comment element [#]_.
The directive argument consists of one or more space-separated class
names. The names are transformed to conform to the regular expression
``[a-z](-?[a-z0-9]+)*`` (see `Identifier Normalization`_ below).
Examples::
.. class:: special
This is a "special" paragraph.
.. class:: exceptional remarkable
An Exceptional Section
======================
This is an ordinary paragraph.
.. class:: multiple
First paragraph.
Second paragraph.
The text above is parsed and transformed into this doctree fragment::
<paragraph classes="special">
This is a "special" paragraph.
<section classes="exceptional remarkable">
<title>
An Exceptional Section
<paragraph>
This is an ordinary paragraph.
<paragraph classes="multiple">
First paragraph.
<paragraph classes="multiple">
Second paragraph.
.. [#] This is also true, if the class directive is "nested" at the end of
an indented text block, for example::
.. note:: the class values set in this directive-block do not apply to
the note but the next paragraph.
.. class:: special
This is a paragraph with class value "special".
This allows the "classification" of individual list items (except the
first, as a preceding class directive applies to the list as a whole)::
* bullet list
.. class:: classy item
* second item, with class argument
.. [#] To set a "classes" attribute value on a block quote, the
"class" directive must be followed by an empty comment::
.. class:: highlights
..
Block quote text.
Without the empty comment, the indented text would be interpreted as the
"class" directive's content, and the classes would be applied to each
element (paragraph, in this case) individually, instead of to the block
quote as a whole.
Identifier Normalization
~~~~~~~~~~~~~~~~~~~~~~~~
Docutils `class names`_ and `identifier keys`_ are normalized to conform
to the regular expression "``[a-z](-?[a-z0-9]+)*``" by converting
* alphabetic characters to lowercase,
* accented characters to the base character,
* non-alphanumeric characters to hyphens,
* consecutive hyphens into one hyphen
and stripping
* leading hyphens and number characters, and
* trailing hyphens.
For example ``"Rot.Gelb&Grün:+2008"`` becomes ``"rot-gelb-grun-2008"`` and
``"1000_Steps!"`` becomes ``"steps"``.
.. topic:: Rationale:
Identifier keys must be valid in all supported output formats.
For HTML 4.1 + CSS1 compatibility, identifiers should have no
underscores, colons, or periods. Hyphens may be used.
- The `HTML 4.01 spec`_ defines identifiers based on SGML tokens:
ID and NAME tokens must begin with a letter ([A-Za-z]) and
may be followed by any number of letters, digits ([0-9]),
hyphens ("-"), underscores ("_"), colons (":"), and periods
(".").
-- https://www.w3.org/TR/html401/types.html#type-name
- The `CSS1 spec`_ defines identifiers based on the "name" token
("flex" tokenizer notation below; "latin1" and "escape" 8-bit
characters have been replaced with XML entities)::
unicode \\[0-9a-f]{1,4}
latin1 [¡-ÿ]
escape {unicode}|\\[ -~¡-ÿ]
nmchar [-A-Za-z0-9]|{latin1}|{escape}
name {nmchar}+
The CSS1 rule requires underscores ("_"), colons (":"), and
periods (".") to be escaped [#]_,
therefore `"classes"`_ and `"ids"`_ attributes should not
contain these characters. Combined with HTML4.1 requirements (the
first character must be a letter; no "unicode", "latin1", or
"escape" characters), this results in the regular expression
``[A-Za-z][-A-Za-z0-9]*``. Docutils adds a normalization by
downcasing and merge of consecutive hyphens.
.. [#] CSS identifiers may use underscores ("_") directly in
`CSS Level 1`__, `CSS2.1`__, CSS2.2__, and CSS3__.
__ https://www.w3.org/TR/CSS21/syndata.html#value-def-identifier
__ https://www.w3.org/TR/CSS/#css-level-1
__ https://www.w3.org/TR/CSS22/syndata.html
__ https://www.w3.org/TR/css-syntax-3/#typedef-ident-token
.. _HTML 4.01 spec: https://www.w3.org/TR/html401/
.. _CSS1 spec: https://www.w3.org/TR/REC-CSS1
.. _role:
Custom Interpreted Text Roles
=============================
:Directive Type: "role"
:Doctree Element: None; affects subsequent parsing.
:Directive Arguments: Two; one required (new `role name`_), one optional
(base role name, in parentheses).
:Directive Options: Possible (depends on base role).
:Directive Content: depends on base role.
The "role" directive dynamically creates a custom `interpreted text
role`_ and registers it with the parser. This means that after
declaring a role like this::
.. role:: custom
the document may use the new "custom" role::
An example of using :custom:`interpreted text`
This will be parsed into the following document tree fragment::
<paragraph>
An example of using
<inline classes="custom">
interpreted text
The role must be declared in a document before it can be used.
.. _role name:
Role names are case insensitive and must conform to the rules of
simple `reference names`_ (but do not share a namespace with
hyperlinks, footnotes, and citations).
The new role may be based on an existing role, specified as a second
argument in parentheses (whitespace optional)::
.. role:: custom(emphasis)
:custom:`text`
The parsed result is as follows::
<paragraph>
<emphasis classes="custom">
text
A special case is the `"raw" role`_: derived roles enable
inline `raw data pass-through`_, e.g.::
.. role:: raw-role(raw)
:format: html latex
:raw-role:`raw text`
If no base role is explicitly specified, a generic custom role is
automatically used. Subsequent interpreted text will produce an
"inline" element with a `"classes"`_ attribute, as in the first example
above.
With most roles, the ":class:" option can be used to set a "classes"
attribute that is different from the role name. For example::
.. role:: custom
:class: special
:custom:`interpreted text`
This is the parsed result::
<paragraph>
<inline classes="special">
interpreted text
.. _role class:
The following option is recognized by the "role" directive for most
base roles:
``class`` : text
Set the `"classes"`_ attribute value on the element produced
(``inline``, or element associated with a base class) when the
custom interpreted text role is used. If no directive options are
specified, a "class" option with the directive argument (role
name) as the value is implied. See the class_ directive above.
Specific base roles may support other options and/or directive
content. See the `reStructuredText Interpreted Text Roles`_ document
for details.
.. _reStructuredText Interpreted Text Roles: roles.html
.. _default-role:
Setting the Default Interpreted Text Role
=========================================
:Directive Type: "default-role"
:Doctree Element: None; affects subsequent parsing.
:Directive Arguments: One, optional (new default role name).
:Directive Options: None.
:Directive Content: None.
The "default-role" directive sets the default interpreted text role,
the role that is used for interpreted text without an explicit role.
For example, after setting the default role like this::
.. default-role:: subscript
any subsequent use of implicit-role interpreted text in the document
will use the "subscript" role::
An example of a `default` role.
This will be parsed into the following document tree fragment::
<paragraph>
An example of a
<subscript>
default
role.
Custom roles may be used (see the "role_" directive above), but it
must have been declared in a document before it can be set as the
default role. See the `reStructuredText Interpreted Text Roles`_
document for details of built-in roles.
The directive may be used without an argument to restore the initial
default interpreted text role, which is application-dependent. The
initial default interpreted text role of the standard reStructuredText
parser is "title-reference".
.. _meta:
Metadata
========
:Directive Type: "meta"
:Doctree Element: `meta <../doctree.html#meta>`__
:Directive Arguments: None.
:Directive Options: None.
:Directive Content: Must contain a flat field list.
The "meta" directive is used to specify metadata\ [#]_ to be stored
in, e.g., `HTML meta elements`_ or as `ODT file properties`_. The
LaTeX writer passes it to the ``pdfinfo`` option of the hyperref_
package. If an output format does not support "invisible" metadata,
content is silently dropped by the writer.
.. note:: Data from some `bibliographic fields`_ is automatically
extracted and stored as metadata, too. However, Bibliographic
Fields are also displayed in the document's screen rendering or
printout.
For an "invisible" *document title*, see the `metadata document
title`_ directive below.
Within the directive block, a flat field list provides the syntax for
metadata. The field name becomes the contents of the "name" attribute
of the META tag, and the field body (interpreted as a single string
without inline markup) becomes the contents of the "content"
attribute. For example::
.. meta::
:description: The reStructuredText plaintext markup language
:keywords: plaintext, markup language
This would be converted to the following HTML::
<meta name="description"
content="The reStructuredText plaintext markup language">
<meta name="keywords" content="plaintext, markup language">
Support for other META attributes ("http-equiv", "scheme", "lang",
"dir") are provided through field arguments, which must be of the form
"attr=value"::
.. meta::
:description lang=en: An amusing story
:description lang=fr: Une histoire amusante
And their HTML equivalents::
<meta name="description" lang="en" content="An amusing story">
<meta name="description" lang="fr" content="Une histoire amusante">
Some META tags use an "http-equiv" attribute instead of the "name"
attribute. To specify "http-equiv" META tags, simply omit the name::
.. meta::
:http-equiv=Content-Type: text/html; charset=ISO-8859-1
HTML equivalent::
<meta http-equiv="Content-Type"
content="text/html; charset=ISO-8859-1">
.. [#] "Metadata" is data about data, in this case data about the
document. Metadata is, e.g., used to describe and classify web
pages in the World Wide Web, in a form that is easy for search
engines to extract and collate.
.. _HTML meta elements:
https://html.spec.whatwg.org/multipage/semantics.html#the-meta-element
.. _ODT file properties:
https://en.wikipedia.org/wiki/OpenDocument_technical_specification#Metadata
.. _hyperref: https://ctan.org/pkg/hyperref
.. _bibliographic fields: restructuredtext.html#bibliographic-fields
.. _title:
Metadata Document Title
=======================
:Directive Type: "title"
:Doctree Element: Sets the document's `title attribute`_.
:Directive Arguments: One, required (the title text).
:Directive Options: None.
:Directive Content: None.
The "title" directive specifies the document title as metadata, which
does not become part of the document body. It overrides the
document-supplied `document title`_ and the `"title" configuration
setting`_. For example, in HTML output the metadata document title
appears in the title bar of the browser window.
.. _document title: restructuredtext.html#document-title
.. _"title" configuration setting: ../../user/config.html#title
Restructuredtext-Test-Directive
===============================
:Directive Type: "restructuredtext-test-directive"
:Doctree Element: system_warning
:Directive Arguments: None.
:Directive Options: None.
:Directive Content: Interpreted as a literal block.
This directive is provided for test purposes only. (Nobody is
expected to type in a name *that* long!) It is converted into a
level-1 (info) system message showing the directive data, possibly
followed by a literal block containing the rest of the directive
block.
--------------
Common Options
--------------
Most of the directives that generate doctree elements support the following
options:
.. _class-option:
.. _class:
``class`` : text (space separated list of `class names`_)
Set a `"classes"`_ attribute value on the doctree element generated by
the directive. See also the class_ directive.
.. _name:
``name`` : text
Add `text` to the `"names"`_ attribute of the doctree element generated
by the directive. This allows `hyperlink references`_ to the element
using `text` as `reference name`_.
Specifying the `name` option of a directive, e.g., ::
.. image:: bild.png
:name: my picture
is a concise syntax alternative to preceding it with a `hyperlink
target`_ ::
.. _my picture:
.. image:: bild.png
.. _reference name:
.. _reference names: restructuredtext.html#reference-names
.. _hyperlink target: restructuredtext.html#hyperlink-targets
.. _hyperlink references: restructuredtext.html#hyperlink-references
.. _class names: ../doctree.html#classnames-type
.. _"classes": ../doctree.html#classes
.. _identifier keys: ../doctree.html#ids-type
.. _"ids": ../doctree.html#ids
.. _"names": ../doctree.html#names
.. _block_quote: ../doctree.html#block-quote
.. _caption: ../doctree.html#caption
.. _classes: ../doctree.html#classes
.. _container element: ../doctree.html#container
.. _decoration: ../doctree.html#decoration
.. _figure: ../doctree.html#figure
.. _footnote: ../doctree.html#footnote
.. _footnote_reference: ../doctree.html#footnote-reference
.. _generated: ../doctree.html#generated
.. _inline elements: ../doctree.html#inline-elements
.. _interpreted text role: roles.html
.. _literal_block: ../doctree.html#literal-block
.. _legend: ../doctree.html#legend
.. _length: restructuredtext.html#length-units
.. _line_block: ../doctree.html#line-block
.. _math_block: ../doctree.html#math-block
.. _pending: ../doctree.html#pending
.. _percentage: restructuredtext.html#percentage-units
.. _rubric: ../doctree.html#rubric
.. _sidebar: ../doctree.html#sidebar
.. _title attribute: ../doctree.html#title-attribute
.. _topic: ../doctree.html#topic
..
Local Variables:
mode: indented-text
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
End:
|