/usr/share/doc/docutils-doc/docs/user/latex.html is in docutils-doc 0.12+dfsg-1.
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 | <?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.12: http://docutils.sourceforge.net/" />
<title>Generating LaTeX with Docutils</title>
<meta name="author" content="Engelbert Gruber, Guenter Milde" />
<meta name="date" content="2013-06-03" />
<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="generating-latex-with-docutils">
<h1 class="title">Generating LaTeX with Docutils</h1>
<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>Engelbert Gruber, Guenter Milde</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>7667</td></tr>
<tr><th class="docinfo-name">Date:</th>
<td>2013-06-03</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="auto-toc simple">
<li><a class="reference internal" href="#introduction" id="id36">1 Introduction</a></li>
<li><a class="reference internal" href="#latex" id="id37">2 LaTeX</a><ul class="auto-toc">
<li><a class="reference internal" href="#latex-packages" id="id38">2.1 LaTeX packages</a></li>
<li><a class="reference internal" href="#docutils-special-latex-macros" id="id39">2.2 Docutils special LaTeX macros</a></li>
<li><a class="reference internal" href="#length-units" id="id40">2.3 Length units</a></li>
</ul>
</li>
<li><a class="reference internal" href="#pdf-generation" id="id41">3 PDF generation</a></li>
<li><a class="reference internal" href="#configuration" id="id42">4 Configuration</a><ul class="auto-toc">
<li><a class="reference internal" href="#options" id="id43">4.1 Options</a></li>
<li><a class="reference internal" href="#latex-code" id="id44">4.2 LaTeX code</a><ul class="auto-toc">
<li><a class="reference internal" href="#style-sheets" id="id45">4.2.1 Style sheets</a></li>
<li><a class="reference internal" href="#latex-preamble" id="id46">4.2.2 LaTeX preamble</a></li>
<li><a class="reference internal" href="#templates" id="id47">4.2.3 Templates</a></li>
<li><a class="reference internal" href="#raw-latex" id="id48">4.2.4 Raw LaTeX</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#how-to-configure-the" id="id49">5 How to configure the ...</a><ul class="auto-toc">
<li><a class="reference internal" href="#admonitions" id="id50">5.1 admonitions</a></li>
<li><a class="reference internal" href="#custom-interpreted-text-roles" id="id51">5.2 custom interpreted text roles</a></li>
<li><a class="reference internal" href="#definition-lists" id="id52">5.3 definition lists</a></li>
<li><a class="reference internal" href="#document-class" id="id53">5.4 document class</a></li>
<li><a class="reference internal" href="#document-info" id="id54">5.5 document info</a></li>
<li><a class="reference internal" href="#document-title" id="id55">5.6 document title</a></li>
<li><a class="reference internal" href="#field-lists" id="id56">5.7 field lists</a></li>
<li><a class="reference internal" href="#figure-and-table-captions" id="id57">5.8 figure and table captions</a></li>
<li><a class="reference internal" href="#figure-placement" id="id58">5.9 figure placement</a></li>
<li><a class="reference internal" href="#font" id="id59">5.10 font</a><ul class="auto-toc">
<li><a class="reference internal" href="#choice-of-suitable-fonts" id="id60">5.10.1 choice of suitable fonts</a></li>
</ul>
</li>
<li><a class="reference internal" href="#font-encoding" id="id61">5.11 font encoding</a></li>
<li><a class="reference internal" href="#font-size" id="id62">5.12 font size</a></li>
<li><a class="reference internal" href="#footnotes" id="id63">5.13 footnotes</a></li>
<li><a class="reference internal" href="#hyphenation" id="id64">5.14 hyphenation</a></li>
<li><a class="reference internal" href="#hyperlinks" id="id65">5.15 hyperlinks</a><ul class="auto-toc">
<li><a class="reference internal" href="#disable-hyperlinks" id="id66">5.15.1 disable hyperlinks</a></li>
</ul>
</li>
<li><a class="reference internal" href="#line-blocks" id="id67">5.16 line blocks</a></li>
<li><a class="reference internal" href="#line-spacing" id="id68">5.17 line spacing</a></li>
<li><a class="reference internal" href="#literal-blocks" id="id69">5.18 literal blocks</a></li>
<li><a class="reference internal" href="#list-of-figures-tables" id="id70">5.19 list of figures/tables</a></li>
<li><a class="reference internal" href="#option-list" id="id71">5.20 option list</a></li>
<li><a class="reference internal" href="#page-breaks" id="id72">5.21 page breaks</a></li>
<li><a class="reference internal" href="#page-layout" id="id73">5.22 page layout</a></li>
<li><a class="reference internal" href="#page-headers-and-footers" id="id74">5.23 page headers and footers</a></li>
<li><a class="reference internal" href="#page-numbering" id="id75">5.24 page numbering</a></li>
<li><a class="reference internal" href="#paper-size" id="id76">5.25 paper size</a></li>
<li><a class="reference internal" href="#paragraph-indent" id="id77">5.26 paragraph indent</a></li>
<li><a class="reference internal" href="#rubric" id="id78">5.27 rubric</a></li>
<li><a class="reference internal" href="#section-numbering" id="id79">5.28 section numbering</a></li>
<li><a class="reference internal" href="#sidebar" id="id80">5.29 sidebar</a></li>
<li><a class="reference internal" href="#size-of-a-pixel" id="id81">5.30 size of a pixel</a></li>
<li><a class="reference internal" href="#topic-element" id="id82">5.31 topic element</a></li>
<li><a class="reference internal" href="#topic-title" id="id83">5.32 topic title</a></li>
<li><a class="reference internal" href="#table-of-contents" id="id84">5.33 table of contents</a></li>
<li><a class="reference internal" href="#title-reference-role" id="id85">5.34 title reference role</a></li>
<li><a class="reference internal" href="#text-encoding" id="id86">5.35 text encoding</a></li>
<li><a class="reference internal" href="#transition-element" id="id87">5.36 transition element</a></li>
</ul>
</li>
<li><a class="reference internal" href="#changes" id="id88">6 Changes</a></li>
<li><a class="reference internal" href="#problems" id="id89">7 Problems</a><ul class="auto-toc">
<li><a class="reference internal" href="#troubleshooting" id="id90">7.1 Troubleshooting</a><ul class="auto-toc">
<li><a class="reference internal" href="#bad-looking-pdf-output" id="id91">7.1.1 Bad looking PDF output</a></li>
<li><a class="reference internal" href="#footnote-mark-and-text-at-different-pages" id="id92">7.1.2 footnote mark and text at different pages</a></li>
<li><a class="reference internal" href="#non-breaking-hyperlinks" id="id93">7.1.3 non-breaking hyperlinks</a></li>
<li><a class="reference internal" href="#glyph-not-defined-in-pd1-encoding" id="id94">7.1.4 Glyph not defined in PD1 encoding</a></li>
<li><a class="reference internal" href="#image-inclusion" id="id95">7.1.5 image inclusion</a></li>
<li><a class="reference internal" href="#why-are-my-images-too-big" id="id96">7.1.6 Why are my images too big?</a></li>
<li><a class="reference internal" href="#error-illegal-unit-px" id="id97">7.1.7 Error <tt class="docutils literal">illegal unit px</tt></a></li>
<li><a class="reference internal" href="#error-symbol-textcurrency-not-provided" id="id98">7.1.8 Error <tt class="docutils literal">Symbol \textcurrency not provided</tt> ...</a></li>
<li><a class="reference internal" href="#search-and-text-extraction" id="id99">7.1.9 Search and text extraction</a></li>
<li><a class="reference internal" href="#unicode-box-drawing-and-block-characters" id="id100">7.1.10 Unicode box drawing and block characters</a></li>
</ul>
</li>
<li><a class="reference internal" href="#bugs-and-open-issues" id="id101">7.2 Bugs and open issues</a><ul class="auto-toc">
<li><a class="reference internal" href="#footnotes-and-citations" id="id102">7.2.1 Footnotes and citations</a></li>
<li><a class="reference internal" href="#tables" id="id103">7.2.2 Tables</a></li>
<li><a class="reference internal" href="#id35" id="id104">7.2.3 Figures</a></li>
<li><a class="reference internal" href="#miscellaneous" id="id105">7.2.4 Miscellaneous</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="introduction">
<h1><a class="toc-backref" href="#id36">1 Introduction</a></h1>
<p>This document covers topics specific to Docutils' <a class="reference external" href="http://www.latex-project.org/">LaTeX</a> export. For
an introduction to LaTeX see, e.g., <a class="reference external" href="http://www.latex-project.org/guides/usrguide.pdf">LaTeX2e for authors</a>. There exists
a wide selecton of <a class="reference external" href="http://www.latex-project.org/guides/">LaTeX Documentation on the net</a> and
<a class="reference external" href="http://www.latex-project.org/guides/books.html">books on LaTeX and related topics</a>.</p>
<p>There are two approaches to typeset documents from reStructuredText
sources via LaTeX:</p>
<ol class="arabic">
<li><p class="first">treat LaTeX as a document format (like HTML):</p>
<p>Transform the internal markup into corresponding LaTeX markup.
For example, a section title would be written with the LaTeX section
command: <tt class="docutils literal">\section{this section title}</tt>.</p>
<p>This keeps the document structure and semantic markup produing a readable
LaTeX file, but may require hacking around Docutils — LaTeX
incompatibilities.</p>
<p>As with HTML, styling is mostly done via style sheets or
<a class="reference internal" href="#latex-packages">LaTeX packages</a>.</p>
<p>If you prefer this approach, try the <span class="incremental">latex2e</span> or the <span class="incremental">xetex</span>
writer.</p>
</li>
<li><p class="first">treat LaTeX as a page description format (like Postscript):</p>
<p>Use LaTeX as a typesetting system to produce the desired output
without representing document structure in the LaTeX source. This
will work around Docutils-incompatible features in LaTeX but
produces a hard to read LaTeX file. Styling is done via options to
the latex writer.</p>
<p>The (orphaned) <span class="incremental">newlatex</span> writer (<tt class="docutils literal">rst2newlatex.py</tt>) uses LaTeX as
a typesetter without caring about producing readable/stylable LaTeX
files.</p>
</li>
</ol>
<p>This documents describes the first approach used by the <span class="incremental">latex2e</span>
and <span class="incremental">xetex</span> writers.</p>
</div>
<div class="section" id="latex">
<h1><a class="toc-backref" href="#id37">2 LaTeX</a></h1>
<p>Unlike HTML/CSS, LaTeX provides one common language for markup and
style definitions. Separation of content and style is realized by
collecting style definitions in the <a class="reference external" href="config.html#documentclass">documentclass</a>, <a class="reference internal" href="#latex-packages">LaTeX packages</a>,
or the document preamble.</p>
<div class="section" id="latex-packages">
<h2><a class="toc-backref" href="#id38">2.1 LaTeX packages</a></h2>
<p>LaTeX packages (similar to Python modules or C libraries) provide
means to extend or modify the LaTeX language by redefining macros or
providing new ones. There is a <em>huge</em> selection of packages (standard
as well as user contributed) coming with your TeX distribution or
available at <a class="reference external" href="http://www.ctan.org">CTAN</a> (see the <a class="reference external" href="http://texcatalogue.sarovar.org/">TeX Catalogue</a>).</p>
</div>
<div class="section" id="docutils-special-latex-macros">
<h2><a class="toc-backref" href="#id39">2.2 Docutils special LaTeX macros</a></h2>
<p>Some Docutils objects have no LaTeX counterpart, they will be typeset
using a Docutils specific LaTeX <em>macro</em> (command, environment, or
length) to allow customization. By convention, special macros use the
prefix <tt class="docutils literal">\DU</tt><a class="footnote-reference" href="#id3" id="id2">[1]</a>.</p>
<p>The generated LaTeX documents should be kept processable by a standard LaTeX
installation. Therefore fallback definitions are included after the <a class="reference internal" href="#custom-style-sheets">custom
style sheets</a>, if a macro is required in the document.</p>
<ul class="simple">
<li>Custom <a class="reference internal" href="#style-sheets">style sheets</a> can define alternative implementations with
<tt class="docutils literal">\newcommand</tt>, <tt class="docutils literal">\newenvironment</tt>, and <tt class="docutils literal">\newlength</tt> followed by
<tt class="docutils literal">\setlength</tt>.</li>
<li>Definitions with <a class="reference internal" href="#raw-latex">raw LaTeX</a> are part of the document body. Use
<tt class="docutils literal">\def</tt>, <tt class="docutils literal">\renewcommand</tt> or <tt class="docutils literal">\renewenvironment</tt>, and <tt class="docutils literal">\setlength</tt>.</li>
</ul>
<p>See the test output <a class="reference external" href="../../test/functional/expected/standalone_rst_latex.tex">standalone_rst_latex.tex</a> for an example of the fallback
definitions and their use in the document.</p>
<table class="docutils footnote" frame="void" id="id3" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id2">[1]</a></td><td>DU for Documentation Utilities = Docutils</td></tr>
</tbody>
</table>
</div>
<div class="section" id="length-units">
<h2><a class="toc-backref" href="#id40">2.3 Length units</a></h2>
<p>LaTeX supports all <a class="reference external" href="../ref/rst/restructuredtext.html#length-units">length units</a> defined for Docutils plus the
following less common units:</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">pt:</th><td class="field-body">typewriter's (or LaTeX) point (1 pt = 1/72.27 in)</td>
</tr>
<tr class="field"><th class="field-name">dd:</th><td class="field-body">didôt (1 dd = 1238/1157 pt)</td>
</tr>
<tr class="field"><th class="field-name">cc:</th><td class="field-body">cîcero (1 cc = 12 dd)</td>
</tr>
<tr class="field"><th class="field-name">sp:</th><td class="field-body">scaled point (1sp = 1/65536pt)</td>
</tr>
</tbody>
</table>
<div class="attention">
<p class="first admonition-title">Attention!</p>
<p>Different definitions of the unit "pt"!</p>
<ul>
<li><p class="first">In Docutils (as well as CSS) the unit symbol "pt" denotes the
<span class="incremental">Postscript point</span> or <span class="incremental">DTP point</span>.</p>
</li>
<li><p class="first">LaTeX uses "pt" for the <span class="incremental">LaTeX point</span>, which is unknown to Docutils and
0.3 % smaller.</p>
</li>
<li><p class="first">The <span class="incremental">DTP point</span> is available in LaTeX as "bp" (big point):</p>
<blockquote>
<p>1 pt = 1/72.25 in < 1 bp = 1/72 in</p>
</blockquote>
</li>
</ul>
<p>Lengths specified in the document with unit "pt" will be given the
unit "bp" in the LaTeX source.</p>
<p class="last">In <a class="reference internal" href="#raw-latex">raw LaTeX</a> and <a class="reference internal" href="#custom-style-sheets">custom style sheets</a>, the <span class="incremental">DTP point</span> must be
specified as "bp", while "pt" is interpreted as <span class="incremental">LaTeX point</span>.</p>
</div>
<p>The default length unit (added by Docutils to length specifications
without unit) is the "DTP point".</p>
<p>For more on lengths in LaTeX, see e.g. <a class="reference external" href="http://www.giss.nasa.gov/tools/latex/ltx-86.html.">Hypertext Help with LaTeX: Lengths</a></p>
</div>
</div>
<div class="section" id="pdf-generation">
<h1><a class="toc-backref" href="#id41">3 PDF generation</a></h1>
<p>In most cases, LaTeX code is not the desired end-format of the document.
LaTeX offers many ways to generate PDF documents from the LaTeX
source, including:</p>
<dl class="docutils">
<dt><span class="target" id="pdflatex">pdflatex</span></dt>
<dd>Generates a PDF document directly from the LaTeX file.</dd>
<dt><span class="target" id="latex-dvipdfmx">latex + dvipdfmx</span></dt>
<dd>Use <tt class="docutils literal">latex</tt> to generate a DVI file and <tt class="docutils literal">dvipdfmx</tt> to produce a PDF
file. If you take this approach, add <tt class="docutils literal">dvipdfmx</tt> to the
_documentoptions.</dd>
<dt><span class="target" id="id6">latex</span> + dvips + ps2pdf</dt>
<dd>Produce a DVI file with <tt class="docutils literal">latex</tt>, postscript with <tt class="docutils literal">dvips</tt> and PDF with
<tt class="docutils literal">ps2pdf</tt>.</dd>
<dt><span class="target" id="xelatex">xelatex</span></dt>
<dd>The <a class="reference external" href="http://tug.org/xetex/">XeTeX</a> engine works with input files in UTF-8 encoding and system
fonts. Export your document with the <span class="incremental">xetex</span> writer (<tt class="docutils literal">rst2xetex</tt>),
if you want to go this route.</dd>
</dl>
<p>You need to call latex (or pdflatex/xelatex) twice (or even three times) to
get internal references correct.</p>
<dl class="docutils">
<dt><span class="target" id="rubber">rubber</span></dt>
<dd>The <a class="reference external" href="http://iml.univ-mrs.fr/~beffara/soft/rubber/">Rubber</a> wrapper for LaTeX and friends can be used to automatically
run all programs the required number of times and delete "spurious" files.
This includes processing bibliographic references or indices, as well as
compilation or conversion of figures.</dd>
</dl>
</div>
<div class="section" id="configuration">
<h1><a class="toc-backref" href="#id42">4 Configuration</a></h1>
<p>The LaTeX code generation can be configured via</p>
<ul class="simple">
<li>configuration <a class="reference internal" href="#options">options</a> to the Docutils writer,</li>
<li><a class="reference internal" href="#latex-packages">LaTeX packages</a>,</li>
<li>custom <a class="reference internal" href="#latex-code">LaTeX code</a> in
+ <a class="reference internal" href="#style-sheets">style sheets</a>,
+ the <a class="reference internal" href="#latex-preamble">LaTeX preamble</a>,
+ the document body (<a class="reference internal" href="#raw-latex">raw LaTeX</a>), or
+ custom <a class="reference internal" href="#templates">templates</a>.</li>
</ul>
<div class="section" id="options">
<span id="option"></span><h2><a class="toc-backref" href="#id43">4.1 Options</a></h2>
<p>Options can be specified as</p>
<ul class="simple">
<li>command-line options (run <tt class="docutils literal">rst2latex.py <span class="pre">--help</span></tt> to get a list of
available options), or</li>
<li>configuration settings (see <a class="reference external" href="config.html">Docutils Configuration</a> for details).</li>
</ul>
</div>
<div class="section" id="latex-code">
<h2><a class="toc-backref" href="#id44">4.2 LaTeX code</a></h2>
<dl class="docutils">
<dt>Custom LaTeX code can be placed in <a class="reference internal" href="#style-sheets">style sheets</a>, the <a href="#id9"><span class="problematic" id="id10">`</span></a>LaTeX</dt>
<dd><div class="first system-message" id="id9">
<p class="system-message-title">System Message: WARNING/2 (<tt class="docutils">docs/user/latex.txt</tt>, line 230); <em><a href="#id10">backlink</a></em></p>
Inline interpreted text or phrase reference start-string without end-string.</div>
<p class="last">preamble`_, the document body (<a class="reference internal" href="#raw-latex">raw LaTeX</a>), or custom <a class="reference internal" href="#templates">templates</a>.</p>
</dd>
</dl>
<div class="section" id="style-sheets">
<span id="custom-style-sheets"></span><span id="style-sheet"></span><h3><a class="toc-backref" href="#id45">4.2.1 Style sheets</a></h3>
<p>A common way of LaTeX customization is the preparation of custom style
sheets, either as simple files with LaTeX code snippets or as home-made
<a class="reference internal" href="#latex-packages">LaTeX packages</a> (see the <a class="reference external" href="http://mirror.ctan.org/macros/latex/doc/clsguide.pdf">clsguide</a> for an introduction on LaTeX
package writing).</p>
<dl class="docutils">
<dt>Options:</dt>
<dd><p class="first"><a class="reference external" href="config.html#stylesheet-latex2e-writer">stylesheet</a></p>
<p class="last">It is possible to specify multiple style sheets and mix <a class="reference internal" href="#latex-packages">LaTeX
packages</a> with <a class="reference internal" href="#custom-style-sheets">custom style sheets</a>.</p>
</dd>
</dl>
<p>You cannot specify package options with the <a class="reference external" href="config.html#stylesheet-latex2e-writer">stylesheet</a> setting. If
you need to pass options to the package, use the <tt class="docutils literal">\usepackage</tt>
command in the <a class="reference internal" href="#latex-preamble">LaTeX preamble</a> or a custom style sheet.</p>
<dl class="docutils">
<dt>Example 1:</dt>
<dd><p class="first">Select Latin Modern fonts with the <span class="incremental">lmodern</span> package:</p>
<pre class="last literal-block">
--stylesheet=lmodern
</pre>
</dd>
<dt>Example 2:</dt>
<dd><p class="first">Use the <span class="incremental">preamble.tex</span> home-made custom style sheet together with
the package <span class="incremental">kerkis</span> (Bookman fonts):</p>
<pre class="last literal-block">
--stylesheet=kerkis,preamble.tex
</pre>
</dd>
<dt>Example 3:</dt>
<dd><p class="first">Select Palatino fonts with old-style numbers and true small-caps
with the LaTeX command</p>
<pre class="literal-block">
\usepackage[osf,sc]{mathpazo}
</pre>
<p class="last">in the <a class="reference internal" href="#latex-preamble">LaTeX preamble</a> or <a class="reference internal" href="#custom-style-sheets">custom style sheets</a>.</p>
</dd>
<dt>Stylesheet Repository</dt>
<dd>There is a <a class="reference external" href="../../../sandbox/stylesheets/">repository of user-contributed style sheets</a> in the
Docutils <a class="reference external" href="../../../sandbox/">Sandbox</a>.</dd>
</dl>
</div>
<div class="section" id="latex-preamble">
<h3><a class="toc-backref" href="#id46">4.2.2 LaTeX preamble</a></h3>
<p>Configuration by LaTeX code in the document preamble is also possible
without a separate stylesheet. This way, packages can be loaded with
options or commands re-defined without the need to create a separate
file (new in Docutils 0.7).</p>
<dl class="docutils">
<dt>Option:</dt>
<dd><a class="reference external" href="config.html#latex-preamble">latex-preamble</a></dd>
<dt>Default:</dt>
<dd>used for <a class="reference internal" href="#font-setup">font setup</a></dd>
<dt>Example:</dt>
<dd><p class="first">To use the better looking <tt class="docutils literal">txtt</tt> font for monospaced text define the
<a class="reference external" href="config.html#latex-preamble">latex-preamble</a> setting in a configuration file:</p>
<pre class="last literal-block">
latex-preamble: \renewcommand{\ttdefault}{txtt}
\usepackage{mathptmx} % Times
\usepackage[scaled=.92]{helvet} % Helvetica
</pre>
</dd>
</dl>
</div>
<div class="section" id="templates">
<h3><a class="toc-backref" href="#id47">4.2.3 Templates</a></h3>
<p>Some customizations require commands at places other than the insertion
point of stylesheets or depend on the deletion/replacement of parts of the
document. This can be done via a custom template. See the <a class="reference external" href="../api/publisher.html">publisher
documentation</a> for a description of the document parts available in a
template file.</p>
<dl class="docutils">
<dt>Option:</dt>
<dd><a class="reference external" href="config.html#template-latex2e-writer">template</a></dd>
</dl>
<p>In addition to the 'default.tex' template, the latex writer directory
contains the alternative 'titlepage.tex'.</p>
<dl class="docutils">
<dt>Example:</dt>
<dd><p class="first">Print a title page including docinfo, dedication, and abstract:</p>
<pre class="last literal-block">
--template=titlepage.tex
</pre>
</dd>
</dl>
</div>
<div class="section" id="raw-latex">
<h3><a class="toc-backref" href="#id48">4.2.4 Raw LaTeX</a></h3>
<p>By means of the <a class="reference external" href="../ref/rst/directives.html#raw">raw directive</a> or a derived <a class="reference internal" href="#custom-role">custom role</a>, one can
give commands directly to LaTeX. These can be both, styling as well as
printing commands.</p>
<dl class="docutils">
<dt>Example:</dt>
<dd><p class="first">Math formula:</p>
<pre class="literal-block">
.. raw:: latex
\[x^3 + 3x^2a + 3xa^2 + a^3,\]
</pre>
<p class="last">(Drawback: the formula will be invisible in other output formats.)</p>
</dd>
</dl>
<p>Most LaTeX code examples also work as raw LaTeX inside the document.
An exception are commands that need to be given in the document
preamble (e.g. package loading with <tt class="docutils literal">\usepackage</tt>, which can be
achieved with the <tt class="docutils literal"><span class="pre">--style-sheet</span></tt> or <tt class="docutils literal"><span class="pre">--latex-preamble</span></tt> command
line options instead). Remember to use <em>re-defining</em> commands for
customizing <a class="reference internal" href="#docutils-special-latex-macros">Docutils special LaTeX macros</a> with raw LaTeX.</p>
<dl class="docutils">
<dt>Example:</dt>
<dd><p class="first">Define the transition command as page break:</p>
<pre class="last literal-block">
.. raw:: latex
\renewcommand*{\DUtransition}{\pagebreak[4]}
</pre>
</dd>
<dt>See also:</dt>
<dd><ul class="first last simple">
<li>Defining a macro for a <a class="reference internal" href="#custom-role">custom role</a>.</li>
<li>Forcing <a class="reference internal" href="#page-breaks">page breaks</a>.</li>
</ul>
</dd>
</dl>
</div>
</div>
</div>
<div class="section" id="how-to-configure-the">
<h1><a class="toc-backref" href="#id49">5 How to configure the ...</a></h1>
<div class="section" id="admonitions">
<h2><a class="toc-backref" href="#id50">5.1 admonitions</a></h2>
<p><a class="reference external" href="../ref/rst/directives.html#admonitions">Admonitions</a> are specially marked "topics" that can appear anywhere an
ordinary body element can.</p>
<dl class="docutils">
<dt>Command:</dt>
<dd><tt class="docutils literal">\DUadmonition</tt></dd>
<dt>Default:</dt>
<dd>Typeset in a frame (90 % of text width).</dd>
</dl>
<p>The admonition title is typeset with the <tt class="docutils literal">\DUtitle</tt> command which also
takes a class argument. See <a class="reference internal" href="#topic-title">topic title</a></p>
<dl class="docutils">
<dt>Example 1:</dt>
<dd><p class="first">A lighter layout without the frame:</p>
<pre class="literal-block">
\newcommand{\DUadmonition}[2][class-arg]{%
% try \DUadmonition#1{#2}:
\ifcsname DUadmonition#1\endcsname%
\csname DUadmonition#1\endcsname{#2}%
\else
\begin{quote}
#2
\end{quote}
\fi
}
</pre>
<p class="last">The first part of this definition acts as a "dispatcher". This way it is
possible to define a special handling of <a class="reference external" href="../ref/rst/directives.html#specific-admonitions">specific admonitions</a> based on
the "class" argument.</p>
</dd>
</dl>
<dl class="docutils">
<dt>Example 2:</dt>
<dd><p class="first">Use <tt class="docutils literal">.. note::</tt> for a margin note:</p>
<pre class="literal-block">
\newcommand{\DUadmonitionnote}[1]{\marginpar{#1}}
</pre>
<p class="last">Make sure there is enough space to fit the note.
See also the <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/marginnote.html">marginnote</a> and <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/pdfcomment.html">pdfcomment</a> packages.</p>
</dd>
</dl>
</div>
<div class="section" id="custom-interpreted-text-roles">
<span id="custom-role"></span><h2><a class="toc-backref" href="#id51">5.2 custom interpreted text roles</a></h2>
<p>The rst <a class="reference external" href="../ref/rst/directives.html#role">role directive</a> allows defining custom <a class="reference external" href="../ref/rst/roles.html">text roles</a>
that mark parts of inline text (spans) with a class argument.</p>
<ul>
<li><p class="first">Role names and class arguments are converted to conform to the regular
expression <tt class="docutils literal"><span class="pre">[a-z][-a-z0-9]*</span></tt> (see <a class="reference external" href="../ref/rst/directives.html#class">class directive</a>).</p>
</li>
<li><p class="first">Class arguments may contain numbers and hyphens, which need special
treatment in LaTeX command names. (The special command <tt class="docutils literal">\@namedef</tt> can
help with the definition of corresponding commands.)</p>
</li>
<li><p class="first">Custom roles can have multiple class arguments.</p>
<p>In contrast to HTML/CSS, the order of the class arguments might matter.</p>
</li>
</ul>
<dl class="docutils">
<dt>Commands:</dt>
<dd><p class="first"><tt class="docutils literal">\DUrole</tt>: dispatcher command</p>
<p class="last"><tt class="docutils literal">\DUroleCLASSARGUMENT</tt>: optional styling command</p>
</dd>
<dt>Default:</dt>
<dd>The definition of <tt class="docutils literal"><span class="pre">\DUrole{CLASSARGUMENT}{}</span></tt> calls the macro named
<tt class="docutils literal">\DUroleCLASSARGUMENT{}</tt><a class="footnote-reference" href="#id14" id="id13">[2]</a> if it is defined (but silently ignores
this class argument if a corresponding macro is not defined).</dd>
</dl>
<table class="docutils footnote" frame="void" id="id14" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id13">[2]</a></td><td>For backwards compatibility, the prefix <tt class="docutils literal"><span class="pre">\docutilsrole...</span></tt> in the
styling commands also recognized.</td></tr>
</tbody>
</table>
<dl class="docutils">
<dt>Example 1:</dt>
<dd><p class="first">Typeset text in small caps:</p>
<pre class="literal-block">
.. role:: smallcaps
:smallcaps:`Fourier` transformation
</pre>
<p>This is transformed to the LaTeX code:</p>
<pre class="literal-block">
\DUrole{smallcaps}{Fourier} transformation
</pre>
<p>The definition</p>
<pre class="literal-block">
\newcommand{\DUrolesmallcaps}{\textsc}
</pre>
<p class="last">as <a class="reference internal" href="#raw-latex">raw LaTeX</a> or in the custom <a class="reference internal" href="#style-sheet">style sheet</a> will give the expected
result (if the text <a class="reference internal" href="#font">font</a> supports small caps).</p>
</dd>
<dt>Example 2:</dt>
<dd><p class="first">Subscript text in normal size and <em>italic</em> shape:</p>
<pre class="literal-block">
.. role:: sub(subscript)
</pre>
<p>As "sub" inherits from the standard "subscript" role, the LaTeX macro
only needs to set the size and shape:</p>
<pre class="last literal-block">
\newcommand{\DUrolesub}{\normalsize\itshape}
</pre>
</dd>
<dt>Example 3:</dt>
<dd><p class="first">A role with several classes and a converted class name:</p>
<pre class="literal-block">
.. role:: custom4
:class: argI argII arg_3
</pre>
<p>is translated to the nested commands:</p>
<pre class="literal-block">
\DUrole{argi}{\DUrole{argii}{\DUrole{arg-3}{<content>}}}
</pre>
<p>With the definitions:</p>
<pre class="literal-block">
\newcommand{\DUroleargi}[1]{\textsc}
\newcommand{\DUroleargii}[1]{{\large #1}}
\makeatletter
\@namedef{DUrolearg-3}{\textbf}
\makeatother
</pre>
<p class="last">in a <a class="reference internal" href="#style-sheet">style sheet</a><a class="footnote-reference" href="#id16" id="id15">[3]</a> or as <a class="reference internal" href="#raw-latex">raw LaTeX</a> in the document source,
text styled with <tt class="docutils literal"><span class="pre">:custom4:`large</span> bold <span class="pre">small-caps`</span></tt> will be typeset
accordingly.</p>
</dd>
</dl>
<table class="docutils footnote" frame="void" id="id16" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id15">[3]</a></td><td>Leave out the <tt class="docutils literal">\makeatletter</tt> - <tt class="docutils literal">\makeatother</tt> pair if the style
sheet is a LaTeX package (<tt class="docutils literal">*.sty</tt>).</td></tr>
</tbody>
</table>
</div>
<div class="section" id="definition-lists">
<h2><a class="toc-backref" href="#id52">5.3 definition lists</a></h2>
<p>ReStructuredText <a class="reference external" href="../ref/rst/restructuredtext.html#definition-lists">definition lists</a> correspond to HTML <tt class="docutils literal"><dl></tt> list
objects.</p>
<dl class="docutils">
<dt>Environment:</dt>
<dd><tt class="docutils literal">description</tt>: LaTeX standard environment</dd>
<dt>Command:</dt>
<dd><tt class="docutils literal">\descriptionlabel</tt>: styling macro for the description term</dd>
<dt>Default:</dt>
<dd>bold label text, hanging indent</dd>
<dt>Example:</dt>
<dd><p class="first">A non-bold label can be achieved with:</p>
<pre class="last literal-block">
\renewcommand\descriptionlabel[1]{\hspace\labelsep \normalfont #1}
</pre>
</dd>
</dl>
</div>
<div class="section" id="document-class">
<h2><a class="toc-backref" href="#id53">5.4 document class</a></h2>
<p>There are hundreds of LaTeX document classes installed by modern
LaTeX distributions, provided by publishers, or available at <a class="reference external" href="http://www.ctan.org">CTAN</a>.
The <a class="reference external" href="http://texcatalogue.sarovar.org/">TeX Catalogue</a> lists most of them.</p>
<dl class="docutils">
<dt>Popular document classes:</dt>
<dd><ul class="first last simple">
<li>article, report, book: standard document classes</li>
<li>scrartcl, scrrprt, scrbook: <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/koma-script.html">KOMA-script</a> classes</li>
<li><a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/memoir.html">memoir</a>: highly configurable class for larger documents</li>
</ul>
</dd>
<dt>Option:</dt>
<dd><a class="reference external" href="config.html#documentclass">documentclass</a></dd>
</dl>
</div>
<div class="section" id="document-info">
<h2><a class="toc-backref" href="#id54">5.5 document info</a></h2>
<p>Content of the <a class="reference external" href="../ref/rst/restructuredtext.html#bibliographic-fields">bibliographic fields</a> at the top of a document.
By default, docinfo items are typeset as a table.</p>
<dl class="docutils">
<dt>Options:</dt>
<dd><a class="reference external" href="config.html#use-latex-docinfo">use-latex-docinfo</a>, <a class="reference external" href="config.html#use-latex-abstract">use-latex-abstract</a></dd>
<dt>Length:</dt>
<dd><tt class="docutils literal">\DUdocinfowidth</tt>: the width for the <span class="incremental">docinfo</span> table.</dd>
<dt>Default:</dt>
<dd>90 % of text width: <tt class="docutils literal">0.9\textwidth</tt></dd>
<dt>Example:</dt>
<dd><p class="first">set to 70 % of text width:</p>
<pre class="last literal-block">
\newlength{\DUdocinfowidth}
\setlength{\DUdocinfowidth}{0.7\textwidth}
</pre>
</dd>
</dl>
</div>
<div class="section" id="document-title">
<h2><a class="toc-backref" href="#id55">5.6 document title</a></h2>
<p>A lone top-level section title is (usually) transformed to the document title
(see <a class="reference external" href="rst/quickref.html#section-structure">section structure</a>).</p>
<p>The format of the document title is defined by the <a class="reference internal" href="#document-class">document class</a>. The
"article" document class uses an in-page title and the "report" and "book"
classes write a separate title page. See the <a class="reference external" href="http://www.tex.ac.uk/faq">TeX FAQ</a> on how to customize
the <a class="reference external" href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=titlsty">style of document titles</a>.</p>
<p>The default title page shows only title and subtitle, date and author
are shown in the <a class="reference internal" href="#document-info">document info</a> table.</p>
<dl class="docutils">
<dt>Options:</dt>
<dd><p class="first"><a class="reference external" href="config.html#use-latex-docinfo">use-latex-docinfo</a></p>
<p class="last"><tt class="docutils literal"><span class="pre">--template=titlepage.tex</span></tt> Put docinfo and abstract into the title page.
A separate title page is used also with the "abstract" document class.</p>
</dd>
</dl>
</div>
<div class="section" id="field-lists">
<h2><a class="toc-backref" href="#id56">5.7 field lists</a></h2>
<p><a class="reference external" href="../ref/rst/restructuredtext.html#field-lists">Field lists</a> may be used as generic two-column table constructs in
documents.</p>
<dl class="docutils">
<dt>Environment:</dt>
<dd><tt class="docutils literal">DUfieldlist</tt></dd>
<dt>Default:</dt>
<dd>Indented description list.</dd>
<dt>Example:</dt>
<dd><p class="first">Use a description list customized with <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/enumitem.html">enumitem</a>:</p>
<pre class="literal-block">
\usepackage{enumitem}
\newenvironment{DUfieldlist}%
{\description[font=,style=sameline,leftmargin=8em]}
{\enddescription}
}
</pre>
<p class="last">The <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/koma-script.html">KOMA-script</a> classes provide a similar environment under the name
<span class="incremental">labeling</span>.</p>
</dd>
</dl>
</div>
<div class="section" id="figure-and-table-captions">
<h2><a class="toc-backref" href="#id57">5.8 figure and table captions</a></h2>
<p>The <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/caption.html">caption</a> package provides many ways to customise the captions in
floating environments like figure and table.</p>
<p>The <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/chngcntr.html">chngcntr</a> package helps to configure the numbering of figure and table
caption numberings.</p>
<p>Some document classes (e.g. <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/koma-script.html">KOMA-script</a>) provide additional configuration.
Also see the related <a class="reference external" href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=running-nos">LaTeX FAQ entry</a></p>
<dl class="docutils">
<dt>Example</dt>
<dd><pre class="first last literal-block">
\usepackage{caption}
\captionsetup{justification=raggedleft,singlelinecheck=false}
</pre>
</dd>
</dl>
</div>
<div class="section" id="figure-placement">
<h2><a class="toc-backref" href="#id58">5.9 figure placement</a></h2>
<p><a class="reference external" href="../ref/rst/directives.html#figure">Figures</a> might be typeset at the place of definition (default) or "float"
to a suitable place at the top or bottom of a page. This is implemented
using the <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/float.html">float</a> package.</p>
<dl class="docutils">
<dt>Command:</dt>
<dd><tt class="docutils literal">\floatplacement</tt></dd>
</dl>
<p>The placement setting is valid from the point of definition until the next
<tt class="docutils literal">\floatplacement</tt> command or the end of the document. See <a class="reference external" href="http://mirror.ctan.org/macros/latex/contrib/float/float.pdf">float.pdf</a> for
details.</p>
<dl class="docutils">
<dt>Default:</dt>
<dd><tt class="docutils literal"><span class="pre">\floatplacement{figure}{H}</span></tt> (here definitely). This corresponds most
closely to the source and HTML placement (principle of least surprise).</dd>
<dt>Example 1:</dt>
<dd><p class="first">In a custom <a class="reference internal" href="#style-sheet">style sheet</a>, set the default to let LaTeX find a suitable
place for figure floats:</p>
<pre class="last literal-block">
\usepackage{float}
\floatplacement{figure}{htbp} % here, top, bottom, extra-page
</pre>
</dd>
<dt>Example 2:</dt>
<dd><p class="first">To move all following figures to the top or bottom of the page write in
the document source:</p>
<pre class="last literal-block">
.. raw:: latex
\floatplacement{figure}{tb}
</pre>
</dd>
</dl>
</div>
<div class="section" id="font">
<span id="font-setup"></span><h2><a class="toc-backref" href="#id59">5.10 font</a></h2>
<p>The selected text font influences the <em>look</em>, the <em>feel</em>,
and the <em>readability</em> of the document (cf.
<a class="reference external" href="http://www.csarven.ca/web-typography">http://www.csarven.ca/web-typography</a>).
Selecting a suitable font also solves the problem with <a class="reference internal" href="#bad-looking-pdf-output">bad looking
PDF output</a>.</p>
<p>Font selection is one of the main differences between LaTeX and XeTeX:</p>
<dl class="docutils">
<dt>LaTeX</dt>
<dd>cannot use the fonts of the operating system directly but needs
specially installed fonts with additional supporting files.</dd>
<dt>XeTeX</dt>
<dd>can use system fonts and provides access to the full feature set of
modern <a class="reference external" href="http://en.wikipedia.org/wiki/OpenType">OpenType</a> fonts.</dd>
</dl>
<p>The default font setup is done in the <a class="reference external" href="config.html#latex-preamble">latex-preamble</a>:</p>
<dl class="docutils">
<dt>LaTeX</dt>
<dd><a class="reference external" href="http://en.wikipedia.org/wiki/PDF#Standard_Type_1_Fonts">PDF standard fonts</a> (Times, Helvetica, Courier)</dd>
<dt>XeTeX</dt>
<dd><p class="first"><a class="reference external" href="http://www.linuxlibertine.org/index.php?id=1&L=1">Linux Libertine</a>, a free, high quality alternative to Times with a
wide coverage of glyphs, styles, and OpenType features.</p>
<p class="last">Despite its name, Linux Libertine can be used on any operating
system that can handle OpenType fonts.</p>
</dd>
</dl>
<p>Alternative fonts can be selected by</p>
<dl class="docutils">
<dt>LaTeX</dt>
<dd><ol class="first loweralpha simple">
<li>specifying the corresponding LaTeX package(s) as argument to the
<a class="reference external" href="config.html#stylesheet-latex2e-writer">stylesheet</a> <a class="reference internal" href="#option">option</a> or with the <tt class="docutils literal">\usepackage</tt> LaTeX command.<ul>
<li>packages can be combined,</li>
<li>passing options to a package is only possible in a <a class="reference internal" href="#style-sheet">style sheet</a>
or the <a class="reference internal" href="#latex-preamble">LaTeX preamble</a>.</li>
</ul>
</li>
<li>changing the font-default macros <tt class="docutils literal">\rmdefault</tt>, <tt class="docutils literal">\sfdefault</tt>
and/or <tt class="docutils literal">\ttdefault</tt> in a custom <a class="reference internal" href="#style-sheet">style sheet</a>, the <a class="reference internal" href="#latex-preamble">LaTeX
preamble</a> or <a class="reference internal" href="#raw-latex">raw LaTeX</a>.</li>
</ol>
<dl class="docutils">
<dt>Example 1:</dt>
<dd><p class="first">Use <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/lm.html">Latin Modern</a>. <a class="reference internal" href="#latex-code">LaTeX code</a>:</p>
<pre class="literal-block">
\usepackage{lmodern}
</pre>
<p>Command line argument:</p>
<pre class="last literal-block">
--stylesheet=lmodern
</pre>
</dd>
<dt>Example 2:</dt>
<dd><p class="first">The <span class="target" id="times-helvetica-courier">Times/Helvetica/Courier</span> <a class="reference external" href="http://en.wikipedia.org/wiki/PDF#Standard_Type_1_Fonts">PDF standard fonts</a> are
selected by the LaTeX code <a class="footnote-reference" href="#id22" id="id21">[4]</a>:</p>
<pre class="literal-block">
\usepackage{mathptmx} % Times for serif and math
\usepackage[scaled=.90]{helvet} % downscaled Helvetica for sans serif
\usepackage{courier} % Courier for teletype (mono-space)
</pre>
<p class="last">Since Docutils 0.7, this is the default value of the
<a class="reference external" href="config.html#latex-preamble">latex-preamble</a> option.</p>
</dd>
</dl>
<table class="docutils footnote" frame="void" id="id22" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id21">[4]</a></td><td>When generating PDF-files from LaTeX, the <a class="reference external" href="http://en.wikipedia.org/wiki/PDF#Standard_Type_1_Fonts">PDF standard
fonts</a> do not need to be embedded in the document. While this
results in smaller files, the actually used fonts on screen and in
print might differ! (For details see, e.g., the <a class="reference external" href="http://www.tex.ac.uk/tex-archive/help/Catalogue/entries/testflow.html">testflow</a> package
documentation.)</td></tr>
</tbody>
</table>
<dl class="last docutils">
<dt>Example 3:</dt>
<dd><p class="first">Use the teletype font from the <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/txfonts.html">txfonts</a> package. As there is no
package for this, we re-define the font macro with the <a class="reference internal" href="#latex-code">LaTeX code</a>:</p>
<pre class="last literal-block">
\renewcommand{\ttdefault}{txtt}
</pre>
</dd>
</dl>
</dd>
<dt>XeTeX</dt>
<dd><p class="first">using the macros of the <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/fontspec.html">fontspec</a> package. Use some font-viewer or
-manager (e.g. <a class="reference external" href="http://fontmatrix.net/">fontmatrix</a>) to find out the correct names of the
fonts on your system.</p>
<dl class="last docutils">
<dt>Example:</dt>
<dd><p class="first"><a class="reference external" href="http://dejavu-fonts.org/">DejaVu</a>, very wide coverage, screen optimized. As this font
runs wide, add <tt class="docutils literal">DIV=10</tt> to the <a class="reference external" href="config.html#documentoptions">documentoptions</a>:</p>
<pre class="last literal-block">
\setmainfont{DejaVu Serif}
\setsansfont{DejaVu Sans}
\setmonofont[HyphenChar=None]{DejaVu Sans Mono}
</pre>
</dd>
</dl>
</dd>
</dl>
<div class="section" id="choice-of-suitable-fonts">
<h3><a class="toc-backref" href="#id60">5.10.1 choice of suitable fonts</a></h3>
<p>High quality free fonts suitable for use with XeTeX are, e.g., listed
at <a class="reference external" href="http://typophile.com/node/18207">Good Libre Fonts</a>, <a class="reference external" href="http://www.alvit.de/blog/article/20-best-license-free-official-fonts">25 Best Free Quality Fonts</a> and the update
<a class="reference external" href="http://www.smashingmagazine.com/2006/10/11/17-more-free-quality-fonts/">19 More Free Quality Fonts</a>.</p>
<p>The <a class="reference external" href="http://www.tug.dk/FontCatalogue/">LaTeX Font Catalogue</a> provides information and examples for a wide
range of fonts available for use with LaTeX. Here is just a selection:</p>
<ol class="loweralpha">
<li><p class="first">The <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/lm.html">Latin Modern</a> (LM) fonts are extended outline versions of the
standard TeX font Computer Modern (CM).</p>
<table class="docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group">
<kbd><span class="option">+1</span></kbd></td>
<td><p class="first last">simple invocation: <tt class="docutils literal"><span class="pre">--stylesheet=lmodern</span></tt></p>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">+1</span></kbd></td>
<td><p class="first">keeps the traditional TeX "look and feel":</p>
<table class="last docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group">
<kbd><span class="option">+1</span></kbd></td>
<td><p class="first last">generally accepted as high quality CM replacement,</p>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">+1</span></kbd></td>
<td><p class="first last">comprehensive math support,</p>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">+1</span></kbd></td>
<td><p class="first last">including optical sizes,</p>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">+1</span></kbd></td>
<td><p class="first last">compatible with extensions made to match CM,</p>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-1</span></kbd></td>
<td><p class="first last">modern types are hard to read at low (screen) resolutions.</p>
</td></tr>
</tbody>
</table>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-2</span></kbd></td>
<td><p class="first">not part of a minimal standard TeX installation</p>
<table class="last docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group">
<kbd><span class="option">-1</span></kbd></td>
<td><p class="first last">might not work out-of-the-box</p>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-1</span></kbd></td>
<td><p class="first last">large additional download (ca. 12 ... 17 MB)</p>
</td></tr>
</tbody>
</table>
</td></tr>
</tbody>
</table>
</li>
<li><p class="first"><a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/cm-super.html">CM-Super</a> is another outline CM replacement.</p>
<table class="docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group">
<kbd><span class="option">+1</span></kbd></td>
<td><p class="first last">simple invocation: modern LaTeX distributions use CM-Super
automatically instead of CM if it is installed.</p>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-1</span></kbd></td>
<td><p class="first last">said to be of inferior quality compared to LM.</p>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-2</span></kbd></td>
<td><p class="first last">not part of a minimal standard TeX installation,
even bigger download size than Latin Modern.</p>
</td></tr>
</tbody>
</table>
</li>
<li><p class="first"><a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/bera.html">Bera</a> (Bitstream Vera)</p>
<table class="docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group">
<kbd><span class="option">+1</span></kbd></td>
<td><p class="first last">simple invocation: <tt class="docutils literal"><span class="pre">--stylesheet=bera</span></tt></p>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">+1</span></kbd></td>
<td><p class="first last">optimized for on-screen viewing with goot hinting</p>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-2</span></kbd></td>
<td><p class="first last">not part of a minimal standard TeX installation</p>
</td></tr>
</tbody>
</table>
</li>
<li><p class="first"><a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/psnfss.html">PSNFSS</a> Postscript fonts</p>
<table class="docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group">
<kbd><span class="option">+1</span></kbd></td>
<td><p class="first last">part of every standard TeX installation</p>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">+1</span></kbd></td>
<td><p class="first last">smaller PDF/Postscript document size if standard fonts are not
embedded</p>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-1</span></kbd></td>
<td><p class="first last">restricted set of glyphs in the free versions <a class="footnote-reference" href="#id25" id="id24">[5]</a></p>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-1</span></kbd></td>
<td><p class="first last">different fonts for roman, sans-serif and typewriter fonts.</p>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-1</span></kbd></td>
<td><p class="first last">invocation somewhat more complex, as several packages are
required for a complete font set, sometimes including package
options.</p>
</td></tr>
</tbody>
</table>
<p>Roman (serif) PSNFSS fonts:</p>
<dl class="docutils">
<dt>Bookman</dt>
<dd><p class="first last">good legibility but very wide.</p>
</dd>
<dt>Charter</dt>
<dd><p class="first last">bread-and-butter type optimized for printing on low-resolution
printers</p>
</dd>
<dt>New Century Schoolbook</dt>
<dd><p class="first last">good legibility but very wide.</p>
</dd>
<dt>Palatino</dt>
<dd><table class="first last docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group">
<kbd><span class="option">+1</span></kbd></td>
<td><p class="first last">recommended by font experts</p>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">+1</span></kbd></td>
<td><p class="first last">good LaTeX support including matching math fonts, small caps,
old-style figures</p>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-1</span></kbd></td>
<td><p class="first last">bad rendering in xpdf viewer (auto-hinting leads to different
x-hight for different characters at some magnifications)
(this is fixed in recent versions).</p>
</td></tr>
</tbody>
</table>
</dd>
<dt>Times</dt>
<dd><table class="first last docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group">
<kbd><span class="option">+1</span></kbd></td>
<td><p class="first last">the serif <a class="reference external" href="http://en.wikipedia.org/wiki/PDF#Standard_Type_1_Fonts">PDF Standard Font</a>,</p>
</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-1</span></kbd></td>
<td><p class="first last">overused and quite narrow (devised for multi-column layouts).</p>
</td></tr>
</tbody>
</table>
</dd>
<dt>Utopia</dt>
<dd><p class="first last">recommended by font experts</p>
</dd>
</dl>
<table border="1" class="docutils">
<caption>Font packages for standard Postscript fonts
(cf. <a class="reference external" href="http://mirror.ctan.org/macros/latex/required/psnfss/psnfss2e.pdf">Using common Postscript fonts with LaTeX</a>)</caption>
<colgroup>
<col width="16%" />
<col width="21%" />
<col width="23%" />
<col width="23%" />
<col width="16%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">Package</th>
<th class="head">Roman</th>
<th class="head">Sans Serif</th>
<th class="head">Typewriter</th>
<th class="head">Math</th>
</tr>
</thead>
<tbody valign="top">
<tr><td>(none)</td>
<td>CM Roman</td>
<td>CM Sans Serif</td>
<td>CM Typewriter</td>
<td>CM Math</td>
</tr>
<tr><td>mathpazo</td>
<td>Palatino</td>
<td> </td>
<td> </td>
<td>Palatino</td>
</tr>
<tr><td>mathptmx</td>
<td>Times</td>
<td> </td>
<td> </td>
<td>Times</td>
</tr>
<tr><td>helvet</td>
<td> </td>
<td>Helvetica</td>
<td> </td>
<td> </td>
</tr>
<tr><td>avant</td>
<td> </td>
<td>Avant Garde</td>
<td> </td>
<td> </td>
</tr>
<tr><td>courier</td>
<td> </td>
<td> </td>
<td>Courier</td>
<td> </td>
</tr>
<tr><td>chancery</td>
<td>Zapf
Chancery</td>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr><td>bookman</td>
<td>Bookman</td>
<td>Avant Garde</td>
<td>Courier</td>
<td> </td>
</tr>
<tr><td>newcent</td>
<td>New Century
Schoolbook</td>
<td>Avant Garde</td>
<td>Courier</td>
<td> </td>
</tr>
<tr><td>charter</td>
<td>Charter</td>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr><td>utopia</td>
<td>Utopia</td>
<td> </td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table>
</li>
</ol>
<table class="docutils footnote" frame="void" id="id25" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id24">[5]</a></td><td>Extended versions of the standard Postscript fonts including
accented chars, Greek and Cyrillic as well as real small-caps
and old-style numbers are available with the <a class="reference external" href="http://www.gust.org.pl/projects/e-foundry/tex-gyre">TeX Gyre</a> bundle
which is part of, e.g., <a class="reference external" href="http://tug.org/texlive/">TeX Live</a>.</td></tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="font-encoding">
<h2><a class="toc-backref" href="#id61">5.11 font encoding</a></h2>
<p>LaTeX font encodings are described in detail in the <a class="reference external" href="http://mirror.ctan.org/macros/latex/doc/encguide.pdf">encguide</a> which is
part of the LaTeX base documentation.</p>
<dl class="docutils">
<dt>Option:</dt>
<dd><a class="reference external" href="config.html#font-encoding">font-encoding</a></dd>
<dt>Default:</dt>
<dd>"T1"</dd>
<dt>Example 1:</dt>
<dd><p class="first">Use the (obsolete) LaTeX default encoding "OT1":</p>
<pre class="literal-block">
--font-encoding=OT1
</pre>
<p>or (without loading the <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/fontenc.html">fontenc</a> package):</p>
<pre class="literal-block">
--font-encoding=""
</pre>
<p class="last">This will improve the look on screen with the default Computer Modern
fonts at the expense of problems with <a class="reference internal" href="#search-and-text-extraction">search and text extraction</a>
The recommended way is to select a T1-encoded "Type 1" (vector)
font, for example <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/lm.html">Latin Modern</a></p>
</dd>
<dt>Example 2:</dt>
<dd><p class="first">Support for characters in the Unicode blocks Latin, Latin-1 Supplement,
and Greek together with a T1-encoded "Type 1" (vector) font, for example
<a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/lm.html">Latin Modern</a>:</p>
<pre class="last literal-block">
--font-encoding=LGR,T1 --stylesheet=lmodern
</pre>
</dd>
</dl>
</div>
<div class="section" id="font-size">
<h2><a class="toc-backref" href="#id62">5.12 font size</a></h2>
<p>Add font size in points to the document options, e.g.
<tt class="docutils literal"><span class="pre">--documentoptions=12</span></tt>, use e.g. the document classes provided by
<a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/extsizes.html">extsizes</a> for values other than [10,11,12].</p>
</div>
<div class="section" id="footnotes">
<h2><a class="toc-backref" href="#id63">5.13 footnotes</a></h2>
<p>By default, footnotes are set with Docutils-specific wrappers around
the standard <tt class="docutils literal">\footnotemark</tt> and <tt class="docutils literal">\footnotetext</tt> commands. You
can configure the footnote layout similar to standard LaTeX footnotes
in a custom <a class="reference internal" href="#style-sheet">style sheet</a>.</p>
<p>Further configuration is possible by alternative definitions of
<tt class="docutils literal">\DUfootnotemark</tt> and <tt class="docutils literal">\DUfootnotetext</tt></p>
<dl class="docutils">
<dt>Example 1:</dt>
<dd><p class="first">Set footnote text with a hanging indent.</p>
<ul class="last">
<li><p class="first">This is the default with <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/koma-script.html">KOMA-script</a> classes, e.g:</p>
<pre class="literal-block">
--documentclass=scrartcl
</pre>
<p>(for further configuration, see the <a class="reference external" href="http://mirror.ctan.org/macros/latex/contrib/koma-script/scrguien.pdf">KOMA-script Guide</a>),</p>
</li>
<li><p class="first">with package <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/footmisc.html">footmisc</a>:</p>
<pre class="literal-block">
\usepackage[hang]{footmisc}
\setlength{\footnotemargin}{0em}
</pre>
<p>(play with the <tt class="docutils literal">\footnotemargin</tt> setting),</p>
</li>
<li><p class="first">redefine <tt class="docutils literal">\DUfootnotetext</tt> inserting <span class="incremental">hangindent</span>:</p>
<pre class="literal-block">
\newcommand{\DUfootnotetext}[4]{%
\begingroup%
\renewcommand{\thefootnote}{%
\protect\raisebox{1em}{\protect\hypertarget{#1}{}}%
\protect\hyperlink{#2}{#3}}%
\footnotetext{\hangindent=2em #4}%
\endgroup%
}
</pre>
<p>(adapt the <tt class="docutils literal">\hangindent</tt> value).</p>
</li>
</ul>
</dd>
<dt>Example 2:</dt>
<dd><p class="first">place the footnote text where it appears in the source document (instead
of at the page bottom). This can be used to get the effect of endnotes
(needs the <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/hanging.html">hanging</a> package):</p>
<pre class="last literal-block">
\usepackage{hanging}
\newcommand{\DUfootnotetext}[4]{%
\par\noindent\raisebox{1em}{\hypertarget{#1}{}}%
\hyperlink{#2}{#3}%
\hangpara{\parindent}{1}#4%
}
</pre>
</dd>
</dl>
</div>
<div class="section" id="hyphenation">
<h2><a class="toc-backref" href="#id64">5.14 hyphenation</a></h2>
<p>The amount of hyphenation is influenced by <tt class="docutils literal">\hyphenpenalty</tt>, setting it to
10000 almost prevents hyphenation. As this produces lines with more space
between words one should increase Latex's <tt class="docutils literal">\tolerance</tt> for this.</p>
<dl class="docutils">
<dt>Example:</dt>
<dd><pre class="first last literal-block">
\hyphenpenalty=5000
\tolerance=1000
</pre>
</dd>
</dl>
</div>
<div class="section" id="hyperlinks">
<h2><a class="toc-backref" href="#id65">5.15 hyperlinks</a></h2>
<dl class="docutils">
<dt>Options:</dt>
<dd><a class="reference external" href="config.html#hyperlink-color">hyperlink-color</a>, <a class="reference external" href="config.html#hyperref-options">hyperref-options</a></dd>
</dl>
<p>Hyperlinks are realized using the <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/hyperref.html">hyperref</a> package. As it re-defines many
standard LaTeX macros, this package is loaded last, <em>after</em> the style
sheets.</p>
<p>However, you can load hyperref before a package that requires its
presence in a <a class="reference internal" href="#style-sheet">style sheet</a> or the <a class="reference internal" href="#latex-preamble">LaTeX preamble</a> (see example
below). This will ignore options set with <a class="reference external" href="config.html#hyperlink-color">hyperlink-color</a> and
<a class="reference external" href="config.html#hyperref-options">hyperref-options</a>.</p>
<p>URLs are typeset with the "url" package (loaded implicitely by "hyperref").
The font of URLs can be defined with the <tt class="docutils literal">\urlstyle</tt> command. Valid
arguments are</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">same:</th><td class="field-body">normal text font, Docutils default,</td>
</tr>
<tr class="field"><th class="field-name">tt:</th><td class="field-body">teletype (monospaced), LaTeX default,</td>
</tr>
<tr class="field"><th class="field-name">rm:</th><td class="field-body">roman,</td>
</tr>
<tr class="field"><th class="field-name">sf:</th><td class="field-body">sans serif</td>
</tr>
</tbody>
</table>
<dl class="docutils">
<dt>Example:</dt>
<dd><p class="first">Custom loading of the hyperref package also switches to
the LaTeX default (monospaced fonts for URLs). Reset to use the text
font:</p>
<pre class="last literal-block">
\usepackage[unicode,colorlinks=true,linkcolor=green]{hyperref}
\urlstyle{same}
</pre>
</dd>
</dl>
<p>See also <a class="reference internal" href="#non-breaking-hyperlinks">non-breaking hyperlinks</a>.</p>
<div class="section" id="disable-hyperlinks">
<h3><a class="toc-backref" href="#id66">5.15.1 disable hyperlinks</a></h3>
<p>To suppress the hyper-linking completely (e.g. for printing or to
avoid clashes with other packages), set <a class="reference external" href="config.html#hyperref-options">hyperref-options</a> to "draft"
or load the "nohyperref" package that comes with the "hyperref"
bundle.</p>
<dl class="docutils">
<dt>Option:</dt>
<dd><tt class="docutils literal"><span class="pre">--hyperref-options=draft</span></tt></dd>
</dl>
<p><a class="reference internal" href="#latex-code">LaTeX code</a>:</p>
<pre class="literal-block">
\usepackage{nohyperref,url}
\urlstyle{same}
</pre>
</div>
</div>
<div class="section" id="line-blocks">
<h2><a class="toc-backref" href="#id67">5.16 line blocks</a></h2>
<p>In <a class="reference external" href="../ref/rst/restructuredtext.html#line-blocks">line blocks</a>, newlines and leading whitespace are respected.</p>
<dl class="docutils">
<dt>Environment:</dt>
<dd><tt class="docutils literal">DUlineblock</tt>: special list environment for line blocks</dd>
<dt>Length:</dt>
<dd><tt class="docutils literal">\DUlineblockindent</tt>: indentation of indented lineblock parts.</dd>
<dt>Default:</dt>
<dd>2.5 times the font hight: <tt class="docutils literal">2.5em</tt></dd>
<dt>Example:</dt>
<dd><p class="first">set to the paragraph indentation:</p>
<pre class="last literal-block">
\newlength{\DUlineblockindent}
\setlength{\DUlineblockindent}{\parindent}
</pre>
</dd>
</dl>
</div>
<div class="section" id="line-spacing">
<h2><a class="toc-backref" href="#id68">5.17 line spacing</a></h2>
<dl class="docutils">
<dt>Commands:</dt>
<dd><p class="first"><tt class="docutils literal">\linespread</tt>: for small adjustments</p>
<p class="last"><tt class="docutils literal">\singlespacing</tt>, <tt class="docutils literal">\onehalfspacing</tt>, and <tt class="docutils literal">\doublespacing</tt>: from
package <span class="incremental">setspace</span></p>
</dd>
<dt>Example 1:</dt>
<dd><p class="first">Get document wide double spacing:</p>
<pre class="last literal-block">
\usepackage{setspace}
\doublespacing
</pre>
</dd>
<dt>Example 2:</dt>
<dd><p class="first">Increase line spacing by five percent for better readability:</p>
<pre class="last literal-block">
\linespread{1.05}
</pre>
</dd>
</dl>
</div>
<div class="section" id="literal-blocks">
<h2><a class="toc-backref" href="#id69">5.18 literal blocks</a></h2>
<p>No markup processing is done within a <a class="reference external" href="../ref/rst/restructuredtext.html#literal-blocks">literal block</a>. It is left as-is,
and is typically rendered in a monospaced typeface</p>
<dl class="docutils">
<dt>Option:</dt>
<dd><a class="reference external" href="config.html#literal-block-env">literal-block-env</a></dd>
</dl>
<p>Example:</p>
<blockquote>
<p><tt class="docutils literal"><span class="pre">--literal-block-env=lstlisting</span></tt></p>
<p>The <tt class="docutils literal">lstlisting</tt> environment is highly configurable (as documented in
<a class="reference external" href="http://mirror.ctan.org/macros/latex/contrib/listings/listings.pdf">listings.pdf</a>), for instance</p>
<pre class="literal-block">
\renewcommand{\ttdefault}{txtt}
\lstset{language=Python, morekeywords=[1]{yield}}
\lstloadlanguages{Python}
\lstset{
basicstyle=\ttfamily,
keywordstyle=\bfseries,
commentstyle=\rmfamily\itshape,
stringstyle=\slshape,
}
\lstset{showstringspaces=false}
\lstset{columns=fullflexible,
basewidth={0.5em,0.4em}}
</pre>
<p>The indentation of literal blocks can be reset with</p>
<pre class="literal-block">
\lstset{resetmargins=true}
</pre>
<p>and/or configured with e. g.:</p>
<pre class="literal-block">
\lstset{xleftmargin=-2em}
</pre>
</blockquote>
</div>
<div class="section" id="list-of-figures-tables">
<h2><a class="toc-backref" href="#id70">5.19 list of figures/tables</a></h2>
<p>Docutils does not support lists of figures or tables.</p>
<p>However, with LaTeX, they can be generated using <a class="reference internal" href="#raw-latex">raw LaTeX</a> in the
document source.</p>
<dl class="docutils">
<dt>Commands:</dt>
<dd><p class="first"><tt class="docutils literal">\listoffigures</tt>: a list of figures</p>
<p class="last"><tt class="docutils literal">\listoftables</tt>: a list of tables</p>
</dd>
<dt>Example:</dt>
<dd><pre class="first last literal-block">
.. raw:: latex
\listoffigures
</pre>
</dd>
</dl>
</div>
<div class="section" id="option-list">
<h2><a class="toc-backref" href="#id71">5.20 option list</a></h2>
<p><a class="reference external" href="../ref/rst/restructuredtext.html#option-lists">Option lists</a> are two-column lists of command-line options and
descriptions, documenting a program's options.</p>
<dl class="docutils">
<dt>Environment:</dt>
<dd><tt class="docutils literal">DUoptionlist</tt>: environment for option lists,</dd>
<dt>Command:</dt>
<dd><tt class="docutils literal">\DUoptionlistlabel</tt>: set appearance of the options</dd>
<dt>Example:</dt>
<dd><p class="first">set command options with a bold monospace font:</p>
<pre class="last literal-block">
\newcommand{\DUoptionlistlabel}{\texttt{\textbf{#1}} \hfill}
</pre>
</dd>
</dl>
</div>
<div class="section" id="page-breaks">
<h2><a class="toc-backref" href="#id72">5.21 page breaks</a></h2>
<ul class="simple">
<li>Page breaks before top-level sections are the default with a
documentclass that provides "chapters", e.g. "book", "memoir" or
"scrbook".</li>
<li>Redefining the section or section* command in a
style sheet is possible too.</li>
<li><a class="reference internal" href="#raw-latex">Raw LaTeX</a> or a <a class="reference internal" href="#custom-role">custom role</a> can be used.</li>
<li>The transition element can be re-defined to produce a page break,</li>
</ul>
<dl class="docutils">
<dt>Commands</dt>
<dd><p class="first"><tt class="docutils literal">\newpage</tt>: hard pagebreak at exactly this position</p>
<p class="last"><tt class="docutils literal">\pagebreak[2]</tt>: recommended page break after line end (precedence 1...4)</p>
</dd>
<dt>Example:</dt>
<dd><p class="first">Define the transition command as page break with the <a class="reference internal" href="#latex-code">LaTeX code</a>:</p>
<pre class="literal-block">
\newcommand*{\DUtransition}{\pagebreak[4]}
</pre>
<p class="last">(use <tt class="docutils literal">\renewcommand</tt> with <a class="reference internal" href="#raw-latex">raw LaTeX</a>).</p>
</dd>
</dl>
</div>
<div class="section" id="page-layout">
<h2><a class="toc-backref" href="#id73">5.22 page layout</a></h2>
<p>By default, paper size and margin settings are determined by the document
class.</p>
<p>The following packages help to configure the page layout:</p>
<ol class="loweralpha">
<li><p class="first">The <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/typearea.html">typearea</a> package (part of the <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/koma-script.html">KOMA-script</a> bundle) calculates a
<em>good</em> page layout (based on rules and recommendations of typography
experts).</p>
<p>See the <a class="reference external" href="http://mirror.ctan.org/macros/latex/contrib/koma-script/scrguien.pdf">KOMA-Script Guide</a> for details on what is a <em>good</em> layout and
how this is achieved.</p>
</li>
<li><p class="first">The <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/geometry.html">geometry</a> package is recommended if you have to follow guidelines
with fixed values for the margins.
For details see the <a class="reference external" href="http://mirror.ctan.org/macros/latex/contrib/geometry/geometry.pdf">geometry manual</a>.</p>
</li>
</ol>
<dl class="docutils">
<dt>Example 1:</dt>
<dd><p class="first">Let <span class="incremental">typearea</span> determine the type area with <tt class="docutils literal">DIV=calc</tt> in the
documentoptions:</p>
<pre class="literal-block">
--documentoptions='a4paper,DIV=calc'
</pre>
<p class="last">The <tt class="docutils literal">DIV</tt> option can also be specified, like <tt class="docutils literal">DIV=10</tt>. It defines how
"crowded" a page will be: larger values mean larger text area (at the
expense of readability).</p>
</dd>
<dt>Example 2:</dt>
<dd><p class="first"><a class="reference internal" href="#latex-code">LaTeX code</a> to set margins with the <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/geometry.html">geometry</a> package:</p>
<pre class="last literal-block">
\usepackage{geometry}
\geometry{hmargin={3cm,0.8in},height=8in}
\geometry{height=10in}.
</pre>
</dd>
</dl>
</div>
<div class="section" id="page-headers-and-footers">
<h2><a class="toc-backref" href="#id74">5.23 page headers and footers</a></h2>
<p>With the <a class="reference external" href="http://www.ctan.org/pkg/fancyhdr">fancyhdr</a> package or the <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/koma-script.html">KOMA-script</a> classes, you can define
custom page head- and foot-lines.</p>
<p>The <a class="reference external" href="../ref/rst/directives.html#header">"header" and "footer" directives</a> save their content in the macros
<tt class="docutils literal">\DUheader</tt> rsp. <tt class="docutils literal">\DUfooter</tt>. The macros can be used in LaTeX code and
will be replaced by LaTeX with the content of the directives.</p>
<dl class="docutils">
<dt>Example:</dt>
<dd><p class="first"><a class="reference internal" href="#latex-code">LaTeX code</a> to place left-aligned "header" and "footer" on every
page with <a class="reference external" href="http://www.ctan.org/pkg/fancyhdr">fancyhdr</a>:</p>
<pre class="last literal-block">
\usepackage{fancyhdr}
\fancyhead[L]{\DUheader}
\fancyfoot{} % reset
\fancyfoot[L]{\DUfooter}
\pagestyle{fancy}
</pre>
</dd>
</dl>
</div>
<div class="section" id="page-numbering">
<h2><a class="toc-backref" href="#id75">5.24 page numbering</a></h2>
<dl class="docutils">
<dt>Example:</dt>
<dd><p class="first">Number pages by chapter (using the <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/chappg.html">chappg</a> package):</p>
<pre class="literal-block">
\usepackage{chappg}
</pre>
<p class="last">See the <a class="reference external" href="http://mirror.ctan.org/macros/latex/contrib/chappg/chappg.pdf">chappg documentation</a> for details.</p>
</dd>
</dl>
</div>
<div class="section" id="paper-size">
<h2><a class="toc-backref" href="#id76">5.25 paper size</a></h2>
<p>Paper geometry can be changed using <tt class="docutils literal"><span class="pre">--documentoptions</span></tt> or with the
<a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/geometry.html">geometry</a> package.</p>
<p><a class="reference internal" href="#latex-code">LaTeX code</a>:</p>
<pre class="literal-block">
\usepackage{geometry}
\geometry{OPTIONLIST}
</pre>
<dl class="docutils">
<dt>Default:</dt>
<dd>a4paper</dd>
</dl>
<p>Some possibilities:</p>
<ul class="simple">
<li>a4paper, b3paper, letterpaper, executivepaper, legalpaper</li>
<li>landscape, portrait, twoside.</li>
</ul>
<dl class="docutils">
<dt>Example:</dt>
<dd><p class="first">Choose A5 pager in landscape orientation with command line argument:</p>
<pre class="literal-block">
--documentoptions=a5paper,landscape
</pre>
<p>The same with LaTeX commands in the <a class="reference internal" href="#style-sheet">style sheet</a>:</p>
<pre class="literal-block">
\usepackage{geometry}
\geometry{a5paper,landscape}
</pre>
<p class="last">For details see the <a class="reference external" href="http://mirror.ctan.org/macros/latex/contrib/geometry/geometry.pdf">geometry manual</a>.</p>
</dd>
</dl>
</div>
<div class="section" id="paragraph-indent">
<h2><a class="toc-backref" href="#id77">5.26 paragraph indent</a></h2>
<dl class="docutils">
<dt>Default (in most document classes):</dt>
<dd>Indent the first line in a paragraph unless it is the first line of a
chapter, section, subsection, or subsubsection.</dd>
<dt>Example:</dt>
<dd><p class="first">To set paragraph indentation to zero but add a vertical space between
load the <span class="incremental">parskip</span> package with the command line argument:</p>
<pre class="literal-block">
--stylesheet=parskip
</pre>
<p>or in a custom <a class="reference internal" href="#style-sheet">style sheet</a> with:</p>
<pre class="last literal-block">
\usepackage{parskip}
</pre>
</dd>
</dl>
</div>
<div class="section" id="rubric">
<h2><a class="toc-backref" href="#id78">5.27 rubric</a></h2>
<p>A <a class="reference external" href="../ref/rst/directives.html#rubric">rubric</a> is like an informal heading that doesn't correspond to the
document's structure.</p>
<dl class="docutils">
<dt>Command:</dt>
<dd><tt class="docutils literal">\DUrubric</tt></dd>
<dt>Default:</dt>
<dd>subsubsection style, italic, centred</dd>
<dt>Example:</dt>
<dd><p class="first">set flushleft and red:</p>
<pre class="last literal-block">
\newcommand*{\DUrubric}[2][class-arg]{%
\subsubsection*{{\color{red}#1}\hfill}}
</pre>
</dd>
</dl>
</div>
<div class="section" id="section-numbering">
<h2><a class="toc-backref" href="#id79">5.28 section numbering</a></h2>
<p>Sections are numbered if there is a <a class="reference external" href="../ref/rst/directives.html#sectnum">sectnum directive</a> in the document.</p>
<dl class="docutils">
<dt>Option: <a class="reference external" href="config.html#sectnum-xform">sectnum_xform</a></dt>
<dd><tt class="docutils literal"><span class="pre">--section-numbering</span></tt>, <tt class="docutils literal"><span class="pre">--no-section-numbering</span></tt></dd>
</dl>
<p>If <a class="reference external" href="config.html#sectnum-xform">sectnum_xform</a> is False, section numbers are generated by LaTeX. In this
case the "prefix" and "suffix" arguments of the <a class="reference external" href="../ref/rst/directives.html#sectnum">sectnum directive</a> are
ignored. The section number style is determined by the <a class="reference internal" href="#document-class">document class</a>
and can be configured in a LaTeX <a class="reference internal" href="#style-sheet">style sheet</a>, e.g.:</p>
<pre class="literal-block">
\setcounter{secnumdepth}{5}
</pre>
<div class="note">
<p class="first admonition-title">Note</p>
<p class="last">The LaTeX name is 'secnumdepth' (whithout 't').</p>
</div>
</div>
<div class="section" id="sidebar">
<h2><a class="toc-backref" href="#id80">5.29 sidebar</a></h2>
<p><a class="reference external" href="http://docutils.sf.net/docutils/docs/ref/rst/directives.html#sidebar">Sidebars</a> are like miniature, parallel documents that occur inside other
documents, providing related or reference material. They can be likened to
super-footnotes; their content is outside of the flow of the document's main
text.</p>
<dl class="docutils">
<dt>Command:</dt>
<dd><tt class="docutils literal">DUsidebar</tt></dd>
<dt>Default:</dt>
<dd>Box with grey background.</dd>
<dt>Example 1:</dt>
<dd><p class="first">Less space before the title:</p>
<pre class="last literal-block">
\providecommand{\DUsidebar}[2]{%
\begin{center}
\colorbox[gray]{0.90}{\parbox{0.9\textwidth}{%
\smallskip\textbf{#1}\smallskip
#2}}
\end{center}
}
</pre>
</dd>
<dt>Example 2:</dt>
<dd><p class="first">Use margin notes:</p>
<pre class="literal-block">
\newcommand{\DUsidebar}[2]{\marginpar{\flushleft \textbf{#1} #2}}
</pre>
<ul class="last simple">
<li>Make sure the margin is wide enough to hold the note.</li>
<li>This fails with some constructs inside the <span class="incremental">side bar</span> and where
marginpar cannot be used, e.g., inside floats, footnotes, or in frames
made with the framed package (see <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/marginnote.html">marginnote</a>).</li>
</ul>
</dd>
</dl>
</div>
<div class="section" id="size-of-a-pixel">
<h2><a class="toc-backref" href="#id81">5.30 size of a pixel</a></h2>
<p>The length unit <tt class="docutils literal">px</tt> is a "relative length" whose value depends on the
<em>resolution</em> of the output device (usually specified in <em>dots per inch</em>
(DPI). However, when producing a PDF, the resolution of the output device
(printer, screen (for PDF-viewer)) is generally not known.</p>
<p>With pdftex, the "resolution" is a configuration setting.</p>
<dl class="docutils">
<dt>Default:</dt>
<dd>72 DPI, i.e. 1 px = 1/72 in.</dd>
<dt>Example:</dt>
<dd><p class="first">Set a resolution of 96 DPI with the <a class="reference internal" href="#latex-code">LaTeX code</a>:</p>
<pre class="last literal-block">
\pdfpxdimen=1in % 1 DPI
\divide\pdfpxdimen by 96 % 96 DPI
</pre>
</dd>
</dl>
</div>
<div class="section" id="topic-element">
<h2><a class="toc-backref" href="#id82">5.31 topic element</a></h2>
<p>A <a class="reference external" href="../ref/rst/directives.html#topic">topic</a> is like a block quote with a title, or a self-contained section with
no subsections.</p>
<p>Topics and rubrics can be used at places where a <a class="reference external" href="../ref/rst/restructuredtext.html#sections">section title</a> is not
allowed (e.g. inside a directive).</p>
<dl class="docutils">
<dt>Command:</dt>
<dd><tt class="docutils literal">DUtopic</tt></dd>
<dt>Default:</dt>
<dd>"quote" environment</dd>
<dt>Example 1:</dt>
<dd><p class="first">If you generally prefer a "normal" section over a block quote, define:</p>
<pre class="last literal-block">
\newcommand{\DUtopic}[2][class-arg]{%
\ifcsname DUtopic#1\endcsname%
\csname DUtopic#1\endcsname{#2}%
\else
#2
\fi
}
</pre>
</dd>
<dt>Example 2:</dt>
<dd><p class="first">If you want a "normal" section for topics with class argument "noquote",
define:</p>
<pre class="last literal-block">
\newcommand{\DUtopicnoquote}[1]{#1}
</pre>
</dd>
</dl>
</div>
<div class="section" id="topic-title">
<h2><a class="toc-backref" href="#id83">5.32 topic title</a></h2>
<p>The titles of <a class="reference internal" href="#admonitions">admonitions</a>, <a class="reference internal" href="#sidebar">sidebar</a>, and <a class="reference internal" href="#topic-element">topic element</a> are defined with
the <tt class="docutils literal">\DUtitle</tt> command that also takes a "class" argument.</p>
<dl class="docutils">
<dt>Example 1:</dt>
<dd><p class="first">a centered and somewhat larger title for topcis:</p>
<pre class="last literal-block">
\newcommand*{\DUtitletopic}[1]{\subsection*{\centering #1}
</pre>
</dd>
<dt>Example 2:</dt>
<dd><p class="first">a right-pointing hand as title for the "attention" directive:</p>
<pre class="literal-block">
\usepackage{pifont}
\newcommand{\DUtitleattention}[1]{\ding{43}}
</pre>
<p>The title argument is "swallowed" by the command.
To have both, hand and title use:</p>
<pre class="last literal-block">
\usepackage{pifont}
\newcommand{\DUtitleattention}[1]{\ding{43} #1}
</pre>
</dd>
</dl>
</div>
<div class="section" id="table-of-contents">
<h2><a class="toc-backref" href="#id84">5.33 table of contents</a></h2>
<p>A <a class="reference external" href="../ref/rst/directives.html#contents">contents directive</a> is replaced by a table of contents (ToC).</p>
<dl class="docutils">
<dt>Option: <a class="reference external" href="config.html#use-latex-toc">use-latex-toc</a></dt>
<dd><tt class="docutils literal"><span class="pre">--use-latex-toc</span></tt>, <tt class="docutils literal"><span class="pre">--use-docutils-toc</span></tt></dd>
</dl>
<p>With use-latex-toc (default since release 0.6):</p>
<ul>
<li><p class="first">The ToC is generated by LaTeX (via the <tt class="docutils literal">\tableofcontents</tt> command).</p>
<p>The layout depends on the choosen document class and can be configured in
a custom <a class="reference internal" href="#style-sheet">style sheet</a> (see e.g. the <a class="reference external" href="http://mirror.ctan.org/macros/latex/contrib/koma-script/scrguien.pdf">KOMA-Script Guide</a> for the
<a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/koma-script.html">KOMA-script</a> classes).</p>
</li>
<li><p class="first">The depth of the ToC and PDF-bookmarks can be configured</p>
<ul class="simple">
<li>with the "depth" argument of the <a class="reference external" href="../ref/rst/directives.html#contents">contents directive</a>, or</li>
<li>in a style sheet with e.g. <tt class="docutils literal"><span class="pre">\setcounter{tocdepth}{5}</span></tt>.</li>
</ul>
</li>
<li><p class="first">Local ToCs are done with the <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/minitoc.html">minitoc</a> package. See the <a class="reference external" href="http://mirror.ctan.org/macros/latex/contrib/minitoc/minitoc.pdf">minitoc
documentation</a> for the numerous configuration options.</p>
</li>
</ul>
<div class="note">
<p class="first admonition-title">Note</p>
<p>Minitoc supports local ToCs only at "part" and top section level
("chapter" or "section"). Local <span class="incremental">contents</span> directives at lower levels
are ignored (a warning is issued).</p>
<p class="last">This is an intended feature of the <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/minitoc.html">minitoc</a> package. If you really
require local ToCs at lower level, turn off the <a class="reference external" href="config.html#use-latex-toc">use-latex-toc</a> option.</p>
</div>
</div>
<div class="section" id="title-reference-role">
<h2><a class="toc-backref" href="#id85">5.34 title reference role</a></h2>
<p><a class="reference external" href="../ref/rst/roles.html#title-reference">Title reference</a> is the default <a class="reference external" href="../ref/rst/directives.html#setting-the-default-interpreted-text-role">default role</a> for <a class="reference external" href="../ref/rst/restructuredtext.html#interpreted-text">interpreted text</a>.</p>
<dl class="docutils">
<dt>Command:</dt>
<dd><tt class="docutils literal">\DUroletitlereference</tt></dd>
<dt>Default:</dt>
<dd>use slanted font (<tt class="docutils literal">\textsl</tt>)</dd>
<dt>Example:</dt>
<dd><p class="first">set title references with a bold monospace font:</p>
<pre class="last literal-block">
\newcommand{\DUroletitlereference}[1]{\texttt{\textbf{#1}}}
</pre>
</dd>
</dl>
</div>
<div class="section" id="text-encoding">
<h2><a class="toc-backref" href="#id86">5.35 text encoding</a></h2>
<p>The encoding of the LaTeX source file is Docutils' <em>output</em> encoding
but LaTeX' <em>input</em> encoding.</p>
<dl class="docutils">
<dt>Option: <a class="reference external" href="config.html#output-encoding">output-encoding</a></dt>
<dd><tt class="docutils literal"><span class="pre">--output-encoding=OUTPUT-ENCODING</span></tt></dd>
<dt>Default:</dt>
<dd>"utf8"</dd>
<dt>Example:</dt>
<dd><p class="first">Encode the LaTeX source file with the ISO <span class="incremental">latin-1</span> (west european)
8-bit encoding (the default in Docutils versions up to 0.6.):</p>
<pre class="last literal-block">
--output-encoding=latin-1
</pre>
</dd>
<dt>Note:</dt>
<dd><p class="first">LaTeX comes with two options for UTF-8 support,</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">utf8:</th><td class="field-body">by the standard <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/inputenc.html">inputenc</a> package with only limited coverage
(mainly accented characters).</td>
</tr>
<tr class="field"><th class="field-name">utf8x:</th><td class="field-body">supported by the <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/unicode.html">ucs</a> package covers a wider range of Unicode
characters than does "utf8". It is, however, a non-standard
extension and no longer developed.</td>
</tr>
</tbody>
</table>
<p class="last">Currently (in version 0.6), "utf8" is used if the output-encoding is
any of "utf_8", "U8", "UTF", or "utf8".</p>
</dd>
</dl>
<!-- with utf8x:
If LaTeX issues a Warning about unloaded/unknown characters adding ::
\PreloadUnicodePage{n}
(where *n* is the Unicode page-number) to the style sheet might help. -->
</div>
<div class="section" id="transition-element">
<h2><a class="toc-backref" href="#id87">5.36 transition element</a></h2>
<p><a class="reference external" href="http://docutils.sf.net/docutils/docs/ref/rst/restructuredtext.html#transitions">Transitions</a> are commonly seen in novels and short fiction, as a gap
spanning one or more lines, marking text divisions or signaling changes in
subject, time, point of view, or emphasis.</p>
<dl class="docutils">
<dt>Command:</dt>
<dd><tt class="docutils literal">\DUtransition</tt></dd>
<dt>Default:</dt>
<dd>A horizontal line, 1/3 of text width</dd>
<dt>Example 1:</dt>
<dd><p class="first">Use three stars:</p>
<pre class="literal-block">
\newcommand*{\DUtransition}[1][class-arg]{\centering{}*\quad*\quad*}
</pre>
<p class="last">Alternatively use the more elaborated version in <a class="reference external" href="../../../sandbox/stylesheets/transition-stars.sty">transition-stars.sty</a>.</p>
</dd>
<dt>Example 2:</dt>
<dd><p class="first">If paragraphs are separated by indentation, you can simply use a vertical
space:</p>
<pre class="last literal-block">
\newcommand*{\DUtransition}[1][class-arg]{\vspace{2ex}}
</pre>
</dd>
</dl>
</div>
</div>
<div class="section" id="changes">
<h1><a class="toc-backref" href="#id88">6 Changes</a></h1>
<ul class="simple">
<li>The Docutils <a class="reference external" href="../../HISTORY.html">HISTORY</a> lists all changes during the history of docutils.</li>
<li>Changes since release (0.5) are summarized in the <a class="reference external" href="../../RELEASE-NOTES.html">RELEASE-NOTES</a>
and explained in detail in <a class="reference external" href="docutils-05-compat.sty.html">docutils-05-compat</a>.</li>
<li><a class="reference external" href="../../docutils/writers/latex2e/docutils-05-compat.sty">docutils-05-compat.sty</a> is a <a class="reference internal" href="#style-sheet">style sheet</a> that provides best possible
backwards compatibility.</li>
</ul>
</div>
<div class="section" id="problems">
<h1><a class="toc-backref" href="#id89">7 Problems</a></h1>
<div class="section" id="troubleshooting">
<h2><a class="toc-backref" href="#id90">7.1 Troubleshooting</a></h2>
<div class="section" id="bad-looking-pdf-output">
<h3><a class="toc-backref" href="#id91">7.1.1 Bad looking PDF output</a></h3>
<blockquote>
<p>What I am looking for when I try Docutils is if the PDF files I can get
are of high quality. Unfortunaltely that never is the case.</p>
<p>So am I just stupid or is there a way to get really high quality pdf from
Docutils?</p>
</blockquote>
<p>Make sure the default font is not a bitmap font.</p>
<p>There is <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/lm.html">Latin Modern</a> if you like the look of the standard font on paper,
but want nice pdf. Or select something else like Times, Palatino, ... via
configuration <a class="reference internal" href="#options">options</a> to the Docutils tool. See <a class="reference internal" href="#font">font</a> and <a class="reference external" href="config.html#font-encoding">font-encoding</a>.</p>
</div>
<div class="section" id="footnote-mark-and-text-at-different-pages">
<h3><a class="toc-backref" href="#id92">7.1.2 footnote mark and text at different pages</a></h3>
<p>Docutils stores the footnote text in a separate node, at the position where
it is specified in the input document. With the default settings, the
footnote is put at the bottom of the page where the footnote text is located,
maybe far away from the footnote mark (see e.g. <a class="reference external" href="rst/demo.txt">rst/demo.txt</a>).</p>
<p>To get footnote mark and text at the same page, keep footnote mark and
footnote text close together!</p>
</div>
<div class="section" id="non-breaking-hyperlinks">
<h3><a class="toc-backref" href="#id93">7.1.3 non-breaking hyperlinks</a></h3>
<p>If you convert with <tt class="docutils literal">latex</tt> (as opposed to <tt class="docutils literal">pdflatex</tt>), hyperlinks will
not wrap and sometimes stick into the margin.</p>
<dl class="docutils">
<dt>Wrong:</dt>
<dd><pre class="first literal-block">
\usepackage[breaklinks=true]{hyperref}
</pre>
<p class="last">"breaklinks" is an internal option that indicates whether the chosen
driver can handle split links. (It might work to <em>disable</em> link breaking.)</p>
</dd>
<dt>Right:</dt>
<dd><p class="first">Use one of the following:</p>
<ol class="last loweralpha simple">
<li>compile with <a class="reference internal" href="#pdflatex">pdflatex</a>,</li>
<li>compile with <a class="reference internal" href="#latex-dvipdfmx">latex + dvipdfmx</a>,</li>
<li>use the package <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/breakurl.html">breakurl</a>,</li>
<li>(for printout) <a class="reference internal" href="#disable-hyperlinks">disable hyperlinks</a> using the package "nohyperref".</li>
</ol>
</dd>
</dl>
<p>See also the <a class="reference external" href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=breaklinks">Link text doesn’t break at end line</a> FAQ entry.</p>
</div>
<div class="section" id="glyph-not-defined-in-pd1-encoding">
<h3><a class="toc-backref" href="#id94">7.1.4 Glyph not defined in PD1 encoding</a></h3>
<p>If a section title or other link contains non-Latin (e.g. Cyrillic)
characters, the LaTeX log contains lots of warnings like:</p>
<pre class="literal-block">
Package hyperref Warning: Glyph not defined in PD1 encoding,
(hyperref) removing `\CYRZ' on input line 6.
...
</pre>
<p>This can be solved with the "unicode" <a class="reference external" href="config.html#stylesheet-latex2e-writer">hyperref_option</a> setting:</p>
<pre class="literal-block">
--hyperref-option=unicode
</pre>
<p>(works also with non-unicode input/output encoding (e.g. "koi8r" or
"latin1"). Newer versions of hyperref default to "unicode=true" if the
document language is "russian".</p>
<p>However, this setting leads to "strange" characters in the bookmarks
if used with <a class="reference internal" href="#xelatex">xelatex</a> in hyperref versions before v6.79g (2009/11/20).
(cf <a class="reference external" href="http://sourceforge.net/tracker/?func=detail&aid=3100778&group_id=38414&atid=422030">bugreport 3100778</a>).</p>
<p>If updating the hyperref package is not an option, the workaround is
to set</p>
<pre class="literal-block">
--hyperref-option="unicode=false"
</pre>
<p>or (in the config file):</p>
<pre class="literal-block">
[xetex writer]
hyperref-option: unicode=false
</pre>
</div>
<div class="section" id="image-inclusion">
<h3><a class="toc-backref" href="#id95">7.1.5 image inclusion</a></h3>
<p><a class="reference external" href="../ref/rst/directives.html#images">Images</a> are included in LaTeX with the help of the <span class="incremental">graphicx</span> package. The
supported file formats depend on the used driver:</p>
<ul class="simple">
<li>Standard <a class="reference internal" href="#id6">latex</a> can include <strong>only EPS</strong> graphics, no other format.</li>
<li><a class="reference internal" href="#latex-dvipdfmx">latex + dvipdfmx</a> works with EPS and JPG (add 'dvipdfmx' to the
<a class="reference external" href="config.html#documentoptions">documentoptions</a> and 'bmpsize' to the <a class="reference external" href="config.html#stylesheet-latex2e-writer">stylesheet</a> setting).</li>
<li><a class="reference internal" href="#pdflatex">pdflatex</a> and <a class="reference internal" href="#xelatex">xelatex</a> work with PNG, JPG, or PDF, but <strong>not EPS</strong>.</li>
</ul>
<p>If PDF-image inclusion in PDF files fails, specifying
<tt class="docutils literal"><span class="pre">--graphicx-option=pdftex</span></tt> or <tt class="docutils literal"><span class="pre">--graphicx-option=auto</span></tt> might help.</p>
<p>For details see <a class="reference external" href="http://mirror.ctan.org/macros/latex/required/graphics/grfguide.pdf">grfguide.pdf</a>.</p>
<p>The <a class="reference internal" href="#rubber">Rubber</a> wrapper can be used for automatic image conversion.</p>
<p>Docutils expects an URI as pointer to the image file. The latex writer
transforms this URI to a local path. By default, LaTeX does not accept
spaces and more than one dot in the filename. If using "traditional"
filenames is not an option, the adding <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/grffile.html">grffile</a> to the <a class="reference internal" href="#style-sheets">style sheets</a>
can help.</p>
</div>
<div class="section" id="why-are-my-images-too-big">
<h3><a class="toc-backref" href="#id96">7.1.6 Why are my images too big?</a></h3>
<p>HTML-browsers use the actual screen resolution (usually around
100 DPI).</p>
<p>The CSS specification suggests:</p>
<blockquote>
<p>It is recommended that the reference pixel be the visual angle of one
pixel on a device with a pixel density of 96 DPI and a distance from the
reader of an arm's length.</p>
<p class="attribution">—<a class="reference external" href="http://www.w3.org/TR/CSS2/syndata.html#length-units">http://www.w3.org/TR/CSS2/syndata.html#length-units</a></p>
</blockquote>
<p>This is why pixmap images without size specification or objects with a size
specified in <tt class="docutils literal">px</tt> tend to come too large in the PDF.</p>
<dl class="docutils">
<dt>Solution:</dt>
<dd>Specify the image size in fixed units (<tt class="docutils literal">pt</tt>, <tt class="docutils literal">cm</tt>, <tt class="docutils literal">in</tt>) or
configure the <a class="reference internal" href="#size-of-a-pixel">size of a pixel</a> (length unit px).</dd>
</dl>
</div>
<div class="section" id="error-illegal-unit-px">
<h3><a class="toc-backref" href="#id97">7.1.7 Error <tt class="docutils literal">illegal unit px</tt></a></h3>
<p>If you convert the LaTeX source with a legacy program, you might get this
error.</p>
<p>The unit "px" was introduced by the <span class="incremental">pdfTeX</span> converter on 2005-02-04.
<span class="incremental">pdfTeX</span> is used also for conversion into DVI format in all modern LaTeX
distributions (since ca. 2006).</p>
<p>If updating LaTeX is not an option, just remove the "px" from the length
specification. HTML/CSS will default to "px" while the <span class="incremental">latexe2</span> writer
will add the fallback unit "bp".</p>
</div>
<div class="section" id="error-symbol-textcurrency-not-provided">
<h3><a class="toc-backref" href="#id98">7.1.8 Error <tt class="docutils literal">Symbol \textcurrency not provided</tt> ...</a></h3>
<p>The currency sign (\u00a4) is not supported by all fonts (some have
an Euro sign at its place). You might see an error like:</p>
<pre class="literal-block">
! Package textcomp Error: Symbol \textcurrency not provided by
(textcomp) font family ptm in TS1 encoding.
(textcomp) Default family used instead.
</pre>
<p>(which in case of font family "ptm" is a false positive). Add either</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">warn:</th><td class="field-body">turn the error in a warning, use the default symbol (bitmap), or</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">force,almostfull:</th></tr>
<tr class="field"><td> </td><td class="field-body">use the symbol provided by the font at the users
risk,</td>
</tr>
</tbody>
</table>
<p>to the document options or use a different font package.</p>
</div>
<div class="section" id="search-and-text-extraction">
<h3><a class="toc-backref" href="#id99">7.1.9 Search and text extraction</a></h3>
<p>Search for text that contains characters outside the ASCII range (e.g.
umlauts) might fail. See <a class="reference internal" href="#font">font</a> and <a class="reference internal" href="#font-encoding">font encoding</a> (as well as
<a class="reference external" href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=srchpdf">Searching PDF files</a> for background information).</p>
</div>
<div class="section" id="unicode-box-drawing-and-block-characters">
<h3><a class="toc-backref" href="#id100">7.1.10 Unicode box drawing and block characters</a></h3>
<p>The easiest solution is to use <a class="reference internal" href="#xelatex">xelatex</a> for <a class="reference internal" href="#pdf-generation">PDF generation</a>.</p>
<p>With "traditional" TeX engines (e.g. <a class="reference internal" href="#pdflatex">pdflatex</a>):</p>
<ul class="simple">
<li>Generate LaTeX code with <a class="reference external" href="config.html#output-encoding">output-encoding</a> "utf-8".</li>
<li>Add the <a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/pmboxdraw.html">pmboxdraw</a> package to the <a class="reference internal" href="#style-sheets">style sheets</a>.
(For shaded boxes also add the <span class="incremental">color</span> package.)</li>
</ul>
<p>Unfortunately, this defines only a subset of the characters
(see <a class="reference external" href="http://mirror.ctan.org/macros/latex/contrib/oberdiek/pmboxdraw.pdf">pmboxdraw.pdf</a> for a list).</p>
</div>
</div>
<div class="section" id="bugs-and-open-issues">
<h2><a class="toc-backref" href="#id101">7.2 Bugs and open issues</a></h2>
<p>Open to be fixed or open to discussion.</p>
<p>See also the entries in the <a class="reference external" href="../dev/todo.html#latex-writer">Docutils TODO list</a>,
the <a class="reference external" href="../../BUGS.html">BUGS</a> documentation and the <a class="reference external" href="http://sourceforge.net/tracker/?group_id=38414&atid=422030">SourceForge Bug Tracker</a>.</p>
<div class="section" id="footnotes-and-citations">
<h3><a class="toc-backref" href="#id102">7.2.1 Footnotes and citations</a></h3>
<p>Initially both were implemented using figure floats, because hyperlinking
back and forth seemed to be impossible. Later the <span class="incremental">figure</span> directive was
added that puts images into figure floats.</p>
<p>This results in footnotes, citations, and figures possibly being mixed at
page foot.</p>
<dl class="docutils">
<dt>Workaround:</dt>
<dd>Select footnote and citation handling with the <a class="reference external" href="config.html#docutils-footnotes">docutils-footnotes</a> and
<a class="reference external" href="config.html#use-latex-citations">use-latex-citations</a> options.</dd>
</dl>
<p>If <tt class="docutils literal"><span class="pre">use-latex-citations</span></tt> is used, a bibliography is inserted right at
the end of the document. <em>This should be customizable</em>.</p>
<p>If <tt class="docutils literal"><span class="pre">use-latex-citations</span></tt> is used adjacent citation references (separated
only by a single space or a newline) are combined to a single citation
group, i.e. <tt class="docutils literal">[cite1]_ [cite2]_</tt> results in <tt class="docutils literal">\cite{cite1,cite2}</tt>.
The appearance in the output can be configured in a <a class="reference internal" href="#style-sheet">style sheet</a>.</p>
</div>
<div class="section" id="tables">
<h3><a class="toc-backref" href="#id103">7.2.2 Tables</a></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">Tablewidth:</th><td class="field-body"><p class="first">reST-documents line length is assumed to be 80 characters. The
tablewidth is set relative to this value. If someone produces
documents with line length of 132 this will fail.</p>
<p class="last">Table width is tried to fit in page even if it is wider than
the assumed linewidth, still assumed linewidth is a hook.</p>
</td>
</tr>
</tbody>
</table>
<ul class="simple">
<li>Table: multicol cells are always left aligned.</li>
<li>The contents of a rowspan cell do not influence table height.
(multirow "feature", use a phantom or strut?)</li>
<li>Multirow cells might mix up the following table rows.</li>
<li>Table cells with both multirow and multicolumn are currently not possible.</li>
<li>literal-blocks in table cells:<ul>
<li>If verbatim or flushleft is used one gets vertical space above and below.</li>
<li>This is bad for the topmost paragraph in a cell, therefore the writer
uses raggedright.</li>
<li>Ragged right fails on followup paragraphs as the vertical space would be
missing.</li>
</ul>
</li>
<li><tt class="docutils literal"><span class="pre">--table-style=booktabs</span></tt>, <tt class="docutils literal">..class:: booktab</tt>: <span class="incremental">booktabs</span> version
1.00 does not work with <span class="incremental">longtable</span>. This is solved in newer versions
(current is 2005/04/14 v1.61803).</li>
</ul>
</div>
<div class="section" id="id35">
<h3><a class="toc-backref" href="#id104">7.2.3 Figures</a></h3>
<ul class="simple">
<li>Figures are always as wide as the containing text. The "figwidth" argument
is currently not supported. As a consequence, the "align" argument has no
effect.</li>
<li>Wrapping text around figures is currently not supported. (Requires the
<a class="reference external" href="http://mirror.ctan.org/help/Catalogue/entries/wrapfig.html">wrapfig</a> package.)</li>
</ul>
</div>
<div class="section" id="miscellaneous">
<h3><a class="toc-backref" href="#id105">7.2.4 Miscellaneous</a></h3>
<ul class="simple">
<li>Pdfbookmark level 4 (and greater) does not work (might be settable but
complicated).</li>
<li>Hyperlinks are not hyphenated; this leads to bad spacing. See
docs/user/rst/demo.txt 2.14 directives.</li>
<li>Pagestyle headings does not work, when sections are starred. Use LaTeX for
the section numbering with the <a class="reference internal" href="#options">options</a> <tt class="docutils literal"><span class="pre">--no-section-numbers</span></tt>
(command line) or <tt class="docutils literal">sectnum_xform: False</tt> (config file).</li>
</ul>
</div>
</div>
</div>
</div>
</body>
</html>
|