/usr/share/doc/docutils-doc/docs/ref/doctree.html is in docutils-doc 0.13.1+dfsg-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 | <?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.13.1: http://docutils.sourceforge.net/" />
<title>The Docutils Document Tree</title>
<meta name="author" content="David Goodger" />
<meta name="date" content="2015-04-20" />
<meta name="copyright" content="This document has been placed in the public domain." />
<link rel="stylesheet" href="../../css/html4css1.css" type="text/css" />
</head>
<body>
<div class="document" id="the-docutils-document-tree">
<h1 class="title">The Docutils Document Tree</h1>
<h2 class="subtitle" id="a-guide-to-the-docutils-dtd">A Guide to the Docutils DTD</h2>
<table class="docinfo" frame="void" rules="none">
<col class="docinfo-name" />
<col class="docinfo-content" />
<tbody valign="top">
<tr><th class="docinfo-name">Author:</th>
<td>David Goodger</td></tr>
<tr><th class="docinfo-name">Contact:</th>
<td><a class="first last reference external" href="mailto:docutils-develop@lists.sourceforge.net">docutils-develop@lists.sourceforge.net</a></td></tr>
<tr><th class="docinfo-name">Revision:</th>
<td>7882</td></tr>
<tr><th class="docinfo-name">Date:</th>
<td>2015-04-20</td></tr>
<tr><th class="docinfo-name">Copyright:</th>
<td>This document has been placed in the public domain.</td></tr>
</tbody>
</table>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#element-hierarchy" id="id190">Element Hierarchy</a></li>
<li><a class="reference internal" href="#element-reference" id="id191">Element Reference</a></li>
<li><a class="reference internal" href="#attribute-reference" id="id192">Attribute Reference</a></li>
<li><a class="reference internal" href="#parameter-entity-reference" id="id193">Parameter Entity Reference</a></li>
</ul>
</div>
<p>This document describes the XML data structure of <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> documents:
the relationships and semantics of elements and attributes. The
Docutils document structure is formally defined by the <a class="reference external" href="docutils.dtd">Docutils
Generic DTD</a> XML document type definition, <a class="reference external" href="docutils.dtd">docutils.dtd</a>, which is
the definitive source for details of element structural relationships.</p>
<p>This document does not discuss implementation details. Those can be
found in internal documentation (docstrings) for the
<tt class="docutils literal">docutils.nodes</tt> module, where the document tree data structure is
implemented in a class library.</p>
<p>The reader is assumed to have some familiarity with XML or SGML, and
an understanding of the data structure meaning of "tree". For a list
of introductory articles, see <a class="reference external" href="http://xml.coverpages.org/xmlIntro.html">Introducing the Extensible Markup
Language (XML)</a>.</p>
<p>The <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> markup is used for illustrative examples
throughout this document. For a gentle introduction, see <a class="reference external" href="../user/rst/quickstart.html">A
ReStructuredText Primer</a>. For complete technical details, see the
<a class="reference external" href="rst/restructuredtext.html">reStructuredText Markup Specification</a>.</p>
<div class="section" id="element-hierarchy">
<h1><a class="toc-backref" href="#id190">Element Hierarchy</a></h1>
<div class="contents local topic" id="id2">
<ul class="simple">
<li><a class="reference internal" href="#structural-elements" id="id194">Structural Elements</a><ul>
<li><a class="reference internal" href="#structural-subelements" id="id195">Structural Subelements</a><ul>
<li><a class="reference internal" href="#bibliographic-elements" id="id196">Bibliographic Elements</a></li>
<li><a class="reference internal" href="#decorative-elements" id="id197">Decorative Elements</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#body-elements" id="id198">Body Elements</a><ul>
<li><a class="reference internal" href="#simple-body-elements" id="id199">Simple Body Elements</a></li>
<li><a class="reference internal" href="#compound-body-elements" id="id200">Compound Body Elements</a><ul>
<li><a class="reference internal" href="#body-subelements" id="id201">Body Subelements</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#inline-elements" id="id202">Inline Elements</a></li>
</ul>
</div>
<p>Below is a simplified diagram of the hierarchy of elements in the
Docutils document tree structure. An element may contain any other
elements immediately below it in the diagram. Notes are written in
square brackets. Element types in parentheses indicate recursive or
one-to-many relationships; sections may contain (sub)sections, tables
contain further body elements, etc.</p>
<pre class="literal-block">
+--------------------------------------------------------------------+
| document [may begin with a title, subtitle, decoration, docinfo] |
| +--------------------------------------+
| | sections [each begins with a title] |
+-----------------------------+-------------------------+------------+
| [body elements:] | (sections) |
| | - literal | - lists | | - hyperlink +------------+
| | blocks | - tables | | targets |
| para- | - doctest | - block | foot- | - sub. defs |
| graphs | blocks | quotes | notes | - comments |
+---------+-----------+----------+-------+--------------+
| [text]+ | [text] | (body elements) | [text] |
| (inline +-----------+------------------+--------------+
| markup) |
+---------+
</pre>
<p>The Docutils document model uses a simple, recursive model for section
structure. A <a class="reference internal" href="#document">document</a> node may contain body elements and <a class="reference internal" href="#section">section</a>
elements. Sections in turn may contain body elements and sections.
The level (depth) of a section element is determined from its physical
nesting level; unlike other document models (<tt class="docutils literal"><h1></tt> in <a class="reference external" href="http://www.w3.org/MarkUp/">HTML</a>,
<tt class="docutils literal"><sect1></tt> in <a class="reference external" href="http://docbook.org/tdg/en/html/docbook.html">DocBook</a>, <tt class="docutils literal"><div1></tt> in <a class="reference external" href="http://www.w3.org/XML/1998/06/xmlspec-report.htm">XMLSpec</a>) the level is not
incorporated into the element name.</p>
<p>The Docutils document model uses strict element content models. Every
element has a unique structure and semantics, but elements may be
classified into general categories (below). Only elements which are
meant to directly contain text data have a mixed content model, where
text data and inline elements may be intermixed. This is unlike the
much looser <a class="reference external" href="http://www.w3.org/MarkUp/">HTML</a> document model, where paragraphs and text data may
occur at the same level.</p>
<div class="section" id="structural-elements">
<h2><a class="toc-backref" href="#id194">Structural Elements</a></h2>
<p>Structural elements may only contain child elements; they do not
directly contain text data. Structural elements may contain body
elements or further structural elements. Structural elements can only
be child elements of other structural elements.</p>
<p>Category members: <a class="reference internal" href="#document">document</a>, <a class="reference internal" href="#section">section</a>, <a class="reference internal" href="#topic">topic</a>, <a class="reference internal" href="#sidebar">sidebar</a></p>
<div class="section" id="structural-subelements">
<h3><a class="toc-backref" href="#id195">Structural Subelements</a></h3>
<p>Structural subelements are child elements of structural elements.
Simple structuctural subelements (<a class="reference internal" href="#title">title</a>, <a class="reference internal" href="#subtitle">subtitle</a>) contain text
data; the others are compound and do not directly contain text data.</p>
<p>Category members: <a class="reference internal" href="#title">title</a>, <a class="reference internal" href="#subtitle">subtitle</a>, <a class="reference internal" href="#decoration">decoration</a>, <a class="reference internal" href="#docinfo">docinfo</a>,
<a class="reference internal" href="#transition">transition</a></p>
<div class="section" id="bibliographic-elements">
<h4><a class="toc-backref" href="#id196">Bibliographic Elements</a></h4>
<p>The <a class="reference internal" href="#docinfo">docinfo</a> element is an optional child of <a class="reference internal" href="#document">document</a>. It groups
bibliographic elements together. All bibliographic elements except
<a class="reference internal" href="#authors">authors</a> and <a class="reference internal" href="#field">field</a> contain text data. <a class="reference internal" href="#authors">authors</a> contains further
bibliographic elements (most notably <a class="reference internal" href="#author">author</a>). <a class="reference internal" href="#field">field</a> contains
<a class="reference internal" href="#field-name">field_name</a> and <a class="reference internal" href="#field-body">field_body</a> body subelements.</p>
<p>Category members: <a class="reference internal" href="#address">address</a>, <a class="reference internal" href="#author">author</a>, <a class="reference internal" href="#authors">authors</a>, <a class="reference internal" href="#contact">contact</a>, <a class="reference internal" href="#copyright">copyright</a>,
<a class="reference internal" href="#date">date</a>, <a class="reference internal" href="#field">field</a>, <a class="reference internal" href="#organization">organization</a>, <a class="reference internal" href="#revision">revision</a>, <a class="reference internal" href="#status">status</a>, <a class="reference internal" href="#version">version</a></p>
</div>
<div class="section" id="decorative-elements">
<h4><a class="toc-backref" href="#id197">Decorative Elements</a></h4>
<p>The <a class="reference internal" href="#decoration">decoration</a> element is also an optional child of <a class="reference internal" href="#document">document</a>. It
groups together elements used to generate page headers and footers.</p>
<p>Category members: <a class="reference internal" href="#footer">footer</a>, <a class="reference internal" href="#header">header</a></p>
</div>
</div>
</div>
<div class="section" id="body-elements">
<h2><a class="toc-backref" href="#id198">Body Elements</a></h2>
<p>Body elements are contained within structural elements and compound
body elements. There are two subcategories of body elements: simple
and compound.</p>
<p>Category members: <a class="reference internal" href="#admonition">admonition</a>, <a class="reference internal" href="#attention">attention</a>, <a class="reference internal" href="#block-quote">block_quote</a>, <a class="reference internal" href="#bullet-list">bullet_list</a>,
<a class="reference internal" href="#caution">caution</a>, <a class="reference internal" href="#citation">citation</a>, <a class="reference internal" href="#comment">comment</a>, <a class="reference internal" href="#compound">compound</a>, <a class="reference internal" href="#container">container</a>, <a class="reference internal" href="#danger">danger</a>,
<a class="reference internal" href="#definition-list">definition_list</a>, <a class="reference internal" href="#doctest-block">doctest_block</a>, <a class="reference internal" href="#enumerated-list">enumerated_list</a>, <a class="reference internal" href="#error">error</a>,
<a class="reference internal" href="#field-list">field_list</a>, <a class="reference internal" href="#figure">figure</a>, <a class="reference internal" href="#footnote">footnote</a>, <a class="reference internal" href="#hint">hint</a>, <a class="reference internal" href="#image">image</a>, <a class="reference internal" href="#important">important</a>,
<a class="reference internal" href="#line-block">line_block</a>, <a class="reference internal" href="#literal-block">literal_block</a>, <a class="reference internal" href="#note">note</a>, <a class="reference internal" href="#option-list">option_list</a>, <a class="reference internal" href="#paragraph">paragraph</a>,
<a class="reference internal" href="#pending">pending</a>, <a class="reference internal" href="#raw">raw</a>, <a class="reference internal" href="#rubric">rubric</a>, <a class="reference internal" href="#substitution-definition">substitution_definition</a>, <a class="reference internal" href="#system-message">system_message</a>,
<a class="reference internal" href="#table">table</a>, <a class="reference internal" href="#target">target</a>, <a class="reference internal" href="#tip">tip</a>, <a class="reference internal" href="#warning">warning</a></p>
<div class="section" id="simple-body-elements">
<h3><a class="toc-backref" href="#id199">Simple Body Elements</a></h3>
<p>Simple body elements are empty or directly contain text data. Those
that contain text data may also contain inline elements. Such
elements therefore have a "mixed content model".</p>
<p>Category members: <a class="reference internal" href="#comment">comment</a>, <a class="reference internal" href="#doctest-block">doctest_block</a>, <a class="reference internal" href="#image">image</a>, <a class="reference internal" href="#literal-block">literal_block</a>,
<a class="reference internal" href="#math-block">math_block</a>, <a class="reference internal" href="#paragraph">paragraph</a>, <a class="reference internal" href="#pending">pending</a>, <a class="reference internal" href="#raw">raw</a>, <a class="reference internal" href="#rubric">rubric</a>, <a class="reference internal" href="#substitution-definition">substitution_definition</a>,
<a class="reference internal" href="#target">target</a></p>
</div>
<div class="section" id="compound-body-elements">
<h3><a class="toc-backref" href="#id200">Compound Body Elements</a></h3>
<p>Compound body elements contain local substructure (body subelements)
and further body elements. They do not directly contain text data.</p>
<p>Category members: <a class="reference internal" href="#admonition">admonition</a>, <a class="reference internal" href="#attention">attention</a>, <a class="reference internal" href="#block-quote">block_quote</a>, <a class="reference internal" href="#bullet-list">bullet_list</a>,
<a class="reference internal" href="#caution">caution</a>, <a class="reference internal" href="#citation">citation</a>, <a class="reference internal" href="#compound">compound</a>, <a class="reference internal" href="#container">container</a>, <a class="reference internal" href="#danger">danger</a>, <a class="reference internal" href="#definition-list">definition_list</a>,
<a class="reference internal" href="#enumerated-list">enumerated_list</a>, <a class="reference internal" href="#error">error</a>, <a class="reference internal" href="#field-list">field_list</a>, <a class="reference internal" href="#figure">figure</a>, <a class="reference internal" href="#footnote">footnote</a>, <a class="reference internal" href="#hint">hint</a>,
<a class="reference internal" href="#important">important</a>, line_block, <a class="reference internal" href="#note">note</a>, <a class="reference internal" href="#option-list">option_list</a>, <a class="reference internal" href="#system-message">system_message</a>, <a class="reference internal" href="#table">table</a>,
<a class="reference internal" href="#tip">tip</a>, <a class="reference internal" href="#warning">warning</a></p>
<div class="section" id="body-subelements">
<h4><a class="toc-backref" href="#id201">Body Subelements</a></h4>
<p>Compound body elements contain specific subelements (e.g. <a class="reference internal" href="#bullet-list">bullet_list</a>
contains <a class="reference internal" href="#list-item">list_item</a>). Subelements may themselves be compound elements
(containing further child elements, like <a class="reference internal" href="#field">field</a>) or simple data
elements (containing text data, like <a class="reference internal" href="#field-name">field_name</a>). These subelements
always occur within specific parent elements, never at the body
element level (beside paragraphs, etc.).</p>
<p>Category members (simple): <a class="reference internal" href="#attribution">attribution</a>, <a class="reference internal" href="#caption">caption</a>, <a class="reference internal" href="#classifier">classifier</a>,
<a class="reference internal" href="#colspec">colspec</a>, <a class="reference internal" href="#field-name">field_name</a>, <a class="reference internal" href="#label">label</a>, <a class="reference internal" href="#line">line</a>, <a class="reference internal" href="#option-argument">option_argument</a>,
<a class="reference internal" href="#option-string">option_string</a>, <a class="reference internal" href="#term">term</a></p>
<p>Category members (compound): <a class="reference internal" href="#definition">definition</a>, <a class="reference internal" href="#definition-list-item">definition_list_item</a>,
<a class="reference internal" href="#description">description</a>, <a class="reference internal" href="#entry">entry</a>, <a class="reference internal" href="#field">field</a>, <a class="reference internal" href="#field-body">field_body</a>, <a class="reference internal" href="#legend">legend</a>, <a class="reference internal" href="#list-item">list_item</a>,
<a class="reference internal" href="#option">option</a>, <a class="reference internal" href="#option-group">option_group</a>, <a class="reference internal" href="#option-list-item">option_list_item</a>, <a class="reference internal" href="#row">row</a>, <a class="reference internal" href="#tbody">tbody</a>, <a class="reference internal" href="#tgroup">tgroup</a>,
<a class="reference internal" href="#thead">thead</a></p>
</div>
</div>
</div>
<div class="section" id="inline-elements">
<h2><a class="toc-backref" href="#id202">Inline Elements</a></h2>
<p>Inline elements directly contain text data, and may also contain
further inline elements. Inline elements are contained within simple
body elements. Most inline elements have a "mixed content model".</p>
<p>Category members: <a class="reference internal" href="#abbreviation">abbreviation</a>, <a class="reference internal" href="#acronym">acronym</a>, <a class="reference internal" href="#citation-reference">citation_reference</a>,
<a class="reference internal" href="#emphasis">emphasis</a>, <a class="reference internal" href="#footnote-reference">footnote_reference</a>, <a class="reference internal" href="#generated">generated</a>, <a class="reference internal" href="#image">image</a>, <a class="reference internal" href="#inline">inline</a>, <a class="reference internal" href="#literal">literal</a>,
<a class="reference internal" href="#math">math</a>, <a class="reference internal" href="#problematic">problematic</a>, <a class="reference internal" href="#reference">reference</a>, <a class="reference internal" href="#strong">strong</a>, <a class="reference internal" href="#subscript">subscript</a>,
<a class="reference internal" href="#substitution-reference">substitution_reference</a>, <a class="reference internal" href="#superscript">superscript</a>, <a class="reference internal" href="#target">target</a>, <a class="reference internal" href="#title-reference">title_reference</a>, <a class="reference internal" href="#raw">raw</a></p>
</div>
</div>
<div class="section" id="element-reference">
<h1><a class="toc-backref" href="#id191">Element Reference</a></h1>
<div class="contents local topic" id="id3">
<ul class="simple">
<li><a class="reference internal" href="#abbreviation" id="id203"><tt class="docutils literal">abbreviation</tt></a></li>
<li><a class="reference internal" href="#acronym" id="id204"><tt class="docutils literal">acronym</tt></a></li>
<li><a class="reference internal" href="#address" id="id205"><tt class="docutils literal">address</tt></a></li>
<li><a class="reference internal" href="#admonition" id="id206"><tt class="docutils literal">admonition</tt></a></li>
<li><a class="reference internal" href="#attention" id="id207"><tt class="docutils literal">attention</tt></a></li>
<li><a class="reference internal" href="#attribution" id="id208"><tt class="docutils literal">attribution</tt></a></li>
<li><a class="reference internal" href="#author" id="id209"><tt class="docutils literal">author</tt></a></li>
<li><a class="reference internal" href="#authors" id="id210"><tt class="docutils literal">authors</tt></a></li>
<li><a class="reference internal" href="#block-quote" id="id211"><tt class="docutils literal">block_quote</tt></a></li>
<li><a class="reference internal" href="#bullet-list" id="id212"><tt class="docutils literal">bullet_list</tt></a></li>
<li><a class="reference internal" href="#caption" id="id213"><tt class="docutils literal">caption</tt></a></li>
<li><a class="reference internal" href="#caution" id="id214"><tt class="docutils literal">caution</tt></a></li>
<li><a class="reference internal" href="#citation" id="id215"><tt class="docutils literal">citation</tt></a></li>
<li><a class="reference internal" href="#citation-reference" id="id216"><tt class="docutils literal">citation_reference</tt></a></li>
<li><a class="reference internal" href="#classifier" id="id217"><tt class="docutils literal">classifier</tt></a></li>
<li><a class="reference internal" href="#colspec" id="id218"><tt class="docutils literal">colspec</tt></a></li>
<li><a class="reference internal" href="#comment" id="id219"><tt class="docutils literal">comment</tt></a></li>
<li><a class="reference internal" href="#compound" id="id220"><tt class="docutils literal">compound</tt></a></li>
<li><a class="reference internal" href="#contact" id="id221"><tt class="docutils literal">contact</tt></a></li>
<li><a class="reference internal" href="#container" id="id222"><tt class="docutils literal">container</tt></a></li>
<li><a class="reference internal" href="#copyright" id="id223"><tt class="docutils literal">copyright</tt></a></li>
<li><a class="reference internal" href="#danger" id="id224"><tt class="docutils literal">danger</tt></a></li>
<li><a class="reference internal" href="#date" id="id225"><tt class="docutils literal">date</tt></a></li>
<li><a class="reference internal" href="#decoration" id="id226"><tt class="docutils literal">decoration</tt></a></li>
<li><a class="reference internal" href="#definition" id="id227"><tt class="docutils literal">definition</tt></a></li>
<li><a class="reference internal" href="#definition-list" id="id228"><tt class="docutils literal">definition_list</tt></a></li>
<li><a class="reference internal" href="#definition-list-item" id="id229"><tt class="docutils literal">definition_list_item</tt></a></li>
<li><a class="reference internal" href="#description" id="id230"><tt class="docutils literal">description</tt></a></li>
<li><a class="reference internal" href="#docinfo" id="id231"><tt class="docutils literal">docinfo</tt></a></li>
<li><a class="reference internal" href="#doctest-block" id="id232"><tt class="docutils literal">doctest_block</tt></a></li>
<li><a class="reference internal" href="#document" id="id233"><tt class="docutils literal">document</tt></a></li>
<li><a class="reference internal" href="#emphasis" id="id234"><tt class="docutils literal">emphasis</tt></a></li>
<li><a class="reference internal" href="#entry" id="id235"><tt class="docutils literal">entry</tt></a></li>
<li><a class="reference internal" href="#enumerated-list" id="id236"><tt class="docutils literal">enumerated_list</tt></a></li>
<li><a class="reference internal" href="#error" id="id237"><tt class="docutils literal">error</tt></a></li>
<li><a class="reference internal" href="#field" id="id238"><tt class="docutils literal">field</tt></a></li>
<li><a class="reference internal" href="#field-body" id="id239"><tt class="docutils literal">field_body</tt></a></li>
<li><a class="reference internal" href="#field-list" id="id240"><tt class="docutils literal">field_list</tt></a></li>
<li><a class="reference internal" href="#field-name" id="id241"><tt class="docutils literal">field_name</tt></a></li>
<li><a class="reference internal" href="#figure" id="id242"><tt class="docutils literal">figure</tt></a></li>
<li><a class="reference internal" href="#footer" id="id243"><tt class="docutils literal">footer</tt></a></li>
<li><a class="reference internal" href="#footnote" id="id244"><tt class="docutils literal">footnote</tt></a></li>
<li><a class="reference internal" href="#footnote-reference" id="id245"><tt class="docutils literal">footnote_reference</tt></a></li>
<li><a class="reference internal" href="#generated" id="id246"><tt class="docutils literal">generated</tt></a></li>
<li><a class="reference internal" href="#header" id="id247"><tt class="docutils literal">header</tt></a></li>
<li><a class="reference internal" href="#hint" id="id248"><tt class="docutils literal">hint</tt></a></li>
<li><a class="reference internal" href="#image" id="id249"><tt class="docutils literal">image</tt></a></li>
<li><a class="reference internal" href="#important" id="id250"><tt class="docutils literal">important</tt></a></li>
<li><a class="reference internal" href="#inline" id="id251"><tt class="docutils literal">inline</tt></a></li>
<li><a class="reference internal" href="#label" id="id252"><tt class="docutils literal">label</tt></a></li>
<li><a class="reference internal" href="#legend" id="id253"><tt class="docutils literal">legend</tt></a></li>
<li><a class="reference internal" href="#line" id="id254"><tt class="docutils literal">line</tt></a></li>
<li><a class="reference internal" href="#line-block" id="id255"><tt class="docutils literal">line_block</tt></a></li>
<li><a class="reference internal" href="#list-item" id="id256"><tt class="docutils literal">list_item</tt></a></li>
<li><a class="reference internal" href="#literal" id="id257"><tt class="docutils literal">literal</tt></a></li>
<li><a class="reference internal" href="#literal-block" id="id258"><tt class="docutils literal">literal_block</tt></a></li>
<li><a class="reference internal" href="#math" id="id259"><tt class="docutils literal">math</tt></a></li>
<li><a class="reference internal" href="#math-block" id="id260"><tt class="docutils literal">math_block</tt></a></li>
<li><a class="reference internal" href="#note" id="id261"><tt class="docutils literal">note</tt></a></li>
<li><a class="reference internal" href="#option" id="id262"><tt class="docutils literal">option</tt></a></li>
<li><a class="reference internal" href="#option-argument" id="id263"><tt class="docutils literal">option_argument</tt></a></li>
<li><a class="reference internal" href="#option-group" id="id264"><tt class="docutils literal">option_group</tt></a></li>
<li><a class="reference internal" href="#option-list" id="id265"><tt class="docutils literal">option_list</tt></a></li>
<li><a class="reference internal" href="#option-list-item" id="id266"><tt class="docutils literal">option_list_item</tt></a></li>
<li><a class="reference internal" href="#option-string" id="id267"><tt class="docutils literal">option_string</tt></a></li>
<li><a class="reference internal" href="#organization" id="id268"><tt class="docutils literal">organization</tt></a></li>
<li><a class="reference internal" href="#paragraph" id="id269"><tt class="docutils literal">paragraph</tt></a></li>
<li><a class="reference internal" href="#pending" id="id270"><tt class="docutils literal">pending</tt></a></li>
<li><a class="reference internal" href="#problematic" id="id271"><tt class="docutils literal">problematic</tt></a></li>
<li><a class="reference internal" href="#raw" id="id272"><tt class="docutils literal">raw</tt></a></li>
<li><a class="reference internal" href="#reference" id="id273"><tt class="docutils literal">reference</tt></a></li>
<li><a class="reference internal" href="#revision" id="id274"><tt class="docutils literal">revision</tt></a></li>
<li><a class="reference internal" href="#row" id="id275"><tt class="docutils literal">row</tt></a></li>
<li><a class="reference internal" href="#rubric" id="id276"><tt class="docutils literal">rubric</tt></a></li>
<li><a class="reference internal" href="#section" id="id277"><tt class="docutils literal">section</tt></a></li>
<li><a class="reference internal" href="#sidebar" id="id278"><tt class="docutils literal">sidebar</tt></a></li>
<li><a class="reference internal" href="#status" id="id279"><tt class="docutils literal">status</tt></a></li>
<li><a class="reference internal" href="#strong" id="id280"><tt class="docutils literal">strong</tt></a></li>
<li><a class="reference internal" href="#subscript" id="id281"><tt class="docutils literal">subscript</tt></a></li>
<li><a class="reference internal" href="#substitution-definition" id="id282"><tt class="docutils literal">substitution_definition</tt></a></li>
<li><a class="reference internal" href="#substitution-reference" id="id283"><tt class="docutils literal">substitution_reference</tt></a></li>
<li><a class="reference internal" href="#subtitle" id="id284"><tt class="docutils literal">subtitle</tt></a></li>
<li><a class="reference internal" href="#superscript" id="id285"><tt class="docutils literal">superscript</tt></a></li>
<li><a class="reference internal" href="#system-message" id="id286"><tt class="docutils literal">system_message</tt></a></li>
<li><a class="reference internal" href="#table" id="id287"><tt class="docutils literal">table</tt></a></li>
<li><a class="reference internal" href="#target" id="id288"><tt class="docutils literal">target</tt></a></li>
<li><a class="reference internal" href="#tbody" id="id289"><tt class="docutils literal">tbody</tt></a></li>
<li><a class="reference internal" href="#term" id="id290"><tt class="docutils literal">term</tt></a></li>
<li><a class="reference internal" href="#tgroup" id="id291"><tt class="docutils literal">tgroup</tt></a></li>
<li><a class="reference internal" href="#thead" id="id292"><tt class="docutils literal">thead</tt></a></li>
<li><a class="reference internal" href="#tip" id="id293"><tt class="docutils literal">tip</tt></a></li>
<li><a class="reference internal" href="#id164" id="id294"><tt class="docutils literal">title</tt></a></li>
<li><a class="reference internal" href="#title-reference" id="id295"><tt class="docutils literal">title_reference</tt></a></li>
<li><a class="reference internal" href="#topic" id="id296"><tt class="docutils literal">topic</tt></a></li>
<li><a class="reference internal" href="#transition" id="id297"><tt class="docutils literal">transition</tt></a></li>
<li><a class="reference internal" href="#version" id="id298"><tt class="docutils literal">version</tt></a></li>
<li><a class="reference internal" href="#warning" id="id299"><tt class="docutils literal">warning</tt></a></li>
</ul>
</div>
<p>Each element in the DTD (document type definition) is described in its
own section below. Each section contains an introduction plus the
following subsections:</p>
<ul>
<li><p class="first">Details (of element relationships and semantics):</p>
<ul class="simple">
<li>Category: One or more references to the element categories in
<a class="reference internal" href="#element-hierarchy">Element Hierarchy</a> above. Some elements belong to more than one
category.</li>
<li>Parents: A list of elements which may contain the element.</li>
<li>Children: A list of elements which may occur within the element.</li>
<li>Analogues: Describes analogous elements in well-known document
models such as <a class="reference external" href="http://www.w3.org/MarkUp/">HTML</a> or <a class="reference external" href="http://docbook.org/tdg/en/html/docbook.html">DocBook</a>. Lists similarities and
differences.</li>
<li>Processing: Lists formatting or rendering recommendations for the
element.</li>
</ul>
</li>
<li><p class="first">Content Model:</p>
<p>The formal XML content model from the <a class="reference external" href="docutils.dtd">Docutils DTD</a>, followed by:</p>
<ul class="simple">
<li>Attributes: Describes (or refers to descriptions of) the possible
values and semantics of each attribute.</li>
<li>Parameter Entities: Lists the parameter entities which directly or
indirectly include the element.</li>
</ul>
</li>
<li><p class="first">Examples: <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> examples are shown along with
fragments of the document trees resulting from parsing.
<span class="target" id="pseudo-xml">Pseudo-XML</span> is used for the results of parsing and processing.
Pseudo-XML is a representation of XML where nesting is indicated by
indentation and end-tags are not shown. Some of the precision of
real XML is given up in exchange for easier readability. For
example, the following are equivalent:</p>
<ul>
<li><p class="first">Real XML:</p>
<pre class="literal-block">
<document>
<section ids="a-title" names="a title">
<title>A Title</title>
<paragraph>A paragraph.</paragraph>
</section>
</document>
</pre>
</li>
<li><p class="first">Pseudo-XML:</p>
<pre class="literal-block">
<document>
<section ids="a-title" names="a title">
<title>
A Title
<paragraph>
A paragraph.
</pre>
</li>
</ul>
</li>
</ul>
<hr class="docutils" />
<p>Many of the element reference sections below are marked "<span class="target" id="to-be-completed">to be
completed</span>". Please help complete this document by contributing to
its writing.</p>
<div class="section" id="abbreviation">
<h2><a class="toc-backref" href="#id203"><tt class="docutils literal">abbreviation</tt></a></h2>
<p>The <tt class="docutils literal">abbreviation</tt> element is an inline element used to represent an
abbreviation being used in the document. An example of an abbreviation is 'St'
being used instead of 'Street'.</p>
<div class="section" id="details">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#inline-elements">Inline Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the %inline.elements; parameter entities in their
content models may contain <tt class="docutils literal">abbreviation</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">abbreviation</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">abbreviation</tt> is analogous to the HTML "abbr" element.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="content-model">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">abbreviation</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="examples">
<h3>Examples</h3>
<p>The <tt class="docutils literal">abbreviation</tt> element is not exposed in default restructured text. It
can only be accessed through custom roles.</p>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> example from a custom <span class="incremental">:abbr:</span> role:</p>
<pre class="literal-block">
<paragraph>
<abbreviation explanation="Street">
St
is a common abbreviation for "street".
</pre>
</div>
</div>
<div class="section" id="acronym">
<h2><a class="toc-backref" href="#id204"><tt class="docutils literal">acronym</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="address">
<h2><a class="toc-backref" href="#id205"><tt class="docutils literal">address</tt></a></h2>
<p>The <tt class="docutils literal">address</tt> element holds the surface mailing address information
for the author (individual or group) of the document, or a third-party
contact address. Its structure is identical to that of the
<a class="reference internal" href="#literal-block">literal_block</a> element: whitespace is significant, especially
newlines.</p>
<div class="section" id="id4">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><p class="first"><a class="reference internal" href="#bibliographic-elements">Bibliographic Elements</a></p>
</td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body"><p class="first">The following elements may contain <tt class="docutils literal">address</tt>: <a class="reference internal" href="#docinfo">docinfo</a>, <a class="reference internal" href="#authors">authors</a></p>
</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><p class="first"><tt class="docutils literal">address</tt> elements contain text data plus <a class="reference internal" href="#inline-elements">inline elements</a>.</p>
</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><p class="first"><tt class="docutils literal">address</tt> is analogous to the DocBook "address" element.</p>
</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body"><p class="first">As with the <a class="reference internal" href="#literal-block">literal_block</a> element, newlines and other whitespace
is significant and must be preserved. However, a monospaced
typeface need not be used.</p>
<p class="last">See also <a class="reference internal" href="#docinfo">docinfo</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id5">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">address</tt> element contains the <a class="reference internal" href="#common-attributes">common attributes</a> (<a class="reference internal" href="#ids">ids</a>,
<a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>), plus <a class="reference internal" href="#xml-space">xml:space</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id187">%bibliographic.elements;</a> parameter entity directly includes
<tt class="docutils literal">address</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id6">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Document Title
==============
:Address: 123 Example Ave.
Example, EX
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms:</p>
<pre class="literal-block">
<document ids="document-title" names="document title">
<title>
Document Title
<docinfo>
<address>
123 Example Ave.
Example, EX
</pre>
<p>See <a class="reference internal" href="#docinfo">docinfo</a> for a more complete example, including processing
context.</p>
</div>
</div>
<div class="section" id="admonition">
<h2><a class="toc-backref" href="#id206"><tt class="docutils literal">admonition</tt></a></h2>
<p>This element is a generic, titled admonition. Also see the specific
admonition elements Docutils offers (in alphabetical order): <a class="reference internal" href="#caution">caution</a>,
<a class="reference internal" href="#danger">danger</a>, <a class="reference internal" href="#error">error</a>, <a class="reference internal" href="#hint">hint</a>, <a class="reference internal" href="#important">important</a>, <a class="reference internal" href="#note">note</a>, <a class="reference internal" href="#tip">tip</a>, <a class="reference internal" href="#warning">warning</a>.</p>
<div class="section" id="id7">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id188">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">admonition</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">admonition</tt> elements begin with a <a class="reference internal" href="#title">title</a> and may contain one or
more <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">admonition</tt> has no direct analogues in common DTDs. It can be
emulated with primitives and type effects.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Rendered distinctly (inset and/or in a box, etc.).</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id8">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#title">title</a>, (<a class="reference internal" href="#id188">%body.elements;</a>)+)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">admonition</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id188">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">admonition</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">admonition</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id9">
<h3>Examples</h3>
<p>reStructuredText source:</p>
<pre class="literal-block">
.. admonition:: And, by the way...
You can make up your own admonition too.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<admonition class="admonition-and-by-the-way">
<title>
And, by the way...
<paragraph>
You can make up your own admonition too.
</pre>
</div>
</div>
<div class="section" id="attention">
<h2><a class="toc-backref" href="#id207"><tt class="docutils literal">attention</tt></a></h2>
<p>The <tt class="docutils literal">attention</tt> element is an admonition, a distinctive and
self-contained notice. Also see the other admonition elements
Docutils offers (in alphabetical order): <a class="reference internal" href="#caution">caution</a>, <a class="reference internal" href="#danger">danger</a>, <a class="reference internal" href="#error">error</a>,
<a class="reference internal" href="#hint">hint</a>, <a class="reference internal" href="#important">important</a>, <a class="reference internal" href="#note">note</a>, <a class="reference internal" href="#tip">tip</a>, <a class="reference internal" href="#warning">warning</a>, and the generic <a class="reference internal" href="#admonition">admonition</a>.</p>
<div class="section" id="id10">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id188">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">attention</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">attention</tt> elements contain one or more <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">attention</tt> has no direct analogues in common DTDs. It can be
emulated with primitives and type effects.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Rendered distinctly (inset and/or in a box, etc.), with the
generated title "Attention!" (or similar).</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id11">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id188">%body.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">attention</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id188">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">attention</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">attention</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id12">
<h3>Examples</h3>
<p>reStructuredText source:</p>
<pre class="literal-block">
.. Attention:: All your base are belong to us.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<attention>
<paragraph>
All your base are belong to us.
</pre>
</div>
</div>
<div class="section" id="attribution">
<h2><a class="toc-backref" href="#id208"><tt class="docutils literal">attribution</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="author">
<h2><a class="toc-backref" href="#id209"><tt class="docutils literal">author</tt></a></h2>
<p>The <tt class="docutils literal">author</tt> element holds the name of the author of the document.</p>
<div class="section" id="id13">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#bibliographic-elements">Bibliographic Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">The following elements may contain <tt class="docutils literal">author</tt>: <a class="reference internal" href="#docinfo">docinfo</a>, <a class="reference internal" href="#authors">authors</a></td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">author</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">author</tt> is analogous to the DocBook "author" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#docinfo">docinfo</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id14">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">author</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id187">%bibliographic.elements;</a> parameter entity directly includes
<tt class="docutils literal">author</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id15">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Document Title
==============
:Author: J. Random Hacker
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms:</p>
<pre class="literal-block">
<document ids="document-title" names="document title">
<title>
Document Title
<docinfo>
<author>
J. Random Hacker
</pre>
<p>See <a class="reference internal" href="#docinfo">docinfo</a> for a more complete example, including processing
context.</p>
</div>
</div>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#id210"><tt class="docutils literal">authors</tt></a></h2>
<p>The <tt class="docutils literal">authors</tt> element is a container for author information for
documents with multiple authors.</p>
<div class="section" id="id16">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#bibliographic-elements">Bibliographic Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#docinfo">docinfo</a> element contains <tt class="docutils literal">authors</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">authors</tt> elements may contain the following elements: <a class="reference internal" href="#author">author</a>,
<a class="reference internal" href="#organization">organization</a>, <a class="reference internal" href="#address">address</a>, <a class="reference internal" href="#contact">contact</a></td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">authors</tt> is analogous to the DocBook "authors" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#docinfo">docinfo</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id17">
<h3>Content Model</h3>
<pre class="literal-block">
((<a class="reference internal" href="#author">author</a>, <a class="reference internal" href="#organization">organization</a>?, <a class="reference internal" href="#address">address</a>?, <a class="reference internal" href="#contact">contact</a>?)+)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">authors</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id187">%bibliographic.elements;</a> parameter entity directly includes
<tt class="docutils literal">authors</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id18">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Document Title
==============
:Authors: J. Random Hacker; Jane Doe
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms:</p>
<pre class="literal-block">
<document ids="document-title" names="document title">
<title>
Document Title
<docinfo>
<authors>
<author>
J. Random Hacker
<author>
Jane Doe
</pre>
<p>In reStructuredText, multiple author's names are separated with
semicolons (";") or commas (","); semicolons take precedence. There
is currently no way to represent the author's organization, address,
or contact in a reStructuredText "Authors" field.</p>
<p>See <a class="reference internal" href="#docinfo">docinfo</a> for a more complete example, including processing
context.</p>
</div>
</div>
<div class="section" id="block-quote">
<h2><a class="toc-backref" href="#id211"><tt class="docutils literal">block_quote</tt></a></h2>
<p>The <tt class="docutils literal">block_quote</tt> element is used for quotations set off from the
main text (standalone).</p>
<div class="section" id="id19">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id188">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">block_quote</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">block_quote</tt> elements contain <a class="reference internal" href="#body-elements">body elements</a> followed by an
optional <a class="reference internal" href="#attribution">attribution</a> element.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">block_quote</tt> is analogous to the "blockquote" element in both
HTML and DocBook.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body"><tt class="docutils literal">block_quote</tt> elements serve to set their contents off from the
main text, typically with indentation and/or other decoration.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id20">
<h3>Content Model</h3>
<pre class="literal-block">
((<a class="reference internal" href="#id188">%body.elements;</a>)+, <a class="reference internal" href="#attribution">attribution</a>?)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">block_quote</tt> element contains only the <a class="reference internal" href="#common-attributes">common
attributes</a>: <a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id188">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">block_quote</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">block_quote</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id21">
<h3>Examples</h3>
<p>reStructuredText source:</p>
<pre class="literal-block">
As a great paleontologist once said,
This theory, that is mine, is mine.
-- Anne Elk (Miss)
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<paragraph>
As a great paleontologist once said,
<block_quote>
<paragraph>
This theory, that is mine, is mine.
<attribution>
Anne Elk (Miss)
</pre>
</div>
</div>
<div class="section" id="bullet-list">
<h2><a class="toc-backref" href="#id212"><tt class="docutils literal">bullet_list</tt></a></h2>
<p>The <tt class="docutils literal">bullet_list</tt> element contains <a class="reference internal" href="#list-item">list_item</a> elements which are
uniformly marked with bullets. Bullets are typically simple dingbats
(symbols) such as circles and squares.</p>
<div class="section" id="id22">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id188">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">bullet_list</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">bullet_list</tt> elements contain one or more <a class="reference internal" href="#list-item">list_item</a> elements.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">bullet_list</tt> is analogous to the HTML "ul" element and to the
DocBook "itemizedlist" element. HTML's "ul" is short for
"unordered list", which we consider to be a misnomer. "Unordered"
implies that the list items may be randomly rearranged without
affecting the meaning of the list. Bullet lists <em>are</em> often
ordered; the ordering is simply left implicit.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Each list item should begin a new vertical block, prefaced by a
bullet/dingbat.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id23">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#list-item">list_item</a> +)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body"><p class="first">The <tt class="docutils literal">bullet_list</tt> element contains the <a class="reference internal" href="#common-attributes">common attributes</a>
(<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>), plus <a class="reference internal" href="#bullet">bullet</a>.</p>
<p><tt class="docutils literal">bullet</tt> is used to record the style of bullet from the input
data. In documents processed from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a>, it contains
one of "-", "+", or "*". It may be ignored in processing.</p>
</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body"><p class="first last">The <a class="reference internal" href="#id188">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">bullet_list</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">bullet_list</tt>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id24">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
- Item 1, paragraph 1.
Item 1, paragraph 2.
- Item 2.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<bullet_list bullet="-">
<list_item>
<paragraph>
Item 1, paragraph 1.
<paragraph>
Item 1, paragraph 2.
<list_item>
<paragraph>
Item 2.
</pre>
<p>See <a class="reference internal" href="#list-item">list_item</a> for another example.</p>
</div>
</div>
<div class="section" id="caption">
<h2><a class="toc-backref" href="#id213"><tt class="docutils literal">caption</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="caution">
<h2><a class="toc-backref" href="#id214"><tt class="docutils literal">caution</tt></a></h2>
<p>The <tt class="docutils literal">caution</tt> element is an admonition, a distinctive and
self-contained notice. Also see the other admonition elements
Docutils offers (in alphabetical order): <a class="reference internal" href="#attention">attention</a>, <a class="reference internal" href="#danger">danger</a>, <a class="reference internal" href="#error">error</a>,
<a class="reference internal" href="#hint">hint</a>, <a class="reference internal" href="#important">important</a>, <a class="reference internal" href="#note">note</a>, <a class="reference internal" href="#tip">tip</a>, <a class="reference internal" href="#warning">warning</a>, and the generic <a class="reference internal" href="#admonition">admonition</a>.</p>
<div class="section" id="id25">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id188">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">caution</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">caution</tt> elements contain one or more <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">caution</tt> is analogous to the DocBook "caution" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Rendered distinctly (inset and/or in a box, etc.), with the
generated title "Caution" (or similar).</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id26">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id188">%body.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">caution</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id188">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">caution</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">caution</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id27">
<h3>Examples</h3>
<p>reStructuredText source:</p>
<pre class="literal-block">
.. Caution:: Don't take any wooden nickels.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<caution>
<paragraph>
Don't take any wooden nickels.
</pre>
</div>
</div>
<div class="section" id="citation">
<h2><a class="toc-backref" href="#id215"><tt class="docutils literal">citation</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="citation-reference">
<h2><a class="toc-backref" href="#id216"><tt class="docutils literal">citation_reference</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="classifier">
<h2><a class="toc-backref" href="#id217"><tt class="docutils literal">classifier</tt></a></h2>
<p>The <tt class="docutils literal">classifier</tt> element contains the classification or type of the
<a class="reference internal" href="#term">term</a> being defined in a <a class="reference internal" href="#definition-list">definition_list</a>. For example, it can be
used to indicate the type of a variable.</p>
<div class="section" id="id28">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a> (simple)</td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#definition-list-item">definition_list_item</a> element contains <tt class="docutils literal">classifier</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">classifier</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">classifier</tt> has no direct analogues in common DTDs. It can be
emulated with primitives or type effects.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#definition-list-item">definition_list_item</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id29">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">classifier</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id30">
<h3>Examples</h3>
<p>Here is a hypothetical data dictionary. <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
name : string
Customer name.
i : int
Temporary index variable.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<definition_list>
<definition_list_item>
<term>
name
<classifier>
string
<definition>
<paragraph>
Customer name.
<definition_list_item>
<term>
i
<classifier>
int
<definition>
<paragraph>
Temporary index variable.
</pre>
</div>
</div>
<div class="section" id="colspec">
<h2><a class="toc-backref" href="#id218"><tt class="docutils literal">colspec</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="comment">
<h2><a class="toc-backref" href="#id219"><tt class="docutils literal">comment</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="compound">
<h2><a class="toc-backref" href="#id220"><tt class="docutils literal">compound</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="contact">
<h2><a class="toc-backref" href="#id221"><tt class="docutils literal">contact</tt></a></h2>
<p>The <tt class="docutils literal">contact</tt> element holds contact information for the author
(individual or group) of the document, or a third-party contact. It
is typically used for an email or web address.</p>
<div class="section" id="id31">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#bibliographic-elements">Bibliographic Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">The following elements may contain <tt class="docutils literal">contact</tt>: <a class="reference internal" href="#docinfo">docinfo</a>, <a class="reference internal" href="#authors">authors</a></td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">contact</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline
elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">contact</tt> is analogous to the DocBook "email" element. The HTML
"address" element serves a similar purpose.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#docinfo">docinfo</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id32">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">contact</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id187">%bibliographic.elements;</a> parameter entity directly includes
<tt class="docutils literal">contact</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id33">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Document Title
==============
:Contact: jrh@example.com
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms:</p>
<pre class="literal-block">
<document ids="document-title" names="document title">
<title>
Document Title
<docinfo>
<contact>
<reference refuri="mailto:jrh@example.com">
jrh@example.com
</pre>
<p>See <a class="reference internal" href="#docinfo">docinfo</a> for a more complete example, including processing
context.</p>
</div>
</div>
<div class="section" id="container">
<h2><a class="toc-backref" href="#id222"><tt class="docutils literal">container</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="copyright">
<h2><a class="toc-backref" href="#id223"><tt class="docutils literal">copyright</tt></a></h2>
<p>The <tt class="docutils literal">copyright</tt> element contains the document's copyright statement.</p>
<div class="section" id="id34">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#bibliographic-elements">Bibliographic Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#docinfo">docinfo</a> element contains <tt class="docutils literal">copyright</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">copyright</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline
elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">copyright</tt> is analogous to the DocBook "copyright" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#docinfo">docinfo</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id35">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">copyright</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id187">%bibliographic.elements;</a> parameter entity directly includes
<tt class="docutils literal">copyright</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id36">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Document Title
==============
:Copyright: This document has been placed in the public domain.
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms:</p>
<pre class="literal-block">
<document ids="document-title" names="document title">
<title>
Document Title
<docinfo>
<copyright>
This document has been placed in the public domain.
</pre>
<p>See <a class="reference internal" href="#docinfo">docinfo</a> for a more complete example, including processing
context.</p>
</div>
</div>
<div class="section" id="danger">
<h2><a class="toc-backref" href="#id224"><tt class="docutils literal">danger</tt></a></h2>
<p>The <tt class="docutils literal">danger</tt> element is an admonition, a distinctive and
self-contained notice. Also see the other admonition elements
Docutils offers (in alphabetical order): <a class="reference internal" href="#attention">attention</a>, <a class="reference internal" href="#caution">caution</a>, <a class="reference internal" href="#error">error</a>,
<a class="reference internal" href="#hint">hint</a>, <a class="reference internal" href="#important">important</a>, <a class="reference internal" href="#note">note</a>, <a class="reference internal" href="#tip">tip</a>, <a class="reference internal" href="#warning">warning</a>, and the generic <a class="reference internal" href="#admonition">admonition</a>.</p>
<div class="section" id="id37">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id188">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">danger</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">danger</tt> elements contain one or more <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">danger</tt> has no direct analogues in common DTDs. It can be
emulated with primitives and type effects.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Rendered distinctly (inset and/or in a box, etc.), with the
generated title "!DANGER!" (or similar).</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id38">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id188">%body.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">danger</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id188">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">danger</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">danger</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id39">
<h3>Examples</h3>
<p>reStructuredText source:</p>
<pre class="literal-block">
.. DANGER:: Mad scientist at work!
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<danger>
<paragraph>
Mad scientist at work!
</pre>
</div>
</div>
<div class="section" id="date">
<h2><a class="toc-backref" href="#id225"><tt class="docutils literal">date</tt></a></h2>
<p>The <tt class="docutils literal">date</tt> element contains the date of publication, release, or
last modification of the document.</p>
<div class="section" id="id40">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#bibliographic-elements">Bibliographic Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#docinfo">docinfo</a> element contains <tt class="docutils literal">date</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">date</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">date</tt> is analogous to the DocBook "date" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Often used with the RCS/CVS keyword "Date". See <a class="reference internal" href="#docinfo">docinfo</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id41">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">date</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id187">%bibliographic.elements;</a> parameter entity directly includes
<tt class="docutils literal">date</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id42">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Document Title
==============
:Date: 2002-08-20
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms:</p>
<pre class="literal-block">
<document ids="document-title" names="document title">
<title>
Document Title
<docinfo>
<date>
2002-08-20
</pre>
<p>See <a class="reference internal" href="#docinfo">docinfo</a> for a more complete example, including processing
context.</p>
</div>
</div>
<div class="section" id="decoration">
<h2><a class="toc-backref" href="#id226"><tt class="docutils literal">decoration</tt></a></h2>
<p>The <tt class="docutils literal">decoration</tt> element is a container for <a class="reference internal" href="#header">header</a> and <a class="reference internal" href="#footer">footer</a>
elements and potential future extensions. These elements are used for
notes, time/datestamp, processing information, etc.</p>
<div class="section" id="id43">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#structural-subelements">Structural Subelements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#document">document</a> element contains <tt class="docutils literal">decoration</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">decoration</tt> elements may contain <a class="reference internal" href="#decorative-elements">decorative elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body">There are no direct analogies to <tt class="docutils literal">decoration</tt> in HTML or in
DocBook. Equivalents are typically constructed from primitives
and/or generated by the processing system.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See the individual <a class="reference internal" href="#decorative-elements">decorative elements</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id44">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#header">header</a>?, <a class="reference internal" href="#footer">footer</a>?)
</pre>
<p>Although the content model doesn't specifically require contents, no
empty <tt class="docutils literal">decoration</tt> elements are ever created.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">decoration</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id45">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
A paragraph.
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms,
assuming that the datestamp command-line option or configuration
setting has been supplied:</p>
<pre class="literal-block">
<document>
<decoration>
<footer>
<paragraph>
Generated on: 2002-08-20.
<paragraph>
A paragraph.
</pre>
</div>
</div>
<div class="section" id="definition">
<h2><a class="toc-backref" href="#id227"><tt class="docutils literal">definition</tt></a></h2>
<p>The <tt class="docutils literal">definition</tt> element is a container for the body elements used
to define a <a class="reference internal" href="#term">term</a> in a <a class="reference internal" href="#definition-list">definition_list</a>.</p>
<div class="section" id="id46">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a> (compound)</td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only <a class="reference internal" href="#definition-list-item">definition_list_item</a> elements contain <tt class="docutils literal">definition</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">definition</tt> elements may contain <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">definition</tt> is analogous to the HTML "dd" element and to the
DocBook "listitem" element (inside a "variablelistentry" element).</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#definition-list-item">definition_list_item</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id47">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id188">%body.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">definition</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id48">
<h3>Examples</h3>
<p>See the examples for the <a class="reference internal" href="#definition-list">definition_list</a>, <a class="reference internal" href="#definition-list-item">definition_list_item</a>, and
<a class="reference internal" href="#classifier">classifier</a> elements.</p>
</div>
</div>
<div class="section" id="definition-list">
<h2><a class="toc-backref" href="#id228"><tt class="docutils literal">definition_list</tt></a></h2>
<p>The <tt class="docutils literal">definition_list</tt> element contains a list of terms and their
definitions. It can be used for glossaries or dictionaries, to
describe or classify things, for dialogues, or to itemize subtopics
(such as in this reference).</p>
<div class="section" id="id49">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id188">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">definition_list</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">definition_list</tt> elements contain one or more
<a class="reference internal" href="#definition-list-item">definition_list_item</a> elements.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">definition_list</tt> is analogous to the HTML "dl" element and to
the DocBook "variablelist" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#definition-list-item">definition_list_item</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id50">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#definition-list-item">definition_list_item</a> +)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">definition_list</tt> element contains only the <a class="reference internal" href="#common-attributes">common
attributes</a>: <a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id188">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">definition_list</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">definition_list</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id51">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Term
Definition.
Term : classifier
The ' : ' indicates a classifier in
definition list item terms only.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<definition_list>
<definition_list_item>
<term>
Term
<definition>
<paragraph>
Definition.
<definition_list_item>
<term>
Term
<classifier>
classifier
<definition>
<paragraph>
The ' : ' indicates a classifier in
definition list item terms only.
</pre>
<p>See <a class="reference internal" href="#definition-list-item">definition_list_item</a> and <a class="reference internal" href="#classifier">classifier</a> for further examples.</p>
</div>
</div>
<div class="section" id="definition-list-item">
<h2><a class="toc-backref" href="#id229"><tt class="docutils literal">definition_list_item</tt></a></h2>
<p>The <tt class="docutils literal">definition_list_item</tt> element contains a single
<a class="reference internal" href="#term">term</a>/<a class="reference internal" href="#definition">definition</a> pair (with optional <a class="reference internal" href="#classifier">classifier</a>).</p>
<div class="section" id="id52">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a> (compound)</td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#definition-list">definition_list</a> element contains
<tt class="docutils literal">definition_list_item</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">definition_list_item</tt> elements each contain a single <a class="reference internal" href="#term">term</a>,
an optional <a class="reference internal" href="#classifier">classifier</a>, and a <a class="reference internal" href="#definition">definition</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">definition_list_item</tt> is analogous to the DocBook
"variablelistentry" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">The optional <a class="reference internal" href="#classifier">classifier</a> can be rendered differently from the
<a class="reference internal" href="#term">term</a>. They should be separated visually, typically by spaces
plus a colon or dash.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id53">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#term">term</a>, <a class="reference internal" href="#classifier">classifier</a>?, <a class="reference internal" href="#definition">definition</a>)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">definition_list_item</tt> element contains only the <a class="reference internal" href="#common-attributes">common
attributes</a>: <a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id54">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Tyrannosaurus Rex : carnivore
Big and scary; the "Tyrant King".
Brontosaurus : herbivore
All brontosauruses are thin at one end,
much much thicker in the middle
and then thin again at the far end.
-- Anne Elk (Miss)
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<definition_list>
<definition_list_item>
<term>
Tyrannosaurus Rex
<classifier>
carnivore
<definition>
<paragraph>
Big and scary; the "Tyrant King".
<definition_list_item>
<term>
Brontosaurus
<classifier>
herbivore
<definition>
<paragraph>
All brontosauruses are thin at one end,
much much thicker in the middle
and then thin again at the far end.
<paragraph>
-- Anne Elk (Miss)
</pre>
<p>See <a class="reference internal" href="#definition-list">definition_list</a> and <a class="reference internal" href="#classifier">classifier</a> for further examples.</p>
</div>
</div>
<div class="section" id="description">
<h2><a class="toc-backref" href="#id230"><tt class="docutils literal">description</tt></a></h2>
<p>The <tt class="docutils literal">description</tt> element contains body elements, describing the
purpose or effect of a command-line option or group of options.</p>
<div class="section" id="id55">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#option-list-item">option_list_item</a> element contains <tt class="docutils literal">description</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">description</tt> elements may contain <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">description</tt> has no direct analogues in common DTDs.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#option-list">option_list</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id56">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id188">%body.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">description</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id57">
<h3>Examples</h3>
<p>See the examples for the <a class="reference internal" href="#option-list">option_list</a> element.</p>
</div>
</div>
<div class="section" id="docinfo">
<h2><a class="toc-backref" href="#id231"><tt class="docutils literal">docinfo</tt></a></h2>
<p>The <tt class="docutils literal">docinfo</tt> element is a container for document bibliographic
data, or meta-data (data about the document). It corresponds to the
front matter of a book, such as the title page and copyright page.</p>
<div class="section" id="id58">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><p class="first"><a class="reference internal" href="#structural-subelements">Structural Subelements</a></p>
</td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body"><p class="first">Only the <a class="reference internal" href="#document">document</a> element contains <tt class="docutils literal">docinfo</tt>.</p>
</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><p class="first"><tt class="docutils literal">docinfo</tt> elements contain <a class="reference internal" href="#bibliographic-elements">bibliographic elements</a>.</p>
</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><p class="first"><tt class="docutils literal">docinfo</tt> is analogous to DocBook "info" elements ("bookinfo"
etc.). There are no directly analogous HTML elements; the "meta"
element carries some of the same information, albeit invisibly.</p>
</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body"><p class="first">The <tt class="docutils literal">docinfo</tt> element may be rendered as a two-column table or
in other styles. It may even be invisible or omitted from the
processed output. Meta-data may be extracted from <tt class="docutils literal">docinfo</tt>
children; for example, HTML <tt class="docutils literal"><meta></tt> tags may be constructed.</p>
<p class="last">When <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> transforms a <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> <a class="reference internal" href="#field-list">field_list</a> into a
<tt class="docutils literal">docinfo</tt> element (see the examples below), RCS/CVS keywords are
normally stripped from simple (one paragraph) field bodies. For
complete details, please see <a class="reference external" href="rst/restructuredtext.html#rcs-keywords">RCS Keywords</a> in the
<a class="reference external" href="rst/restructuredtext.html">reStructuredText Markup Specification</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id59">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id187">%bibliographic.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">docinfo</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id60">
<h3>Examples</h3>
<p>Docinfo is represented in <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> by a <a class="reference internal" href="#field-list">field_list</a> in a
bibliographic context: the first non-comment element of a <a class="reference internal" href="#document">document</a>,
after any document <a class="reference internal" href="#title">title</a>/<a class="reference internal" href="#subtitle">subtitle</a>. The field list is transformed
into a <tt class="docutils literal">docinfo</tt> element and its children by a transform. Source:</p>
<pre class="literal-block">
Docinfo Example
===============
:Author: J. Random Hacker
:Contact: jrh@example.com
:Date: 2002-08-18
:Status: Work In Progress
:Version: 1
:Filename: $RCSfile$
:Copyright: This document has been placed in the public domain.
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms:</p>
<pre class="literal-block">
<document ids="docinfo-example" names="docinfo example">
<title>
Docinfo Example
<docinfo>
<author>
J. Random Hacker
<contact>
<reference refuri="mailto:jrh@example.com">
jrh@example.com
<date>
2002-08-18
<status>
Work In Progress
<version>
1
<field>
<field_name>
Filename
<field_body>
<paragraph>
doctree.txt
<copyright>
This document has been placed in the public domain.
</pre>
<p>Note that "Filename" is a non-standard <tt class="docutils literal">docinfo</tt> field, so becomes a
generic <tt class="docutils literal">field</tt> element. Also note that the "RCSfile" keyword
syntax has been stripped from the "Filename" data.</p>
<p>See <a class="reference internal" href="#field-list">field_list</a> for an example in a non-bibliographic context. Also
see the individual examples for the various <a class="reference internal" href="#bibliographic-elements">bibliographic elements</a>.</p>
</div>
</div>
<div class="section" id="doctest-block">
<h2><a class="toc-backref" href="#id232"><tt class="docutils literal">doctest_block</tt></a></h2>
<p>The <tt class="docutils literal">doctest_block</tt> element is a Python-specific variant of
<a class="reference internal" href="#literal-block">literal_block</a>. It is a block of text where line breaks and
whitespace are significant and must be preserved. <tt class="docutils literal">doctest_block</tt>
elements are used for interactive Python interpreter sessions, which
are distinguished by their input prompt: <tt class="docutils literal">>>></tt>. They are meant to
illustrate usage by example, and provide an elegant and powerful
testing environment via the <a class="reference external" href="http://www.python.org/doc/current/lib/module-doctest.html">doctest module</a> in the Python standard
library.</p>
<div class="section" id="id61">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#simple-body-elements">Simple Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id188">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">doctest_block</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">doctest_block</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline
elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">doctest_block</tt> is analogous to the HTML "pre" element and to
the DocBook "programlisting" and "screen" elements.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">As with <a class="reference internal" href="#literal-block">literal_block</a>, <tt class="docutils literal">doctest_block</tt> elements are typically
rendered in a monospaced typeface. It is crucial that all
whitespace and line breaks are preserved in the rendered form.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id62">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">doctest_block</tt> element contains the <a class="reference internal" href="#common-attributes">common attributes</a>
(<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>), plus <a class="reference internal" href="#xml-space">xml:space</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id188">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">doctest_block</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">doctest_block</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id63">
<h3>Examples</h3>
<p>reStructuredText source:</p>
<pre class="literal-block">
This is an ordinary paragraph.
>>> print 'this is a Doctest block'
this is a Doctest block
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<paragraph>
This is an ordinary paragraph.
<doctest_block xml:space="preserve">
>>> print 'this is a Doctest block'
this is a Doctest block
</pre>
</div>
</div>
<div class="section" id="document">
<h2><a class="toc-backref" href="#id233"><tt class="docutils literal">document</tt></a></h2>
<p>The <tt class="docutils literal">document</tt> element is the root (topmost) element of the Docutils
document tree. <tt class="docutils literal">document</tt> is the direct or indirect ancestor of
every other element in the tree. It encloses the entire document
tree. It is the starting point for a document.</p>
<div class="section" id="id64">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#structural-elements">Structural Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">The <tt class="docutils literal">document</tt> element has no parents.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">document</tt> elements may contain <a class="reference internal" href="#structural-subelements">structural subelements</a>,
<a class="reference internal" href="#structural-elements">structural elements</a>, and <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">document</tt> is analogous to the HTML "html" element and to
several DocBook elements such as "book".</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id65">
<h3>Content Model</h3>
<pre class="literal-block">
( (<a class="reference internal" href="#title">title</a>, <a class="reference internal" href="#subtitle">subtitle</a>?)?,
<a class="reference internal" href="#decoration">decoration</a>?,
(<a class="reference internal" href="#docinfo">docinfo</a>, <a class="reference internal" href="#transition">transition</a>?)?,
<a class="reference internal" href="#structure-model">%structure.model;</a> )
</pre>
<p>Depending on the source of the data and the stage of processing, the
"document" may not initially contain a "title". A document title is
not directly representable in <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a>. Instead, a lone
top-level section may have its title promoted to become the document
<a class="reference internal" href="#title">title</a>, and similarly for a lone second-level (sub)section's title to
become the document <a class="reference internal" href="#subtitle">subtitle</a>.</p>
<p>The contents of "<a class="reference internal" href="#decoration">decoration</a>" may be specified in a document,
constructed programmatically, or both. The "<a class="reference internal" href="#docinfo">docinfo</a>" may be
transformed from an initial <a class="reference internal" href="#field-list">field_list</a>.</p>
<p>See the <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity for details of the body
of a <tt class="docutils literal">document</tt>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">document</tt> element contains the <a class="reference internal" href="#common-attributes">common attributes</a> (<a class="reference internal" href="#ids">ids</a>,
<a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>), plus an optional <a class="reference internal" href="#title-attribute">title</a>
attribute which stores the document title metadata.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id67">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
A Title
=======
A paragraph.
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result from simple parsing:</p>
<pre class="literal-block">
<document>
<section ids="a-title" names="a title">
<title>
A Title
<paragraph>
A paragraph.
</pre>
<p>After applying transforms, the section title is promoted to become the
document title:</p>
<pre class="literal-block">
<document ids="a-title" names="a title">
<title>
A Title
<paragraph>
A paragraph.
</pre>
</div>
</div>
<div class="section" id="emphasis">
<h2><a class="toc-backref" href="#id234"><tt class="docutils literal">emphasis</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="entry">
<h2><a class="toc-backref" href="#id235"><tt class="docutils literal">entry</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="enumerated-list">
<h2><a class="toc-backref" href="#id236"><tt class="docutils literal">enumerated_list</tt></a></h2>
<p>The <tt class="docutils literal">enumerated_list</tt> element contains <a class="reference internal" href="#list-item">list_item</a> elements which are
uniformly marked with enumerator labels.</p>
<div class="section" id="id68">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id188">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">enumerated_list</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">enumerated_list</tt> elements contain one or more <a class="reference internal" href="#list-item">list_item</a>
elements.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">enumerated_list</tt> is analogous to the HTML "ol" element and to
the DocBook "orderedlist" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Each list item should begin a new vertical block, prefaced by a
enumeration marker (such as "1.").</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id69">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#list-item">list_item</a> +)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body"><p class="first">The <tt class="docutils literal">enumerated_list</tt> element contains the <a class="reference internal" href="#common-attributes">common attributes</a>
(<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>), plus <a class="reference internal" href="#enumtype">enumtype</a>,
<a class="reference internal" href="#prefix">prefix</a>, <a class="reference internal" href="#suffix">suffix</a>, and <a class="reference internal" href="#start">start</a>.</p>
<p><tt class="docutils literal">enumtype</tt> is used to record the intended enumeration sequence,
one of "arabic" (1, 2, 3, ...), "loweralpha" (a, b, c, ..., z),
"upperalpha" (A, B, C, ..., Z), "lowerroman" (i, ii, iii, iv, ...,
mmmmcmxcix [4999]), or "upperroman" (I, II, III, IV, ...,
MMMMCMXCIX [4999]).</p>
<p><tt class="docutils literal">prefix</tt> stores the formatting characters used before the
enumerator. In documents originating from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> data,
it will contain either "" (empty string) or "(" (left
parenthesis). It may or may not affect processing.</p>
<p><tt class="docutils literal">suffix</tt> stores the formatting characters used after the
enumerator. In documents originating from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> data,
it will contain either "." (period) or ")" (right parenthesis).
Depending on the capabilities of the output format, this attribute
may or may not affect processing.</p>
<p><tt class="docutils literal">start</tt> contains the ordinal value of the first item in the
list, in decimal. For lists beginning at value 1 ("1", "a", "A",
"i", or "I"), this attribute may be omitted.</p>
</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body"><p class="first last">The <a class="reference internal" href="#id188">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">enumerated_list</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">enumerated_list</tt>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id70">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
1. Item 1.
(A) Item A.
(B) Item B.
(C) Item C.
2. Item 2.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<enumerated_list enumtype="arabic" prefix="" suffix=".">
<list_item>
<paragraph>
Item 1.
<enumerated_list enumtype="upperalpha" prefix="(" suffix=")">
<list_item>
<paragraph>
Item A.
<list_item>
<paragraph>
Item B.
<list_item>
<paragraph>
Item C.
<list_item>
<paragraph>
Item 2.
</pre>
<p>See <a class="reference internal" href="#list-item">list_item</a> for another example.</p>
</div>
</div>
<div class="section" id="error">
<h2><a class="toc-backref" href="#id237"><tt class="docutils literal">error</tt></a></h2>
<p>The <tt class="docutils literal">error</tt> element is an admonition, a distinctive and
self-contained notice. Also see the other admonition elements
Docutils offers (in alphabetical order): <a class="reference internal" href="#attention">attention</a>, <a class="reference internal" href="#caution">caution</a>,
<a class="reference internal" href="#danger">danger</a>, <a class="reference internal" href="#hint">hint</a>, <a class="reference internal" href="#important">important</a>, <a class="reference internal" href="#note">note</a>, <a class="reference internal" href="#tip">tip</a>, <a class="reference internal" href="#warning">warning</a>, and the generic
<a class="reference internal" href="#admonition">admonition</a>.</p>
<div class="section" id="id71">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id188">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">error</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">error</tt> elements contain one or more <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">error</tt> has no direct analogues in common DTDs. It can be
emulated with primitives and type effects.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Rendered distinctly (inset and/or in a box, etc.), with the
generated title "Error" (or similar).</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id72">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id188">%body.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">error</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>: <a class="reference internal" href="#ids">ids</a>,
<a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id188">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">error</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity indirectly
includes <tt class="docutils literal">error</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id73">
<h3>Examples</h3>
<p>reStructuredText source:</p>
<pre class="literal-block">
.. Error:: Does not compute.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<error>
<paragraph>
Does not compute.
</pre>
</div>
</div>
<div class="section" id="field">
<h2><a class="toc-backref" href="#id238"><tt class="docutils literal">field</tt></a></h2>
<p>The <tt class="docutils literal">field</tt> element contains a pair of <a class="reference internal" href="#field-name">field_name</a> and <a class="reference internal" href="#field-body">field_body</a>
elements.</p>
<div class="section" id="id74">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">The following elements may contain <tt class="docutils literal">field</tt>: <a class="reference internal" href="#docinfo">docinfo</a>,
<a class="reference internal" href="#field-list">field_list</a></td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body">Each <tt class="docutils literal">field</tt> element contains one <a class="reference internal" href="#field-name">field_name</a> and one
<a class="reference internal" href="#field-body">field_body</a> element.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">field</tt> has no direct analogues in common DTDs.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#field-list">field_list</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id75">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#field-name">field_name</a>, <a class="reference internal" href="#field-body">field_body</a>)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">field</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id187">%bibliographic.elements;</a> parameter entity directly includes
<tt class="docutils literal">field</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id76">
<h3>Examples</h3>
<p>See the examples for the <a class="reference internal" href="#field-list">field_list</a> and <a class="reference internal" href="#docinfo">docinfo</a> elements.</p>
</div>
</div>
<div class="section" id="field-body">
<h2><a class="toc-backref" href="#id239"><tt class="docutils literal">field_body</tt></a></h2>
<p>The <tt class="docutils literal">field_body</tt> element contains body elements. It is analogous to
a database field's data.</p>
<div class="section" id="id77">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#field">field</a> element contains <tt class="docutils literal">field_body</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">field_body</tt> elements may contain <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">field_body</tt> has no direct analogues in common DTDs.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#field-list">field_list</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id78">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id188">%body.elements;</a>)*
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">field_body</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id79">
<h3>Examples</h3>
<p>See the examples for the <a class="reference internal" href="#field-list">field_list</a> and <a class="reference internal" href="#docinfo">docinfo</a> elements.</p>
</div>
</div>
<div class="section" id="field-list">
<h2><a class="toc-backref" href="#id240"><tt class="docutils literal">field_list</tt></a></h2>
<p>The <tt class="docutils literal">field_list</tt> element contains two-column table-like structures
resembling database records (label & data pairs). Field lists are
often meant for further processing. In <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a>, field lists
are used to represent bibliographic fields (contents of the <a class="reference internal" href="#docinfo">docinfo</a>
element) and directive options.</p>
<div class="section" id="id80">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id188">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">field_list</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">field_list</tt> elements contain one or more <a class="reference internal" href="#field">field</a> elements.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">field_list</tt> has no direct analogues in common DTDs. It can be
emulated with primitives such as tables.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">A <tt class="docutils literal">field_list</tt> is typically rendered as a two-column list, where
the first column contains "labels" (usually with a colon suffix).
However, field lists are often used for extension syntax or
special processing. Such structures do not survive as field lists
to be rendered.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id81">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#field">field</a> +)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">field_list</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id188">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">field_list</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">field_list</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id82">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
:Author: Me
:Version: 1
:Date: 2001-08-11
:Parameter i: integer
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<field_list>
<field>
<field_name>
Author
<field_body>
<paragraph>
Me
<field>
<field_name>
Version
<field_body>
<paragraph>
1
<field>
<field_name>
Date
<field_body>
<paragraph>
2001-08-11
<field>
<field_name>
Parameter i
<field_body>
<paragraph>
integer
</pre>
</div>
</div>
<div class="section" id="field-name">
<h2><a class="toc-backref" href="#id241"><tt class="docutils literal">field_name</tt></a></h2>
<p>The <tt class="docutils literal">field_name</tt> element contains text; it is analogous to a
database field's name.</p>
<div class="section" id="id83">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a> (simple)</td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#field">field</a> element contains <tt class="docutils literal">field_name</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">field_name</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">field_name</tt> has no direct analogues in common DTDs.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#field-list">field_list</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id84">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">field_name</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id85">
<h3>Examples</h3>
<p>See the examples for the <a class="reference internal" href="#field-list">field_list</a> and <a class="reference internal" href="#docinfo">docinfo</a> elements.</p>
</div>
</div>
<div class="section" id="figure">
<h2><a class="toc-backref" href="#id242"><tt class="docutils literal">figure</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="footer">
<h2><a class="toc-backref" href="#id243"><tt class="docutils literal">footer</tt></a></h2>
<p>The <tt class="docutils literal">footer</tt> element is a container element whose contents are meant
to appear at the bottom of a web page, or repeated at the bottom of
every printed page. The <tt class="docutils literal">footer</tt> element may contain processing
information (datestamp, a link to <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a>, etc.) as well as custom
content.</p>
<div class="section" id="id86">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#decorative-elements">Decorative Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#decoration">decoration</a> element contains <tt class="docutils literal">footer</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">footer</tt> elements may contain <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body">There are no direct analogies to <tt class="docutils literal">footer</tt> in HTML or DocBook.
Equivalents are typically constructed from primitives and/or
generated by the processing system.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id87">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id188">%body.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">footer</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id88">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
A paragraph.
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms,
assuming that the datestamp command-line option or configuration
setting has been supplied:</p>
<pre class="literal-block">
<document>
<decoration>
<footer>
<paragraph>
Generated on: 2002-08-20.
<paragraph>
A paragraph.
</pre>
</div>
</div>
<div class="section" id="footnote">
<h2><a class="toc-backref" href="#id244"><tt class="docutils literal">footnote</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="footnote-reference">
<h2><a class="toc-backref" href="#id245"><tt class="docutils literal">footnote_reference</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="generated">
<h2><a class="toc-backref" href="#id246"><tt class="docutils literal">generated</tt></a></h2>
<p>Docutils wraps <tt class="docutils literal">generated</tt> elements around text that is inserted
(generated) by Docutils; i.e., text that was not in the document, like
section numbers inserted by the "sectnum" directive.</p>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="header">
<h2><a class="toc-backref" href="#id247"><tt class="docutils literal">header</tt></a></h2>
<p>The <tt class="docutils literal">header</tt> element is a container element whose contents are meant
to appear at the top of a web page, or at the top of every printed
page.</p>
<div class="section" id="id89">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#decorative-elements">Decorative Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#decoration">decoration</a> element contains <tt class="docutils literal">header</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">header</tt> elements may contain <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body">There are no direct analogies to <tt class="docutils literal">header</tt> in HTML or DocBook.
Equivalents are typically constructed from primitives and/or
generated by the processing system.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id90">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id188">%body.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">header</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id91">
<h3>Examples</h3>
<p>reStructuredText source fragment:</p>
<pre class="literal-block">
.. header:: This space for rent.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<document>
<decoration>
<header>
<paragraph>
This space for rent.
</pre>
</div>
</div>
<div class="section" id="hint">
<h2><a class="toc-backref" href="#id248"><tt class="docutils literal">hint</tt></a></h2>
<p>The <tt class="docutils literal">hint</tt> element is an admonition, a distinctive and
self-contained notice. Also see the other admonition elements
Docutils offers (in alphabetical order): <a class="reference internal" href="#attention">attention</a>, <a class="reference internal" href="#caution">caution</a>,
<a class="reference internal" href="#danger">danger</a>, <a class="reference internal" href="#error">error</a>, <a class="reference internal" href="#important">important</a>, <a class="reference internal" href="#note">note</a>, <a class="reference internal" href="#tip">tip</a>, <a class="reference internal" href="#warning">warning</a>, and the generic
<a class="reference internal" href="#admonition">admonition</a>.</p>
<div class="section" id="id92">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id188">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">hint</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">hint</tt> elements contain one or more <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">hint</tt> has no direct analogues in common DTDs. It can be
emulated with primitives and type effects.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Rendered distinctly (inset and/or in a box, etc.), with the
generated title "Hint" (or similar).</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id93">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id188">%body.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">hint</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>: <a class="reference internal" href="#ids">ids</a>,
<a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id188">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">hint</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity indirectly
includes <tt class="docutils literal">hint</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id94">
<h3>Examples</h3>
<p>reStructuredText source:</p>
<pre class="literal-block">
.. Hint:: It's bigger than a bread box.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<hint>
<paragraph>
It's bigger than a bread box.
</pre>
</div>
</div>
<div class="section" id="image">
<h2><a class="toc-backref" href="#id249"><tt class="docutils literal">image</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="important">
<h2><a class="toc-backref" href="#id250"><tt class="docutils literal">important</tt></a></h2>
<p>The <tt class="docutils literal">important</tt> element is an admonition, a distinctive and
self-contained notice. Also see the other admonition elements
Docutils offers (in alphabetical order): <a class="reference internal" href="#attention">attention</a>, <a class="reference internal" href="#caution">caution</a>,
<a class="reference internal" href="#danger">danger</a>, <a class="reference internal" href="#error">error</a>, <a class="reference internal" href="#hint">hint</a>, <a class="reference internal" href="#note">note</a>, <a class="reference internal" href="#tip">tip</a>, <a class="reference internal" href="#warning">warning</a>, and the generic
<a class="reference internal" href="#admonition">admonition</a>.</p>
<div class="section" id="id95">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id188">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">important</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">important</tt> elements contain one or more <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">important</tt> is analogous to the DocBook "important" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Rendered distinctly (inset and/or in a box, etc.), with the
generated title "Important" (or similar).</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id96">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id188">%body.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">important</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id188">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">important</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">important</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id97">
<h3>Examples</h3>
<p>reStructuredText source:</p>
<pre class="literal-block">
.. Important::
* Wash behind your ears.
* Clean up your room.
* Back up your data.
* Call your mother.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<important>
<bullet_list>
<list_item>
<paragraph>
Wash behind your ears.
<list_item>
<paragraph>
Clean up your room.
<list_item>
<paragraph>
Back up your data.
<list_item>
<paragraph>
Call your mother.
</pre>
</div>
</div>
<div class="section" id="inline">
<h2><a class="toc-backref" href="#id251"><tt class="docutils literal">inline</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="label">
<h2><a class="toc-backref" href="#id252"><tt class="docutils literal">label</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="legend">
<h2><a class="toc-backref" href="#id253"><tt class="docutils literal">legend</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="line">
<h2><a class="toc-backref" href="#id254"><tt class="docutils literal">line</tt></a></h2>
<p>The <tt class="docutils literal">line</tt> element contains a single line of text, part of a
<a class="reference internal" href="#line-block">line_block</a>.</p>
<div class="section" id="id98">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a> (simple)</td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#line-block">line_block</a> element contains <tt class="docutils literal">line</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">line</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">line</tt> has no direct analogues in common DTDs. It can be
emulated with primitives or type effects.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#line-block">line_block</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id99">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">line</tt> element contains the <a class="reference internal" href="#common-attributes">common attributes</a> (<a class="reference internal" href="#ids">ids</a>,
<a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>), plus <a class="reference internal" href="#xml-space">xml:space</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id100">
<h3>Examples</h3>
<p>See <a class="reference internal" href="#line-block">line_block</a>.</p>
</div>
</div>
<div class="section" id="line-block">
<h2><a class="toc-backref" href="#id255"><tt class="docutils literal">line_block</tt></a></h2>
<p>The <tt class="docutils literal">line_block</tt> element contains a sequence of lines and nested
line blocks. Line breaks (implied between elements) and leading
whitespace (indicated by nesting) is significant and must be
preserved. <tt class="docutils literal">line_block</tt> elements are commonly used for verse and
addresses. See <a class="reference internal" href="#literal-block">literal_block</a> for an alternative useful for program
listings and interactive computer sessions.</p>
<div class="section" id="id101">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id188">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">line_block</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">line_block</tt> elements may contain <a class="reference internal" href="#line">line</a> elements and nested
<tt class="docutils literal">line_block</tt> elements.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">line_block</tt> is analogous to the DocBook "literallayout" element
and to the HTML "pre" element (with modifications to typeface
styles).</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Unlike <tt class="docutils literal">literal_block</tt>, <tt class="docutils literal">line_block</tt> elements are typically
rendered in an ordinary text typeface. It is crucial that leading
whitespace and line breaks are preserved in the rendered form.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id102">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#line">line</a> | <a class="reference internal" href="#line-block">line_block</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">line_block</tt> element contains the <a class="reference internal" href="#common-attributes">common attributes</a> (<a class="reference internal" href="#ids">ids</a>,
<a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>), plus <a class="reference internal" href="#xml-space">xml:space</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id188">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">line_block</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">line_block</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id103">
<h3>Examples</h3>
<p>reStructuredText uses a directive to indicate a <tt class="docutils literal">line_block</tt>.
Example source:</p>
<pre class="literal-block">
Take it away, Eric the Orchestra Leader!
| A one, two, a one two three four
|
| Half a bee, philosophically,
| must, *ipso facto*, half not be.
| But half the bee has got to be,
| *vis a vis* its entity. D'you see?
|
| But can a bee be said to be
| or not to be an entire bee,
| when half the bee is not a bee,
| due to some ancient injury?
|
| Singing...
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<paragraph>
Take it away, Eric the Orchestra Leader!
<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...
</pre>
</div>
</div>
<div class="section" id="list-item">
<h2><a class="toc-backref" href="#id256"><tt class="docutils literal">list_item</tt></a></h2>
<p>The <tt class="docutils literal">list_item</tt> element is a container for the elements of a list
item.</p>
<div class="section" id="id104">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a> (compound)</td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">The <a class="reference internal" href="#bullet-list">bullet_list</a> and <a class="reference internal" href="#enumerated-list">enumerated_list</a> elements contain
<tt class="docutils literal">list_item</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">list_item</tt> elements may contain <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">list_item</tt> is analogous to the HTML "li" element and to the
DocBook "listitem" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#bullet-list">bullet_list</a> or <a class="reference internal" href="#enumerated-list">enumerated_list</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id105">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id188">%body.elements;</a>)*
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">list_item</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id106">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
1. Outer list, item 1.
* Inner list, item 1.
* Inner list, item 2.
2. Outer list, item 2.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<enumerated_list enumtype="arabic" prefix="" suffix=".">
<list_item>
<paragraph>
Outer list, item 1.
<bullet_list bullet="*">
<list_item>
<paragraph>
Inner list, item 1.
<list_item>
<paragraph>
Inner list, item 2.
<list_item>
<paragraph>
Outer list, item 2.
</pre>
<p>See <a class="reference internal" href="#bullet-list">bullet_list</a> or <a class="reference internal" href="#enumerated-list">enumerated_list</a> for further examples.</p>
</div>
</div>
<div class="section" id="literal">
<h2><a class="toc-backref" href="#id257"><tt class="docutils literal">literal</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="literal-block">
<h2><a class="toc-backref" href="#id258"><tt class="docutils literal">literal_block</tt></a></h2>
<p>The <tt class="docutils literal">literal_block</tt> element contains a block of text where line
breaks and whitespace are significant and must be preserved.
<tt class="docutils literal">literal_block</tt> elements are commonly used for program listings and
interactive computer sessions. See <a class="reference internal" href="#line-block">line_block</a> for an alternative
useful for verse and addresses.</p>
<div class="section" id="id107">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#simple-body-elements">Simple Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id188">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">literal_block</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">literal_block</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline
elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">literal_block</tt> is analogous to the HTML "pre" element and to
the DocBook "programlisting" and "screen" elements.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body"><tt class="docutils literal">literal_block</tt> elements are typically rendered in a monospaced
typeface. It is crucial that all whitespace and line breaks are
preserved in the rendered form.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id108">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">literal_block</tt> element contains the <a class="reference internal" href="#common-attributes">common attributes</a>
(<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>), plus <a class="reference internal" href="#xml-space">xml:space</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id188">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">literal_block</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">literal_block</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id109">
<h3>Examples</h3>
<p>reStructuredText source:</p>
<pre class="literal-block">
Here is a literal block::
if literal_block:
text = 'is left as-is'
spaces_and_linebreaks = 'are preserved'
markup_processing = None
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<paragraph>
Here is a literal block:
<literal_block xml:space="preserve">
if literal_block:
text = 'is left as-is'
spaces_and_linebreaks = 'are preserved'
markup_processing = None
</pre>
</div>
</div>
<div class="section" id="math">
<h2><a class="toc-backref" href="#id259"><tt class="docutils literal">math</tt></a></h2>
<p>The <tt class="docutils literal">math</tt> element contains text in <span class="incremental">LaTeX math format</span> <a class="footnote-reference" href="#latex-math" id="id110">[1]</a>
that is typeset as mathematical notation (inline formula).</p>
<p>If the output format does not support math typesetting, the content is
inserted verbatim.</p>
<div class="section" id="id111">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#inline-elements">Inline Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id189">%inline.elements;</a> parameter entities in
their content models may contain <tt class="docutils literal">math</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">math</tt> elements may contain text data.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">math</tt> is analogous to a MathML "math" element or
the LaTeX (<tt class="docutils literal">$ math $</tt>) mode.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Rendered as mathematical notation.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id112">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">math</tt> element contains the <a class="reference internal" href="#common-attributes">common attributes</a>
(<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>).</td>
</tr>
</tbody>
</table>
<table class="docutils footnote" frame="void" id="latex-math" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label">[1]</td><td><em>(<a class="fn-backref" href="#id110">1</a>, <a class="fn-backref" href="#id113">2</a>)</em> For details of the supported mathematical language, see
the <a class="reference external" href="rst/directives.html#math">"math" directive</a></td></tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="math-block">
<h2><a class="toc-backref" href="#id260"><tt class="docutils literal">math_block</tt></a></h2>
<p>The <tt class="docutils literal">math_block</tt> element contains a block of text in <span class="incremental">LaTeX math
format</span> <a class="footnote-reference" href="#latex-math" id="id113">[1]</a> that is typeset as mathematical notation
(display formula). The <tt class="docutils literal">math_block</tt> element is generated during
the initial parse from a "math" directive.</p>
<p>If the output format does not support math typesetting, the content is
inserted verbatim.</p>
<div class="section" id="id114">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#simple-body-elements">Simple Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id188">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">math_block</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">math_block</tt> elements may contain text data.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">math_block</tt> is analogous to a LaTeX "equation*" environment or
a MathML "math" element displayed as block-level element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Rendered in a block as mathematical notation, typically centered or with
indentation</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id115">
<h3>Content Model</h3>
<pre class="literal-block">
(#PCDATA)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">math</tt> element contains the <a class="reference internal" href="#common-attributes">common attributes</a>
(<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>).</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="note">
<h2><a class="toc-backref" href="#id261"><tt class="docutils literal">note</tt></a></h2>
<p>The <tt class="docutils literal">note</tt> element is an admonition, a distinctive and
self-contained notice. Also see the other admonition elements
Docutils offers (in alphabetical order): <a class="reference internal" href="#attention">attention</a>, <a class="reference internal" href="#caution">caution</a>,
<a class="reference internal" href="#danger">danger</a>, <a class="reference internal" href="#error">error</a>, <a class="reference internal" href="#hint">hint</a>, <a class="reference internal" href="#important">important</a>, <a class="reference internal" href="#tip">tip</a>, <a class="reference internal" href="#warning">warning</a>, and the generic
<a class="reference internal" href="#admonition">admonition</a>.</p>
<div class="section" id="id116">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id188">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">note</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">note</tt> elements contain one or more <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">note</tt> is analogous to the DocBook "note" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Rendered distinctly (inset and/or in a box, etc.), with the
generated title "Note" (or similar).</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id117">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id188">%body.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">note</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>: <a class="reference internal" href="#ids">ids</a>,
<a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id188">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">note</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity indirectly
includes <tt class="docutils literal">note</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id118">
<h3>Examples</h3>
<p>reStructuredText source:</p>
<pre class="literal-block">
.. Note:: Admonitions can be handy to break up a
long boring technical document.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<note>
<paragraph>
Admonitions can be handy to break up a
long boring technical document.
</pre>
</div>
</div>
<div class="section" id="option">
<h2><a class="toc-backref" href="#id262"><tt class="docutils literal">option</tt></a></h2>
<p>The <tt class="docutils literal">option</tt> element groups an option string together with zero or
more option argument placeholders. Note that <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a>
currently supports only one argument per option.</p>
<div class="section" id="id119">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#option-group">option_group</a> element contains <tt class="docutils literal">option</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body">Each <tt class="docutils literal">option</tt> element contains one <a class="reference internal" href="#option-string">option_string</a> and zero or
more <a class="reference internal" href="#option-argument">option_argument</a> elements.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">option</tt> has no direct analogues in common DTDs.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#option-list">option_list</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id120">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#option-string">option_string</a>, <a class="reference internal" href="#option-argument">option_argument</a> *)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">option</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id121">
<h3>Examples</h3>
<p>See the examples for the <a class="reference internal" href="#option-list">option_list</a> element.</p>
</div>
</div>
<div class="section" id="option-argument">
<h2><a class="toc-backref" href="#id263"><tt class="docutils literal">option_argument</tt></a></h2>
<p>The <tt class="docutils literal">option_argument</tt> element contains placeholder text for option
arguments.</p>
<div class="section" id="id122">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#option">option</a> element contains <tt class="docutils literal">option_argument</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">option_argument</tt> elements contain text data only.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">option_argument</tt> has no direct analogues in common DTDs.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">The value of the "delimiter" attribute is prefixed to the
<tt class="docutils literal">option_argument</tt>, separating it from its <a class="reference internal" href="#option-string">option_string</a> or a
preceding <tt class="docutils literal">option_argument</tt>. The <tt class="docutils literal">option_argument</tt> text is
typically rendered in a monospaced typeface, possibly italicized
or otherwise altered to indicate its placeholder nature.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id123">
<h3>Content Model</h3>
<pre class="literal-block">
(#PCDATA)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body"><p class="first">The <tt class="docutils literal">option_argument</tt> element contains the <a class="reference internal" href="#common-attributes">common attributes</a> (<a class="reference internal" href="#ids">ids</a>,
<a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>), plus <a class="reference internal" href="#delimiter">delimiter</a>.</p>
<p class="last"><tt class="docutils literal">delimiter</tt> contains the text preceding the <tt class="docutils literal">option_argument</tt>:
either the text separating it from the <a class="reference internal" href="#option-string">option_string</a> (typically
either "=" or " ") or the text between option arguments (typically
either "," or " ").</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id124">
<h3>Examples</h3>
<p>See the examples for the <a class="reference internal" href="#option-list">option_list</a> element.</p>
</div>
</div>
<div class="section" id="option-group">
<h2><a class="toc-backref" href="#id264"><tt class="docutils literal">option_group</tt></a></h2>
<p>The <tt class="docutils literal">option_group</tt> element groups together one or more <a class="reference internal" href="#option">option</a>
elements, all synonyms.</p>
<div class="section" id="id125">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><p class="first"><a class="reference internal" href="#body-subelements">Body Subelements</a></p>
</td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body"><p class="first">Only the <a class="reference internal" href="#option-list-item">option_list_item</a> element contains <tt class="docutils literal">option_group</tt>.</p>
</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><p class="first"><tt class="docutils literal">option_group</tt> elements contain one or more <a class="reference internal" href="#option">option</a> elements.</p>
<p><tt class="docutils literal">option_group</tt> is an empty element and has no children.</p>
<p>Each <tt class="docutils literal">option_group</tt> element contains one _ and
one _ element.</p>
</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><p class="first"><tt class="docutils literal">option_group</tt> has no direct analogues in common DTDs.</p>
</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body"><p class="first last">Typically <a class="reference internal" href="#option">option</a> elements within an <tt class="docutils literal">option_group</tt> are joined
together in a comma-separated list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id126">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#option-group">option_group</a>, <a class="reference internal" href="#description">description</a>)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">option_group</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id127">
<h3>Examples</h3>
<p>See the examples for the <a class="reference internal" href="#option-list">option_list</a> element.</p>
</div>
</div>
<div class="section" id="option-list">
<h2><a class="toc-backref" href="#id265"><tt class="docutils literal">option_list</tt></a></h2>
<p>Each <tt class="docutils literal">option_list</tt> element contains a two-column list of
command-line options and descriptions, documenting a program's
options.</p>
<div class="section" id="id128">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id188">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">option_list</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">option_list</tt> elements contain one or more <a class="reference internal" href="#option-list-item">option_list_item</a>
elements.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">option_list</tt> has no direct analogues in common DTDs. It can be
emulated with primitives such as tables.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">An <tt class="docutils literal">option_list</tt> is typically rendered as a two-column list,
where the first column contains option strings and arguments, and
the second column contains descriptions.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id129">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#option-list-item">option_list_item</a> +)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">option_list</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id188">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">option_list</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">option_list</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id130">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
-a command-line option "a"
-1 file, --one=file, --two file
Multiple options with arguments.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<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>
-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.
</pre>
</div>
</div>
<div class="section" id="option-list-item">
<h2><a class="toc-backref" href="#id266"><tt class="docutils literal">option_list_item</tt></a></h2>
<p>The <tt class="docutils literal">option_list_item</tt> element is a container for a pair of
<a class="reference internal" href="#option-group">option_group</a> and <a class="reference internal" href="#description">description</a> elements.</p>
<div class="section" id="id131">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#option-list">option_list</a> element contains <tt class="docutils literal">option_list_item</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body">Each <tt class="docutils literal">option_list_item</tt> element contains one <a class="reference internal" href="#option-group">option_group</a> and
one <a class="reference internal" href="#description">description</a> element.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">option_list_item</tt> has no direct analogues in common DTDs.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#option-list">option_list</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id132">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#option-group">option_group</a>, <a class="reference internal" href="#description">description</a>)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">option_list_item</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id133">
<h3>Examples</h3>
<p>See the examples for the <a class="reference internal" href="#option-list">option_list</a> element.</p>
</div>
</div>
<div class="section" id="option-string">
<h2><a class="toc-backref" href="#id267"><tt class="docutils literal">option_string</tt></a></h2>
<p>The <tt class="docutils literal">option_string</tt> element contains the text of a command-line
option.</p>
<div class="section" id="id134">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#option">option</a> element contains <tt class="docutils literal">option_string</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">option_string</tt> elements contain text data only.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">option_string</tt> has no direct analogues in common DTDs.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">The <tt class="docutils literal">option_string</tt> text is typically rendered in a monospaced
typeface.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id135">
<h3>Content Model</h3>
<pre class="literal-block">
(#PCDATA)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">option_string</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id136">
<h3>Examples</h3>
<p>See the examples for the <a class="reference internal" href="#option-list">option_list</a> element.</p>
</div>
</div>
<div class="section" id="organization">
<h2><a class="toc-backref" href="#id268"><tt class="docutils literal">organization</tt></a></h2>
<p>The <tt class="docutils literal">organization</tt> element contains the name of document author's
organization, or the organization responsible for the document.</p>
<div class="section" id="id137">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#bibliographic-elements">Bibliographic Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#docinfo">docinfo</a> element contains <tt class="docutils literal">organization</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">organization</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline
elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">organization</tt> is analogous to the DocBook "orgname",
"corpname", or "publishername" elements.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#docinfo">docinfo</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id138">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">organization</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id187">%bibliographic.elements;</a> parameter entity directly includes
<tt class="docutils literal">organization</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id139">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Document Title
==============
:Organization: Humankind
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms:</p>
<pre class="literal-block">
<document ids="document-title" names="document title">
<title>
Document Title
<docinfo>
<organization>
Humankind
</pre>
<p>See <a class="reference internal" href="#docinfo">docinfo</a> for a more complete example, including processing
context.</p>
</div>
</div>
<div class="section" id="paragraph">
<h2><a class="toc-backref" href="#id269"><tt class="docutils literal">paragraph</tt></a></h2>
<p>The <tt class="docutils literal">paragraph</tt> element contains the text and inline elements of a
single paragraph, a fundamental building block of documents.</p>
<div class="section" id="id140">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#simple-body-elements">Simple Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id188">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">paragraph</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">paragraph</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline
elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">paragraph</tt> is analogous to the HTML "p" element and to the
DocBook "para" elements.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id141">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">paragraph</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id188">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">paragraph</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity
indirectly includes <tt class="docutils literal">paragraph</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id142">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
A paragraph.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<paragraph>
A paragraph.
</pre>
</div>
</div>
<div class="section" id="pending">
<h2><a class="toc-backref" href="#id270"><tt class="docutils literal">pending</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="problematic">
<h2><a class="toc-backref" href="#id271"><tt class="docutils literal">problematic</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="raw">
<h2><a class="toc-backref" href="#id272"><tt class="docutils literal">raw</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="reference">
<h2><a class="toc-backref" href="#id273"><tt class="docutils literal">reference</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="revision">
<h2><a class="toc-backref" href="#id274"><tt class="docutils literal">revision</tt></a></h2>
<p>The <tt class="docutils literal">revision</tt> element contains the revision number of the document.
It can be used alone or in conjunction with <a class="reference internal" href="#version">version</a>.</p>
<div class="section" id="id143">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#bibliographic-elements">Bibliographic Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#docinfo">docinfo</a> element contains <tt class="docutils literal">revision</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">revision</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline
elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">revision</tt> is analogous to but simpler than the DocBook
"revision" element. It closely matches the DocBook "revnumber"
element, but in a simpler context.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Often used with the RCS/CVS keyword "Revision". See <a class="reference internal" href="#docinfo">docinfo</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id144">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">revision</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id187">%bibliographic.elements;</a> parameter entity directly includes
<tt class="docutils literal">revision</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id145">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Document Title
==============
:Version: 1
:Revision: b
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms:</p>
<pre class="literal-block">
<document ids="document-title" names="document title">
<title>
Document Title
<docinfo>
<version>
1
<revision>
b
</pre>
<p>See <a class="reference internal" href="#docinfo">docinfo</a> for a more complete example, including processing
context.</p>
</div>
</div>
<div class="section" id="row">
<h2><a class="toc-backref" href="#id275"><tt class="docutils literal">row</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="rubric">
<h2><a class="toc-backref" href="#id276"><tt class="docutils literal">rubric</tt></a></h2>
<blockquote>
<p>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. ...</p>
<p class="attribution">—Random House Webster's College Dictionary, 1991</p>
</blockquote>
<p>A rubric is like an informal heading that doesn't correspond to the
document's structure.</p>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="section">
<h2><a class="toc-backref" href="#id277"><tt class="docutils literal">section</tt></a></h2>
<p>The <tt class="docutils literal">section</tt> element is the main unit of hierarchy for Docutils
documents. Docutils <tt class="docutils literal">section</tt> elements are a recursive structure; a
<tt class="docutils literal">section</tt> may contain other <tt class="docutils literal">section</tt> elements, without limit.
Paragraphs and other body elements may occur before a <tt class="docutils literal">section</tt>, but
not after it.</p>
<div class="section" id="id146">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#structural-elements">Structural Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">The following elements may contain <tt class="docutils literal">section</tt>: <a class="reference internal" href="#document">document</a>,
<a class="reference internal" href="#section">section</a></td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">section</tt> elements begin with a <a class="reference internal" href="#title">title</a>, and may contain <a class="reference internal" href="#body-elements">body
elements</a> as well as <a class="reference internal" href="#transition">transition</a>, <a class="reference internal" href="#topic">topic</a>, and <a class="reference internal" href="#sidebar">sidebar</a> elements.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">section</tt> is analogous to DocBook recursive "section" elements,
and to HTML "div" elements combined with "h1" etc. title elements.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id147">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#title">title</a>,
<a class="reference internal" href="#structure-model">%structure.model;</a>)
</pre>
<p>See the <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity for details of the body
of a <tt class="docutils literal">section</tt>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">section</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#section-elements">%section.elements;</a> parameter entity directly includes
<tt class="docutils literal">section</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity indirectly
includes <tt class="docutils literal">section</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id148">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Title 1
=======
Paragraph 1.
Title 2
-------
Paragraph 2.
Title 3
=======
Paragraph 3.
Title 4
-------
Paragraph 4.
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing:</p>
<pre class="literal-block">
<document>
<section ids="title-1" names="title 1">
<title>
Title 1
<paragraph>
Paragraph 1.
<section ids="title-2" names="title 2">
<title>
Title 2
<paragraph>
Paragraph 2.
<section ids="title-3" names="title 3">
<title>
Title 3
<paragraph>
Paragraph 3.
<section ids="title-4" names="title 4">
<title>
Title 4
<paragraph>
Paragraph 4.
</pre>
</div>
</div>
<div class="section" id="sidebar">
<h2><a class="toc-backref" href="#id278"><tt class="docutils literal">sidebar</tt></a></h2>
<p>Sidebars are like miniature, parallel documents that occur inside
other documents, providing related or reference material. A
<tt class="docutils literal">sidebar</tt> 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.</p>
<p>The <tt class="docutils literal">sidebar</tt> element is a nonrecursive <a class="reference internal" href="#section">section</a>-like construct
which may occur at the top level of a <a class="reference internal" href="#section">section</a> wherever a body element
(list, table, etc.) is allowed. In other words, <tt class="docutils literal">sidebar</tt> elements
cannot nest inside body elements, so you can't have a <tt class="docutils literal">sidebar</tt>
inside a <tt class="docutils literal">table</tt> or a <tt class="docutils literal">list</tt>, or inside another <tt class="docutils literal">sidebar</tt> (or
<a class="reference internal" href="#topic">topic</a>).</p>
<div class="section" id="id149">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#structural-elements">Structural Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">The following elements may contain <tt class="docutils literal">sidebar</tt>: <a class="reference internal" href="#document">document</a>,
<a class="reference internal" href="#section">section</a></td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">sidebar</tt> elements begin with a <a class="reference internal" href="#title">title</a> and an optional <a class="reference internal" href="#subtitle">subtitle</a>
and contain <a class="reference internal" href="#body-elements">body elements</a> and <a class="reference internal" href="#topic">topic</a> elements.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">sidebar</tt> is analogous to the DocBook "sidebar" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">A <tt class="docutils literal">sidebar</tt> element should be set off from the rest of the
document somehow, typically with a border. Sidebars typically
"float" to the side of the page and the document's main text flows
around them.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id150">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#title">title</a>, <a class="reference internal" href="#subtitle">subtitle</a>?,
(<a class="reference internal" href="#id188">%body.elements;</a> | <a class="reference internal" href="#topic">topic</a>)+)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">sidebar</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity directly includes
<tt class="docutils literal">sidebar</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id151">
<h3>Examples</h3>
<p>The <a class="reference external" href="rst/directives.html#sidebar">"sidebar" directive</a> is used to create a <tt class="docutils literal">sidebar</tt> element.
<a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
.. sidebar:: Title
:subtitle: If Desired
Body.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<sidebar>
<title>
Title
<subtitle>
If Desired
<paragraph>
Body.
</pre>
</div>
</div>
<div class="section" id="status">
<h2><a class="toc-backref" href="#id279"><tt class="docutils literal">status</tt></a></h2>
<p>The <tt class="docutils literal">status</tt> element contains a status statement for the document,
such as "Draft", "Final", "Work In Progress", etc.</p>
<div class="section" id="id152">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#bibliographic-elements">Bibliographic Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#docinfo">docinfo</a> element contains <tt class="docutils literal">status</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">status</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">status</tt> is analogous to the DocBook "status" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#docinfo">docinfo</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id153">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">status</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id187">%bibliographic.elements;</a> parameter entity directly includes
<tt class="docutils literal">status</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id154">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Document Title
==============
:Status: Work In Progress
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms:</p>
<pre class="literal-block">
<document ids="document-title" names="document title">
<title>
Document Title
<docinfo>
<status>
Work In Progress
</pre>
<p>See <a class="reference internal" href="#docinfo">docinfo</a> for a more complete example, including processing
context.</p>
</div>
</div>
<div class="section" id="strong">
<h2><a class="toc-backref" href="#id280"><tt class="docutils literal">strong</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="subscript">
<h2><a class="toc-backref" href="#id281"><tt class="docutils literal">subscript</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="substitution-definition">
<h2><a class="toc-backref" href="#id282"><tt class="docutils literal">substitution_definition</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="substitution-reference">
<h2><a class="toc-backref" href="#id283"><tt class="docutils literal">substitution_reference</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="subtitle">
<h2><a class="toc-backref" href="#id284"><tt class="docutils literal">subtitle</tt></a></h2>
<p>The <tt class="docutils literal">subtitle</tt> element stores the subtitle of a <a class="reference internal" href="#document">document</a>.</p>
<div class="section" id="id155">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#structural-subelements">Structural Subelements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">The <a class="reference internal" href="#document">document</a> and <a class="reference internal" href="#sidebar">sidebar</a> elements may contain <tt class="docutils literal">subtitle</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">subtitle</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline
elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">subtitle</tt> is analogous to HTML header elements ("h2" etc.) and
to the DocBook "subtitle" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">A document's subtitle is usually rendered smaller than its <a class="reference internal" href="#title">title</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id156">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">subtitle</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id157">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
=======
Title
=======
----------
Subtitle
----------
A paragraph.
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms:</p>
<pre class="literal-block">
<document ids="title" names="title">
<title>
Title
<subtitle ids="subtitle" names="subtitle">
Subtitle
<paragraph>
A paragraph.
</pre>
<p>Note how two section levels have collapsed, promoting their titles to
become the document's title and subtitle. Since there is only one
structural element (document), the subsection's <tt class="docutils literal">ids</tt> and <tt class="docutils literal">names</tt>
attributes are stored in the <tt class="docutils literal">subtitle</tt> element.</p>
</div>
</div>
<div class="section" id="superscript">
<h2><a class="toc-backref" href="#id285"><tt class="docutils literal">superscript</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="system-message">
<h2><a class="toc-backref" href="#id286"><tt class="docutils literal">system_message</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="table">
<h2><a class="toc-backref" href="#id287"><tt class="docutils literal">table</tt></a></h2>
<p>Docutils tables are based on the Exchange subset of the CALS-table model
(OASIS Technical Memorandum 9901:1999 "XML Exchange Table Model DTD",
<a class="reference external" href="http://www.oasis-open.org/html/tm9901.htm">http://www.oasis-open.org/html/tm9901.htm</a>).</p>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="target">
<h2><a class="toc-backref" href="#id288"><tt class="docutils literal">target</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="tbody">
<h2><a class="toc-backref" href="#id289"><tt class="docutils literal">tbody</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="term">
<h2><a class="toc-backref" href="#id290"><tt class="docutils literal">term</tt></a></h2>
<p>The <tt class="docutils literal">term</tt> element contains a word or phrase being defined in a
<a class="reference internal" href="#definition-list">definition_list</a>.</p>
<div class="section" id="id158">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#body-subelements">Body Subelements</a> (simple)</td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#definition-list-item">definition_list_item</a> element contains <tt class="docutils literal">term</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">term</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">term</tt> is analogous to the HTML "dt" element and to the DocBook
"term" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">See <a class="reference internal" href="#definition-list-item">definition_list_item</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id159">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">term</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id160">
<h3>Examples</h3>
<p>See the examples for the <a class="reference internal" href="#definition-list">definition_list</a>, <a class="reference internal" href="#definition-list-item">definition_list_item</a>, and
<a class="reference internal" href="#classifier">classifier</a> elements.</p>
</div>
</div>
<div class="section" id="tgroup">
<h2><a class="toc-backref" href="#id291"><tt class="docutils literal">tgroup</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="thead">
<h2><a class="toc-backref" href="#id292"><tt class="docutils literal">thead</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="tip">
<h2><a class="toc-backref" href="#id293"><tt class="docutils literal">tip</tt></a></h2>
<p>The <tt class="docutils literal">tip</tt> element is an admonition, a distinctive and self-contained
notice. Also see the other admonition elements Docutils offers (in
alphabetical order): <a class="reference internal" href="#attention">attention</a>, <a class="reference internal" href="#caution">caution</a>, <a class="reference internal" href="#danger">danger</a>, <a class="reference internal" href="#error">error</a>, <a class="reference internal" href="#hint">hint</a>,
<a class="reference internal" href="#important">important</a>, <a class="reference internal" href="#note">note</a>, <a class="reference internal" href="#warning">warning</a>, and the generic <a class="reference internal" href="#admonition">admonition</a>.</p>
<div class="section" id="id161">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id188">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">tip</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">tip</tt> elements contain one or more <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">tip</tt> is analogous to the DocBook "tip" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Rendered distinctly (inset and/or in a box, etc.), with the
generated title "Tip" (or similar).</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id162">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id188">%body.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">tip</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>: <a class="reference internal" href="#ids">ids</a>,
<a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id188">%body.elements;</a> parameter entity directly includes <tt class="docutils literal">tip</tt>.
The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity indirectly includes
<tt class="docutils literal">tip</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id163">
<h3>Examples</h3>
<p>reStructuredText source:</p>
<pre class="literal-block">
.. Tip:: 15% if the service is good.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<tip>
<paragraph>
15% if the service is good.
</pre>
</div>
</div>
<div class="section" id="id164">
<span id="title"></span><h2><a class="toc-backref" href="#id294"><tt class="docutils literal">title</tt></a></h2>
<p>The <tt class="docutils literal">title</tt> element stores the title of a <a class="reference internal" href="#document">document</a>, <a class="reference internal" href="#section">section</a>,
<a class="reference internal" href="#topic">topic</a>, <a class="reference internal" href="#sidebar">sidebar</a>, or generic <a class="reference internal" href="#admonition">admonition</a>.</p>
<div class="section" id="id165">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#structural-subelements">Structural Subelements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">The following elements may contain <tt class="docutils literal">title</tt>: <a class="reference internal" href="#document">document</a>, <a class="reference internal" href="#section">section</a>,
<a class="reference internal" href="#topic">topic</a>, <a class="reference internal" href="#sidebar">sidebar</a>, <a class="reference internal" href="#admonition">admonition</a></td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">title</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">title</tt> is analogous to HTML "title" and header ("h1" etc.)
elements, and to the DocBook "title" element.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id166">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body"><p class="first">The <tt class="docutils literal">title</tt> element contains the <a class="reference internal" href="#common-attributes">common attributes</a> (<a class="reference internal" href="#ids">ids</a>,
<a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>), plus <a class="reference internal" href="#refid">refid</a> and <a class="reference internal" href="#auto">auto</a>.</p>
<p><tt class="docutils literal">refid</tt> is used as a backlink to a table of contents entry.</p>
<p class="last"><tt class="docutils literal">auto</tt> is used to indicate (with value "1") that the <tt class="docutils literal">title</tt>
has been numbered automatically.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id167">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
A Title
=======
A paragraph.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<section ids="a-title" names="a title">
<title>
A Title
<paragraph>
A paragraph.
</pre>
</div>
</div>
<div class="section" id="title-reference">
<h2><a class="toc-backref" href="#id295"><tt class="docutils literal">title_reference</tt></a></h2>
<p><a class="reference internal" href="#to-be-completed">To be completed</a>.</p>
</div>
<div class="section" id="topic">
<h2><a class="toc-backref" href="#id296"><tt class="docutils literal">topic</tt></a></h2>
<p>The <tt class="docutils literal">topic</tt> element is a nonrecursive <a class="reference internal" href="#section">section</a>-like construct which
may occur at the top level of a <a class="reference internal" href="#section">section</a> wherever a body element
(list, table, etc.) is allowed. In other words, <tt class="docutils literal">topic</tt> elements
cannot nest inside body elements, so you can't have a <tt class="docutils literal">topic</tt> inside
a <tt class="docutils literal">table</tt> or a <tt class="docutils literal">list</tt>, or inside another <tt class="docutils literal">topic</tt>.</p>
<div class="section" id="id168">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#structural-elements">Structural Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">The following elements may contain <tt class="docutils literal">topic</tt>: <a class="reference internal" href="#document">document</a>, <a class="reference internal" href="#section">section</a>,
<a class="reference internal" href="#sidebar">sidebar</a></td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">topic</tt> elements begin with a <a class="reference internal" href="#title">title</a> and may contain <a class="reference internal" href="#body-elements">body
elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">topic</tt> is analogous to the DocBook "simplesect" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">A <tt class="docutils literal">topic</tt> element should be set off from the rest of the
document somehow, such as with indentation or a border.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id169">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#title">title</a>?,
(<a class="reference internal" href="#id188">%body.elements;</a>)+)
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">topic</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity directly includes
<tt class="docutils literal">topic</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id170">
<h3>Examples</h3>
<p>The <a class="reference external" href="rst/directives.html#topic">"topic" directive</a> is used to create a <tt class="docutils literal">topic</tt> element.
<a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
.. topic:: Title
Body.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<topic>
<title>
Title
<paragraph>
Body.
</pre>
</div>
</div>
<div class="section" id="transition">
<h2><a class="toc-backref" href="#id297"><tt class="docutils literal">transition</tt></a></h2>
<p>The <tt class="docutils literal">transition</tt> element is commonly seen in novels and short
fiction, as a gap spanning one or more lines, with or without a type
ornament such as a row of asterisks. Transitions separate body
elements and sections, dividing a section into untitled divisions. A
transition may not begin or end a section <a class="footnote-reference" href="#id172" id="id171">[2]</a> or document, nor may
two transitions be immediately adjacent.</p>
<p>See <a class="reference external" href="../dev/rst/alternatives.html#doctree-representation-of-transitions">Doctree Representation of Transitions</a> in <a class="reference external" href="../dev/rst/alternatives.html">A Record of
reStructuredText Syntax Alternatives</a>.</p>
<table class="docutils footnote" frame="void" id="id172" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id171">[2]</a></td><td>In reStructuredText markup, a transition may appear to fall at
the end of a section immediately before another section. A
transform recognizes this case and moves the transition so it
separates the sections.</td></tr>
</tbody>
</table>
<div class="section" id="id175">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#structural-subelements">Structural Subelements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">The following elements may contain <tt class="docutils literal">transition</tt>: <a class="reference internal" href="#document">document</a>,
<a class="reference internal" href="#section">section</a></td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">transition</tt> is an empty element and has no children.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">transition</tt> is analogous to the HTML "hr" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">The <tt class="docutils literal">transition</tt> element is typically rendered as vertical
whitespace (more than that separating paragraphs), with or without
a horizontal line or row of asterisks. In novels, transitions are
often represented as a row of three well-spaced asterisks with
vertical space above and below.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id176">
<h3>Content Model</h3>
<pre class="literal-block">
EMPTY
</pre>
<p>The <tt class="docutils literal">transition</tt> element has no content; it is a "point element".</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">transition</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity directly includes
<tt class="docutils literal">transition</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id177">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Paragraph 1.
--------
Paragraph 2.
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing:</p>
<pre class="literal-block">
<document>
<paragraph>
Paragraph 1.
<transition>
<paragraph>
Paragraph 2.
</pre>
</div>
</div>
<div class="section" id="version">
<h2><a class="toc-backref" href="#id298"><tt class="docutils literal">version</tt></a></h2>
<p>The <tt class="docutils literal">version</tt> element contains the version number of the document.
It can be used alone or in conjunction with <a class="reference internal" href="#revision">revision</a>.</p>
<div class="section" id="id178">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#bibliographic-elements">Bibliographic Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">Only the <a class="reference internal" href="#docinfo">docinfo</a> element contains <tt class="docutils literal">version</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">version</tt> elements may contain text data plus <a class="reference internal" href="#inline-elements">inline
elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">version</tt> may be considered analogous to the DocBook "revision",
"revnumber", or "biblioid" elements.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Sometimes used with the RCS/CVS keyword "Revision". See <a class="reference internal" href="#docinfo">docinfo</a>
and <a class="reference internal" href="#revision">revision</a>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id179">
<h3>Content Model</h3>
<pre class="literal-block">
<a class="reference internal" href="#text-model">%text.model;</a>
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">version</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id187">%bibliographic.elements;</a> parameter entity directly includes
<tt class="docutils literal">version</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id180">
<h3>Examples</h3>
<p><a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source:</p>
<pre class="literal-block">
Document Title
==============
:Version: 1.1
</pre>
<p>Complete <a class="reference internal" href="#pseudo-xml">pseudo-XML</a> result after parsing and applying transforms:</p>
<pre class="literal-block">
<document ids="document-title" names="document title">
<title>
Document Title
<docinfo>
<version>
1.1
</pre>
<p>See <a class="reference internal" href="#docinfo">docinfo</a> for a more complete example, including processing
context.</p>
</div>
</div>
<div class="section" id="warning">
<h2><a class="toc-backref" href="#id299"><tt class="docutils literal">warning</tt></a></h2>
<p>The <tt class="docutils literal">warning</tt> element is an admonition, a distinctive and
self-contained notice. Also see the other admonition elements
Docutils offers (in alphabetical order): <a class="reference internal" href="#attention">attention</a>, <a class="reference internal" href="#caution">caution</a>,
<a class="reference internal" href="#danger">danger</a>, <a class="reference internal" href="#error">error</a>, <a class="reference internal" href="#hint">hint</a>, <a class="reference internal" href="#important">important</a>, <a class="reference internal" href="#note">note</a>, <a class="reference internal" href="#tip">tip</a>.</p>
<div class="section" id="id181">
<h3>Details</h3>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Category:</th><td class="field-body"><a class="reference internal" href="#compound-body-elements">Compound Body Elements</a></td>
</tr>
<tr class="field"><th class="field-name">Parents:</th><td class="field-body">All elements employing the <a class="reference internal" href="#id188">%body.elements;</a> or
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entities in their content models
may contain <tt class="docutils literal">warning</tt>.</td>
</tr>
<tr class="field"><th class="field-name">Children:</th><td class="field-body"><tt class="docutils literal">warning</tt> elements contain one or more <a class="reference internal" href="#body-elements">body elements</a>.</td>
</tr>
<tr class="field"><th class="field-name">Analogues:</th><td class="field-body"><tt class="docutils literal">warning</tt> is analogous to the DocBook "warning" element.</td>
</tr>
<tr class="field"><th class="field-name">Processing:</th><td class="field-body">Rendered distinctly (inset and/or in a box, etc.), with the
generated title "Warning" (or similar).</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id182">
<h3>Content Model</h3>
<pre class="literal-block">
(<a class="reference internal" href="#id188">%body.elements;</a>)+
</pre>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Attributes:</th><td class="field-body">The <tt class="docutils literal">warning</tt> element contains only the <a class="reference internal" href="#common-attributes">common attributes</a>:
<a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>, <a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">Parameter Entities:</th></tr>
<tr class="field"><td> </td><td class="field-body">The <a class="reference internal" href="#id188">%body.elements;</a> parameter entity directly includes
<tt class="docutils literal">warning</tt>. The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity indirectly
includes <tt class="docutils literal">warning</tt>.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id183">
<h3>Examples</h3>
<p>reStructuredText source:</p>
<pre class="literal-block">
.. WARNING:: Reader discretion is strongly advised.
</pre>
<p><a class="reference internal" href="#pseudo-xml">Pseudo-XML</a> fragment from simple parsing:</p>
<pre class="literal-block">
<warning>
<paragraph>
Reader discretion is strongly advised.
</pre>
</div>
</div>
</div>
<div class="section" id="attribute-reference">
<h1><a class="toc-backref" href="#id192">Attribute Reference</a></h1>
<div class="contents local topic" id="id184">
<ul class="simple">
<li><a class="reference internal" href="#anonymous" id="id300"><tt class="docutils literal">anonymous</tt></a></li>
<li><a class="reference internal" href="#auto" id="id301"><tt class="docutils literal">auto</tt></a></li>
<li><a class="reference internal" href="#backrefs" id="id302"><tt class="docutils literal">backrefs</tt></a></li>
<li><a class="reference internal" href="#bullet" id="id303"><tt class="docutils literal">bullet</tt></a></li>
<li><a class="reference internal" href="#classes" id="id304"><tt class="docutils literal">classes</tt></a></li>
<li><a class="reference internal" href="#delimiter" id="id305"><tt class="docutils literal">delimiter</tt></a></li>
<li><a class="reference internal" href="#dupnames" id="id306"><tt class="docutils literal">dupnames</tt></a></li>
<li><a class="reference internal" href="#enumtype" id="id307"><tt class="docutils literal">enumtype</tt></a></li>
<li><a class="reference internal" href="#ids" id="id308"><tt class="docutils literal">ids</tt></a></li>
<li><a class="reference internal" href="#names" id="id309"><tt class="docutils literal">names</tt></a></li>
<li><a class="reference internal" href="#prefix" id="id310"><tt class="docutils literal">prefix</tt></a></li>
<li><a class="reference internal" href="#refid" id="id311"><tt class="docutils literal">refid</tt></a></li>
<li><a class="reference internal" href="#refname" id="id312"><tt class="docutils literal">refname</tt></a></li>
<li><a class="reference internal" href="#refuri" id="id313"><tt class="docutils literal">refuri</tt></a></li>
<li><a class="reference internal" href="#source" id="id314"><tt class="docutils literal">source</tt></a></li>
<li><a class="reference internal" href="#start" id="id315"><tt class="docutils literal">start</tt></a></li>
<li><a class="reference internal" href="#suffix" id="id316"><tt class="docutils literal">suffix</tt></a></li>
<li><a class="reference internal" href="#xml-space" id="id317"><tt class="docutils literal">xml:space</tt></a></li>
<li><a class="reference internal" href="#id185" id="id318"><tt class="docutils literal">title</tt></a></li>
</ul>
</div>
<p><span class="target" id="common-attributes">Common Attributes</span>: Through the <a class="reference internal" href="#basic-atts">%basic.atts;</a> parameter entity,
all elements contain the following attributes: <a class="reference internal" href="#ids">ids</a>, <a class="reference internal" href="#names">names</a>, <a class="reference internal" href="#dupnames">dupnames</a>,
<a class="reference internal" href="#source">source</a>, and <a class="reference internal" href="#classes">classes</a>.</p>
<p id="attribute-type">Attribute types:</p>
<dl class="docutils">
<dt><tt class="docutils literal">CDATA</tt></dt>
<dd>Character data. <tt class="docutils literal">CDATA</tt> attributes may contain arbitrary text.</dd>
<dt><tt class="docutils literal">ID</tt></dt>
<dd>Like a <tt class="docutils literal">NMTOKEN</tt>, but it must begin with a letter (a "name
production"). Identical <tt class="docutils literal">ID</tt> values must not appear more than
once in a document; i.e., ID values must uniquely identify their
elements.</dd>
<dt><tt class="docutils literal">IDREF</tt></dt>
<dd>A reference to an <tt class="docutils literal">ID</tt> value (a name production) of another
element.</dd>
<dt><tt class="docutils literal">IDREFS</tt></dt>
<dd>One or more space-separated <tt class="docutils literal">ID</tt> references (name productions).</dd>
<dt><tt class="docutils literal">NMTOKEN</tt></dt>
<dd>A "name token". One or more of letters, digits, ".", "-", and
"_".</dd>
<dt><tt class="docutils literal">NMTOKENS</tt></dt>
<dd>One or more space-separated <tt class="docutils literal">NMTOKEN</tt> names.</dd>
<dt><tt class="docutils literal">%yesorno;</tt></dt>
<dd>No if zero ("0"), yes if any other value. This is a parameter
entity which resolves to a <tt class="docutils literal">NMTOKEN</tt> attribute type.</dd>
<dt><tt class="docutils literal">%number;</tt></dt>
<dd>This emphasizes that the attribute value must be a number. This
is a parameter entity which resolves to a <tt class="docutils literal">NMTOKEN</tt> attribute
type.</dd>
<dt>enumeration</dt>
<dd>The attribute value may be one of a specified list of values.</dd>
</dl>
<div class="section" id="anonymous">
<h2><a class="toc-backref" href="#id300"><tt class="docutils literal">anonymous</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">%yesorno;</tt>. Default value: none (implies no).</p>
<p>The <tt class="docutils literal">anonymous</tt> attribute is used for unnamed hyperlinks in the
<a class="reference internal" href="#target">target</a> and <a class="reference internal" href="#reference">reference</a> elements (via the <a class="reference internal" href="#anonymous-att">%anonymous.att;</a> parameter
entity).</p>
</div>
<div class="section" id="auto">
<h2><a class="toc-backref" href="#id301"><tt class="docutils literal">auto</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">CDATA</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">auto</tt> attribute is used to indicate automatically-numbered
<a class="reference internal" href="#footnote">footnote</a>, <a class="reference internal" href="#footnote-reference">footnote_reference</a> and <a class="reference internal" href="#title">title</a> elements (via the
<a class="reference internal" href="#auto-att">%auto.att;</a> parameter entity).</p>
</div>
<div class="section" id="backrefs">
<h2><a class="toc-backref" href="#id302"><tt class="docutils literal">backrefs</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">IDREFS</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">backrefs</tt> attribute contains a space-separated list of <a class="reference internal" href="#ids">ids</a>
references, used for backlinks from <a class="reference internal" href="#footnote">footnote</a>, <a class="reference internal" href="#citation">citation</a>, and
<a class="reference internal" href="#system-message">system_message</a> elements (via the <a class="reference internal" href="#backrefs-att">%backrefs.att;</a> parameter entity).</p>
</div>
<div class="section" id="bullet">
<h2><a class="toc-backref" href="#id303"><tt class="docutils literal">bullet</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">CDATA</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">bullet</tt> attribute is used in the <a class="reference internal" href="#bullet-list">bullet_list</a> element.</p>
</div>
<div class="section" id="classes">
<h2><a class="toc-backref" href="#id304"><tt class="docutils literal">classes</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">NMTOKENS</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">classes</tt> attribute is a list containing zero or more names used
to classify an element. The names are converted to conform to the
regular expression <tt class="docutils literal"><span class="pre">[a-z](-?[a-z0-9]+)*</span></tt> (see the <a class="reference external" href="rst/directives.html#class">"class"
directive</a> description for details and <a class="reference external" href="rst/directives.html#rationale">rationale</a>).</p>
<p>The purpose of the attribute is to indicate
an "is-a" variant relationship, to allow an extensible way of defining
sub-classes of existing elements. It can be used to carry context
forward between a Docutils Reader and Writer, when a custom structure
is reduced to a standardized document tree. One common use is in
conjunction with stylesheets, to add selection criteria. It should
not be used to carry formatting instructions or arbitrary content.</p>
<p>The <tt class="docutils literal">classes</tt> attribute's contents should be ignorable. Writers that
are not familiar with the variant expressed should be able to ignore
the attribute.</p>
<p><tt class="docutils literal">classes</tt> is one of the <a class="reference internal" href="#common-attributes">common attributes</a>, shared by all Docutils
elements.</p>
</div>
<div class="section" id="delimiter">
<h2><a class="toc-backref" href="#id305"><tt class="docutils literal">delimiter</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">CDATA</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">delimiter</tt> attribute is used in the <a class="reference internal" href="#option-argument">option_argument</a> element.</p>
</div>
<div class="section" id="dupnames">
<h2><a class="toc-backref" href="#id306"><tt class="docutils literal">dupnames</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">CDATA</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">dupnames</tt> attribute is a list containing the names of an
element when there has been a naming conflict. The contents of the
<tt class="docutils literal">dupnames</tt> attribute would have been transferred from the <a class="reference internal" href="#names">names</a>
attribute. An element may have at most one of the <tt class="docutils literal">names</tt> or
<tt class="docutils literal">dupnames</tt> attributes, but not both. <tt class="docutils literal">dupnames</tt> is one of the
<a class="reference internal" href="#common-attributes">common attributes</a>, shared by all Docutils elements.</p>
</div>
<div class="section" id="enumtype">
<h2><a class="toc-backref" href="#id307"><tt class="docutils literal">enumtype</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: enumeration, one of "arabic", "loweralpha",
"upperalpha", "lowerroman", or "upperroman". Default value: none.</p>
<p>The <tt class="docutils literal">enumtype</tt> attribute is used in the <a class="reference internal" href="#enumerated-list">enumerated_list</a> element.</p>
</div>
<div class="section" id="ids">
<h2><a class="toc-backref" href="#id308"><tt class="docutils literal">ids</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">NMTOKENS</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">ids</tt> attribute is a list containing one or more unique
identifier keys. <tt class="docutils literal">ids</tt> is one of the <a class="reference internal" href="#common-attributes">common attributes</a>, shared
by all Docutils elements.</p>
</div>
<div class="section" id="names">
<h2><a class="toc-backref" href="#id309"><tt class="docutils literal">names</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">CDATA</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">names</tt> attribute is a list containing the names of an element,
typically originating from the element's title or content. Each name
in <tt class="docutils literal">names</tt> must be unique; if there are name conflicts (two or more
elements want to the same name), the contents will be transferred to
the <a class="reference internal" href="#dupnames">dupnames</a> attribute on the duplicate elements. An element may
have at most one of the <tt class="docutils literal">names</tt> or <tt class="docutils literal">dupnames</tt> attributes, but not
both. <tt class="docutils literal">names</tt> is one of the <a class="reference internal" href="#common-attributes">common attributes</a>, shared by all
Docutils elements.</p>
</div>
<div class="section" id="prefix">
<h2><a class="toc-backref" href="#id310"><tt class="docutils literal">prefix</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">CDATA</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">prefix</tt> attribute is used in the <a class="reference internal" href="#enumerated-list">enumerated_list</a> element.</p>
</div>
<div class="section" id="refid">
<h2><a class="toc-backref" href="#id311"><tt class="docutils literal">refid</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">IDREF</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">refid</tt> attribute contains references to <a class="reference internal" href="#ids">ids</a> attributes in
other elements. It is used by the <a class="reference internal" href="#target">target</a>, <a class="reference internal" href="#reference">reference</a>,
<a class="reference internal" href="#footnote-reference">footnote_reference</a>, <a class="reference internal" href="#citation-reference">citation_reference</a>, <a class="reference internal" href="#title">title</a> and <a class="reference internal" href="#problematic">problematic</a>
elements (via the <a class="reference internal" href="#refid-att">%refid.att;</a> and <a class="reference internal" href="#reference-atts">%reference.atts;</a> parameter
entities).</p>
</div>
<div class="section" id="refname">
<h2><a class="toc-backref" href="#id312"><tt class="docutils literal">refname</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">NMTOKENS</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">refname</tt> attribute contains an internal reference to the
<a class="reference internal" href="#names">names</a> attribute of another element. On a <a class="reference internal" href="#target">target</a> element,
<tt class="docutils literal">refname</tt> indicates an indirect target which may resolve to either
an internal or external reference. <tt class="docutils literal">refname</tt> is used by the
<a class="reference internal" href="#target">target</a>, <a class="reference internal" href="#reference">reference</a>, <a class="reference internal" href="#footnote-reference">footnote_reference</a>, <a class="reference internal" href="#citation-reference">citation_reference</a>, and
<a class="reference internal" href="#substitution-reference">substitution_reference</a> elements (via the <a class="reference internal" href="#refname-att">%refname.att;</a> and
<a class="reference internal" href="#reference-atts">%reference.atts;</a> parameter entities).</p>
</div>
<div class="section" id="refuri">
<h2><a class="toc-backref" href="#id313"><tt class="docutils literal">refuri</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">CDATA</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">refuri</tt> attribute contains an external reference to a URI/URL.
It is used by the <a class="reference internal" href="#target">target</a>, <a class="reference internal" href="#reference">reference</a>, <a class="reference internal" href="#footnote-reference">footnote_reference</a>, and
<a class="reference internal" href="#citation-reference">citation_reference</a> elements (via the <a class="reference internal" href="#reference-atts">%reference.atts;</a> parameter
entity).</p>
</div>
<div class="section" id="source">
<h2><a class="toc-backref" href="#id314"><tt class="docutils literal">source</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">CDATA</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">source</tt> attribute is used to store the path or URL to the
source text that was used to produce the document tree. It is one of
the <a class="reference internal" href="#common-attributes">common attributes</a>, shared by all Docutils elements.</p>
</div>
<div class="section" id="start">
<h2><a class="toc-backref" href="#id315"><tt class="docutils literal">start</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">%number;</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">start</tt> attribute is used in the <a class="reference internal" href="#enumerated-list">enumerated_list</a> element.</p>
</div>
<div class="section" id="suffix">
<h2><a class="toc-backref" href="#id316"><tt class="docutils literal">suffix</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">CDATA</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">suffix</tt> attribute is used in the <a class="reference internal" href="#enumerated-list">enumerated_list</a> element.</p>
</div>
<div class="section" id="xml-space">
<h2><a class="toc-backref" href="#id317"><tt class="docutils literal">xml:space</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: one of "default" or "preserve". Default value:
"preserve" (fixed).</p>
<p>The <tt class="docutils literal">xml:space</tt> attribute is a standard XML attribute for
whitespace-preserving elements. It is used by the <a class="reference internal" href="#literal-block">literal_block</a>,
<a class="reference internal" href="#line-block">line_block</a>, <a class="reference internal" href="#doctest-block">doctest_block</a>, <a class="reference internal" href="#comment">comment</a>, and <a class="reference internal" href="#raw">raw</a> elements (via the
<a class="reference internal" href="#fixedspace-att">%fixedspace.att;</a> parameter entity). It is a fixed attribute, meant
to communicate to an XML parser that the element contains significant
whitespace. The attribute value should not be set in a document
instance.</p>
</div>
<div class="section" id="id185">
<span id="title-attribute"></span><h2><a class="toc-backref" href="#id318"><tt class="docutils literal">title</tt></a></h2>
<p><a class="reference internal" href="#attribute-type">Attribute type</a>: <tt class="docutils literal">CDATA</tt>. Default value: none.</p>
<p>The <tt class="docutils literal">title</tt> attribute stores the title metadata of a document. This
title is typically not part of the rendered document. It may for
example be used in HTML's <tt class="docutils literal">title</tt> element.</p>
</div>
</div>
<div class="section" id="parameter-entity-reference">
<h1><a class="toc-backref" href="#id193">Parameter Entity Reference</a></h1>
<div class="contents local topic" id="id186">
<ul class="simple">
<li><a class="reference internal" href="#anonymous-att" id="id319"><tt class="docutils literal">%anonymous.att;</tt></a></li>
<li><a class="reference internal" href="#auto-att" id="id320"><tt class="docutils literal">%auto.att;</tt></a></li>
<li><a class="reference internal" href="#backrefs-att" id="id321"><tt class="docutils literal">%backrefs.att;</tt></a></li>
<li><a class="reference internal" href="#basic-atts" id="id322"><tt class="docutils literal">%basic.atts;</tt></a></li>
<li><a class="reference internal" href="#id187" id="id323"><tt class="docutils literal">%bibliographic.elements;</tt></a></li>
<li><a class="reference internal" href="#id188" id="id324"><tt class="docutils literal">%body.elements;</tt></a></li>
<li><a class="reference internal" href="#fixedspace-att" id="id325"><tt class="docutils literal">%fixedspace.att;</tt></a></li>
<li><a class="reference internal" href="#id189" id="id326"><tt class="docutils literal">%inline.elements;</tt></a></li>
<li><a class="reference internal" href="#reference-atts" id="id327"><tt class="docutils literal">%reference.atts;</tt></a></li>
<li><a class="reference internal" href="#refid-att" id="id328"><tt class="docutils literal">%refid.att;</tt></a></li>
<li><a class="reference internal" href="#refname-att" id="id329"><tt class="docutils literal">%refname.att;</tt></a></li>
<li><a class="reference internal" href="#refuri-att" id="id330"><tt class="docutils literal">%refuri.att;</tt></a></li>
<li><a class="reference internal" href="#section-elements" id="id331"><tt class="docutils literal">%section.elements;</tt></a></li>
<li><a class="reference internal" href="#structure-model" id="id332"><tt class="docutils literal">%structure.model;</tt></a></li>
<li><a class="reference internal" href="#text-model" id="id333"><tt class="docutils literal">%text.model;</tt></a></li>
</ul>
</div>
<p>Parameter entities are used to simplify the DTD (to share definitions
and reduce duplication) and to allow the DTD to be customized by
wrapper DTDs (external client DTDs that use or import the Docutils
DTD). Parameter entities may be overridden by wrapper DTDs, replacing
the definitions below with custom definitions. Parameter entities
whose names begin with "additional" are meant to allow easy extension
by wrapper DTDs.</p>
<div class="section" id="anonymous-att">
<h2><a class="toc-backref" href="#id319"><tt class="docutils literal">%anonymous.att;</tt></a></h2>
<p>The <tt class="docutils literal">%anonymous.att;</tt> parameter entity contains the <a class="reference internal" href="#anonymous">anonymous</a>
attribute, used for unnamed hyperlinks.</p>
<p>Entity definition:</p>
<pre class="literal-block">
<a class="reference internal" href="#anonymous">anonymous</a> %yesorno; #IMPLIED
</pre>
<p>The <a class="reference internal" href="#reference">reference</a> and <a class="reference internal" href="#target">target</a> elements directly employ the
<tt class="docutils literal">%anonymous.att;</tt> parameter entity in their attribute lists.</p>
</div>
<div class="section" id="auto-att">
<h2><a class="toc-backref" href="#id320"><tt class="docutils literal">%auto.att;</tt></a></h2>
<p>The <tt class="docutils literal">%auto.att;</tt> parameter entity contains the <a class="reference internal" href="#auto">auto</a> attribute, used
to indicate an automatically-numbered footnote or title.</p>
<p>Entity definition:</p>
<pre class="literal-block">
<a class="reference internal" href="#auto">auto</a> CDATA #IMPLIED
</pre>
<p>The <a class="reference internal" href="#footnote">footnote</a>, <a class="reference internal" href="#footnote-reference">footnote_reference</a>, and <a class="reference internal" href="#title">title</a> elements directly
employ the <tt class="docutils literal">%auto.att;</tt> parameter entity in their attribute lists.</p>
</div>
<div class="section" id="backrefs-att">
<h2><a class="toc-backref" href="#id321"><tt class="docutils literal">%backrefs.att;</tt></a></h2>
<p>The <tt class="docutils literal">%backrefs.att;</tt> parameter entity contains the <a class="reference internal" href="#backrefs">backrefs</a>
attribute, a space-separated list of id references, for backlinks.</p>
<p>Entity definition:</p>
<pre class="literal-block">
<a class="reference internal" href="#backrefs">backrefs</a> IDREFS #IMPLIED
</pre>
<p>The <a class="reference internal" href="#citation">citation</a>, <a class="reference internal" href="#footnote">footnote</a>, and <a class="reference internal" href="#system-message">system_message</a> elements directly employ
the <tt class="docutils literal">%backrefs.att;</tt> parameter entity in their attribute lists.</p>
</div>
<div class="section" id="basic-atts">
<h2><a class="toc-backref" href="#id322"><tt class="docutils literal">%basic.atts;</tt></a></h2>
<p>The <tt class="docutils literal">%basic.atts;</tt> parameter entity lists attributes common to all
Docutils elements. See <a class="reference internal" href="#common-attributes">Common Attributes</a>.</p>
<p>Entity definition:</p>
<pre class="literal-block">
<a class="reference internal" href="#ids">ids</a> NMTOKENS #IMPLIED
<a class="reference internal" href="#names">names</a> CDATA #IMPLIED
<a class="reference internal" href="#dupnames">dupnames</a> CDATA #IMPLIED
<a class="reference internal" href="#source">source</a> CDATA #IMPLIED
<a class="reference internal" href="#classes">classes</a> NMTOKENS #IMPLIED
%additional.basic.atts;
</pre>
<p>The <tt class="docutils literal">%additional.basic.atts;</tt> parameter entity can be used by
wrapper DTDs to extend <tt class="docutils literal">%basic.atts;</tt>.</p>
</div>
<div class="section" id="id187">
<h2><a class="toc-backref" href="#id323"><tt class="docutils literal">%bibliographic.elements;</tt></a></h2>
<p>The <tt class="docutils literal">%bibliographic.elements;</tt> parameter entity contains an OR-list of all
<a class="reference internal" href="#bibliographic-elements">bibliographic elements</a>.</p>
<p>Entity definition:</p>
<pre class="literal-block">
<a class="reference internal" href="#author">author</a> | <a class="reference internal" href="#authors">authors</a> | <a class="reference internal" href="#organization">organization</a> | <a class="reference internal" href="#contact">contact</a> | <a class="reference internal" href="#address">address</a>
| <a class="reference internal" href="#version">version</a> | <a class="reference internal" href="#revision">revision</a> | <a class="reference internal" href="#status">status</a> | <a class="reference internal" href="#date">date</a> | <a class="reference internal" href="#copyright">copyright</a>
| <a class="reference internal" href="#field">field</a>
%additional.bibliographic.elements;
</pre>
<p>The <tt class="docutils literal">%additional.bibliographic.elements;</tt> parameter entity can be used by
wrapper DTDs to extend <tt class="docutils literal">%bibliographic.elements;</tt>.</p>
<p>Only the <a class="reference internal" href="#docinfo">docinfo</a> element directly employs the
<tt class="docutils literal">%bibliographic.elements;</tt> parameter entity in its content model.</p>
</div>
<div class="section" id="id188">
<h2><a class="toc-backref" href="#id324"><tt class="docutils literal">%body.elements;</tt></a></h2>
<p>The <tt class="docutils literal">%body.elements;</tt> parameter entity contains an OR-list of all
<a class="reference internal" href="#body-elements">body elements</a>. <tt class="docutils literal">%body.elements;</tt> is itself contained within the
<a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity.</p>
<p>Entity definition:</p>
<pre class="literal-block">
<a class="reference internal" href="#admonition">admonition</a> | <a class="reference internal" href="#attention">attention</a> | <a class="reference internal" href="#block-quote">block_quote</a> | <a class="reference internal" href="#bullet-list">bullet_list</a> | <a class="reference internal" href="#caution">caution</a>
| <a class="reference internal" href="#citation">citation</a> | <a class="reference internal" href="#compound">compound</a> | <a class="reference internal" href="#comment">comment</a> | <a class="reference internal" href="#container">container</a> | <a class="reference internal" href="#danger">danger</a> |
<a class="reference internal" href="#definition-list">definition_list</a> | <a class="reference internal" href="#doctest-block">doctest_block</a> | <a class="reference internal" href="#enumerated-list">enumerated_list</a> | <a class="reference internal" href="#error">error</a> |
<a class="reference internal" href="#field-list">field_list</a> | <a class="reference internal" href="#figure">figure</a> | <a class="reference internal" href="#footnote">footnote</a> | <a class="reference internal" href="#hint">hint</a> | <a class="reference internal" href="#image">image</a> | <a class="reference internal" href="#important">important</a>
| <a class="reference internal" href="#line-block">line_block</a> | <a class="reference internal" href="#literal-block">literal_block</a> | <a class="reference internal" href="#note">note</a> | <a class="reference internal" href="#option-list">option_list</a> |
<a class="reference internal" href="#paragraph">paragraph</a> | <a class="reference internal" href="#pending">pending</a> | <a class="reference internal" href="#raw">raw</a> <a class="reference internal" href="#reference">reference</a> | <a class="reference internal" href="#rubric">rubric</a> |
<a class="reference internal" href="#substitution-definition">substitution_definition</a> | <a class="reference internal" href="#system-message">system_message</a> | <a class="reference internal" href="#table">table</a> | <a class="reference internal" href="#target">target</a> |
<a class="reference internal" href="#tip">tip</a> | <a class="reference internal" href="#warning">warning</a> %additional.body.elements;
</pre>
<p>The <tt class="docutils literal">%additional.body.elements;</tt> parameter entity can be used by
wrapper DTDs to extend <tt class="docutils literal">%body.elements;</tt>.</p>
<p>The <tt class="docutils literal">%body.elements;</tt> parameter entity is directly employed in the
content models of the following elements: <a class="reference internal" href="#admonition">admonition</a>, <a class="reference internal" href="#attention">attention</a>,
<a class="reference internal" href="#block-quote">block_quote</a>, <a class="reference internal" href="#caution">caution</a>, <a class="reference internal" href="#citation">citation</a>, <a class="reference internal" href="#compound">compound</a>, <a class="reference internal" href="#danger">danger</a>, <a class="reference internal" href="#definition">definition</a>,
<a class="reference internal" href="#description">description</a>, <a class="reference internal" href="#entry">entry</a>, <a class="reference internal" href="#error">error</a>, <a class="reference internal" href="#field-body">field_body</a>, <a class="reference internal" href="#footer">footer</a>, <a class="reference internal" href="#footnote">footnote</a>,
<a class="reference internal" href="#header">header</a>, <a class="reference internal" href="#hint">hint</a>, <a class="reference internal" href="#important">important</a>, <a class="reference internal" href="#legend">legend</a>, <a class="reference internal" href="#list-item">list_item</a>, <a class="reference internal" href="#note">note</a>, <a class="reference internal" href="#sidebar">sidebar</a>,
<a class="reference internal" href="#system-message">system_message</a>, <a class="reference internal" href="#tip">tip</a>, <a class="reference internal" href="#topic">topic</a>, <a class="reference internal" href="#warning">warning</a></p>
<p>Via <a class="reference internal" href="#structure-model">%structure.model;</a>, the <tt class="docutils literal">%body.elements;</tt> parameter entity is
indirectly employed in the content models of the <a class="reference internal" href="#document">document</a> and
<a class="reference internal" href="#section">section</a> elements.</p>
</div>
<div class="section" id="fixedspace-att">
<h2><a class="toc-backref" href="#id325"><tt class="docutils literal">%fixedspace.att;</tt></a></h2>
<p>The <tt class="docutils literal">%fixedspace.att;</tt> parameter entity contains the <a class="reference internal" href="#xml-space">xml:space</a>
attribute, a standard XML attribute for whitespace-preserving
elements.</p>
<p>Entity definition:</p>
<pre class="literal-block">
<a class="reference internal" href="#xml-space">xml:space</a> (default | preserve) #FIXED 'preserve'
</pre>
<p>The <tt class="docutils literal">%fixedspace.att;</tt> parameter entity is directly employed in the
attribute lists of the following elements: <a class="reference internal" href="#address">address</a>, <a class="reference internal" href="#comment">comment</a>,
<a class="reference internal" href="#doctest-block">doctest_block</a>, <a class="reference internal" href="#line-block">line_block</a>, <a class="reference internal" href="#literal-block">literal_block</a>, <a class="reference internal" href="#raw">raw</a></p>
</div>
<div class="section" id="id189">
<h2><a class="toc-backref" href="#id326"><tt class="docutils literal">%inline.elements;</tt></a></h2>
<p>The <tt class="docutils literal">%inline.elements;</tt> parameter entity contains an OR-list of all
<a class="reference internal" href="#inline-elements">inline elements</a>.</p>
<p>Entity definition:</p>
<pre class="literal-block">
<a class="reference internal" href="#abbreviation">abbreviation</a> | <a class="reference internal" href="#acronym">acronym</a> | <a class="reference internal" href="#citation-reference">citation_reference</a> | <a class="reference internal" href="#emphasis">emphasis</a> |
<a class="reference internal" href="#footnote-reference">footnote_reference</a> | <a class="reference internal" href="#generated">generated</a> | <a class="reference internal" href="#image">image</a> | <a class="reference internal" href="#inline">inline</a> | <a class="reference internal" href="#literal">literal</a> |
<a class="reference internal" href="#problematic">problematic</a> | <a class="reference internal" href="#raw">raw</a> | <a class="reference internal" href="#reference">reference</a> | <a class="reference internal" href="#strong">strong</a> | <a class="reference internal" href="#substitution-reference">substitution_reference</a> |
<a class="reference internal" href="#subscript">subscript</a> | <a class="reference internal" href="#superscript">superscript</a> | <a class="reference internal" href="#target">target</a> | <a class="reference internal" href="#title-reference">title_reference</a>
%additional.inline.elements;
</pre>
<p>The <tt class="docutils literal">%additional.inline.elements;</tt> parameter entity can be used by
wrapper DTDs to extend <tt class="docutils literal">%inline.elements;</tt>.</p>
<p>Via <a class="reference internal" href="#text-model">%text.model;</a>, the <tt class="docutils literal">%inline.elements;</tt> parameter entity is
indirectly employed in the content models of the following elements:
<a class="reference internal" href="#abbreviation">abbreviation</a>, <a class="reference internal" href="#acronym">acronym</a>, <a class="reference internal" href="#address">address</a>, <a class="reference internal" href="#attribution">attribution</a>, <a class="reference internal" href="#author">author</a>, <a class="reference internal" href="#caption">caption</a>,
<a class="reference internal" href="#classifier">classifier</a>, <a class="reference internal" href="#contact">contact</a>, <a class="reference internal" href="#copyright">copyright</a>, <a class="reference internal" href="#date">date</a>, <a class="reference internal" href="#doctest-block">doctest_block</a>, <a class="reference internal" href="#emphasis">emphasis</a>,
<a class="reference internal" href="#generated">generated</a>, <a class="reference internal" href="#inline">inline</a>, <a class="reference internal" href="#line-block">line_block</a>, <a class="reference internal" href="#literal-block">literal_block</a>, <a class="reference internal" href="#math">math</a>, <a class="reference internal" href="#math-block">math_block</a>,
<a class="reference internal" href="#organization">organization</a>,
<a class="reference internal" href="#paragraph">paragraph</a>, <a class="reference internal" href="#problematic">problematic</a>, <a class="reference internal" href="#raw">raw</a>, <a class="reference internal" href="#reference">reference</a>, <a class="reference internal" href="#revision">revision</a>, <a class="reference internal" href="#rubric">rubric</a>,
<a class="reference internal" href="#status">status</a>, <a class="reference internal" href="#strong">strong</a>, <a class="reference internal" href="#subscript">subscript</a>, <a class="reference internal" href="#substitution-definition">substitution_definition</a>,
<a class="reference internal" href="#substitution-reference">substitution_reference</a>, <a class="reference internal" href="#subtitle">subtitle</a>, <a class="reference internal" href="#superscript">superscript</a>, <a class="reference internal" href="#target">target</a>, <a class="reference internal" href="#term">term</a>,
<a class="reference internal" href="#title">title</a>, <a class="reference internal" href="#title-reference">title_reference</a>, <a class="reference internal" href="#version">version</a></p>
</div>
<div class="section" id="reference-atts">
<h2><a class="toc-backref" href="#id327"><tt class="docutils literal">%reference.atts;</tt></a></h2>
<p>The <tt class="docutils literal">%reference.atts;</tt> parameter entity groups together the <a class="reference internal" href="#refuri">refuri</a>,
<a class="reference internal" href="#refid">refid</a>, and <a class="reference internal" href="#refname">refname</a> attributes.</p>
<p>Entity definition:</p>
<pre class="literal-block">
<a class="reference internal" href="#refuri-att">%refuri.att;</a>
<a class="reference internal" href="#refid-att">%refid.att;</a>
<a class="reference internal" href="#refname-att">%refname.att;</a>
%additional.reference.atts;
</pre>
<p>The <tt class="docutils literal">%additional.reference.atts;</tt> parameter entity can be used by
wrapper DTDs to extend <tt class="docutils literal">%additional.reference.atts;</tt>.</p>
<p>The <a class="reference internal" href="#citation-reference">citation_reference</a>, <a class="reference internal" href="#footnote-reference">footnote_reference</a>, <a class="reference internal" href="#reference">reference</a>, and <a class="reference internal" href="#target">target</a>
elements directly employ the <tt class="docutils literal">%reference.att;</tt> parameter entity in
their attribute lists.</p>
</div>
<div class="section" id="refid-att">
<h2><a class="toc-backref" href="#id328"><tt class="docutils literal">%refid.att;</tt></a></h2>
<p>The <tt class="docutils literal">%refid.att;</tt> parameter entity contains the <a class="reference internal" href="#refid">refid</a> attribute, an
internal reference to the <a class="reference internal" href="#ids">ids</a> attribute of another element.</p>
<p>Entity definition:</p>
<pre class="literal-block">
<a class="reference internal" href="#refid">refid</a> CDATA #IMPLIED
</pre>
<p>The <a class="reference internal" href="#title">title</a> and <a class="reference internal" href="#problematic">problematic</a> elements directly employ the
<tt class="docutils literal">%refid.att;</tt> parameter entity in their attribute lists.</p>
<p>Via <a class="reference internal" href="#reference-atts">%reference.atts;</a>, the <tt class="docutils literal">%refid.att;</tt> parameter entity is
indirectly employed in the attribute lists of the <a class="reference internal" href="#citation-reference">citation_reference</a>,
<a class="reference internal" href="#footnote-reference">footnote_reference</a>, <a class="reference internal" href="#reference">reference</a>, and <a class="reference internal" href="#target">target</a> elements.</p>
</div>
<div class="section" id="refname-att">
<h2><a class="toc-backref" href="#id329"><tt class="docutils literal">%refname.att;</tt></a></h2>
<p>The <tt class="docutils literal">%refname.att;</tt> parameter entity contains the <a class="reference internal" href="#refname">refname</a>
attribute, an internal reference to the <a class="reference internal" href="#names">names</a> attribute of another
element. On a <a class="reference internal" href="#target">target</a> element, <tt class="docutils literal">refname</tt> indicates an indirect
target which may resolve to either an internal or external
reference.</p>
<p>Entity definition:</p>
<pre class="literal-block">
<a class="reference internal" href="#refname">refname</a> NMTOKENS #IMPLIED
</pre>
<p>The <a class="reference internal" href="#substitution-reference">substitution_reference</a> element directly employs the
<tt class="docutils literal">%refname.att;</tt> parameter entity in its attribute list.</p>
<p>Via <a class="reference internal" href="#reference-atts">%reference.atts;</a>, the <tt class="docutils literal">%refname.att;</tt> parameter entity is
indirectly employed in the attribute lists of the <a class="reference internal" href="#citation-reference">citation_reference</a>,
<a class="reference internal" href="#footnote-reference">footnote_reference</a>, <a class="reference internal" href="#reference">reference</a>, and <a class="reference internal" href="#target">target</a> elements.</p>
</div>
<div class="section" id="refuri-att">
<h2><a class="toc-backref" href="#id330"><tt class="docutils literal">%refuri.att;</tt></a></h2>
<p>The <tt class="docutils literal">%refuri.att;</tt> parameter entity contains the <a class="reference internal" href="#refuri">refuri</a> attribute,
an external reference to a URI/URL.</p>
<p>Entity definition:</p>
<pre class="literal-block">
<a class="reference internal" href="#refuri">refuri</a> CDATA #IMPLIED
</pre>
<p>Via <a class="reference internal" href="#reference-atts">%reference.atts;</a>, the <tt class="docutils literal">%refuri.att;</tt> parameter entity is
indirectly employed in the attribute lists of the <a class="reference internal" href="#citation-reference">citation_reference</a>,
<a class="reference internal" href="#footnote-reference">footnote_reference</a>, <a class="reference internal" href="#reference">reference</a>, and <a class="reference internal" href="#target">target</a> elements.</p>
</div>
<div class="section" id="section-elements">
<h2><a class="toc-backref" href="#id331"><tt class="docutils literal">%section.elements;</tt></a></h2>
<p>The <tt class="docutils literal">%section.elements;</tt> parameter entity contains an OR-list of all
<a class="reference internal" href="#section">section</a>-equivalent elements. <tt class="docutils literal">%section.elements;</tt> is itself
contained within the <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity.</p>
<p>Entity definition:</p>
<pre class="literal-block">
<a class="reference internal" href="#section">section</a>
%additional.section.elements;
</pre>
<p>The <tt class="docutils literal">%additional.section.elements;</tt> parameter entity can be used
by wrapper DTDs to extend <tt class="docutils literal">%section.elements;</tt>.</p>
<p>Via <a class="reference internal" href="#structure-model">%structure.model;</a>, the <tt class="docutils literal">%section.elements;</tt> parameter entity
is indirectly employed in the content models of the <a class="reference internal" href="#document">document</a> and
<a class="reference internal" href="#section">section</a> elements.</p>
</div>
<div class="section" id="structure-model">
<h2><a class="toc-backref" href="#id332"><tt class="docutils literal">%structure.model;</tt></a></h2>
<p>The <tt class="docutils literal">%structure.model;</tt> parameter entity encapsulates the
hierarchical structure of a document and of its constituent parts.
See the discussion of the <a class="reference internal" href="#element-hierarchy">element hierarchy</a> above.</p>
<p>Entity definition:</p>
<pre class="literal-block">
( ( (<a class="reference internal" href="#id188">%body.elements;</a> | <a class="reference internal" href="#topic">topic</a> | <a class="reference internal" href="#sidebar">sidebar</a>)+, <a class="reference internal" href="#transition">transition</a>? )*,
( (<a class="reference internal" href="#section-elements">%section.elements;</a>), (<a class="reference internal" href="#transition">transition</a>?, (<a class="reference internal" href="#section-elements">%section.elements;</a>) )* )? )
</pre>
<p>Each <a class="reference internal" href="#document">document</a> or <a class="reference internal" href="#section">section</a> contains zero or more body elements,
topics, and/or sidebars, optionally interspersed with single
transitions, followed by zero or more sections (whose contents are
recursively the same as this model) optionally interspersed with
transitions.</p>
<p>The following restrictions are imposed by this model:</p>
<ul class="simple">
<li>Transitions must be separated by other elements (body elements,
sections, etc.). In other words, a transition may not be
immediately adjacent to another transition.</li>
<li>A transition may not occur at the beginning of a document or
section.</li>
</ul>
<p>An additional restriction, which cannot be expressed in the language
of DTDs, is imposed by software:</p>
<ul class="simple">
<li>A transition may not occur at the end of a document or section.</li>
</ul>
<p>The <a class="reference internal" href="#structure-model">%structure.model;</a> parameter entity is directly employed in the
content models of the <a class="reference internal" href="#document">document</a> and <a class="reference internal" href="#section">section</a> elements.</p>
</div>
<div class="section" id="text-model">
<h2><a class="toc-backref" href="#id333"><tt class="docutils literal">%text.model;</tt></a></h2>
<p>The <tt class="docutils literal">%text.model;</tt> parameter entity is used by many elements to
represent text data mixed with <a class="reference internal" href="#inline-elements">inline elements</a>.</p>
<p>Entity definition:</p>
<pre class="literal-block">
(#PCDATA | <a class="reference internal" href="#id189">%inline.elements;</a>)*
</pre>
<p>The <tt class="docutils literal">%text.model;</tt> parameter entity is directly employed in the
content models of the following elements: <a class="reference internal" href="#abbreviation">abbreviation</a>, <a class="reference internal" href="#acronym">acronym</a>,
<a class="reference internal" href="#address">address</a>, <a class="reference internal" href="#author">author</a>, <a class="reference internal" href="#caption">caption</a>, <a class="reference internal" href="#classifier">classifier</a>, <a class="reference internal" href="#contact">contact</a>, <a class="reference internal" href="#copyright">copyright</a>, <a class="reference internal" href="#date">date</a>,
<a class="reference internal" href="#doctest-block">doctest_block</a>, <a class="reference internal" href="#emphasis">emphasis</a>, <a class="reference internal" href="#field-name">field_name</a>, <a class="reference internal" href="#generated">generated</a>, <a class="reference internal" href="#line-block">line_block</a>,
<a class="reference internal" href="#literal-block">literal_block</a>, <a class="reference internal" href="#organization">organization</a>, <a class="reference internal" href="#paragraph">paragraph</a>, <a class="reference internal" href="#problematic">problematic</a>, <a class="reference internal" href="#raw">raw</a>,
<a class="reference internal" href="#reference">reference</a>, <a class="reference internal" href="#revision">revision</a>, <a class="reference internal" href="#status">status</a>, <a class="reference internal" href="#strong">strong</a>, <a class="reference internal" href="#substitution-definition">substitution_definition</a>,
<a class="reference internal" href="#substitution-reference">substitution_reference</a>, <a class="reference internal" href="#subtitle">subtitle</a>, <a class="reference internal" href="#target">target</a>, <a class="reference internal" href="#term">term</a>, <a class="reference internal" href="#title">title</a>, <a class="reference internal" href="#version">version</a></p>
<!-- Local Variables:
mode: indented-text
indent-tabs-mode: nil
sentence-end-double-space: t
fill-column: 70
End: -->
</div>
</div>
</div>
</body>
</html>
|