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 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348
|
<document ids="restructuredtext-test-document doctitle" names="restructuredtext\ test\ document doctitle" source="functional/input/standalone_rst_pseudoxml.txt" title="reStructuredText Test Document">
<title>
reStructuredText Test Document
<subtitle ids="examples-of-syntax-constructs subtitle" names="examples\ of\ syntax\ constructs subtitle">
Examples of Syntax Constructs
<decoration>
<header>
<paragraph>
Document header
<footer>
<paragraph>
Document footer
<docinfo>
<author>
David Goodger
<address xml:space="preserve">
123 Example Street
Example, EX Canada
A1B 2C3
<contact>
<reference refuri="mailto:goodger@python.org">
goodger@python.org
<authors>
<author>
Me
<author>
Myself
<author>
I
<organization>
humankind
<date>
Now, or yesterday. Or maybe even
<emphasis>
before
yesterday.
<status>
This is a "work in progress"
<revision>
is managed by a version control system.
<version>
1
<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.
<field classes="field-name">
<field_name>
field name
<field_body>
<paragraph>
This is a "generic bibliographic field".
<field classes="field-name-2">
<field_name>
field name "2"
<field_body>
<paragraph>
Generic bibliographic fields may contain multiple body elements.
<paragraph>
Like this.
<topic classes="dedication">
<title>
Dedication
<paragraph>
For Docutils users & co-developers.
<topic classes="abstract">
<title>
Abstract
<paragraph>
This is a test document, containing at least one example of each
reStructuredText construct.
<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.
<target refid="doctitle">
<comment xml:space="preserve">
Above is the document title, and below is the subtitle.
They are transformed from section titles after parsing.
<target refid="subtitle">
<comment xml:space="preserve">
bibliographic fields (which also require a transform):
<meta content="reStructuredText, test, parser" name="keywords">
<meta content="A test document, containing at least one example of each reStructuredText construct." lang="en" name="description">
<raw format="latex" xml:space="preserve">
\pagebreak[4] % start ToC on new page
<topic classes="contents" ids="table-of-contents" names="table\ of\ contents">
<title>
Table of Contents
<bullet_list classes="auto-toc">
<list_item>
<paragraph>
<reference ids="id34" refid="structural-elements">
<generated classes="sectnum">
1
Structural Elements
<bullet_list classes="auto-toc">
<list_item>
<paragraph>
<reference ids="id35" refid="section-title">
<generated classes="sectnum">
1.1
Section Title
<list_item>
<paragraph>
<reference ids="id36" refid="empty-section">
<generated classes="sectnum">
1.2
Empty Section
<list_item>
<paragraph>
<reference ids="id37" refid="transitions">
<generated classes="sectnum">
1.3
Transitions
<list_item>
<paragraph>
<reference ids="id38" refid="body-elements">
<generated classes="sectnum">
2
Body Elements
<bullet_list classes="auto-toc">
<list_item>
<paragraph>
<reference ids="id39" refid="paragraphs">
<generated classes="sectnum">
2.1
Paragraphs
<bullet_list classes="auto-toc">
<list_item>
<paragraph>
<reference ids="id40" refid="inline-markup">
<generated classes="sectnum">
2.1.1
Inline Markup
<list_item>
<paragraph>
<reference ids="id41" refid="bullet-lists">
<generated classes="sectnum">
2.2
Bullet Lists
<list_item>
<paragraph>
<reference ids="id42" refid="enumerated-lists">
<generated classes="sectnum">
2.3
Enumerated Lists
<list_item>
<paragraph>
<reference ids="id43" refid="definition-lists">
<generated classes="sectnum">
2.4
Definition Lists
<list_item>
<paragraph>
<reference ids="id44" refid="field-lists">
<generated classes="sectnum">
2.5
Field Lists
<list_item>
<paragraph>
<reference ids="id45" refid="option-lists">
<generated classes="sectnum">
2.6
Option Lists
<list_item>
<paragraph>
<reference ids="id46" refid="literal-blocks">
<generated classes="sectnum">
2.7
Literal Blocks
<list_item>
<paragraph>
<reference ids="id47" refid="line-blocks">
<generated classes="sectnum">
2.8
Line Blocks
<list_item>
<paragraph>
<reference ids="id48" refid="block-quotes">
<generated classes="sectnum">
2.9
Block Quotes
<list_item>
<paragraph>
<reference ids="id49" refid="doctest-blocks">
<generated classes="sectnum">
2.10
Doctest Blocks
<list_item>
<paragraph>
<reference ids="id50" refid="footnotes">
<generated classes="sectnum">
2.11
Footnotes
<list_item>
<paragraph>
<reference ids="id51" refid="citations">
<generated classes="sectnum">
2.12
Citations
<list_item>
<paragraph>
<reference ids="id52" refid="targets">
<generated classes="sectnum">
2.13
Targets
<bullet_list classes="auto-toc">
<list_item>
<paragraph>
<reference ids="id53" refid="duplicate-target-names">
<generated classes="sectnum">
2.13.1
Duplicate Target Names
<list_item>
<paragraph>
<reference ids="id54" refid="id21">
<generated classes="sectnum">
2.13.2
Duplicate Target Names
<list_item>
<paragraph>
<reference ids="id55" refid="directives">
<generated classes="sectnum">
2.14
Directives
<bullet_list classes="auto-toc">
<list_item>
<paragraph>
<reference ids="id56" refid="document-parts">
<generated classes="sectnum">
2.14.1
Document Parts
<list_item>
<paragraph>
<reference ids="id57" refid="images-and-figures">
<generated classes="sectnum">
2.14.2
Images and Figures
<list_item>
<paragraph>
<reference ids="id58" refid="admonitions">
<generated classes="sectnum">
2.14.3
Admonitions
<list_item>
<paragraph>
<reference ids="id59" refid="topics-sidebars-and-rubrics">
<generated classes="sectnum">
2.14.4
Topics, Sidebars, and Rubrics
<list_item>
<paragraph>
<reference ids="id60" refid="target-footnotes">
<generated classes="sectnum">
2.14.5
Target Footnotes
<list_item>
<paragraph>
<reference ids="id61" refid="replacement-text">
<generated classes="sectnum">
2.14.6
Replacement Text
<list_item>
<paragraph>
<reference ids="id62" refid="compound-paragraph">
<generated classes="sectnum">
2.14.7
Compound Paragraph
<list_item>
<paragraph>
<reference ids="id63" refid="parsed-literal-blocks">
<generated classes="sectnum">
2.14.8
Parsed Literal Blocks
<list_item>
<paragraph>
<reference ids="id64" refid="code">
<generated classes="sectnum">
2.14.9
Code
<list_item>
<paragraph>
<reference ids="id65" refid="substitution-definitions">
<generated classes="sectnum">
2.15
Substitution Definitions
<list_item>
<paragraph>
<reference ids="id66" refid="comments">
<generated classes="sectnum">
2.16
Comments
<list_item>
<paragraph>
<reference ids="id67" refid="raw-text">
<generated classes="sectnum">
2.17
Raw text
<list_item>
<paragraph>
<reference ids="id68" refid="container">
<generated classes="sectnum">
2.18
Container
<list_item>
<paragraph>
<reference ids="id69" refid="colspanning-tables">
<generated classes="sectnum">
2.19
Colspanning tables
<list_item>
<paragraph>
<reference ids="id70" refid="rowspanning-tables">
<generated classes="sectnum">
2.20
Rowspanning tables
<list_item>
<paragraph>
<reference ids="id71" refid="complex-tables">
<generated classes="sectnum">
2.21
Complex tables
<list_item>
<paragraph>
<reference ids="id72" refid="list-tables">
<generated classes="sectnum">
2.22
List Tables
<list_item>
<paragraph>
<reference ids="id73" refid="error-handling">
<generated classes="sectnum">
3
Error Handling
<section ids="structural-elements" names="structural\ elements">
<title auto="1" refid="id34">
<generated classes="sectnum">
1
Structural Elements
<section ids="section-title" names="section\ title">
<title auto="1" refid="id35">
<generated classes="sectnum">
1.1
Section Title
<subtitle ids="section-subtitle" names="section\ subtitle">
Section Subtitle
<paragraph>
Lone subsections are converted to a section subtitle by a transform
activated with the
<literal>
--section-subtitles
command line option or the
<literal>
sectsubtitle-xform
configuration value.
<section ids="empty-section" names="empty\ section">
<title auto="1" refid="id36">
<generated classes="sectnum">
1.2
Empty Section
<section ids="transitions" names="transitions">
<title auto="1" refid="id37">
<generated classes="sectnum">
1.3
Transitions
<paragraph>
Here's a transition:
<transition>
<paragraph>
It divides the section. Transitions may also occur between sections:
<transition>
<section ids="body-elements" names="body\ elements">
<title auto="1" refid="id38">
<generated classes="sectnum">
2
Body Elements
<section ids="paragraphs" names="paragraphs">
<title auto="1" refid="id39">
<generated classes="sectnum">
2.1
Paragraphs
<paragraph>
A paragraph.
<section ids="inline-markup" names="inline\ markup">
<title auto="1" refid="id40">
<generated classes="sectnum">
2.1.1
Inline Markup
<paragraph>
Paragraphs contain text and may contain inline markup:
<emphasis>
emphasis
,
<strong>
strong emphasis
,
<literal>
inline literals
, standalone hyperlinks
(
<reference refuri="http://www.python.org">
http://www.python.org
), external hyperlinks (
<reference name="Python" refuri="http://www.python.org/">
Python
<footnote_reference auto="1" ids="id26" refid="id25">
5
), internal
cross-references (
<reference name="example" refid="example">
example
), external hyperlinks with embedded URIs
(
<reference name="Python web site" refuri="http://www.python.org">
Python web site
),
<reference anonymous="1" name="anonymous hyperlink references" refuri="http://www.python.org/">
anonymous hyperlink
references
<footnote_reference auto="1" ids="id31" refid="id25">
5
(
<reference anonymous="1" name="a second reference" refuri="http://docutils.sourceforge.net/">
a second reference
<footnote_reference auto="1" ids="id33" refid="id32">
7
), footnote references (manually
numbered
<footnote_reference ids="id1" refid="id8">
1
, anonymous auto-numbered
<footnote_reference auto="1" ids="id2" refid="id12">
3
, labeled auto-numbered
<footnote_reference auto="1" ids="id3" refid="label">
2
, or symbolic
<footnote_reference auto="*" ids="id4" refid="id13">
*
), citation references (
<citation_reference ids="id5" refid="cit2002">
CIT2002
),
substitution references (
<image alt="EXAMPLE" uri="../../../docs/user/rst/images/biohazard.png">
), and
<target ids="inline-hyperlink-targets" names="inline\ hyperlink\ targets">
inline hyperlink targets
(see
<reference name="Targets" refid="targets">
Targets
below for a reference back to here). Character-level
inline markup is also possible (although exceedingly ugly!) in
<emphasis>
re
<literal>
Structured
<emphasis>
Text
. Problems are indicated by
<problematic ids="id24" refid="id23">
|problematic|
text
(generated by processing errors; this one is intentional). Here is a
reference to the
<reference name="doctitle" refid="doctitle">
doctitle
and the
<reference name="subtitle" refid="subtitle">
subtitle
.
<target anonymous="1" ids="id6" refuri="http://www.python.org/">
<target anonymous="1" ids="id7" refuri="http://docutils.sourceforge.net/">
<paragraph>
The default role for interpreted text is
<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
); an
RFC reference (
<reference refuri="http://tools.ietf.org/html/rfc2822.html">
RFC 2822
); an abbreviation (
<abbreviation>
abb.
), an acronym
(
<acronym>
reST
), code (
<literal classes="code">
print "hello world"
); a
<subscript>
subscript
;
a
<superscript>
superscript
and explicit roles for
<title_reference>
Docutils
'
<emphasis>
standard
<strong>
inline
<literal>
markup
.
<comment xml:space="preserve">
DO NOT RE-WRAP THE FOLLOWING PARAGRAPH!
<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).
<paragraph>
If the
<literal>
--pep-references
option was supplied, there should be a
live link to PEP 258 here.
<section ids="bullet-lists" names="bullet\ lists">
<title auto="1" refid="id41">
<generated classes="sectnum">
2.2
Bullet Lists
<bullet_list bullet="-">
<list_item>
<paragraph>
A bullet list
<bullet_list bullet="+">
<list_item>
<paragraph>
Nested bullet list.
<list_item>
<paragraph>
Nested item 2.
<list_item>
<paragraph>
Item 2.
<paragraph>
Paragraph 2 of item 2.
<bullet_list bullet="*">
<list_item>
<paragraph>
Nested bullet list.
<list_item>
<paragraph>
Nested item 2.
<bullet_list bullet="-">
<list_item>
<paragraph>
Third level.
<list_item>
<paragraph>
Item 2.
<list_item>
<paragraph>
Nested item 3.
<list_item>
<paragraph>
This nested list should be compacted by the HTML writer.
<target ids="target" names="target">
<comment xml:space="preserve">
Even if this item contains a target and a comment.
<section ids="enumerated-lists" names="enumerated\ lists">
<title auto="1" refid="id42">
<generated classes="sectnum">
2.3
Enumerated Lists
<enumerated_list enumtype="arabic" prefix="" suffix=".">
<list_item>
<paragraph>
Arabic numerals.
<enumerated_list enumtype="loweralpha" prefix="" suffix=")">
<list_item>
<paragraph>
lower alpha)
<enumerated_list enumtype="lowerroman" prefix="(" suffix=")">
<list_item>
<paragraph>
(lower roman)
<enumerated_list enumtype="upperalpha" prefix="" suffix=".">
<list_item>
<paragraph>
upper alpha.
<enumerated_list enumtype="upperroman" prefix="" suffix=")">
<list_item>
<paragraph>
upper roman)
<list_item>
<paragraph>
Lists that don't start at 1:
<enumerated_list enumtype="arabic" prefix="" start="3" suffix=".">
<list_item>
<paragraph>
Three
<list_item>
<paragraph>
Four
<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)
<enumerated_list enumtype="upperalpha" prefix="" start="3" suffix=".">
<list_item>
<paragraph>
C
<list_item>
<paragraph>
D
<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)
<enumerated_list enumtype="lowerroman" prefix="" start="3" suffix=".">
<list_item>
<paragraph>
iii
<list_item>
<paragraph>
iv
<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)
<section ids="definition-lists" names="definition\ lists">
<title auto="1" refid="id43">
<generated classes="sectnum">
2.4
Definition Lists
<definition_list>
<definition_list_item>
<term>
Term
<definition>
<paragraph>
Definition
<definition_list_item>
<term>
Term
<classifier>
classifier
<definition>
<paragraph>
Definition paragraph 1.
<paragraph>
Definition paragraph 2.
<definition_list_item>
<term>
Term
<definition>
<paragraph>
Definition
<definition_list_item>
<term>
Term
<classifier>
classifier one
<classifier>
classifier two
<definition>
<paragraph>
Definition
<section ids="field-lists" names="field\ lists">
<title auto="1" refid="id44">
<generated classes="sectnum">
2.5
Field Lists
<field_list>
<field>
<field_name>
what
<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.
<field>
<field_name>
how arg1 arg2
<field_body>
<paragraph>
The field marker is a colon, the field name, and a colon.
<paragraph>
The field body may contain one or more body elements, indented
relative to the field marker.
<field>
<field_name>
credits
<field_body>
<paragraph classes="credits">
This paragraph has the
<title_reference>
credits
class set. (This is actually not
about credits but just for ensuring that the class attribute
doesn't get stripped away.)
<section ids="option-lists" names="option\ lists">
<title auto="1" refid="id45">
<generated classes="sectnum">
2.6
Option Lists
<paragraph>
For listing command-line options:
<option_list>
<option_list_item>
<option_group>
<option>
<option_string>
-a
<description>
<paragraph>
command-line option "a"
<option_list_item>
<option_group>
<option>
<option_string>
-b
<option_argument delimiter=" ">
file
<description>
<paragraph>
options can have arguments
and long descriptions
<option_list_item>
<option_group>
<option>
<option_string>
--long
<description>
<paragraph>
options can be long also
<option_list_item>
<option_group>
<option>
<option_string>
--input
<option_argument delimiter="=">
file
<description>
<paragraph>
long options can also have
arguments
<option_list_item>
<option_group>
<option>
<option_string>
--very-long-option
<description>
<paragraph>
The description can also start on the next line.
<paragraph>
The description may contain multiple body elements,
regardless of where it starts.
<option_list_item>
<option_group>
<option>
<option_string>
-x
<option>
<option_string>
-y
<option>
<option_string>
-z
<description>
<paragraph>
Multiple options are an "option group".
<option_list_item>
<option_group>
<option>
<option_string>
-v
<option>
<option_string>
--verbose
<description>
<paragraph>
Commonly-seen: short & long options.
<option_list_item>
<option_group>
<option>
<option_string>
-1
<option_argument delimiter=" ">
file
<option>
<option_string>
--one
<option_argument delimiter="=">
file
<option>
<option_string>
--two
<option_argument delimiter=" ">
file
<description>
<paragraph>
Multiple options with arguments.
<option_list_item>
<option_group>
<option>
<option_string>
/V
<description>
<paragraph>
DOS/VMS-style options too
<paragraph>
There must be at least two spaces between the option and the
description.
<section ids="literal-blocks" names="literal\ blocks">
<title auto="1" refid="id46">
<generated classes="sectnum">
2.7
Literal Blocks
<paragraph>
Literal blocks are indicated with a double-colon ("::") at the end of
the preceding paragraph (over there
<literal>
-->
). They can be indented:
<literal_block xml:space="preserve">
if literal_block:
text = 'is left as-is'
spaces_and_linebreaks = 'are preserved'
markup_processing = None
<paragraph>
Or they can be quoted without indentation:
<literal_block xml:space="preserve">
>> Great idea!
>
> Why didn't I think of that?
<section ids="line-blocks" names="line\ blocks">
<title auto="1" refid="id47">
<generated classes="sectnum">
2.8
Line Blocks
<paragraph>
This section tests line blocks. Line blocks are body elements which
consist of lines and other line blocks. Nested line blocks cause
indentation.
<line_block>
<line>
This is a line block. It ends with a blank line.
<line_block>
<line>
New lines begin with a vertical bar ("|").
<line>
Line breaks and initial indent are significant, and preserved.
<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>
The left edge of a continuation line need not be aligned with
the left edge of the text above it.
<line_block>
<line>
This is a second line block.
<line>
<line>
Blank lines are permitted internally, but they must begin with a "|".
<paragraph>
Another line block, surrounded by paragraphs:
<line_block>
<line>
And it's no good waiting by the window
<line>
It's no good waiting for the sun
<line>
Please believe me, the things you dream of
<line>
They don't fall in the lap of no-one
<paragraph>
Take it away, Eric the Orchestra Leader!
<block_quote>
<line_block>
<line>
A one, two, a one two three four
<line>
<line>
Half a bee, philosophically,
<line_block>
<line>
must,
<emphasis>
ipso facto
, half not be.
<line>
But half the bee has got to be,
<line_block>
<line>
<emphasis>
vis a vis
its entity. D'you see?
<line>
<line>
But can a bee be said to be
<line_block>
<line>
or not to be an entire bee,
<line_block>
<line>
when half the bee is not a bee,
<line_block>
<line>
due to some ancient injury?
<line>
<line>
Singing...
<paragraph>
A line block, like the following poem by Christian Morgenstern, can
also be centre-aligned:
<line_block classes="language-de align-center">
<line>
<strong>
Die Trichter
<line>
<line>
Zwei Trichter wandeln durch die Nacht.
<line>
Durch ihres Rumpfs verengten Schacht
<line>
fließt weißes Mondlicht
<line>
still und heiter
<line>
auf ihren
<line>
Waldweg
<line>
u. s.
<line>
w.
<line>
<section ids="block-quotes" names="block\ quotes">
<title auto="1" refid="id48">
<generated classes="sectnum">
2.9
Block Quotes
<paragraph>
Block quotes consist of indented body elements:
<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.
<attribution>
Anne Elk (Miss)
<paragraph>
The language of a quote (like any other object) can be specified by
a class attribute:
<comment xml:space="preserve">
<block_quote classes="language-fr">
<paragraph>
ReStructuredText est un langage de balisage léger utilisé
notamment dans la documentation du langage Python.
<section ids="doctest-blocks" names="doctest\ blocks">
<title auto="1" refid="id49">
<generated classes="sectnum">
2.10
Doctest Blocks
<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)
<section ids="footnotes" names="footnotes">
<title auto="1" refid="id50">
<generated classes="sectnum">
2.11
Footnotes
<footnote backrefs="id1 id9 id22" ids="id8" names="1">
<label>
1
<paragraph>
A footnote contains body elements, consistently indented by at
least 3 spaces.
<paragraph>
This is the footnote's second paragraph.
<footnote auto="1" backrefs="id3 id10" ids="label" names="label">
<label>
2
<paragraph>
Footnotes may be numbered, either manually (as in
<footnote_reference ids="id9" refid="id8">
1
) 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="id10" refid="label">
2
) and as a
<reference anonymous="1" name="hyperlink reference" refid="label">
hyperlink reference
.
<target anonymous="1" ids="id11" refid="label">
<footnote auto="1" backrefs="id2" ids="id12" names="3">
<label>
3
<paragraph>
This footnote is numbered automatically and anonymously using a
label of "#" only.
<paragraph>
This is the second paragraph.
<paragraph>
And this is the third paragraph.
<footnote auto="*" backrefs="id4" ids="id13">
<label>
*
<paragraph>
Footnotes may also use symbols, specified with a "*" label.
Here's a reference to the next footnote:
<footnote_reference auto="*" ids="id14" refid="id15">
†
.
<footnote auto="*" backrefs="id14" ids="id15">
<label>
†
<paragraph>
This footnote shows the next symbol in the sequence.
<footnote ids="id16" names="4">
<label>
4
<paragraph>
Here's an unreferenced footnote, with a reference to a
nonexistent footnote:
<problematic ids="id17" refid="id83">
[5]_
.
<section ids="citations" names="citations">
<title auto="1" refid="id51">
<generated classes="sectnum">
2.12
Citations
<citation backrefs="id5 id18" ids="cit2002" names="cit2002">
<label>
CIT2002
<paragraph>
Citations are text-labeled footnotes. They may be
rendered separately and differently from footnotes.
<paragraph>
Here's a reference to the above,
<citation_reference ids="id18" refid="cit2002">
CIT2002
, and a
<problematic ids="id19" refid="id84">
[nonexistent]_
citation.
<target refid="another-target">
<section ids="targets another-target" names="targets another\ target">
<title auto="1" refid="id52">
<generated classes="sectnum">
2.13
Targets
<target refid="example">
<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
, above.
<reference name="Inline hyperlink targets" refid="inline-hyperlink-targets">
Inline
hyperlink targets
are also possible.
<paragraph>
Section headers are implicit targets, referred to by name. See
<reference name="Targets" refid="targets">
Targets
, which is a subsection of
<reference name="Body Elements" refid="body-elements">
Body Elements
.
<paragraph>
Explicit external targets are interpolated into references such as
"
<reference name="Python" refuri="http://www.python.org/">
Python
<footnote_reference auto="1" ids="id27" refid="id25">
5
".
<target ids="python" names="python" refuri="http://www.python.org/">
<paragraph>
Targets may be indirect and anonymous. Thus
<reference anonymous="1" name="this phrase" refid="targets">
this phrase
may also
refer to the
<reference name="Targets" refid="targets">
Targets
section.
<target anonymous="1" ids="id20" refid="targets">
<paragraph>
Here's a
<problematic ids="id86" refid="id85">
`hyperlink reference without a target`_
, which generates an
error.
<section dupnames="duplicate\ target\ names" ids="duplicate-target-names">
<title auto="1" refid="id53">
<generated classes="sectnum">
2.13.1
Duplicate Target Names
<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.
<section dupnames="duplicate\ target\ names" ids="id21">
<title auto="1" refid="id54">
<generated classes="sectnum">
2.13.2
Duplicate Target Names
<system_message backrefs="id21" level="1" line="438" source="functional/input/data/standard.txt" type="INFO">
<paragraph>
Duplicate implicit target name: "duplicate target names".
<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="id88" refid="id87">
`Duplicate Target Names`_
), an error is generated.
<section ids="directives" names="directives">
<title auto="1" refid="id55">
<generated classes="sectnum">
2.14
Directives
<topic classes="contents local" ids="contents" names="contents">
<bullet_list classes="auto-toc">
<list_item>
<paragraph>
<reference ids="id74" refid="document-parts">
<generated classes="sectnum">
2.14.1
Document Parts
<list_item>
<paragraph>
<reference ids="id75" refid="images-and-figures">
<generated classes="sectnum">
2.14.2
Images and Figures
<list_item>
<paragraph>
<reference ids="id76" refid="admonitions">
<generated classes="sectnum">
2.14.3
Admonitions
<list_item>
<paragraph>
<reference ids="id77" refid="topics-sidebars-and-rubrics">
<generated classes="sectnum">
2.14.4
Topics, Sidebars, and Rubrics
<list_item>
<paragraph>
<reference ids="id78" refid="target-footnotes">
<generated classes="sectnum">
2.14.5
Target Footnotes
<list_item>
<paragraph>
<reference ids="id79" refid="replacement-text">
<generated classes="sectnum">
2.14.6
Replacement Text
<list_item>
<paragraph>
<reference ids="id80" refid="compound-paragraph">
<generated classes="sectnum">
2.14.7
Compound Paragraph
<list_item>
<paragraph>
<reference ids="id81" refid="parsed-literal-blocks">
<generated classes="sectnum">
2.14.8
Parsed Literal Blocks
<list_item>
<paragraph>
<reference ids="id82" refid="code">
<generated classes="sectnum">
2.14.9
Code
<paragraph>
These are just a sample of the many reStructuredText Directives. For
others, please see
<reference refuri="http://docutils.sourceforge.net/docs/ref/rst/directives.html">
http://docutils.sourceforge.net/docs/ref/rst/directives.html
.
<section ids="document-parts" names="document\ parts">
<title auto="1" refid="id74">
<generated classes="sectnum">
2.14.1
Document Parts
<paragraph>
An example of the "contents" directive can be seen above this section
(a local, untitled table of
<reference name="contents" refid="contents">
contents
) and at the beginning of the
document (a document-wide
<reference name="table of contents" refid="table-of-contents">
table of contents
).
<section ids="images-and-figures" names="images\ and\ figures">
<title auto="1" refid="id75">
<generated classes="sectnum">
2.14.2
Images and Figures
<paragraph>
An image directive (also clickable -- a hyperlink reference):
<reference name="directives" refid="directives">
<image classes="class1 class2" uri="../../../docs/user/rst/images/title.png">
<paragraph>
Image with multiple IDs:
<target refid="image-target-1">
<target refid="image-target-2">
<target refid="image-target-3">
<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/title.png">
<paragraph>
A centered image:
<image align="center" uri="../../../docs/user/rst/images/biohazard.png">
<paragraph>
A left-aligned image:
<image align="left" uri="../../../docs/user/rst/images/biohazard.png">
<paragraph>
This paragraph might flow around the image.
The specific behavior depends upon the style sheet and
the browser or rendering software used.
<paragraph>
A right-aligned image:
<image align="right" uri="../../../docs/user/rst/images/biohazard.png">
<paragraph>
This paragraph might flow around the image.
The specific behavior depends upon the style sheet and
the browser or rendering software used.
<paragraph>
For inline images see
<reference name="Substitution Definitions" refid="substitution-definitions">
Substitution Definitions
.
<paragraph>
Image size:
<paragraph>
An image 2 em wide:
<image uri="../../../docs/user/rst/images/biohazard.png" width="2em">
<paragraph>
An image 2 em wide and 15 pixel high:
<image height="15px" uri="../../../docs/user/rst/images/biohazard.png" width="2em">
<paragraph>
An image occupying 50% of the line width:
<image uri="../../../docs/user/rst/images/title.png" width="50%">
<paragraph>
An image 2 cm high:
<image height="2cm" uri="../../../docs/user/rst/images/biohazard.png">
<paragraph>
A
<emphasis>
figure
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.
<figure classes="figclass1 figclass2">
<image alt="reStructuredText, the markup syntax" classes="class1 class2" uri="../../../docs/user/rst/images/title.png" width="258">
<caption>
Plaintext markup syntax and parser system.
<legend>
<table>
<tgroup cols="2">
<colspec colwidth="12">
<colspec colwidth="47">
<tbody>
<row>
<entry>
<paragraph>
re
<entry>
<paragraph>
Revised, revisited, based on 're' module.
<row>
<entry>
<paragraph>
Structured
<entry>
<paragraph>
Structure-enhanced text, structuredtext.
<row>
<entry>
<paragraph>
Text
<entry>
<paragraph>
Well it is, isn't it?
<paragraph>
This paragraph is also part of the legend.
<paragraph>
A left-aligned figure:
<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">
<caption>
This is the caption.
<legend>
<paragraph>
This is the legend.
<paragraph>
The legend may consist of several paragraphs.
<paragraph>
This paragraph might flow around the figure.
<paragraph>
The specific behavior depends upon the style sheet and the browser or
rendering software used.
<paragraph>
A centered figure:
<figure align="center">
<image uri="../../../docs/user/rst/images/biohazard.png" width="40px">
<caption>
This is the caption.
<legend>
<paragraph>
This is the legend.
<paragraph>
The legend may consist of several paragraphs.
<paragraph>
This paragraph might flow around the figure.
<paragraph>
The specific behavior depends upon the style sheet and the browser or
rendering software used.
<paragraph>
A right-aligned figure:
<figure align="right">
<image uri="../../../docs/user/rst/images/biohazard.png" width="40px">
<caption>
This is the caption.
<legend>
<paragraph>
This is the legend.
<paragraph>
The legend may consist of several paragraphs.
<paragraph>
This paragraph might flow around the figure. The specific behavior depends
upon the style sheet and the browser or rendering software used.
<paragraph>
Tables may be given titles and additional arguments with the
<emphasis>
table
directive:
<table align="left">
<title>
left-aligned table
<tgroup cols="2">
<colspec colwidth="5">
<colspec colwidth="5">
<thead>
<row>
<entry>
<paragraph>
A
<entry>
<paragraph>
not A
<tbody>
<row>
<entry>
<paragraph>
False
<entry>
<paragraph>
True
<row>
<entry>
<paragraph>
True
<entry>
<paragraph>
False
<table align="center">
<title>
center-aligned table
<tgroup cols="2">
<colspec colwidth="5">
<colspec colwidth="5">
<thead>
<row>
<entry>
<paragraph>
A
<entry>
<paragraph>
not A
<tbody>
<row>
<entry>
<paragraph>
False
<entry>
<paragraph>
True
<row>
<entry>
<paragraph>
True
<entry>
<paragraph>
False
<table align="right">
<title>
right-aligned table
<tgroup cols="2">
<colspec colwidth="5">
<colspec colwidth="5">
<thead>
<row>
<entry>
<paragraph>
A
<entry>
<paragraph>
not A
<tbody>
<row>
<entry>
<paragraph>
False
<entry>
<paragraph>
True
<row>
<entry>
<paragraph>
True
<entry>
<paragraph>
False
<paragraph>
With the "widths" argument "auto" (or "class" value "colwidths-auto"),
column widths are determined by the backend (if supported by the
writer/backend).
<target refid="target1">
<target refid="target2">
<table classes="colwidths-auto" ids="target2 target1" names="target2 target1">
<tgroup cols="3">
<colspec colwidth="7">
<colspec colwidth="7">
<colspec colwidth="10">
<thead>
<row>
<entry>
<paragraph>
A
<entry>
<paragraph>
B
<entry>
<paragraph>
A or B
<tbody>
<row>
<entry>
<paragraph>
False
<entry>
<paragraph>
False
<entry>
<paragraph>
False
<row>
<entry>
<paragraph>
True
<entry>
<paragraph>
False
<entry>
<paragraph>
True
<row>
<entry>
<paragraph>
False
<entry>
<paragraph>
True
<entry>
<paragraph>
True
<row>
<entry>
<paragraph>
True
<entry>
<paragraph>
True
<entry>
<paragraph>
True
<section ids="admonitions" names="admonitions">
<title auto="1" refid="id76">
<generated classes="sectnum">
2.14.3
Admonitions
<attention>
<paragraph>
Directives at large.
<caution>
<paragraph>
Don't take any wooden nickels.
<danger>
<paragraph>
Mad scientist at work!
<error>
<paragraph>
Does not compute.
<hint>
<paragraph>
It's bigger than a bread box.
<important>
<bullet_list bullet="-">
<list_item>
<paragraph>
Wash behind your ears.
<list_item>
<paragraph>
Clean up your room.
<list_item>
<paragraph>
Call your mother.
<list_item>
<paragraph>
Back up your data.
<note>
<paragraph>
This is a note.
<tip>
<paragraph>
15% if the service is good.
<warning>
<paragraph>
Strong prose may provoke extreme mental exertion.
Reader discretion is strongly advised.
<admonition classes="admonition-and-by-the-way">
<title>
And, by the way...
<paragraph>
You can make up your own admonition too.
<target ids="docutils" names="docutils" refuri="http://docutils.sourceforge.net/">
<section ids="topics-sidebars-and-rubrics" names="topics,\ sidebars,\ and\ rubrics">
<title auto="1" refid="id77">
<generated classes="sectnum">
2.14.4
Topics, Sidebars, and Rubrics
<paragraph>
<emphasis>
Sidebars
are like miniature, parallel documents.
<sidebar>
<title>
Sidebar Title
<subtitle>
Optional Subtitle
<paragraph>
This is a sidebar. It is for text outside the flow of the main
text.
<rubric>
This is a rubric inside a sidebar
<paragraph>
Sidebars often appear beside the main text with a border and a different
background or font color.
<paragraph>
A
<emphasis>
topic
is like a block quote with a title, or a self-contained section
with no subsections.
<topic>
<title>
Topic Title
<paragraph>
This is a topic.
<paragraph>
A
<emphasis>
rubric
is like an informal heading that doesn't correspond to the
document's structure. It is typically highlighted in red (hence the name).
<rubric>
This is a rubric
<paragraph>
Topics and rubrics can be used at places where a
<reference name="section title" refid="section-title">
section title
is not
allowed (e.g. inside a directive).
<section ids="target-footnotes" names="target\ footnotes">
<title auto="1" refid="id78">
<generated classes="sectnum">
2.14.5
Target Footnotes
<footnote auto="1" backrefs="id26 id27 id28 id31" ids="id25" names="TARGET_NOTE:\ id25">
<label>
5
<paragraph>
<reference refuri="http://www.python.org/">
http://www.python.org/
<footnote auto="1" backrefs="id30" ids="id29" names="TARGET_NOTE:\ id29">
<label>
6
<paragraph>
<reference refuri="http://pygments.org/">
http://pygments.org/
<footnote auto="1" backrefs="id33" ids="id32" names="TARGET_NOTE:\ id32">
<label>
7
<paragraph>
<reference refuri="http://docutils.sourceforge.net/">
http://docutils.sourceforge.net/
<section ids="replacement-text" names="replacement\ text">
<title auto="1" refid="id79">
<generated classes="sectnum">
2.14.6
Replacement Text
<paragraph>
I recommend you try
<reference refuri="http://www.python.org/">
Python,
<emphasis>
the
best language around
<footnote_reference auto="1" ids="id28" refid="id25">
5
.
<substitution_definition names="Python">
Python,
<emphasis>
the
best language around
<section ids="compound-paragraph" names="compound\ paragraph">
<title auto="1" refid="id80">
<generated classes="sectnum">
2.14.7
Compound Paragraph
<paragraph>
The
<emphasis>
compound
directive is used to create a "compound paragraph", which
is a single logical paragraph containing multiple physical body
elements. For example:
<compound>
<paragraph>
The 'rm' command is very dangerous. If you are logged
in as root and enter
<literal_block xml:space="preserve">
cd /
rm -rf *
<paragraph>
you will erase the entire contents of your file system.
<paragraph>
Test the handling and display of compound paragraphs:
<compound classes="some-class">
<paragraph>
Compound 2, paragraph 1,
<paragraph>
compound 2, paragraph 2,
<bullet_list bullet="*">
<list_item>
<paragraph>
list item 1,
<list_item>
<paragraph>
list item 2,
<paragraph>
compound 2, paragraph 3.
<compound>
<paragraph>
Compound 3, only consisting of one paragraph.
<compound>
<literal_block xml:space="preserve">
Compound 4.
This one starts with a literal block.
<paragraph>
Compound 4, paragraph following the literal block.
<paragraph>
Now something
<emphasis>
really
perverted -- a nested compound block. This is
just to test that it works at all; the results don't have to be
meaningful.
<compound>
<paragraph>
Compound 5, block 1 (a paragraph).
<compound>
<paragraph>
Compound 6 is block 2 in compound 5.
<paragraph>
Compound 6, another paragraph.
<paragraph>
Compound 5, block 3 (a paragraph).
<compound>
<paragraph>
Compound 7, tests the inclusion of various block-level
elements in one logical paragraph. First a table,
<table>
<tgroup cols="3">
<colspec colwidth="20">
<colspec colwidth="20">
<colspec colwidth="20">
<tbody>
<row>
<entry>
<paragraph>
Left cell, first
paragraph.
<paragraph>
Left cell, second
paragraph.
<entry>
<paragraph>
Middle cell,
consisting of
exactly one
paragraph.
<entry>
<paragraph>
Right cell.
<paragraph>
Paragraph 2.
<paragraph>
Paragraph 3.
<paragraph>
followed by a paragraph. This physical paragraph is
actually a continuation of the paragraph before the table. It is followed
by
<block_quote>
<paragraph>
a quote and
<enumerated_list enumtype="arabic" prefix="" suffix=".">
<list_item>
<paragraph>
an enumerated list,
<paragraph>
a paragraph,
<option_list>
<option_list_item>
<option_group>
<option>
<option_string>
--an
<description>
<paragraph>
option list,
<paragraph>
a paragraph,
<field_list>
<field>
<field_name>
a field
<field_body>
<paragraph>
list,
<paragraph>
a paragraph,
<definition_list>
<definition_list_item>
<term>
a definition
<definition>
<paragraph>
list,
<paragraph>
a paragraph, an image:
<image uri="../../../docs/user/rst/images/biohazard.png">
<paragraph>
a paragraph,
<line_block>
<line>
a line
<line>
block,
<paragraph>
a paragraph followed by a comment,
<comment xml:space="preserve">
this is a comment
<paragraph>
a paragraph, a
<note>
<paragraph>
with content
<paragraph>
and the final paragraph of the compound 7.
<section ids="parsed-literal-blocks" names="parsed\ literal\ blocks">
<title auto="1" refid="id81">
<generated classes="sectnum">
2.14.8
Parsed Literal Blocks
<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
,
<strong>
strong
,
<literal>
literal
text
,
<subscript>
sub-
and
<superscript>
super
scripts,
inline formulas:
<math>
A = 2 \pi r^2
,
footnotes
<footnote_reference ids="id22" refid="id8">
1
,
<target ids="hyperlink-targets" names="hyperlink\ targets">
hyperlink targets
, and
<reference name="references" refuri="http://www.python.org/">
references
<target ids="references" names="references" refuri="http://www.python.org/">
.
<section ids="code" names="code">
<title auto="1" refid="id82">
<generated classes="sectnum">
2.14.9
Code
<paragraph>
Blocks of source code can be set with the
<title_reference>
code
directive. If the code
language is specified, the content is parsed and tagged by the
<reference name="Pygments" refuri="http://pygments.org/">
Pygments
<footnote_reference auto="1" ids="id30" refid="id29">
6
syntax highlighter and can be formatted with a style sheet. (Code parsing
is turned off using the
<literal>
syntax-highlight
config setting in the test
conversions in order to get identical results with/without installed
Pygments highlighter.)
<literal_block classes="code python" xml:space="preserve">
print 'This is Python code.'
<paragraph>
The
<literal>
:number-lines:
option (with optional start value) generates line
numbers:
<literal_block classes="code python" xml:space="preserve">
<inline classes="ln">
8
# print integers from 0 to 9:
<inline classes="ln">
9
for i in range(10):
<inline classes="ln">
10
print i
<paragraph>
For inline code snippets, there is the
<title_reference>
code
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>
Docutils uses LaTeX syntax for math directives and roles:
<literal classes="code tex">
\alpha = f(x)
prints
<math>
\alpha = f(x)
.
<paragraph>
The
<literal>
:code:
option of the
<title_reference>
include
directive sets the included content
as a code block, here the rst file
<literal>
header_footer.txt
with line numbers:
<literal_block classes="code rst" source="functional/input/data/header_footer.txt" xml:space="preserve">
<inline classes="ln">
1
.. header:: Document header
<inline classes="ln">
2
.. footer:: Document footer
<target ids="pygments" names="pygments" refuri="http://pygments.org/">
<section ids="substitution-definitions" names="substitution\ definitions">
<title auto="1" refid="id65">
<generated classes="sectnum">
2.15
Substitution Definitions
<paragraph>
An inline image (
<image alt="EXAMPLE" uri="../../../docs/user/rst/images/biohazard.png">
) example:
<substitution_definition names="EXAMPLE">
<image alt="EXAMPLE" uri="../../../docs/user/rst/images/biohazard.png">
<paragraph>
(Substitution definitions are not visible in the HTML source.)
<section ids="comments" names="comments">
<title auto="1" refid="id66">
<generated classes="sectnum">
2.16
Comments
<paragraph>
Here's one:
<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: ä ö ü æ ø å
<paragraph>
(View the HTML source to see the comment.)
<section ids="raw-text" names="raw\ text">
<title auto="1" refid="id67">
<generated classes="sectnum">
2.17
Raw text
<paragraph>
This does not necessarily look nice, because there may be missing white space.
<paragraph>
It's just there to freeze the behavior.
<raw format="html latex" xml:space="preserve">
A test.
<raw format="html latex" xml:space="preserve">
Second test.
<raw classes="myclass" format="html latex" xml:space="preserve">
Another test with myclass set.
<paragraph>
This is the
<raw classes="myrawroleclass" format="html latex" xml:space="preserve">
fourth test
with myrawroleclass set.
<raw format="html" xml:space="preserve">
Fifth test in HTML.<br />Line two.
<raw format="latex" xml:space="preserve">
Fifth test in LaTeX.\\Line two.
<section ids="container" names="container">
<title auto="1" refid="id68">
<generated classes="sectnum">
2.18
Container
<container classes="custom">
<paragraph>
paragraph 1
<paragraph>
paragraph 2
<section ids="colspanning-tables" names="colspanning\ tables">
<title auto="1" refid="id69">
<generated classes="sectnum">
2.19
Colspanning tables
<paragraph>
This table has a cell spanning two columns:
<table>
<tgroup cols="3">
<colspec colwidth="5">
<colspec colwidth="5">
<colspec colwidth="6">
<thead>
<row>
<entry morecols="1">
<paragraph>
Inputs
<entry>
<paragraph>
Output
<row>
<entry>
<paragraph>
A
<entry>
<paragraph>
B
<entry>
<paragraph>
A or B
<tbody>
<row>
<entry>
<paragraph>
False
<entry>
<paragraph>
False
<entry>
<paragraph>
False
<row>
<entry>
<paragraph>
True
<entry>
<paragraph>
False
<entry>
<paragraph>
True
<row>
<entry>
<paragraph>
False
<entry>
<paragraph>
True
<entry>
<paragraph>
True
<row>
<entry>
<paragraph>
True
<entry>
<paragraph>
True
<entry>
<paragraph>
True
<section ids="rowspanning-tables" names="rowspanning\ tables">
<title auto="1" refid="id70">
<generated classes="sectnum">
2.20
Rowspanning tables
<paragraph>
Here's a table with cells spanning several rows:
<table>
<tgroup cols="3">
<colspec colwidth="24">
<colspec colwidth="12">
<colspec colwidth="18">
<thead>
<row>
<entry>
<paragraph>
Header row, column 1
(header rows optional)
<entry>
<paragraph>
Header 2
<entry>
<paragraph>
Header 3
<tbody>
<row>
<entry>
<paragraph>
body row 1, column 1
<entry>
<paragraph>
column 2
<entry>
<paragraph>
column 3
<row>
<entry>
<paragraph>
body row 2
<entry morerows="1">
<paragraph>
Cells may
span rows.
<entry morerows="1">
<paragraph>
Another
rowspanning
cell.
<row>
<entry>
<paragraph>
body row 3
<section ids="complex-tables" names="complex\ tables">
<title auto="1" refid="id71">
<generated classes="sectnum">
2.21
Complex tables
<paragraph>
Here's a complex table, which should test all features.
<table>
<tgroup cols="4">
<colspec colwidth="24">
<colspec colwidth="12">
<colspec colwidth="10">
<colspec colwidth="10">
<thead>
<row>
<entry>
<paragraph>
Header row, column 1
(header rows optional)
<entry>
<paragraph>
Header 2
<entry>
<paragraph>
Header 3
<entry>
<paragraph>
Header 4
<tbody>
<row>
<entry>
<paragraph>
body row 1, column 1
<entry>
<paragraph>
column 2
<entry>
<paragraph>
column 3
<entry>
<paragraph>
column 4
<row>
<entry>
<paragraph>
body row 2
<entry morecols="2">
<paragraph>
Cells may span columns.
<row>
<entry>
<paragraph>
body row 3
<entry morerows="1">
<paragraph>
Cells may
span rows.
<paragraph>
Paragraph.
<entry morecols="1" morerows="1">
<bullet_list bullet="-">
<list_item>
<paragraph>
Table cells
<list_item>
<paragraph>
contain
<list_item>
<paragraph>
body elements.
<row>
<entry>
<paragraph>
body row 4
<row>
<entry>
<paragraph>
body row 5
<entry morecols="1">
<paragraph>
Cells may also be
empty:
<literal>
-->
<entry>
<section ids="list-tables" names="list\ tables">
<title auto="1" refid="id72">
<generated classes="sectnum">
2.22
List Tables
<paragraph>
Here's a list table exercising all features:
<table classes="colwidths-given test">
<title>
list table with integral header
<tgroup cols="3">
<colspec colwidth="10" stub="1">
<colspec colwidth="20">
<colspec colwidth="30">
<thead>
<row>
<entry>
<paragraph>
Treat
<entry>
<paragraph>
Quantity
<entry>
<paragraph>
Description
<tbody>
<row>
<entry>
<paragraph>
Albatross
<entry>
<paragraph>
2.99
<entry>
<paragraph>
On a stick!
<row>
<entry>
<paragraph>
Crunchy Frog
<entry>
<paragraph>
1.49
<entry>
<paragraph>
If we took the bones out, it wouldn't be
crunchy, now would it?
<row>
<entry>
<paragraph>
Gannet Ripple
<entry>
<paragraph>
1.99
<entry>
<paragraph>
On a stick!
<table align="center">
<title>
center aligned list table
<tgroup cols="2">
<colspec colwidth="50">
<colspec colwidth="50">
<tbody>
<row>
<entry>
<paragraph>
Albatross
<entry>
<paragraph>
2.99
<row>
<entry>
<paragraph>
Crunchy Frog
<entry>
<paragraph>
1.49
<row>
<entry>
<paragraph>
Gannet Ripple
<entry>
<paragraph>
1.99
<section ids="error-handling" names="error\ handling">
<title auto="1" refid="id73">
<generated classes="sectnum">
3
Error Handling
<paragraph>
Any errors caught during processing will generate system messages.
<paragraph>
There should be five messages in the following, auto-generated
section, "Docutils System Messages":
<comment xml:space="preserve">
section should be added by Docutils automatically
<section classes="system-messages">
<title>
Docutils System Messages
<system_message backrefs="id24" ids="id23" level="3" line="104" source="functional/input/data/standard.txt" type="ERROR">
<paragraph>
Undefined substitution referenced: "problematic".
<system_message backrefs="id17" ids="id83" level="3" line="391" source="functional/input/data/standard.txt" type="ERROR">
<paragraph>
Unknown target name: "5".
<system_message backrefs="id19" ids="id84" level="3" line="400" source="functional/input/data/standard.txt" type="ERROR">
<paragraph>
Unknown target name: "nonexistent".
<system_message backrefs="id86" ids="id85" level="3" line="427" source="functional/input/data/standard.txt" type="ERROR">
<paragraph>
Unknown target name: "hyperlink reference without a target".
<system_message backrefs="id88" ids="id87" level="3" line="440" source="functional/input/data/standard.txt" type="ERROR">
<paragraph>
Duplicate target name, cannot be used as a unique reference: "duplicate target names".
<system_message level="1" line="163" source="functional/input/data/standard.txt" type="INFO">
<paragraph>
Hyperlink target "target" is not referenced.
<system_message level="1" line="405" source="functional/input/data/standard.txt" type="INFO">
<paragraph>
Hyperlink target "another-target" is not referenced.
<system_message level="1" line="473" source="functional/input/data/standard.txt" type="INFO">
<paragraph>
Hyperlink target "image-target-1" is not referenced.
<system_message level="1" line="474" source="functional/input/data/standard.txt" type="INFO">
<paragraph>
Hyperlink target "image-target-2" is not referenced.
<system_message level="1" line="475" source="functional/input/data/standard.txt" type="INFO">
<paragraph>
Hyperlink target "image-target-3" is not referenced.
<system_message level="1" line="639" source="functional/input/data/standard.txt" type="INFO">
<paragraph>
Hyperlink target "target1" is not referenced.
<system_message level="1" line="640" source="functional/input/data/standard.txt" type="INFO">
<paragraph>
Hyperlink target "target2" is not referenced.
<system_message level="1" line="685" source="functional/input/data/standard.txt" type="INFO">
<paragraph>
Hyperlink target "docutils" is not referenced.
<system_message level="1" line="851" source="functional/input/data/standard.txt" type="INFO">
<paragraph>
Hyperlink target "hyperlink targets" is not referenced.
|