1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554
|
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY tex "TeX">
<!ENTITY latex "LaTeX">
]>
<book id="latex2e.dbk" lang="en">
<title>&latex;2e reference manual (September 2009)</title>
<!-- %**end of header (This is for running Texinfo on a region.) -->
<!-- xx merge http://ctan.org/tex-archive/info/latex-info/ -->
<!-- xx check http://ctan.org/tex-archive/info/latexcheat -->
<!-- xx latex 2.09 should be complete, but latex2e stuff is missing. -->
<!-- xx The typeset source2e will have an index with all kernel -->
<!-- xx commands, which would be a good start. classes.dtx et al. -->
<!-- xx define additional commands, and some of the kernel commands are -->
<!-- xx internal and so shouldn't be included here. -->
<bookinfo>
<legalnotice>
<para>This document is an unofficial reference manual for &latex;, a
document preparation system, version as of September 2009.</para>
<para>This was originally translated from <filename>LATEX.HLP</filename> v1.0a in the VMS
Help Library. The pre-translation version was written by
George D. Greenwade of Sam Houston State University. The
&latex; 2.09 version was written by Stephen Gilmore. The
&latex;2e version was adapted from this by Torsten Martinsen. Karl
Berry made further updates and additions, and gratefully acknowledges
using <citetitle>Hypertext Help with &latex;</citetitle>, by Sheldon Green, and the
<citetitle>&latex; Command Summary</citetitle> (for &latex; 2.09) by L. Botway
and C. Biemesderfer (published by the &tex; Users Group as
<citetitle>&tex;niques</citetitle> number 10), as reference material (text was not
directly copied).</para>
<para>Copyright © 2007, 2008, 2009 Karl Berry.
Copyright © 1988, 1994, 2007 Stephen Gilmore.
Copyright © 1994, 1995, 1996 Torsten Martinsen.</para>
<para>Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
are preserved on all copies.</para>
<para>Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the entire
resulting derived work is distributed under the terms of a permission
notice identical to this one.</para>
<para>Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions.</para>
</legalnotice>
</bookinfo>
<chapter label="" xreflabel="LaTeX2e" id="Top">
<title>&latex;2e</title>
<para>This document is an unofficial reference manual for &latex;, a
document preparation system, version as of September 2009. It is
intended to cover &latex;2e, which has been the standard version of
&latex; for many years.</para>
<para><indexterm role="cp"><primary>Knuth, Donald E.</primary></indexterm><indexterm role="cp"><primary>Lamport, Leslie</primary></indexterm><indexterm role="cp"><primary>&latex; Project team</primary></indexterm>&latex; is implemented as a macro package for Donald E. Knuth's
&tex; typesetting program. &latex; was originally created by Leslie
Lamport; it is now maintained by a group of volunteers
(<ulink url="http://latex-project.org">http://latex-project.org</ulink>). The official documentation written
by the &latex; project is available there. Again, the present
document is unofficial and has not been reviewed by the &latex;
maintainers.</para>
</chapter>
<chapter label="1" id="Overview">
<title>Overview of &latex;</title>
<para><indexterm role="cp"><primary>overview of &latex;</primary></indexterm><indexterm role="cp"><primary>&latex; overview</primary></indexterm>
The &latex; command typesets a file of text using the &tex; program
and the &latex; “macro package” for &tex;. To be more specific,
it processes an input file containing the text of a document with
interspersed commands that describe how the text should be formatted.
It produces at least three files as output:</para>
<orderedlist numeration="arabic">
<listitem>
<para>A main output file, which is one of:</para>
<orderedlist numeration="arabic">
<listitem>
<para>If invoked as <command>latex</command>, a “Device Independent” (<filename>.dvi</filename>)
file. This contains commands that can be translated into commands for
a variety of output devices. You can view such <filename>.dvi</filename> output of
&latex; by using a program such as <command>xdvi</command> (display directly)
or <command>dvips</command> (convert to PostScript).</para>
</listitem>
<listitem>
<para>If invoked as <command>pdflatex</command>, a “Portable Document Format”
(<filename>.pdf</filename>) file. Typically, this is a self-contained file, with
all fonts and images embedded. This can be very useful, but it does
make the output much larger than the <filename>.dvi</filename> produced from the
same document.</para>
</listitem>
</orderedlist>
<para>There are other less-common variants of &latex; (and &tex;) as well,
which can produce HTML, XML, and other things.</para>
</listitem>
<listitem>
<para>A “transcript” or <filename>.log</filename> file that contains summary information and
diagnostic messages for any errors discovered in the input file.</para>
</listitem>
<listitem>
<para>An “auxiliary” or <filename>.aux</filename> file. This is used by &latex; itself, for
things such as sectioning.</para>
</listitem>
</orderedlist>
<para>A &latex; command begins with the command name, which consists of a
<literal>\</literal> followed by either (a) a string of letters or (b) a
single non-letter. Arguments contained in square brackets, <literal>[]</literal>,
are optional while arguments contained in braces, <literal>{}</literal>, are
required.</para>
<para>&latex; is case sensitive. Enter all commands in lower case unless
explicitly directed to do otherwise.</para>
</chapter>
<chapter label="2" id="Starting-&-ending">
<title>Starting & ending</title>
<para><indexterm role="cp"><primary>starting & ending</primary></indexterm><indexterm role="cp"><primary>ending & starting</primary></indexterm>
A minimal input file looks like the following:</para>
<screen>
\documentclass{<replaceable>class</replaceable>}
\begin{document}
<replaceable>your text</replaceable>
\end{document}
</screen>
<para role="continues">where the <replaceable>class</replaceable> is a valid document class for &latex;.
See <xref linkend="Document-classes"></xref>, for details of the various document classes
available locally.</para>
<para><indexterm role="cp"><primary>preamble, defined</primary></indexterm>You may include other &latex; commands between the <literal>\documentclass</literal>
and the <literal>\begin{document}</literal> commands (this area is called the
<firstterm>preamble</firstterm>).</para>
</chapter>
<chapter label="3" id="Document-classes">
<title>Document classes</title>
<para><indexterm role="cp"><primary>document classes</primary></indexterm><indexterm role="cp"><primary>classes of documents</primary></indexterm><indexterm role="fn"><primary>\documentclass</primary></indexterm>
The class of a given document is defined with the command:</para>
<screen>
\documentclass[<replaceable>options</replaceable>]{<replaceable>class</replaceable>}
</screen>
<para role="continues">The <literal>\documentclass</literal> command must be the first command in a
&latex; source file.</para>
<para><indexterm role="fn"><primary>article class</primary></indexterm><indexterm role="fn"><primary>report class</primary></indexterm><indexterm role="fn"><primary>book class</primary></indexterm><indexterm role="fn"><primary>letter class</primary></indexterm><indexterm role="fn"><primary>slides class</primary></indexterm>Built-in &latex; document <replaceable>class</replaceable> names are (many other document
classes are available as add-ons; see <xref linkend="Overview"></xref>):</para>
<screen>
article report book letter slides
</screen>
<!-- xx briefly describe each one -->
<para>Standard <replaceable>options</replaceable> are described below.</para>
<sect1 label="3.1" id="Document-class-options">
<title>Document class options</title>
<para><indexterm role="cp"><primary>document class options</primary></indexterm><indexterm role="cp"><primary>options, document class</primary></indexterm><indexterm role="cp"><primary>class options</primary></indexterm><indexterm role="cp"><primary>global options</primary></indexterm>
You can specify so-called <firstterm>global options</firstterm> or <firstterm>class options</firstterm>
to the <literal>\documentclass</literal> command by enclosing them in square
brackets as usual. To specify more than one <replaceable>option</replaceable>, separate
them with a comma:</para>
<screen>
\documentclass[<replaceable>option1</replaceable>,<replaceable>option2</replaceable>,...]{<replaceable>class</replaceable>}
</screen>
<para>Here is the list of the standard class options.</para>
<para><indexterm role="fn"><primary>10pt option</primary></indexterm><indexterm role="fn"><primary>11pt option</primary></indexterm><indexterm role="fn"><primary>12pt option</primary></indexterm>All of the standard classes except <literal>slides</literal> accept the following
options for selecting the typeface size (default is <literal>10pt</literal>):</para>
<screen>
10pt 11pt 12pt
</screen>
<para><indexterm role="fn"><primary>a4paper option</primary></indexterm><indexterm role="fn"><primary>a5paper option</primary></indexterm><indexterm role="fn"><primary>b5paper option</primary></indexterm><indexterm role="fn"><primary>executivepaper option</primary></indexterm><indexterm role="fn"><primary>legalpaper option</primary></indexterm><indexterm role="fn"><primary>letterpaper option</primary></indexterm>All of the standard classes accept these options for selecting the paper
size (default is <literal>letterpaper</literal>):</para>
<screen>
a4paper a5paper b5paper executivepaper legalpaper letterpaper
</screen>
<para><indexterm role="fn"><primary>draft option</primary></indexterm><indexterm role="fn"><primary>final option</primary></indexterm><indexterm role="fn"><primary>fleqn option</primary></indexterm><indexterm role="fn"><primary>landscape option</primary></indexterm><indexterm role="fn"><primary>leqno option</primary></indexterm><indexterm role="fn"><primary>openbib option</primary></indexterm><indexterm role="fn"><primary>titlepage option</primary></indexterm><indexterm role="fn"><primary>notitlepage option</primary></indexterm>Miscellaneous other options:</para>
<variablelist>
<varlistentry>
<term><literal>draft, final</literal></term>
<listitem>
<para><indexterm role="cp"><primary>black boxes, omitting</primary></indexterm>mark/do not mark overfull boxes with a big black box; default is <literal>final</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>fleqn</literal></term>
<listitem>
<para>Put displayed formulas flush left; default is centered.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>landscape</literal></term>
<listitem>
<para>Selects landscape format; default is portrait.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>leqno</literal></term>
<listitem>
<para>Put equation numbers on the left side of equations; default is the right side.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>openbib</literal></term>
<listitem>
<para>Use “open” bibliography format.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>titlepage, notitlepage</literal></term>
<listitem>
<para>Specifies whether the title page is separate; default depends on the class.</para>
</listitem>
</varlistentry>
</variablelist>
<para>These options are not available with the slides class:</para>
<para><indexterm role="fn"><primary>onecolumn option</primary></indexterm><indexterm role="fn"><primary>twocolumn option</primary></indexterm><indexterm role="fn"><primary>oneside option</primary></indexterm><indexterm role="fn"><primary>twoside option</primary></indexterm><indexterm role="fn"><primary>openright option</primary></indexterm><indexterm role="fn"><primary>openany option</primary></indexterm></para>
<variablelist>
<varlistentry>
<term><literal>onecolumn</literal></term>
<term><literal>twocolumn</literal></term>
<listitem>
<para>Typeset in one or two columns; default is <literal>onecolumn</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>oneside</literal></term>
<term><literal>twoside</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\evensidemargin</primary></indexterm><indexterm role="fn"><primary>\oddsidemargin</primary></indexterm>Selects one- or two-sided layout; default is <literal>oneside</literal>, except
for the <literal>book</literal> class.</para>
<para>The <literal>\evensidemargin</literal> (<literal>\oddsidemargin</literal> parameter determines
the distance on even (odd) numbered pages between the left side of the
page and the text's left margin. The defaults vary with the paper
size and whether one- or two-side layout is selected. For one-sided
printing the text is centered, for two-sided, <literal>\oddsidemargin</literal> is
40% of the difference between <literal>\paperwidth</literal> and <literal>\textwidth</literal>
with <literal>\evensidemargin</literal> the remainder.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>openright</literal></term>
<term><literal>openany</literal></term>
<listitem>
<para>Determines if a chapter should start on a
right-hand page; default is <literal>openright</literal> for book.</para>
</listitem>
</varlistentry>
</variablelist>
<para>The <literal>slides</literal> class offers the option <literal>clock</literal> for printing
the time at the bottom of each note.</para>
<para><indexterm role="cp"><primary>packages, loading</primary></indexterm><indexterm role="cp"><primary>loading additional packages</primary></indexterm><indexterm role="fn"><primary>\usepackage</primary></indexterm>Additional packages are loaded like this:</para>
<screen>
\usepackage[<replaceable>options</replaceable>]{<replaceable>pkg</replaceable>}
</screen>
<para>To specify more than one <replaceable>pkg</replaceable>, you can separate them with a
comma, or use multiple <literal>\usepackage</literal> commands.</para>
<para><indexterm role="cp"><primary>global options</primary></indexterm><indexterm role="cp"><primary>options, global</primary></indexterm>Any options given in the <literal>\documentclass</literal> command that are unknown
by the selected document class are passed on to the packages loaded with
<literal>\usepackage</literal>.</para>
</sect1>
</chapter>
<chapter label="4" id="Typefaces">
<title>Typefaces</title>
<para><indexterm role="cp"><primary>typefaces</primary></indexterm><indexterm role="cp"><primary>fonts</primary></indexterm>
Two important aspects of selecting a <firstterm>font</firstterm> are specifying a size
and a style. The &latex; commands for doing this are described here.</para>
<sect1 label="4.1" id="Font-styles">
<title>Font styles</title>
<para><indexterm role="cp"><primary>font styles</primary></indexterm><indexterm role="cp"><primary>typeface styles</primary></indexterm><indexterm role="cp"><primary>styles of text</primary></indexterm>
The following type style commands are supported by &latex;.</para>
<para>These commands are used like <literal>\textit{italic text}</literal>. The
corresponding command in parenthesis is the “declaration form”, which
takes no arguments. The scope of the declaration form lasts until the
next type style command or the end of the current group.</para>
<para>The declaration forms are cumulative; i.e., you can say either
<literal>\sffamily\bfseries</literal> or <literal>\bfseries\sffamily</literal> to get bold
sans serif.</para>
<para>You can also use the environment form of the declaration forms; for instance,
<literal>\begin{ttfamily}...\end{ttfamily}</literal>.</para>
<variablelist>
<varlistentry>
<term><literal>\textrm (\rmfamily)</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\textrm</primary></indexterm><indexterm role="fn"><primary>\rmfamily</primary></indexterm>Roman.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\textit (\itshape)</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\textit</primary></indexterm><indexterm role="fn"><primary>\itshape</primary></indexterm>Italics.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\emph</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\emph</primary></indexterm><indexterm role="cp"><primary>emphasis</primary></indexterm>Emphasis (switches between <literal>\textit</literal> and <literal>\textrm</literal>).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\textmd (\mdseries)</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\textmd</primary></indexterm><indexterm role="fn"><primary>\mdseries</primary></indexterm>Medium weight (default).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\textbf (\bfseries)</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\textbf</primary></indexterm><indexterm role="fn"><primary>\bfseries</primary></indexterm>Boldface.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\textup (\upshape)</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\textup</primary></indexterm><indexterm role="fn"><primary>\upshape</primary></indexterm>Upright (default). The opposite of slanted.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\textsl (\slshape)</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\textsl</primary></indexterm><indexterm role="fn"><primary>\slshape</primary></indexterm>Slanted.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\textsf (\sffamily)</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\textsf</primary></indexterm><indexterm role="fn"><primary>\sffamily</primary></indexterm>Sans serif.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\textsc (\scshape)</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\textsc</primary></indexterm><indexterm role="fn"><primary>\scshape</primary></indexterm>Small caps.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\texttt (\ttfamily)</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\texttt</primary></indexterm><indexterm role="fn"><primary>\ttfamily</primary></indexterm>Typewriter.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\textnormal (\normalfont)</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\textnormal</primary></indexterm><indexterm role="fn"><primary>\normalfont</primary></indexterm>Main document font.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\mathrm</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\mathrm</primary></indexterm>Roman, for use in math mode.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\mathbf</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\mathbf</primary></indexterm>Boldface, for use in math mode.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\mathsf</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\mathsf</primary></indexterm>Sans serif, for use in math mode.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\mathtt</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\mathtt</primary></indexterm>Typewriter, for use in math mode.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\mathit</literal></term>
<term><literal>(\mit)</literal></term>
<listitem>
<para>Italics, for use in math mode.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\mathnormal</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\mathnormal</primary></indexterm>For use in math mode, e.g. inside another type style declaration.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\mathcal</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\mathcal</primary></indexterm>`Calligraphic' letters, for use in math mode.</para>
</listitem>
</varlistentry>
</variablelist>
<para>In addition, the command
<literal>\mathversion{bold}</literal>
<indexterm role="fn"><primary>\mathversion</primary></indexterm>can be used for switching to bold letters and symbols in
formulas. <literal>\mathversion{normal}</literal> restores the default.</para>
<para>&latex; also provides these commands, which unconditionally switch to
the given style, that is, are <emphasis>not</emphasis> cumulative. They are used
differently than the above commands, too: <literal>{\<replaceable>cmd</replaceable> ...}</literal>
instead of <literal>\<replaceable>cmd</replaceable>{...}</literal>. These are two very different
things.</para>
<variablelist>
<varlistentry>
<term><literal>\bf</literal></term>
<listitem>
<para><indexterm role="cp"><primary>bold font</primary></indexterm>Switch to <emphasis role="bold">bold face</emphasis>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\cal</literal></term>
<listitem>
<para><indexterm role="cp"><primary>script letters for math</primary></indexterm><indexterm role="cp"><primary>calligraphic letters for math</primary></indexterm>Switch to calligraphic letters for math.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\em</literal></term>
<listitem>
<para><indexterm role="cp"><primary>emphasis</primary></indexterm>Emphasis (italics within roman, roman within italics).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\it</literal></term>
<listitem>
<para><indexterm role="cp"><primary>italic font</primary></indexterm>Italics.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\rm</literal></term>
<listitem>
<para><indexterm role="cp"><primary>roman font</primary></indexterm>Roman.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\sc</literal></term>
<listitem>
<para><indexterm role="cp"><primary>small caps font</primary></indexterm>Small caps.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\sf</literal></term>
<listitem>
<para><indexterm role="cp"><primary>sans serif font</primary></indexterm>Sans serif.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\sl</literal></term>
<listitem>
<para><indexterm role="cp"><primary>slanted font</primary></indexterm><indexterm role="cp"><primary>oblique font</primary></indexterm>Slanted (oblique).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\tt</literal></term>
<listitem>
<para><indexterm role="cp"><primary>typewriter font</primary></indexterm><indexterm role="cp"><primary>monospace font</primary></indexterm><indexterm role="cp"><primary>fixed-width font</primary></indexterm>Typewriter (monospace, fixed-width).</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 label="4.2" id="Font-sizes">
<title>Font sizes</title>
<para><indexterm role="cp"><primary>font sizes</primary></indexterm><indexterm role="cp"><primary>typeface sizes</primary></indexterm><indexterm role="cp"><primary>sizes of text</primary></indexterm>
The following standard type size commands are supported by &latex;.
The table shows the command name and the corresponding actual font
size used (in points) with the ‘<literal>10pt</literal>’, ‘<literal>11pt</literal>’, and
‘<literal>12pt</literal>’ document size options, respectively (see <xref linkend="Document-class-options"></xref>).</para>
<para><indexterm role="fn"><primary>\tiny</primary></indexterm><indexterm role="fn"><primary>\scriptsize</primary></indexterm><indexterm role="fn"><primary>\footnotesize</primary></indexterm><indexterm role="fn"><primary>\small</primary></indexterm><indexterm role="fn"><primary>\normalsize</primary></indexterm><indexterm role="fn"><primary>\large</primary></indexterm><indexterm role="fn"><primary>\Large</primary></indexterm><indexterm role="fn"><primary>\LARGE</primary></indexterm><indexterm role="fn"><primary>\huge</primary></indexterm><indexterm role="fn"><primary>\Huge</primary></indexterm></para>
<informaltable>
<tgroup cols="4">
<colspec colwidth="42*"></colspec>
<colspec colwidth="7*"></colspec>
<colspec colwidth="7*"></colspec>
<colspec colwidth="7*"></colspec>
<thead>
<row>
<entry>Command</entry>
<entry><literal>10pt</literal></entry>
<entry><literal>11pt</literal></entry>
<entry><literal>12pt</literal></entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>\tiny</literal></entry>
<entry>5</entry>
<entry>6</entry>
<entry>6</entry>
</row>
<row>
<entry><literal>\scriptsize</literal></entry>
<entry>7</entry>
<entry>8</entry>
<entry>8</entry>
</row>
<row>
<entry><literal>\footnotesize</literal></entry>
<entry>8</entry>
<entry>9</entry>
<entry>10</entry>
</row>
<row>
<entry><literal>\small</literal></entry>
<entry>9</entry>
<entry>10</entry>
<entry>10.95</entry>
</row>
<row>
<entry><literal>\normalsize</literal> (default)</entry>
<entry>10</entry>
<entry>10.95</entry>
<entry>12</entry>
</row>
<row>
<entry><literal>\large</literal></entry>
<entry>12</entry>
<entry>12</entry>
<entry>14.4</entry>
</row>
<row>
<entry><literal>\Large</literal></entry>
<entry>14.4</entry>
<entry>14.4</entry>
<entry>17.28</entry>
</row>
<row>
<entry><literal>\LARGE</literal></entry>
<entry>17.28</entry>
<entry>17.28</entry>
<entry>20.74</entry>
</row>
<row>
<entry><literal>\huge</literal></entry>
<entry>20.74</entry>
<entry>20.74</entry>
<entry>24.88</entry>
</row>
<row>
<entry><literal>\Huge</literal></entry>
<entry>24.88</entry>
<entry>24.88</entry>
<entry>24.88</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>The commands as listed here are “declaration forms”. The scope of
the declaration form lasts until the next type style command or the
end of the current group. You can also use the environment form of
these commands; for instance, <literal>\begin{tiny}...\end{tiny}</literal>.</para>
</sect1>
<sect1 label="4.3" id="Low-level-font-commands">
<title>Low-level font commands</title>
<para><indexterm role="cp"><primary>low-level font commands</primary></indexterm><indexterm role="cp"><primary>font commands, low-level</primary></indexterm>
These commands are primarily intended for writers of macros and
packages. The commands listed here are only a subset of the available
ones.</para>
<variablelist>
<varlistentry>
<term><literal>\fontencoding{enc}</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\fontencoding</primary></indexterm>Select font encoding. Valid encodings include <literal>OT1</literal> and <literal>T1</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\fontfamily{family}</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\fontfamily</primary></indexterm>Select font family. Valid families include:</para>
<itemizedlist mark="bullet">
<listitem>
<para><literal>cmr</literal> for Computer Modern Roman</para>
</listitem>
<listitem>
<para><literal>cmss</literal> for Computer Modern Sans Serif</para>
</listitem>
<listitem>
<para><literal>cmtt</literal> for Computer Modern Typewriter</para>
</listitem>
</itemizedlist>
<para>and numerous others.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\fontseries{series}</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\fontseries</primary></indexterm>Select font series. Valid series include:</para>
<itemizedlist mark="bullet">
<listitem>
<para><literal>m</literal> Medium (normal)</para>
</listitem>
<listitem>
<para><literal>b</literal> Bold</para>
</listitem>
<listitem>
<para><literal>c</literal> Condensed</para>
</listitem>
<listitem>
<para><literal>bc</literal> Bold condensed</para>
</listitem>
<listitem>
<para><literal>bx</literal> Bold extended</para>
</listitem>
</itemizedlist>
<para>and various other combinations.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\fontshape{shape}</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\fontshape</primary></indexterm>Select font shape. Valid shapes are:</para>
<itemizedlist mark="bullet">
<listitem>
<para><literal>n</literal> Upright (normal)</para>
</listitem>
<listitem>
<para><literal>it</literal> Italic</para>
</listitem>
<listitem>
<para><literal>sl</literal> Slanted (oblique)</para>
</listitem>
<listitem>
<para><literal>sc</literal> Small caps</para>
</listitem>
<listitem>
<para><literal>ui</literal> Upright italics</para>
</listitem>
<listitem>
<para><literal>ol</literal> Outline</para>
</listitem>
</itemizedlist>
<para>The two last shapes are not available for most font families.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\fontsize{size}{skip}</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\fontsize</primary></indexterm><indexterm role="fn"><primary>\baselineskip</primary></indexterm>Set font size. The first parameter is the font size to switch to and
the second is the line spacing to use; this is stored in a parameter
named <literal>\baselineskip</literal>. The unit of both parameters defaults to
pt. The default <literal>\baselineskip</literal> for the Computer Modern typeface
is 1.2 times the <literal>\fontsize</literal>.</para>
<para><indexterm role="fn"><primary>\baselinestretch</primary></indexterm><indexterm role="cp"><primary><literal>setspace</literal> package</primary></indexterm>The line spacing is also multiplied by the value of the
<literal>\baselinestretch</literal> parameter when the type size changes; the
default is 1. However, the best way to “double space” a document,
if you should be unlucky enough to have to produce such, is to use the
<literal>setspace</literal> package; see
<ulink url="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linespace">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=linespace</ulink>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\selectfont</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\selectfont</primary></indexterm>The changes made by calling the four font commands described above do
not come into effect until <literal>\selectfont</literal> is called.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\usefont{enc}{family}{series}{shape}</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\usefont</primary></indexterm>The same as invoking <literal>\fontencoding</literal>, <literal>\fontfamily</literal>,
<literal>\fontseries</literal> and <literal>\fontshape</literal> with the given parameters,
followed by <literal>\selectfont</literal>.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
</chapter>
<chapter label="5" id="Layout">
<title>Layout</title>
<para><indexterm role="cp"><primary>layout commands</primary></indexterm>
Miscellaneous commands for controlling the general layout of the page.</para>
<sect1 label="5.1" id="\onecolumn">
<title><literal>\onecolumn</literal></title>
<para><indexterm role="fn"><primary>\onecolumn</primary></indexterm><indexterm role="cp"><primary>one-column output</primary></indexterm>
The <literal>\onecolumn</literal> declaration starts a new page and produces
single-column output. This is the default.</para>
</sect1>
<sect1 label="5.2" id="\twocolumn">
<title><literal>\twocolumn</literal></title>
<para><indexterm role="fn"><primary>\twocolumn</primary></indexterm><indexterm role="cp"><primary>multicolumn text</primary></indexterm><indexterm role="cp"><primary>two-column output</primary></indexterm>
Synopsis:</para>
<screen>
\twocolumn[<replaceable>text1col</replaceable>]
</screen>
<para>The <literal>\twocolumn</literal> declaration starts a new page and produces
two-column output. If the optional <replaceable>text1col</replaceable> argument is present,
it is typeset in one-column mode before the two-column typesetting
starts.</para>
<para>These parameters control typesetting in two-column output:</para>
<variablelist>
<varlistentry>
<term><literal>\columnsep</literal></term>
<listitem>
<para>The distance between columns (35pt by default).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\columnseprule</literal></term>
<listitem>
<para>The width of the rule between columns; the default is 0pt, so there is no rule.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\columnwidth</literal></term>
<listitem>
<para>The width of the current column; this is equal to <literal>\textwidth</literal> in
single-column text.</para>
</listitem>
</varlistentry>
</variablelist>
<para>These parameters control float behavior in two-column output:</para>
<variablelist>
<varlistentry>
<term><literal>\dbltopfraction</literal></term>
<listitem>
<para>Maximum fraction at the top of a two-column page that may be occupied
by floats. Default ‘<literal>.7</literal>’, can be usefully redefined to (say)
‘<literal>.9</literal>’ to avoid going to float pages so soon.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\dblfloatpagefraction</literal></term>
<listitem>
<para>The minimum fraction of a float page that must be occupied by floats,
for a two-column float page. Default ‘<literal>.5</literal>’.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\dblfloatsep</literal></term>
<listitem>
<para>Distance between floats at the top or bottom of a two-column float
page. Default ‘<literal>12pt plus2pt minus2pt</literal>’ for ‘<literal>10pt</literal>’ and
‘<literal>11pt</literal>’ documents, ‘<literal>14pt plus2pt minus4pt</literal>’ for ‘<literal>12pt</literal>’.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\dbltextfloatsep</literal></term>
<listitem>
<para>Distance between a multi-column float at the top or bottom of a page
and the main text. Default ‘<literal>20pt plus2pt minus4pt</literal>’.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 label="5.3" id="\flushbottom">
<title><literal>\flushbottom</literal></title>
<para><indexterm role="fn"><primary>\flushbottom</primary></indexterm>
The <literal>\flushbottom</literal> declaration makes all text pages the same
height, adding extra vertical space where necessary to fill out the
page.</para>
<para>This is the default if <literal>twocolumn</literal> mode is selected
(see <xref linkend="Document-class-options"></xref>).</para>
</sect1>
<sect1 label="5.4" id="\raggedbottom">
<title><literal>\raggedbottom</literal></title>
<para><indexterm role="fn"><primary>\raggedbottom</primary></indexterm><indexterm role="cp"><primary>stretch, omitting vertical</primary></indexterm>
The <literal>\raggedbottom</literal> declaration makes all pages the natural
height of the material on that page. No rubber lengths will be
stretched.</para>
</sect1>
<sect1 label="5.5" id="Page-layout-parameters">
<title>Page layout parameters</title>
<para><indexterm role="cp"><primary>page layout parameters</primary></indexterm><indexterm role="cp"><primary>parameters, page layout</primary></indexterm><indexterm role="cp"><primary>layout, page parameters for</primary></indexterm><indexterm role="cp"><primary>header, parameters for</primary></indexterm><indexterm role="cp"><primary>footer, parameters for</primary></indexterm><indexterm role="cp"><primary>running header and footer</primary></indexterm></para>
<variablelist>
<varlistentry>
<term><literal>\headheight</literal></term>
<listitem>
<para>Height of the box that contains the running head. Default is
‘<literal>30pt</literal>’, except in the <literal>book</literal> class, where it varies with the
type size.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\headsep</literal></term>
<listitem>
<para>Vertical distance between the bottom of the header line and the top of
the main text. Default is ‘<literal>25pt</literal>’, except in the <literal>book</literal>
class, where it varies with the type size.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\footskip</literal></term>
<listitem>
<para>Distance from the baseline of the last line of text to the baseline of
the page footer. Default is ‘<literal>30pt</literal>’, except in the <literal>book</literal>
class, where it varies with the type size.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\linewidth</literal></term>
<listitem>
<para>Width of the current line; the default varies with the font size,
paper width, two-column mode, etc. For an <literal>article</literal> document in
‘<literal>10pt</literal>’, it's set to ‘<literal>345pt</literal>’; in two-column mode, that
becomes ‘<literal>229.5pt</literal>’.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\textheight</literal></term>
<listitem>
<para>The normal vertical height of the page body; the default varies with
the font size, document class, etc. For an <literal>article</literal> or
<literal>report</literal> document in ‘<literal>10pt</literal>’, it's set to
‘<literal>43\baselineskip</literal>’; for <literal>book</literal>, it's ‘<literal>41\baselineskip</literal>’.
For ‘<literal>11pt</literal>’, it's ‘<literal>38\baselineskip</literal>’ and for ‘<literal>12pt</literal>’,
‘<literal>36\baselineskip</literal>’.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\textwidth</literal></term>
<listitem>
<para>The normal horizontal width of the page body; the default varies as
usual. For an <literal>article</literal> or <literal>report</literal> document, it's
‘<literal>345pt</literal>’ at ‘<literal>10pt</literal>’, ‘<literal>360pt</literal>’ at ‘<literal>11pt</literal>’, and
‘<literal>390pt</literal>’ at ‘<literal>12pt</literal>’. For a <literal>book</literal> document, it's
‘<literal>4.5in</literal>’ at ‘<literal>10pt</literal>’, and ‘<literal>5in</literal>’ at ‘<literal>11pt</literal>’ or ‘<literal>12pt</literal>’.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\topmargin</literal></term>
<listitem>
<para>Space between the top of the &tex; page (one inch from the top of the
paper, by default) and the top of the header. The default is computed
based on many other parameters: <literal>\paperheight − 2in −
\headheight − \headsep − \textheight − \footskip</literal>, and
then divided by two.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\topskip</literal></term>
<listitem>
<para>Minimum distance between the top of the page body and the baseline of
the first line of text. For the standard clases, the default is the
same as the font size, e.g., ‘<literal>10pt</literal>’ at ‘<literal>10pt</literal>’.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
</chapter>
<chapter label="6" id="Sectioning">
<title>Sectioning</title>
<para><indexterm role="cp"><primary>sectioning</primary></indexterm>
Sectioning commands provide the means to structure your text into units:</para>
<variablelist>
<varlistentry>
<term><literal>\part</literal></term>
<term><literal>\chapter</literal></term>
<listitem>
<para>(report and book class only)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\section</literal></term>
<term><literal>\subsection</literal></term>
<term><literal>\subsubsection</literal></term>
<term><literal>\paragraph</literal></term>
<term><literal>\subparagraph</literal></term>
</varlistentry>
</variablelist>
<para>All sectioning commands take the same general form, e.g.,</para>
<screen>
\chapter[<replaceable>toctitle</replaceable>]{<replaceable>title</replaceable>}
</screen>
<para>In addition to providing the heading <replaceable>title</replaceable> in the main text, the
section title can appear in two other places:</para>
<orderedlist numeration="arabic">
<listitem>
<para>The table of contents.</para>
</listitem>
<listitem>
<para>The running head at the top of the page.</para>
</listitem>
</orderedlist>
<para>You may not want the same text in these places as in the main text.
To handle this, the sectioning commands have an optional argument
<replaceable>toctitle</replaceable> that, when given, specifies the text for these other
places.</para>
<para><indexterm role="cp"><primary>*-form of sectioning commands</primary></indexterm>Also, all sectioning commands have <literal>*</literal>-forms that print
<replaceable>title</replaceable> as usual, but do not include a number and do not make an
entry in the table of contents. For instance:</para>
<screen>
\section*{Preamble}
</screen>
<para><indexterm role="fn"><primary>\appendix</primary></indexterm><indexterm role="cp"><primary>appendix, creating</primary></indexterm>The <literal>\appendix</literal> command changes the way following sectional units
are numbered. The <literal>\appendix</literal> command itself generates no text
and does not affect the numbering of parts. The normal use of this
command is something like</para>
<screen>
\chapter{A Chapter}
…
\appendix
\chapter{The First Appendix}
</screen>
</chapter>
<chapter label="7" id="Cross-references">
<title>Cross references</title>
<para><indexterm role="cp"><primary>cross references</primary></indexterm>
One reason for numbering things like figures and equations is to refer
the reader to them, as in “See Figure 3 for more details.”</para>
<sect1 label="7.1" id="\label">
<title><literal>\label</literal></title>
<para><indexterm role="fn"><primary>\label</primary></indexterm>
Synopsis:</para>
<screen>
\label{<replaceable>key</replaceable>}
</screen>
<para>A <literal>\label</literal> command appearing in ordinary text assigns to
<replaceable>key</replaceable> the number of the current sectional unit; one appearing
inside a numbered environment assigns that number to <replaceable>key</replaceable>.</para>
<para>A <replaceable>key</replaceable> name can consist of any sequence of letters, digits, or
punctuation characters. Upper and lowercase letters are distinguished.</para>
<para>To avoid accidentally creating two labels with the same name, it is
common to use labels consisting of a prefix and a suffix separated by
a colon or period. Some conventionally-used prefixes:</para>
<variablelist>
<varlistentry>
<term><literal>ch</literal></term>
<listitem>
<para>for chapters</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>sec</literal></term>
<listitem>
<para>for lower-level sectioning commands</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>fig</literal></term>
<listitem>
<para>for figures</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>tab</literal></term>
<listitem>
<para>for tables</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>eq</literal></term>
<listitem>
<para>for equations</para>
</listitem>
</varlistentry>
</variablelist>
<para>Thus, a label for a figure would look like <literal>fig:snark</literal> or
<literal>fig.snark</literal>.</para>
</sect1>
<sect1 label="7.2" id="\pageref">
<title><literal>\pageref{<replaceable>key</replaceable>}</literal></title>
<para><indexterm role="fn"><primary>\pageref</primary></indexterm><indexterm role="cp"><primary>cross referencing with page number</primary></indexterm><indexterm role="cp"><primary>page number, cross referencing</primary></indexterm>
Synopsis:</para>
<screen>
\pageref{<replaceable>key</replaceable>}
</screen>
<para>The <literal>\pageref</literal>{<replaceable>key</replaceable>} command produces the page number of
the place in the text where the corresponding
<literal>\label</literal>{<replaceable>key</replaceable>} command appears.</para>
</sect1>
<sect1 label="7.3" id="\ref">
<title><literal>\ref{<replaceable>key</replaceable>}</literal></title>
<para><indexterm role="fn"><primary>\ref</primary></indexterm><indexterm role="cp"><primary>cross referencing, symbolic</primary></indexterm><indexterm role="cp"><primary>section number, cross referencing</primary></indexterm><indexterm role="cp"><primary>equation number, cross referencing</primary></indexterm><indexterm role="cp"><primary>figure number, cross referencing</primary></indexterm><indexterm role="cp"><primary>footnote number, cross referencing</primary></indexterm>
Synopsis:</para>
<screen>
\ref{<replaceable>key</replaceable>}
</screen>
<para>The <literal>\ref</literal> command produces the number of the sectional unit,
equation, footnote, figure, …, of the corresponding
<literal>\label</literal> command (see <xref linkend="\label"></xref>). It does not produce any text,
such as the word `Section' or `Figure', just the bare number itself.</para>
</sect1>
</chapter>
<chapter label="8" id="Environments">
<title>Environments</title>
<para><indexterm role="cp"><primary>environments</primary></indexterm>
<indexterm role="fn"><primary>\begin</primary></indexterm><indexterm role="fn"><primary>\end</primary></indexterm>
&latex; provides many environments for marking off certain text.
Each environment begins and ends in the same manner:</para>
<screen>
\begin{<replaceable>envname</replaceable>}
...
\end{<replaceable>envname</replaceable>}
</screen>
<sect1 label="8.1" id="abstract">
<title><literal>abstract</literal></title>
<para><indexterm role="fn"><primary>abstract environment</primary></indexterm><indexterm role="cp"><primary>abstracts</primary></indexterm>
Synopsis:</para>
<screen>
\begin{abstract}
...
\end{abstract}
</screen>
<para>Environment for producing an abstract, possibly of multiple paragraphs.</para>
</sect1>
<sect1 label="8.2" id="array">
<title><literal>array</literal></title>
<para><indexterm role="fn"><primary>array environment</primary></indexterm><indexterm role="cp"><primary>arrays, math</primary></indexterm>
Synopsis:</para>
<screen>
\begin{array}{<replaceable>template</replaceable>}
<replaceable>col1 text</replaceable>&<replaceable>col1 text</replaceable>&<replaceable>coln</replaceable>}\\
...
\end{array}
</screen>
<para>Math arrays are produced with the <literal>array</literal> environment, normally
within an <literal>equation</literal> environment (see <xref linkend="equation"></xref>). It has a
single mandatory <replaceable>template</replaceable> argument describing the number of
columns and the alignment within them. Each column <replaceable>col</replaceable> is
specified by a single letter that tells how items in that row should
be formatted, as follows:</para>
<variablelist>
<varlistentry>
<term><literal>c</literal></term>
<listitem>
<para>centered</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>l</literal></term>
<listitem>
<para>flush left</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>r</literal></term>
<listitem>
<para>flush right</para>
</listitem>
</varlistentry>
</variablelist>
<para><indexterm role="fn"><primary>\\ (for <literal>array</literal>)</primary></indexterm>Column entries are separated by <literal>&</literal>. Column entries may include
other &latex; commands. Each row of the array is terminated with
<literal>\\</literal>.</para>
<para><indexterm role="fn"><primary>@{...}</primary></indexterm>In the template, the construct <literal>@{<replaceable>text</replaceable>}</literal> puts <replaceable>text</replaceable>
between columns in each row.</para>
<para>Here's an example:</para>
<screen>
\begin{equation}
\begin{array}{lrc}
left1 & right1 & centered1 \\
left2 & right2 & centered2 \\
\end{array}
\end{equation}
</screen>
<para><indexterm role="fn"><primary>\arraycolsep</primary></indexterm>The <literal>\arraycolsep</literal> parameter defines half the width of the space
separating columns; the default is ‘<literal>5pt</literal>’. See <xref linkend="tabular"></xref>, for other
parameters which affect formatting in <literal>array</literal> environments,
namely <literal>\arrayrulewidth</literal> and <literal>\arraystretch</literal>.</para>
<para>The <literal>array</literal> environment can only be used in math mode.</para>
</sect1>
<sect1 label="8.3" id="center">
<title><literal>center</literal></title>
<para><indexterm role="fn"><primary>center environment</primary></indexterm><indexterm role="cp"><primary>centering text, environment for</primary></indexterm>
Synopsis:</para>
<screen>
\begin{center}
<replaceable>line1</replaceable> \\
<replaceable>line2</replaceable> \\
\end{center}
</screen>
<para><indexterm role="fn"><primary>\\ (for <literal>center</literal>)</primary></indexterm>The <literal>center</literal> environment allows you to create a paragraph
consisting of lines that are centered within the left and right
margins on the current page. Each line is terminated with the
string <literal>\\</literal>.</para>
<sect2 label="8.3.1" id="\centering">
<title><literal>\centering</literal></title>
<para><indexterm role="fn"><primary>\centering</primary></indexterm><indexterm role="cp"><primary>centering text, declaration for</primary></indexterm>
The <literal>\centering</literal> declaration corresponds to the <literal>center</literal>
environment. This declaration can be used inside an environment such
as <literal>quote</literal> or in a <literal>parbox</literal>. Thus, the text of a figure or
table can be centered on the page by putting a <literal>\centering</literal>
command at the beginning of the figure or table environment.</para>
<para>Unlike the <literal>center</literal> environment, the <literal>\centering</literal> command
does not start a new paragraph; it simply changes how &latex; formats
paragraph units. To affect a paragraph unit's format, the scope of
the declaration must contain the blank line or <literal>\end</literal> command (of
an environment such as quote) that ends the paragraph unit.</para>
<para>Here's an example:</para>
<screen>
\begin{quote}
\centering
first line \\
second line \\
\end{quote}
</screen>
</sect2>
</sect1>
<sect1 label="8.4" id="description">
<title><literal>description</literal></title>
<para><indexterm role="fn"><primary>description environment</primary></indexterm><indexterm role="cp"><primary>labelled lists, creating</primary></indexterm><indexterm role="cp"><primary>description lists, creating</primary></indexterm>
Synopsis:</para>
<screen>
\begin{description}
\item [<replaceable>label1</replaceable>] <replaceable>item1</replaceable>
\item [<replaceable>label2</replaceable>] <replaceable>item2</replaceable>
...
\end{description}
</screen>
<para><indexterm role="fn"><primary>\item</primary></indexterm>The <literal>description</literal> environment is used to make labelled lists. Each
<replaceable>label</replaceable> is typeset in bold, flush right. The <replaceable>item</replaceable> text may
contain multiple paragraphs.</para>
<para><indexterm role="cp"><primary>bold typewriter, avoiding</primary></indexterm><indexterm role="cp"><primary>typewriter labels in lists</primary></indexterm>Another variation: since the bold style is applied to the labels, if
you typeset a label in typewriter using <literal>\texttt</literal>, you'll get
bold typewriter: <literal>\item[\texttt{bold and typewriter}]</literal>. This
may be too bold, among other issues. To get just typewriter, use
<literal>\tt</literal>, which resets all other style variations: <literal>\item[{\tt
plain typewriter}]</literal>.</para>
<para>For details about list spacing, see <xref linkend="itemize"></xref>.</para>
</sect1>
<sect1 label="8.5" id="displaymath">
<title><literal>displaymath</literal></title>
<para><indexterm role="fn"><primary>displaymath environment</primary></indexterm>
Synopsis:</para>
<screen>
\begin{displaymath}
<replaceable>math</replaceable>
\end{displaymath}
</screen>
<para role="continues">or</para>
<screen>
\[<replaceable>math</replaceable>\]
</screen>
<para>The <literal>displaymath</literal> environment (<literal>\[...\]</literal> is a synonym)
typesets the <replaceable>math</replaceable> text on its own line, centered by default.
The global <literal>fleqn</literal> option makes equations flush left; see
<xref linkend="Document-class-options"></xref>.</para>
<para>No equation number is added to <literal>displaymath</literal> text; to get an
equation number, use the <literal>equation</literal> environment (see <xref linkend="equation"></xref>).</para>
</sect1>
<sect1 label="8.6" id="document">
<title><literal>document</literal></title>
<para><indexterm role="fn"><primary>document environment</primary></indexterm>
The <literal>document</literal> environment encloses the body of a document.
It is required in every &latex; document. See <xref linkend="Starting-&-ending"></xref>.</para>
</sect1>
<sect1 label="8.7" id="enumerate">
<title><literal>enumerate</literal></title>
<para><indexterm role="fn"><primary>enumerate environment</primary></indexterm><indexterm role="cp"><primary>lists of items, numbered</primary></indexterm>
Synopsis:</para>
<screen>
\begin{enumerate}
\item <replaceable>item1</replaceable>
\item <replaceable>item2</replaceable>
...
\end{enumerate}
</screen>
<para>The <literal>enumerate</literal> environment produces a numbered list. Enumerations
can be nested within one another, up to four levels deep. They can also
be nested within other paragraph-making environments, such as
<literal>itemize</literal> (see <xref linkend="itemize"></xref>) and <literal>description</literal>
(see <xref linkend="description"></xref>).</para>
<para><indexterm role="fn"><primary>\item</primary></indexterm>Each item of an enumerated list begins with an <literal>\item</literal> command.
There must be at least one <literal>\item</literal> command within the environment.</para>
<para>By default, the numbering at each level is done like this:</para>
<orderedlist numeration="arabic">
<listitem>
<para>1., 2., …</para>
</listitem>
<listitem>
<para>(a), (b), …</para>
</listitem>
<listitem>
<para>i., ii., …</para>
</listitem>
<listitem>
<para>A., B., …</para>
</listitem>
</orderedlist>
<para><indexterm role="fn"><primary>\enumi</primary></indexterm><indexterm role="fn"><primary>\enumii</primary></indexterm><indexterm role="fn"><primary>\enumiii</primary></indexterm><indexterm role="fn"><primary>\enumiv</primary></indexterm>The <literal>enumerate</literal> environment uses the counters <literal>\enumi</literal>
through <literal>\enumiv</literal> counters (see <xref linkend="Counters"></xref>). If the optional
argument to <literal>\item</literal> is given, the counter is not incremented for
that item.</para>
<para><indexterm role="fn"><primary>\labelenumi</primary></indexterm><indexterm role="fn"><primary>\labelenumii</primary></indexterm><indexterm role="fn"><primary>\labelenumiii</primary></indexterm><indexterm role="fn"><primary>\labelenumiv</primary></indexterm>The <literal>enumerate</literal> environment uses the commands <literal>\labelenumi</literal>
through <literal>\labelenumiv</literal> to produce the default label. So, you can
use <literal>\renewcommand</literal> to change the labels (see <xref linkend="\newcommand-&-\renewcommand"></xref>). For instance, to have the first level use uppercase
letters:</para>
<para><indexterm role="fn"><primary>\Alph example</primary></indexterm></para>
<screen>
\renewcommand{\labelenumi}{\Alph{enumi}}
</screen>
</sect1>
<sect1 label="8.8" id="eqnarray">
<title><literal>eqnarray</literal></title>
<para><indexterm role="fn"><primary>eqnarray environment</primary></indexterm><indexterm role="cp"><primary>equations, aligning</primary></indexterm><indexterm role="cp"><primary>aligning Equations</primary></indexterm></para>
<screen>
\begin{eqnarray} <lineannotation>(or <literal>eqnarray*</literal>)</lineannotation>
<replaceable>formula1</replaceable> \\
<replaceable>formula2</replaceable> \\
...
\end{eqnarray}
</screen>
<para><indexterm role="fn"><primary>\\ (for <literal>eqnarray</literal>)</primary></indexterm>The <literal>eqnarray</literal> environment is used to display a sequence of
equations or inequalities. It is very much like a three-column
<literal>array</literal> environment, with consecutive rows separated by <literal>\\</literal>
and consecutive items within a row separated by an <literal>&</literal>.</para>
<para><indexterm role="fn"><primary>\\* (for <literal>eqnarray</literal>)</primary></indexterm><literal>\\*</literal> can also be used to separate equations, with its normal
meaning of not allowing a page break at that line.</para>
<para><indexterm role="fn"><primary>\nonumber</primary></indexterm><indexterm role="cp"><primary>equation numbers, omitting</primary></indexterm>An equation number is placed on every line unless that line has a
<literal>\nonumber</literal> command. Alternatively, The <literal>*</literal>-form of the
environment (<literal>\begin{eqnarray*} ... \end{eqnarray*}</literal>) will
omit equation numbering entirely, while otherwise being the same as
<literal>eqnarray</literal>.</para>
<para><indexterm role="fn"><primary>\lefteqn</primary></indexterm>The command <literal>\lefteqn</literal> is used for splitting long formulas across
lines. It typesets its argument in display style flush left in a box of
zero width.</para>
</sect1>
<sect1 label="8.9" id="equation">
<title><literal>equation</literal></title>
<para><indexterm role="fn"><primary>equation environment</primary></indexterm><indexterm role="cp"><primary>equations, environment for</primary></indexterm><indexterm role="cp"><primary>formulas, environment for</primary></indexterm>
Synopsis:</para>
<screen>
\begin{equation}
<replaceable>math</replaceable>
\end{equation}
</screen>
<para>The <literal>equation</literal> environment starts a <literal>displaymath</literal>
environment (see <xref linkend="displaymath"></xref>), e.g., centering the <replaceable>math</replaceable> text
on the page, and also places an equation number in the right margin.</para>
</sect1>
<sect1 label="8.10" id="figure">
<title><literal>figure</literal></title>
<para><indexterm role="fn"><primary>figure</primary></indexterm><indexterm role="cp"><primary>inserting figures</primary></indexterm><indexterm role="cp"><primary>figures, inserting</primary></indexterm></para>
<screen>
\begin{figure[*]}[<replaceable>placement</replaceable>]
<replaceable>figbody</replaceable>
\label{<replaceable>label}</replaceable>
\caption[<replaceable>loftitle</replaceable>]{<replaceable>text</replaceable>}
\end{figure}
</screen>
<para>Figures are objects that are not part of the normal text, and are
instead “floated” to a convenient place, such as the top of a page.
Figures will not be split between two pages.</para>
<para>When typesetting in double-columns, the starred form produces a
full-width figure (across both columns).</para>
<para>The optional argument <literal>[placement]</literal> determines where &latex; will try
to place your figure. There are four places where &latex; can possibly
put a float:</para>
<variablelist>
<varlistentry>
<term><literal>t</literal></term>
<listitem>
<para>(Top)—at the top of a text page.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>b</literal></term>
<listitem>
<para>(Bottom)—at the bottom of a text page. However, <literal>b</literal> is not
allowed for full-width floats (<literal>figure*</literal>) with double-column
output. To ameliorate this, use the <literal>stfloats</literal> or
<literal>dblfloatfix</literal> package, but see the discussion at caveats in the
FAQ: <ulink url="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfloat">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=2colfloat</ulink>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>h</literal></term>
<listitem>
<para><indexterm role="cp"><primary><literal>float</literal> package</primary></indexterm>(Here)—at the position in the text where the figure environment
appears. However, this is not allowed by itself, <literal>t</literal> is
automatically added. To absolutely force a figure to appear “here”,
use the <literal>float</literal> and use its <literal>H</literal> placement letter. (That
package also provides other options.)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>p</literal></term>
<listitem>
<para>(Page of floats)—on a separate float page, which is a page
containing no text, only floats.</para>
</listitem>
</varlistentry>
</variablelist>
<para>The standard report and article classes use the default placement
<literal>tbp</literal>.</para>
<para>The body of the figure is made up of whatever text, &latex; commands, etc.
you wish.</para>
<para><indexterm role="fn"><primary>\caption</primary></indexterm>The <literal>\caption</literal> command specifies caption <replaceable>text</replaceable> for the
figure. The caption is numbered by default. If <replaceable>loftitle</replaceable> is
present, it is used in the list of figures instead of <replaceable>text</replaceable>
(see <xref linkend="Tables-of-contents"></xref>).</para>
<!-- xx float-placement, float-caption sections? -->
<variablelist>
<title><indexterm role="fn"><primary>\bottomfraction</primary></indexterm>The maximum fraction of the page allowed to be occuped by floats atthe bottom; default ‘<literal>.3</literal>’.</title>
<varlistentry>
<term><literal>\floatpagefraction</literal></term>
<listitem>
<para>The minimum fraction of a float page that must be occupied by floats;
default ‘<literal>.5</literal>’.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\floatsep</literal></term>
<listitem>
<para>Space between floats at the top or bottom of a page; default
‘<literal>12pt plus2pt minus2pt</literal>’.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\intextsep</literal></term>
<listitem>
<para>Space above and below a float in the middle of the main text; default
‘<literal>12pt plus2pt minus2pt</literal>’ for ‘<literal>10pt</literal>’ and ‘<literal>11pt</literal>’ styles,
‘<literal>14pt plus4pt minus4pt</literal>’ for ‘<literal>12pt</literal>’.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\textfloatsep</literal></term>
<listitem>
<para>Space between the last (first) float at the top (bottom) of a page;
default ‘<literal>20pt plus2pt minus4pt</literal>’.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\textfraction</literal></term>
<listitem>
<para>Minimum fraction of a page that must be text; if floats take up too
much space to preserve this much text, floats will be moved to a
different page. The default is ‘<literal>.2</literal>’.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\topfraction</literal></term>
<listitem>
<para>Maximum fraction at the top of a page that may be occupied before
floats; default is ‘<literal>.7</literal>’.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 label="8.11" id="flushleft">
<title><literal>flushleft</literal></title>
<para><indexterm role="fn"><primary>flushleft environment</primary></indexterm><indexterm role="cp"><primary>left-justifying text, environment for</primary></indexterm><indexterm role="cp"><primary>ragged right text, environment for</primary></indexterm></para>
<screen>
\begin{flushleft}
<replaceable>line1</replaceable> \\
<replaceable>line2</replaceable> \\
...
\end{flushleft}
</screen>
<para><indexterm role="fn"><primary>\\ for <literal>flushleft</literal></primary></indexterm>The <literal>flushleft</literal> environment allows you to create a paragraph
consisting of lines that are flush to the left-hand margin and ragged
right Each line must be terminated with the string <literal>\\</literal>.</para>
<sect2 label="8.11.1" id="\raggedright">
<title><literal>\raggedright</literal></title>
<para><indexterm role="fn"><primary>\raggedright</primary></indexterm><indexterm role="cp"><primary>ragged right text</primary></indexterm><indexterm role="cp"><primary>left-justifying text</primary></indexterm><indexterm role="cp"><primary>justification, ragged right</primary></indexterm>
The <literal>\raggedright</literal> declaration corresponds to the
<literal>flushleft</literal> environment. This declaration can be used inside an
environment such as <literal>quote</literal> or in a <literal>parbox</literal>.</para>
<para>Unlike the <literal>flushleft</literal> environment, the <literal>\raggedright</literal>
command does not start a new paragraph; it only changes how &latex;
formats paragraph units. To affect a paragraph unit's format, the
scope of the declaration must contain the blank line or <literal>\end</literal>
command that ends the paragraph unit.</para>
</sect2>
</sect1>
<sect1 label="8.12" id="flushright">
<title><literal>flushright</literal></title>
<para><indexterm role="fn"><primary>flushright environment</primary></indexterm><indexterm role="cp"><primary>ragged left text, environment for</primary></indexterm><indexterm role="cp"><primary>right-justifying text, environment for</primary></indexterm></para>
<screen>
\begin{flushright}
<replaceable>line1</replaceable> \\
<replaceable>line2</replaceable> \\
...
\end{flushright}
</screen>
<para><indexterm role="fn"><primary>\\ (for <literal>flushright</literal>)</primary></indexterm>The <literal>flushright</literal> environment allows you to create a paragraph
consisting of lines that are flush to the right-hand margin and ragged
left. Each line must be terminated with the string <literal>\\</literal>.</para>
<sect2 label="8.12.1" id="\raggedleft">
<title><literal>\raggedleft</literal></title>
<para><indexterm role="fn"><primary>\raggedleft</primary></indexterm><indexterm role="cp"><primary>ragged left text</primary></indexterm><indexterm role="cp"><primary>justification, ragged left</primary></indexterm><indexterm role="cp"><primary>right-justifying text</primary></indexterm>
The <literal>\raggedleft</literal> declaration corresponds to the
<literal>flushright</literal> environment. This declaration can be used inside an
environment such as <literal>quote</literal> or in a <literal>parbox</literal>.</para>
<para>Unlike the <literal>flushright</literal> environment, the <literal>\raggedleft</literal>
command does not start a new paragraph; it only changes how &latex;
formats paragraph units. To affect a paragraph unit's format, the
scope of the declaration must contain the blank line or <literal>\end</literal>
command that ends the paragraph unit.</para>
</sect2>
</sect1>
<sect1 label="8.13" id="itemize">
<title><literal>itemize</literal></title>
<para><indexterm role="fn"><primary>itemize environment</primary></indexterm><indexterm role="fn"><primary>\item</primary></indexterm><indexterm role="cp"><primary>lists of items</primary></indexterm><indexterm role="cp"><primary>unordered lists</primary></indexterm><indexterm role="cp"><primary>bulleted lists</primary></indexterm>
Synopsis:</para>
<screen>
\begin{itemize}
\item <replaceable>item1</replaceable>
\item <replaceable>item2</replaceable>
...
\end{itemize}
</screen>
<para>The <literal>itemize</literal> environment produces an “unordered”, “bulleted”
list. Itemizations can be nested within one another, up to four
levels deep. They can also be nested within other paragraph-making
environments, such as <literal>enumerate</literal> (see <xref linkend="enumerate"></xref>).</para>
<para>Each item of an <literal>itemize</literal> list begins with an <literal>\item</literal> command.
There must be at least one <literal>\item</literal> command within the environment.</para>
<para>By default, the marks at each level look like this:</para>
<orderedlist numeration="arabic">
<listitem>
<para>• (bullet)</para>
</listitem>
<listitem>
<para><emphasis role="bold">--<!-- /@w --></emphasis> (bold en-dash)</para>
</listitem>
<listitem>
<para>* (asterisk)</para>
</listitem>
<listitem>
<para>. (centered dot, rendered here as a period)</para>
</listitem>
</orderedlist>
<para><indexterm role="fn"><primary>\labelitemi</primary></indexterm><indexterm role="fn"><primary>\labelitemii</primary></indexterm><indexterm role="fn"><primary>\labelitemiii</primary></indexterm><indexterm role="fn"><primary>\labelitemiv</primary></indexterm>The <literal>itemize</literal> environment uses the commands <literal>\labelitemi</literal>
through <literal>\labelitemiv</literal> to produce the default label. So, you can
use <literal>\renewcommand</literal> to change the labels. For instance, to have
the first level use diamonds:</para>
<screen>
\renewcommand{\labelitemi}{$\diamond$}
</screen>
<para><indexterm role="fn"><primary>\leftmargin</primary></indexterm><indexterm role="fn"><primary>\leftmargini</primary></indexterm><indexterm role="fn"><primary>\leftmarginii</primary></indexterm><indexterm role="fn"><primary>\leftmarginiii</primary></indexterm><indexterm role="fn"><primary>\leftmarginiv</primary></indexterm><indexterm role="fn"><primary>\leftmarginv</primary></indexterm><indexterm role="fn"><primary>\leftmarginvi</primary></indexterm>The <literal>\leftmargini</literal> through <literal>\leftmarginvi</literal> parameters define
the distance between the left margin of the enclosing environment and
the left margin of the list. By convention, <literal>\leftmargin</literal> is set
to the appropriate <literal>\leftmargin<replaceable>N</replaceable></literal> when a new level of
nesting is entered.</para>
<para>The defaults vary from ‘<literal>.5em</literal>’ (highest levels of nesting) to
‘<literal>2.5em</literal>’ (first level), and are a bit reduced in two-column mode.
This example greatly reduces the margin space for outermost lists:</para>
<screen>
\setlength{\leftmargini}{1.25em} % default 2.5em
</screen>
<!-- xx should be in its own generic section -->
<para>Some parameters that affect list formatting:</para>
<variablelist>
<varlistentry>
<term><literal>\itemindent</literal></term>
<listitem>
<para>Extra indentation before each item in a list; default zero.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\labelsep</literal></term>
<listitem>
<para>Space between the label and text of an item; default ‘<literal>.5em</literal>’.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\labelwidth</literal></term>
<listitem>
<para>Width of the label; default ‘<literal>2em</literal>’, or ‘<literal>1.5em</literal>’ in two-column mode.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\listparindent</literal></term>
<listitem>
<para>Extra indentation added to second and subsequent paragraphs within a
list item; default ‘<literal>0pt</literal>’.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\rightmargin</literal></term>
<listitem>
<para>Horizontal distance between the right margin of the list and the
enclosing environment; default ‘<literal>0pt</literal>’, except in the <literal>quote</literal>,
<literal>quotation</literal>, and <literal>verse</literal> environments, where it is set equal
to <literal>\leftmargin</literal>.</para>
</listitem>
</varlistentry>
</variablelist>
<para>Parameters affecting vertical spacing between list items (rather
loose, by default).</para>
<variablelist>
<varlistentry>
<term><literal>\itemsep</literal></term>
<listitem>
<para>Vertical space between items. The default is <literal>2pt plus1pt
minus1pt</literal> for <literal>10pt</literal> documents, <literal>3pt plus2pt minus1pt</literal> for
<literal>11pt</literal>, and <literal>4.5pt plus2pt minus1pt</literal> for <literal>12pt</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\parsep</literal></term>
<listitem>
<para>Extra vertical space between paragraphs within a list item. Defaults
are the same as <literal>\itemsep</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\topsep</literal></term>
<listitem>
<para>Vertical space between the first item and the preceding paragraph.
For top-level lists, the default is <literal>8pt plus2pt minus4pt</literal> for
<literal>10pt</literal> documents, <literal>9pt plus3pt minus5pt</literal> for <literal>11pt</literal>,
and <literal>10pt plus4pt minus6pt</literal> for <literal>12pt</literal>. These are reduced
for nested lists.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\partopsep</literal></term>
<listitem>
<para>Extra space added to <literal>\topsep</literal> when the list environment starts a
paragraph. The default is <literal>2pt plus1pt minus1pt</literal> for <literal>10pt</literal>
documents, <literal>3pt plus1pt minus1pt</literal> for <literal>11pt</literal>, and <literal>3pt
plus2pt minus2pt</literal> for <literal>12pt</literal>.</para>
</listitem>
</varlistentry>
</variablelist>
<para><indexterm role="fn"><primary>\parskip example</primary></indexterm>Especially for lists with short items, it may be desirable to elide
space between items. Here is an example defining an <literal>itemize*</literal>
environment with no extra spacing between items, or between paragraphs
within a single item (<literal>\parskip</literal> is not list-specific,
see <xref linkend="\parskip"></xref>):</para>
<screen>
\newenvironment{itemize*}%
{\begin{itemize}%
\setlength{\itemsep}{0pt}%
\setlength{\parsep}{0pt}}%
\setlength{\parskip}{0pt}}%
{\end{itemize}}
</screen>
</sect1>
<sect1 label="8.14" id="letter">
<title><literal>letter</literal> environment: writing letters</title>
<para><indexterm role="fn"><primary>letter</primary></indexterm>
This environment is used for creating letters. See <xref linkend="Letters"></xref>.</para>
</sect1>
<sect1 label="8.15" id="list">
<title><literal>list</literal></title>
<para><indexterm role="fn"><primary>list</primary></indexterm><indexterm role="cp"><primary>lists of items, generic</primary></indexterm>
The <literal>list</literal> environment is a generic environment which is used for
defining many of the more specific environments. It is seldom used in
documents, but often in macros.</para>
<screen>
\begin{list}{<replaceable>labeling</replaceable>}{<replaceable>spacing</replaceable>}
\item <replaceable>item1</replaceable>
\item <replaceable>item2</replaceable>
...
\end{list}
</screen>
<para>The mandatory <replaceable>labeling</replaceable> argument specifies how items should be
labelled (unless the optional argument is supplied to <literal>\item</literal>).
This argument is a piece of text that is inserted in a box to form the
label. It can and usually does contain other &latex; commands.</para>
<para>The mandatory <replaceable>spacing</replaceable> argument contains commands to change the
spacing parameters for the list. This argument will most often be
empty, i.e., <literal>{}</literal>, which leaves the default spacing.</para>
</sect1>
<sect1 label="8.16" id="math">
<title><literal>math</literal></title>
<para><indexterm role="fn"><primary>math environment</primary></indexterm><indexterm role="cp"><primary>in-line formulas</primary></indexterm>
Synopsis:</para>
<screen>
\begin{math}
<replaceable>math</replaceable>
\end{math}
</screen>
<para>The <literal>math</literal> environment inserts the given <replaceable>math</replaceable> within the
running text. <literal>\(...\))</literal> and <literal>$...$</literal> are synonyms.
See <xref linkend="Math-formulas"></xref>.</para>
</sect1>
<sect1 label="8.17" id="minipage">
<title><literal>minipage</literal></title>
<para><indexterm role="fn"><primary>minipage environment</primary></indexterm><indexterm role="cp"><primary>minipage, creating a</primary></indexterm></para>
<screen>
\begin{minipage}[<replaceable>position</replaceable>][<replaceable>height</replaceable>][<replaceable>inner-pos</replaceable>]{<replaceable>width</replaceable>}
<replaceable>text</replaceable>
\end{minipage}
</screen>
<para>The <literal>minipage</literal> environment typesets its body <replaceable>text</replaceable> in a
block that will not be broken across pages. This is similar to the
<literal>\parbox</literal> command (see <xref linkend="\parbox"></xref>), but unlike <literal>\parbox</literal>,
other paragraph-making environments can be used inside a minipage.</para>
<!-- (xxref positions) -->
<para>The arguments are the same as for <literal>\parbox</literal> (see <xref linkend="\parbox"></xref>).</para>
<para><indexterm role="cp"><primary>indentation of paragraphs, in minipage</primary></indexterm><indexterm role="cp"><primary>paragraph indentation, in minipage</primary></indexterm><indexterm role="fn"><primary>\parindent</primary></indexterm>By default, paragraphs are not indented in the <literal>minipage</literal>
environment. You can restore indentation with a command such as
<literal>\setlength{\parindent}{1pc}</literal> command.</para>
<para><indexterm role="cp"><primary>footnotes in figures</primary></indexterm><indexterm role="cp"><primary>figures, footnotes in</primary></indexterm>Footnotes in a <literal>minipage</literal> environment are handled in a way that is
particularly useful for putting footnotes in figures or tables. A
<literal>\footnote</literal> or <literal>\footnotetext</literal> command puts the footnote at
the bottom of the minipage instead of at the bottom of the page, and it
uses the <literal>\mpfootnote</literal> counter instead of the ordinary
<literal>footnote</literal> counter (see <xref linkend="Counters"></xref>).</para>
<para>However, don't put one minipage inside another if you are using
footnotes; they may wind up at the bottom of the wrong minipage.</para>
</sect1>
<sect1 label="8.18" id="picture">
<title><literal>picture</literal></title>
<para><indexterm role="fn"><primary>picture</primary></indexterm><indexterm role="cp"><primary>creating pictures</primary></indexterm><indexterm role="cp"><primary>pictures, creating</primary></indexterm></para>
<screen>
\begin{picture}(width,height)(x offset,y offset)
… <replaceable>picture commands</replaceable> …
\end{picture}
</screen>
<para><indexterm role="fn"><primary>\unitlength</primary></indexterm>The <literal>picture</literal> environment allows you to create just about any
kind of picture you want containing text, lines, arrows and circles.
You tell &latex; where to put things in the picture by specifying
their coordinates. A coordinate is a number that may have a decimal
point and a minus sign—a number like <literal>5</literal>, <literal>0.3</literal> or
<literal>-3.1416</literal>. A coordinate specifies a length in multiples of the
unit length <literal>\unitlength</literal>, so if <literal>\unitlength</literal> has been set
to <literal>1cm</literal>, then the coordinate 2.54 specifies a length of 2.54
centimeters. You should only change the value of <literal>\unitlength</literal>,
using the <literal>\setlength</literal> command, outside of a <literal>picture</literal>
environment.</para>
<para>A position is a pair of coordinates, such as <literal>(2.4,-5)</literal>, specifying
the point with x-coordinate <literal>2.4</literal> and y-coordinate <literal>-5</literal>.
Coordinates are specified in the usual way with respect to an origin,
which is normally at the lower-left corner of the picture. Note that
when a position appears as an argument, it is not enclosed in braces;
the parentheses serve to delimit the argument.</para>
<para>The <literal>picture</literal> environment has one mandatory argument, which is a
<literal>position</literal>. It specifies the size of the picture. The environment
produces a rectangular box with width and height determined by this
argument's x- and y-coordinates.</para>
<para>The <literal>picture</literal> environment also has an optional <literal>position</literal>
argument, following the <literal>size</literal> argument, that can change the
origin. (Unlike ordinary optional arguments, this argument is not
contained in square brackets.) The optional argument gives the
coordinates of the point at the lower-left corner of the picture
(thereby determining the origin). For example, if <literal>\unitlength</literal>
has been set to <literal>1mm</literal>, the command</para>
<screen>
\begin{picture}(100,200)(10,20)
</screen>
<para role="continues">produces a picture of width 100 millimeters and height 200
millimeters, whose lower-left corner is the point (10,20) and whose
upper-right corner is therefore the point (110,220). When you first
draw a picture, you typically omit the optional argument, leaving the
origin at the lower-left corner. If you then want to modify your
picture by shifting everything, you can just add the appropriate
optional argument.</para>
<para>The environment's mandatory argument determines the nominal size of the
picture. This need bear no relation to how large the picture really is;
&latex; will happily allow you to put things outside the picture, or even
off the page. The picture's nominal size is used by &latex; in determining
how much room to leave for it.</para>
<para>Everything that appears in a picture is drawn by the <literal>\put</literal>
command. The command</para>
<screen>
\put (11.3,-.3){...}
</screen>
<para role="continues">puts the object specified by <literal>...</literal> in the
picture, with its reference point at coordinates (11.3,-.3).
The reference points for various objects will be described below.</para>
<para><indexterm role="fn"><primary>lR box</primary></indexterm>The <literal>\put</literal> command creates an <firstterm>LR box</firstterm>. You can put anything
that can go in an <literal>\mbox</literal> (see <xref linkend="\mbox"></xref>) in the text argument of
the <literal>\put</literal> command. When you do this, the reference point will
be the lower left corner of the box.</para>
<para>The <literal>picture</literal> commands are described in the following sections.</para>
<sect2 label="8.18.1" id="\circle">
<title><literal>\circle</literal></title>
<para><indexterm role="fn"><primary>\circle</primary></indexterm></para>
<screen>
\circle[*]{<replaceable>diameter</replaceable>}
</screen>
<para>The <literal>\circle</literal> command produces a circle with a diameter as close
to the specified one as possible. The <literal>*</literal>-form of the command
draws a solid circle.</para>
<para>Circles up to 40 pt can be drawn.</para>
</sect2>
<sect2 label="8.18.2" id="\makebox-(picture)">
<title><literal>\makebox</literal></title>
<para><indexterm role="fn"><primary>\makebox (picture)</primary></indexterm>
<literal>\makebox(width,height)[position]{...}</literal></para>
<para>The <literal>\makebox</literal> command for the picture environment is similar to
the normal <literal>\makebox</literal> command except that you must specify a
<literal>width</literal> and <literal>height</literal> in multiples of <literal>\unitlength</literal>.</para>
<para>The optional argument, <literal>[position]</literal>, specifies the quadrant that
your text appears in. You may select up to two of the following:</para>
<variablelist>
<varlistentry>
<term><literal>t</literal></term>
<listitem>
<para>Moves the item to the top of the rectangle.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>b</literal></term>
<listitem>
<para>Moves the item to the bottom.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>l</literal></term>
<listitem>
<para>Moves the item to the left.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>r</literal></term>
<listitem>
<para>Moves the item to the right.</para>
</listitem>
</varlistentry>
</variablelist>
<para>See <xref linkend="\makebox"></xref>.</para>
</sect2>
<sect2 label="8.18.3" id="\framebox-(picture)">
<title><literal>\framebox</literal></title>
<para><indexterm role="fn"><primary>\framebox</primary></indexterm>
Synopsis:</para>
<screen>
\framebox(<replaceable>width</replaceable>,<replaceable>height</replaceable>)[<replaceable>pos</replaceable>]{...}
</screen>
<para>The <literal>\framebox</literal> command is like <literal>\makebox</literal> (see previous
section), except that it puts a frame around the outside of the box
that it creates.</para>
<para><indexterm role="fn"><primary>\fboxrule</primary></indexterm><indexterm role="fn"><primary>\fboxsep</primary></indexterm>The <literal>\framebox</literal> command produces a rule of thickness
<literal>\fboxrule</literal>, and leaves a space <literal>\fboxsep</literal> between the rule
and the contents of the box.</para>
</sect2>
<sect2 label="8.18.4" id="\dashbox">
<title><literal>\dashbox</literal></title>
<para><indexterm role="fn"><primary>\dashbox</primary></indexterm>
Draws a box with a dashed line. Synopsis:</para>
<screen>
\dashbox{<replaceable>dlen</replaceable>}(<replaceable>rwidth</replaceable>,<replaceable>rheight</replaceable>)[<replaceable>pos</replaceable>]{<replaceable>text</replaceable>}
</screen>
<para><literal>\dashbox</literal> creates a dashed rectangle around <replaceable>text</replaceable> in a
<literal>picture</literal> environment. Dashes are <replaceable>dlen</replaceable> units long, and the
rectangle has overall width <replaceable>rwidth</replaceable> and height <replaceable>rheight</replaceable>.
The <replaceable>text</replaceable> is positioned at optional <replaceable>pos</replaceable>.
<!-- xxref positions. -->
A dashed box looks best when the <literal>rwidth</literal> and <literal>rheight</literal> are
multiples of the <literal>dlen</literal>.</para>
</sect2>
<sect2 label="8.18.5" id="\frame">
<title><literal>\frame</literal></title>
<para><indexterm role="fn"><primary>\frame</primary></indexterm>
Synopsis:</para>
<screen>
\frame{<replaceable>text</replaceable>}
</screen>
<para>The <literal>\frame</literal> command puts a rectangular frame around <replaceable>text</replaceable>.
The reference point is the bottom left corner of the frame. No extra
space is put between the frame and the object.</para>
</sect2>
<sect2 label="8.18.6" id="\line">
<title><literal>\line</literal></title>
<para><indexterm role="fn"><primary>\line</primary></indexterm>
Synopsis:</para>
<screen>
\line(<replaceable>xslope</replaceable>,<replaceable>yslope</replaceable>){<replaceable>length</replaceable>}
</screen>
<para>The <literal>\line</literal> command draws a line with the given <replaceable>length</replaceable> and
slope <replaceable>xslope</replaceable>/<replaceable>yslope</replaceable>.</para>
<para>Standard &latex; can only draw lines with <replaceable>slope</replaceable> = x/y,
where x and y have integer values from −6
through 6. For lines of any slope, not to mention other shapes,
see the <literal>curve2e</literal> and many many other packages on CTAN.</para>
</sect2>
<sect2 label="8.18.7" id="\linethickness">
<title><literal>\linethickness</literal></title>
<para><indexterm role="fn"><primary>\linethickness</primary></indexterm>
The <literal>\linethickness{<replaceable>dim</replaceable>}</literal> command declares the thickness
of horizontal and vertical lines in a picture environment to be
<replaceable>dim</replaceable>, which must be a positive length.</para>
<para><literal>\linethickness</literal> does not affect the thickness of slanted lines,
circles, or the quarter circles drawn by <literal>\oval</literal>.</para>
</sect2>
<sect2 label="8.18.8" id="\thicklines">
<title><literal>\thicklines</literal></title>
<para><indexterm role="fn"><primary>\thicklines</primary></indexterm>
The <literal>\thicklines</literal> command is an alternate line thickness for
horizontal and vertical lines in a picture environment;
cf. <xref linkend="\linethickness"></xref> and <xref linkend="\thinlines"></xref>.</para>
</sect2>
<sect2 label="8.18.9" id="\thinlines">
<title><literal>\thinlines</literal></title>
<para><indexterm role="fn"><primary>\thinlines</primary></indexterm>
The <literal>\thinlines</literal> command is the default line thickness for
horizontal and vertical lines in a picture environment;
cf. <xref linkend="\linethickness"></xref> and <xref linkend="\thicklines"></xref>.</para>
</sect2>
<sect2 label="8.18.10" id="\multiput">
<title><literal>\multiput</literal></title>
<para><indexterm role="fn"><primary>\multiput</primary></indexterm>
Synopsis:</para>
<screen>
\multiput(<replaceable>x</replaceable>,<replaceable>y</replaceable>)(<replaceable>delta_x</replaceable>,<replaceable>delta_y</replaceable>){<replaceable>n</replaceable>}{<replaceable>obj</replaceable>}
</screen>
<para>The <literal>\multiput</literal> command copies the object <replaceable>obj</replaceable> in a regular
pattern across a picture. <replaceable>obj</replaceable> is first placed at position
(x,y), then at (x+\delta x,y+\delta y), and so on,
<replaceable>n</replaceable> times.</para>
</sect2>
<sect2 label="8.18.11" id="\oval">
<title><literal>\oval</literal></title>
<para><indexterm role="fn"><primary>\oval</primary></indexterm>
Synopsis:</para>
<screen>
\oval(<replaceable>width</replaceable>,<replaceable>height</replaceable>)[<replaceable>portion</replaceable>]
</screen>
<para>The <literal>\oval</literal> command produces a rectangle with rounded corners.
The optional argument <replaceable>portion</replaceable> allows you to select part of the
oval via the following:</para>
<variablelist>
<varlistentry>
<term><literal>t</literal></term>
<listitem>
<para>selects the top portion;</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>b</literal></term>
<listitem>
<para>selects the bottom portion;</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>r</literal></term>
<listitem>
<para>selects the right portion;</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>l</literal></term>
<listitem>
<para>selects the left portion.</para>
</listitem>
</varlistentry>
</variablelist>
<para>The “corners” of the oval are made with quarter circles with a
maximum radius of 20pt, so large “ovals” will look more like
boxes with rounded corners.</para>
</sect2>
<sect2 label="8.18.12" id="\put">
<title><literal>\put</literal></title>
<para><indexterm role="fn"><primary>\put</primary></indexterm>
<literal>\put(x coord,y coord){ ... }</literal></para>
<para>The <literal>\put</literal> command places the item specified by the mandatory
argument at the given coordinates.</para>
</sect2>
<sect2 label="8.18.13" id="\shortstack">
<title><literal>\shortstack</literal></title>
<para><indexterm role="fn"><primary>\shortstack</primary></indexterm>
Synopsis:</para>
<screen>
\shortstack[<replaceable>position</replaceable>]{...\\...\\...}
</screen>
<para>The <literal>\shortstack</literal> command produces a stack of objects. The valid
positions are:</para>
<variablelist>
<varlistentry>
<term><literal>r</literal></term>
<listitem>
<para>Move the objects to the right of the stack.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>l</literal></term>
<listitem>
<para>Move the objects to the left of the stack</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>c</literal></term>
<listitem>
<para>Move the objects to the centre of the stack (default)</para>
</listitem>
</varlistentry>
</variablelist>
<para><indexterm role="fn"><primary>\\ (for <literal>\shortstack</literal> objects)</primary></indexterm>Objects are separated with <literal>\\</literal>.</para>
</sect2>
<sect2 label="8.18.14" id="\vector">
<title><literal>\vector</literal></title>
<para><indexterm role="fn"><primary>\vector</primary></indexterm>
Synopsis:</para>
<screen>
\vector(<replaceable>x-slope</replaceable>,<replaceable>y-slope</replaceable>){<replaceable>length</replaceable>}
</screen>
<para>The <literal>\vector</literal> command draws a line with an arrow of the specified
length and slope. The x and y values must lie between
−4 and +4, inclusive.</para>
</sect2>
</sect1>
<sect1 label="8.19" id="quotation">
<title><literal>quotation</literal></title>
<para><indexterm role="fn"><primary>quotation</primary></indexterm><indexterm role="cp"><primary>quoted text with paragraph indentation, displaying</primary></indexterm><indexterm role="cp"><primary>displaying quoted text with paragraph indentation</primary></indexterm><indexterm role="cp"><primary>paragraph indentations in quoted text</primary></indexterm>
Synopsis:</para>
<screen>
\begin{quotation}
<replaceable>text</replaceable>
\end{quotation}
</screen>
<para>The margins of the <literal>quotation</literal> environment are indented on both
the left and the right. The text is justified at both margins.
Leaving a blank line between text produces a new paragraph.</para>
<para>Unlike the <literal>quote</literal> environment, each paragraph is indented
normally.</para>
</sect1>
<sect1 label="8.20" id="quote">
<title><literal>quote</literal></title>
<para><indexterm role="fn"><primary>quote</primary></indexterm><indexterm role="cp"><primary>quoted text without paragraph indentation, displaying</primary></indexterm><indexterm role="cp"><primary>displaying quoted text without paragraph indentation</primary></indexterm><indexterm role="cp"><primary>paragraph indentations in quoted text, omitting</primary></indexterm>
Snyopsis:</para>
<screen>
\begin{quote}
<replaceable>text</replaceable>
\end{quote}
</screen>
<para>The margins of the <literal>quote</literal> environment are indented on both the
left and the right. The text is justified at both margins. Leaving a
blank line between text produces a new paragraph.</para>
<para>Unlike the <literal>quotation</literal> environment, paragraphs are not indented.</para>
</sect1>
<sect1 label="8.21" id="tabbing">
<title><literal>tabbing</literal></title>
<para><indexterm role="fn"><primary>tabbing environment</primary></indexterm><indexterm role="cp"><primary>tab stops, using</primary></indexterm><indexterm role="cp"><primary>lining text up in columns using tab stops</primary></indexterm><indexterm role="cp"><primary>alignment via tabbing</primary></indexterm>
Synopsis:</para>
<screen>
\begin{tabbing}
<replaceable>row1col1</replaceable> \= <replaceable>row1col2</replaceable> \= <replaceable>row1col3</replaceable> \= <replaceable>row1col4</replaceable> \\
<replaceable>row2col1</replaceable> \> \> <replaceable>row2col3</replaceable> \\
...
\end{tabbing}
</screen>
<para>The <literal>tabbing</literal> environment provides a way to align text in
columns. It works by setting tab stops and tabbing to them much as
was done on an ordinary typewriter. It is best suited for cases where
the width of each column is constant and known in advance.</para>
<para>This environment can be broken across pages, unlike the <literal>tabular</literal>
environment.</para>
<para>The following commands can be used inside a <literal>tabbing</literal> enviroment:</para>
<variablelist>
<varlistentry>
<term><literal>\\ tabbing</literal></term>
<listitem>
<para>End a line.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\= (tabbing)</literal></term>
<listitem>
<para>Sets a tab stop at the current position.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\> (tabbing)</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\></primary></indexterm>Advances to the next tab stop.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\<</literal></term>
<listitem>
<para>Put following text to the left of the local margin (without changing
the margin). Can only be used at the start of the line.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\+</literal></term>
<listitem>
<para>Moves the left margin of the next and all the
following commands one tab stop to the right, beginning tabbed line if
necessary.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\-</literal></term>
<listitem>
<para>Moves the left margin of the next and all the
following commands one tab stop to the left, beginning tabbed line if
necessary.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\' (tabbing)</literal></term>
<listitem>
<para>Moves everything that you have typed so far in the
current column, i.e. everything from the most recent <literal>\></literal>,
<literal>\<</literal>, <literal>\'</literal>, <literal>\\</literal>, or <literal>\kill</literal> command, to the right
of the previous column, flush against the current column's tab stop.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\` (tabbing)</literal></term>
<listitem>
<para>Allows you to put text flush right against any tab stop, including tab
stop 0. However, it can't move text to the right of the last column
because there's no tab stop there. The <literal>\`</literal> command moves all the
text that follows it, up to the <literal>\\</literal> or <literal>\end{tabbing}</literal>
command that ends the line, to the right margin of the tabbing
environment. There must be no <literal>\></literal> or <literal>\'</literal> command between
the <literal>\`</literal> and the command that ends the line.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\a (tabbing)</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\a' (acute accent in tabbing)</primary></indexterm><indexterm role="fn"><primary>\a` (grave accent in tabbing)</primary></indexterm><indexterm role="fn"><primary>\a= (macron accent in tabbing)</primary></indexterm>In a <literal>tabbing</literal> environment, the commands <literal>\=</literal>, <literal>\'</literal> and
<literal>\`</literal> do not produce accents as usual (see <xref linkend="Accents"></xref>). Instead,
the commands <literal>\a=</literal>, <literal>\a'</literal> and <literal>\a`</literal> are used.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\kill</literal></term>
<listitem>
<para>Sets tab stops without producing text. Works just like <literal>\\</literal>
except that it throws away the current line instead of producing
output for it. The effect of any <literal>\=</literal>, <literal>\+</literal> or <literal>\-</literal>
commands in that line remain in effect.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\poptabs</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\poptabs</primary></indexterm>Restores the tab stop positions saved by the last <literal>\pushtabs</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\pushtabs</literal></term>
<listitem>
<para>Saves all current tab stop positions. Useful for temporarily changing
tab stop positions in the middle of a <literal>tabbing</literal> environment.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\tabbingsep</literal></term>
<listitem>
<para>Distance to left of tab stop moved by <literal>\'</literal>.</para>
</listitem>
</varlistentry>
</variablelist>
<para>This example typesets a Pascal function in a traditional format:</para>
<screen>
\begin{tabbing}
function \= fact(n : integer) : integer;\\
\> begin \= \+ \\
\> if \= n $>$ 1 then \+ \\
fact := n * fact(n-1) \- \\
else \+ \\
fact := 1; \-\- \\
end;\\
\end{tabbing}
</screen>
</sect1>
<sect1 label="8.22" id="table">
<title><literal>table</literal></title>
<para><indexterm role="fn"><primary>table</primary></indexterm><indexterm role="cp"><primary>tables, creating</primary></indexterm><indexterm role="cp"><primary>creating tables</primary></indexterm>
Synopsis:</para>
<screen>
\begin{table}[placement]
body of the table
\caption{table title}
\end{table}
</screen>
<para>Tables are objects that are not part of the normal text, and are
usually “floated” to a convenient place, like the top of a page.
Tables will not be split between two pages.</para>
<para>The optional argument <literal>[placement]</literal> determines where &latex; will try
to place your table. There are four places where &latex; can possibly put
a float; these are the same as that used with the <literal>figure</literal>
environment, and described there (see <xref linkend="figure"></xref>).</para>
<para>The standard <literal>report</literal> and <literal>article</literal> classes use the default
placement <literal>[tbp]</literal>.</para>
<para>The body of the table is made up of whatever text, &latex; commands, etc.,
you wish. The <literal>\caption</literal> command allows you to title your table.</para>
</sect1>
<sect1 label="8.23" id="tabular">
<title><literal>tabular</literal></title>
<para><indexterm role="fn"><primary>tabular environment</primary></indexterm><indexterm role="cp"><primary>lines in tables</primary></indexterm><indexterm role="cp"><primary>lining text up in tables</primary></indexterm>
Synopsis:</para>
<screen>
\begin{tabular}[pos]{cols}
column 1 entry & column 2 entry ... & column n entry \\
...
\end{tabular}
</screen>
<para>or</para>
<screen>
\begin{tabular*}{width}[pos]{cols}
column 1 entry & column 2 entry ... & column n entry \\
...
\end{tabular*}
</screen>
<para>These environments produce a box consisting of a sequence of rows of
items, aligned vertically in columns.</para>
<para><indexterm role="fn"><primary>\\ for <literal>tabular</literal></primary></indexterm><literal>\\</literal> must be used to specify the end of each row of the table,
except for the last, where it is optional—unless an <literal>\hline</literal>
command (to put a rule below the table) follows.</para>
<para>The mandatory and optional arguments consist of:</para>
<variablelist>
<varlistentry>
<term><literal>width</literal></term>
<listitem>
<para>Specifies the width of the <literal>tabular*</literal> environment. There must be
rubber space between columns that can stretch to fill out the specified
width.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>pos</literal></term>
<listitem>
<para>Specifies the vertical position; default is alignment on the centre of
the environment.</para>
<variablelist>
<varlistentry>
<term><literal>t</literal></term>
<listitem>
<para>align on top row</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>b</literal></term>
<listitem>
<para>align on bottom row</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>cols</literal></term>
<listitem>
<para>Specifies the column formatting. It consists of a sequence of the
following specifiers, corresponding to the sequence of columns and
intercolumn material.</para>
<variablelist>
<varlistentry>
<term><literal>l</literal></term>
<listitem>
<para>A column of left-aligned items.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>r</literal></term>
<listitem>
<para>A column of right-aligned items.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal></literal></term>
<listitem>
<para>A column of centred items.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>|</literal></term>
<listitem>
<para>A vertical line the full height and depth of the environment.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>@{<replaceable>text</replaceable>}</literal></term>
<listitem>
<para>This inserts <replaceable>text</replaceable> in every row. An @-expression suppresses the
intercolumn space normally inserted between columns; any desired space
between the inserted text and the adjacent items must be included in
text. An <literal>\extracolsep{wd}</literal> command in an @-expression causes
an extra space of width <literal>wd</literal> to appear to the left of all
subsequent columns, until countermanded by another <literal>\extracolsep</literal>
command. Unlike ordinary intercolumn space, this extra space is not
suppressed by an @-expression. An <literal>\extracolsep</literal> command can be
used only in an @-expression in the <literal>cols</literal> argument.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>p{<replaceable>wd</replaceable>}</literal></term>
<listitem>
<para>Produces a column with each item typeset in a parbox of width
<replaceable>wd</replaceable>, as if it were the argument of a
<literal>\parbox[t]{<replaceable>wd</replaceable>}</literal> command. However, a <literal>\\</literal> may not
appear in the item, except in the following situations:</para>
<orderedlist numeration="arabic">
<listitem>
<para>inside an environment like <literal>minipage</literal>, <literal>array</literal>, or <literal>tabular</literal>.</para>
</listitem>
<listitem>
<para>inside an explicit <literal>\parbox</literal>.</para>
</listitem>
<listitem>
<para>in the scope of a <literal>\centering</literal>, <literal>\raggedright</literal>, or <literal>\raggedleft</literal>
declaration. The latter declarations must appear inside braces or an
environment when used in a <literal>p</literal>-column element.</para>
</listitem>
</orderedlist>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>*{<replaceable>num</replaceable>}{<replaceable>cols</replaceable>}</literal></term>
<listitem>
<para>Equivalent to <replaceable>num</replaceable> copies of <replaceable>cols</replaceable>, where <replaceable>num</replaceable> is a
positive integer and <replaceable>cols</replaceable> is any list of column-specifiers,
which may contain another <literal>*-expression</literal>.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
<para>Parameters that control formatting:
<!-- xx defaults, own node (xref from array)? --></para>
<variablelist>
<varlistentry>
<term><literal>\arrayrulewidth</literal></term>
<listitem>
<para>Thickness of the rule created by <literal>|</literal>, <literal>\hline</literal>, and
<literal>\vline</literal> in the <literal>tabular</literal> and <literal>array</literal> environments; the
default is ‘<literal>.4pt</literal>’.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\arraystretch</literal></term>
<listitem>
<para>Scaling of spacing between rows in the <literal>tabular</literal> and <literal>array</literal>
environments; default is ‘<literal>1</literal>’, for no scaling.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\doublerulesep</literal></term>
<listitem>
<para>Horizontal distance between the vertical rules produced by <literal>||</literal>
in the <literal>tabular</literal> and <literal>array</literal> environments; default is ‘<literal>2pt</literal>’.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\tabcolsep</literal></term>
<listitem>
<para>Half the width of the space between columns; default is ‘<literal>6pt</literal>’.</para>
</listitem>
</varlistentry>
</variablelist>
<para>These commands can be used inside a <literal>tabular</literal> environment:</para>
<sect2 label="8.23.1" id="\multicolumn">
<title><literal>\multicolumn</literal></title>
<para><indexterm role="fn"><primary>\multicolumn</primary></indexterm>
Synopsis:</para>
<screen>
\multicolumn{<replaceable>cols</replaceable>}{<replaceable>pos</replaceable>}{<replaceable>text</replaceable>}
</screen>
<para>The <literal>\multicolumn</literal> command makes an entry that spans several
columns. The first mandatory argument, <replaceable>cols</replaceable>, specifies the
number of columns to span. The second mandatory argument, <replaceable>pos</replaceable>,
specifies the formatting of the entry; <literal>c</literal> for centered, <literal>l</literal>
for flushleft, <literal>r</literal> for flushright. The third mandatory argument,
<replaceable>text</replaceable>, specifies what text to put in the entry.</para>
<para>Here's an example showing two columns separated by an en-dash;
<literal>\multicolumn</literal> is used for the heading:</para>
<screen>
\begin{tabular}{r@{--}l}
\multicolumn{2}{c}{\bf Unicode}\cr
0x80&0x7FF \cr
0x800&0xFFFF \cr
0x10000&0x1FFFF \cr
\end{tabular}
</screen>
</sect2>
<sect2 label="8.23.2" id="\cline">
<title><literal>\cline</literal></title>
<para><indexterm role="fn"><primary>\cline</primary></indexterm>
Synopsis:</para>
<screen>
\cline{<replaceable>i</replaceable>-<replaceable>j</replaceable>}
</screen>
<para>The <literal>\cline</literal> command draws horizontal lines across the columns
specified, beginning in column <replaceable>i</replaceable> and ending in column <replaceable>j</replaceable>,
which are specified in the mandatory argument.</para>
</sect2>
<sect2 label="8.23.3" id="\hline">
<title><literal>\hline</literal></title>
<para><indexterm role="fn"><primary>\hline</primary></indexterm>
The <literal>\hline</literal> command draws a horizontal line the width of the
enclosing <literal>tabular</literal> or <literal>array</literal> environment. It's most
commonly used to draw a line at the top, bottom, and between the rows
of a table.</para>
</sect2>
<sect2 label="8.23.4" id="\vline">
<title><literal>\vline</literal></title>
<para><indexterm role="fn"><primary>\vline</primary></indexterm>
The <literal>\vline</literal> command will draw a vertical line extending the full
height and depth of its row. An <literal>\hfill</literal> command can be used to
move the line to the edge of the column. It can also be used in an
@-expression.</para>
</sect2>
</sect1>
<sect1 label="8.24" id="thebibliography">
<title><literal>thebibliography</literal></title>
<para><indexterm role="fn"><primary>thebibliography</primary></indexterm><indexterm role="cp"><primary>bibliography, creating (manually)</primary></indexterm>
Synopsis:</para>
<screen>
\begin{thebibliography}{<replaceable>widest-label</replaceable>}
\bibitem[<replaceable>label</replaceable>]{<replaceable>cite_key}</replaceable>
...
\end{thebibliography}
</screen>
<para>The <literal>thebibliography</literal> environment produces a bibliography or
reference list.</para>
<para>In the <literal>article</literal> class, this reference list is labelled
“References”; in the <literal>report</literal> class, it is labelled
“Bibliography”. You can change the label (in the standard classes)
by redefining the command <literal>\refname</literal>. For instance, this
eliminates it entirely:</para>
<screen>
\renewcommand{\refname}{}
</screen>
<para>The mandatory <replaceable>widest-label</replaceable> argument is text that, when typeset,
is as wide as the widest item label produced by the <literal>\bibitem</literal>
commands. It is typically given as <literal>9</literal> for bibliographies with
less than 10 references, <literal>99</literal> for ones with less than 100, etc.</para>
<sect2 label="8.24.1" id="\bibitem">
<title><literal>\bibitem</literal></title>
<para><indexterm role="fn"><primary>\bibitem</primary></indexterm>
Synopsis:</para>
<screen>
\bibitem[<replaceable>label</replaceable>]{<replaceable>cite_key</replaceable>}
</screen>
<para>The <literal>\bibitem</literal> command generates an entry labelled by
<replaceable>label</replaceable>. If the <replaceable>label</replaceable> argument is missing, a number is
automatically generated using the <literal>enumi</literal> counter. The
<replaceable>cite_key</replaceable> is any sequence of letters, numbers, and punctuation
symbols not containing a comma.</para>
<para>This command writes an entry to the <filename>.aux</filename> file containing the
item's <replaceable>cite_key</replaceable> and label. When the <filename>.aux</filename> file is read by
the <literal>\begin{document}</literal> command, the item's <literal>label</literal> is
associated with <literal>cite_key</literal>, causing references to <replaceable>cite_key</replaceable>
with a <literal>\cite</literal> command (see next section) to produce the
associated label.</para>
</sect2>
<sect2 label="8.24.2" id="\cite">
<title><literal>\cite</literal></title>
<para><indexterm role="fn"><primary>\cite</primary></indexterm>
Synopsis:</para>
<screen>
\cite[<replaceable>subcite</replaceable>]{<replaceable>keys</replaceable>
</screen>
<para>The <replaceable>keys</replaceable> argument is a list of one or more citation keys,
separated by commas. This command generates an in-text citation to
the references associated with <replaceable>keys</replaceable> by entries in the
<filename>.aux</filename> file.</para>
<para>The text of the optional <replaceable>subcite</replaceable> argument appears after the
citation. For example, <literal>\cite[p.~314]{knuth}</literal> might produce
`[Knuth, p. 314]'.</para>
</sect2>
<sect2 label="8.24.3" id="\nocite">
<title><literal>\nocite</literal></title>
<para><indexterm role="fn"><primary>\nocite</primary></indexterm>
<literal>\nocite{key_list}</literal></para>
<para>The <literal>\nocite</literal> command produces no text, but writes <literal>key_list</literal>,
which is a list of one or more citation keys, on the <filename>.aux</filename> file.</para>
</sect2>
<sect2 label="8.24.4" id="Using-BibTeX">
<title>Using Bib&tex;</title>
<para><indexterm role="cp"><primary>using Bib&tex;</primary></indexterm><indexterm role="cp"><primary>bib&tex;, using</primary></indexterm><indexterm role="cp"><primary>bibliography, creating (automatically)</primary></indexterm><indexterm role="fn"><primary>\bibliographystyle</primary></indexterm><indexterm role="fn"><primary>\bibliography</primary></indexterm>
If you use the Bib&tex; program by Oren Patashnik (highly
recommended if you need a bibliography of more than a couple of
titles) to maintain your bibliography, you don't use the
<literal>thebibliography</literal> environment (see <xref linkend="thebibliography"></xref>). Instead,
you include the lines</para>
<screen>
\bibliographystyle{<replaceable>bibstyle</replaceable>}
\bibliography{<replaceable>bibfile1</replaceable>,<replaceable>bibfile2</replaceable>}
</screen>
<para>The <literal>\bibliographystyle</literal> command does not produce any output of
its own. Rather, it defines the style in which the bibliography will
be produced: <replaceable>bibstyle</replaceable> refers to a file
<replaceable>bibstyle</replaceable><filename>.bst</filename>, which defines how your citations will look.
The standard <replaceable>style</replaceable> names distributed with Bib&tex; are:</para>
<variablelist>
<varlistentry>
<term><literal>alpha</literal></term>
<listitem>
<para>Sorted alphabetically. Labels are formed from name of author and year of
publication.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>plain</literal></term>
<listitem>
<para>Sorted alphabetically. Labels are numeric.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>unsrt</literal></term>
<listitem>
<para>Like <literal>plain</literal>, but entries are in order of citation.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>abbrv</literal></term>
<listitem>
<para>Like <literal>plain</literal>, but more compact labels.</para>
</listitem>
</varlistentry>
</variablelist>
<para>In addition, numerous other Bib&tex; style files exist tailored to
the demands of various publications. See
<ulink url="http://www.ctan.org/tex-archive/biblio/bibtex/contrib">http://www.ctan.org/tex-archive/biblio/bibtex/contrib</ulink>.</para>
<para>The <literal>\bibliography</literal> command is what actually produces the
bibliography. The argument to <literal>\bibliography</literal> refers to files
named <filename><replaceable>bibfile</replaceable>.bib</filename>, which should contain your database in
Bib&tex; format. Only the entries referred to via <literal>\cite</literal> and
<literal>\nocite</literal> will be listed in the bibliography.</para>
</sect2>
</sect1>
<sect1 label="8.25" id="theorem">
<title><literal>theorem</literal></title>
<para><indexterm role="fn"><primary>theorem environment</primary></indexterm><indexterm role="cp"><primary>theorems, typesetting</primary></indexterm>
Synopsis:</para>
<screen>
\begin{theorem}
<replaceable>theorem-text</replaceable>
\end{theorem}
</screen>
<para>The <literal>theorem</literal> environment produces “Theorem <replaceable>n</replaceable>” in
boldface followed by <replaceable>theorem-text</replaceable>, where the numbering
possibilities for <replaceable>n</replaceable> are described under <literal>\newtheorem</literal>
(see <xref linkend="\newtheorem"></xref>).</para>
</sect1>
<sect1 label="8.26" id="titlepage">
<title><literal>titlepage</literal></title>
<para><indexterm role="fn"><primary>titlepage environment</primary></indexterm><indexterm role="cp"><primary>making a title page</primary></indexterm><indexterm role="cp"><primary>title pages, creating</primary></indexterm>
Synopsis:</para>
<screen>
\begin{titlepage}
<replaceable>text</replaceable>
\end{titlepage}
</screen>
<para>The <literal>titlepage</literal> environment creates a title page, i.e., a page
with no printed page number or heading. It also causes the following
page to be numbered page one. Formatting the title page is left to
you. The <literal>\today</literal> command may be useful on title pages
(see <xref linkend="\today"></xref>).</para>
<para>You can use the <literal>\maketitle</literal> command (see <xref linkend="\maketitle"></xref>) to
produce a standard title page without a <literal>titlepage</literal> environment.</para>
</sect1>
<sect1 label="8.27" id="verbatim">
<title><literal>verbatim</literal></title>
<para><indexterm role="fn"><primary>verbatim environment</primary></indexterm><indexterm role="cp"><primary>verbatim text</primary></indexterm><indexterm role="cp"><primary>simulating typed text</primary></indexterm><indexterm role="cp"><primary>typed text, simulating</primary></indexterm><indexterm role="cp"><primary>code, typesetting</primary></indexterm><indexterm role="cp"><primary>computer programs, typesetting</primary></indexterm>
Synopsis:</para>
<screen>
\begin{verbatim}
<replaceable>literal-text</replaceable>
\end{verbatim}
</screen>
<para>The <literal>verbatim</literal> environment is a paragraph-making environment in
which &latex; produces exactly what you type in; for instance the
<literal>\</literal> character produces a printed ‘<literal>\</literal>’. It turns &latex;
into a typewriter with carriage returns and blanks having the same
effect that they would on a typewriter.</para>
<para>The <literal>verbatim</literal> uses a monospaced typewriter-like font (<literal>\tt</literal>).</para>
<sect2 label="8.27.1" id="\verb">
<title><literal>\verb</literal></title>
<para><indexterm role="fn"><primary>\verb</primary></indexterm><indexterm role="cp"><primary>verbatim text, inline</primary></indexterm>
Synopsis:</para>
<screen>
\verb<replaceable>char</replaceable><replaceable>literal-text</replaceable><replaceable>char</replaceable>
\verb*<replaceable>char</replaceable><replaceable>literal-text</replaceable><replaceable>char</replaceable>
</screen>
<para>The <literal>\verb</literal> command typesets <replaceable>literal-text</replaceable> as it is input,
including special characters and spaces, using the typewriter
(<literal>\tt</literal>) font. No spaces are allowed between <literal>\verb</literal> or
<literal>\verb*</literal> and the delimiter <replaceable>char</replaceable>, which begins and ends the
verbatim text. The delimiter must not appear in <replaceable>literal-text</replaceable>.</para>
<para><indexterm role="cp"><primary>visible space</primary></indexterm>The <literal>*</literal>-form differs only in that spaces are printed with a
“visible space” character.</para>
</sect2>
</sect1>
<sect1 label="8.28" id="verse">
<title><literal>verse</literal></title>
<para><indexterm role="fn"><primary>verse environment</primary></indexterm><indexterm role="cp"><primary>poetry, an environment for</primary></indexterm>
Synopsis:</para>
<screen>
\begin{verse}
<replaceable>line1</replaceable> \\
<replaceable>line2</replaceable> \\
...
\end{verse}
</screen>
<para>The <literal>verse</literal> environment is designed for poetry, though you may find
other uses for it.</para>
<para><indexterm role="fn"><primary>\\ for <literal>verse</literal></primary></indexterm>The margins are indented on the left and the right, paragraphs are not
indented, and the text is not justified. Separate the lines of each
stanza with <literal>\\</literal>, and use one or more blank lines to separate the
stanzas.</para>
</sect1>
</chapter>
<chapter label="9" id="Footnotes">
<title>Footnotes</title>
<para><indexterm role="cp"><primary>footnotes, creating</primary></indexterm>
Footnotes can be produced in one of two ways. They can be produced
with one command, the <literal>\footnote</literal> command. They can also be
produced with two commands, the <literal>\footnotemark</literal> and the
<literal>\footnotetext</literal> commands.</para>
<sect1 label="9.1" id="\footnote">
<title><literal>\footnote</literal></title>
<para><indexterm role="fn"><primary>\footnote</primary></indexterm>
Synopsis:</para>
<screen>
\footnote[<replaceable>number</replaceable>]{<replaceable>text</replaceable>}
</screen>
<para>The <literal>\footnote</literal> command places the numbered footnote <replaceable>text</replaceable>
at the bottom of the current page. The optional argument <replaceable>number</replaceable>
changes the default footnote number.</para>
<para>This command can only be used in outer paragraph mode; i.e., you
cannot use it in sectioning commands like <literal>\chapter</literal>, in figures,
tables or in a <literal>tabular</literal> environment. (See following sections.)
<!-- xx mention packages that fix this --></para>
</sect1>
<sect1 label="9.2" id="\footnotemark">
<title><literal>\footnotemark</literal></title>
<para><indexterm role="fn"><primary>\footnotemark</primary></indexterm>
With no optional argument, the <literal>\footnotemark</literal> command puts the
current footnote number in the text. This command can be used in
inner paragraph mode. You give the text of the footnote separately,
with the <literal>\footnotetext</literal> command.</para>
<para>This command can be used to produce several consecutive footnote
markers referring to the same footnote with</para>
<screen>
\footnotemark[\value{footnote}]
</screen>
<para>after the first <literal>\footnote</literal> command.</para>
</sect1>
<sect1 label="9.3" id="\footnotetext">
<title><literal>\footnotetext</literal></title>
<para><indexterm role="fn"><primary>\footnotetext</primary></indexterm>
Synopsis:</para>
<screen>
\footnotetext[<replaceable>number</replaceable>]{<replaceable>text</replaceable>}
</screen>
<para>The <literal>\footnotetext</literal> command places <replaceable>text</replaceable> at the bottom of
the page as a footnote. This command can come anywhere after the
<literal>\footnotemark</literal> command. The <literal>\footnotetext</literal> command must
appear in outer paragraph mode.</para>
<para>The optional argument <replaceable>number</replaceable> changes the default footnote number.</para>
</sect1>
<sect1 label="9.4" id="Footnote-parameters">
<title>Footnote parameters</title>
<para><indexterm role="cp"><primary>footnote parameters</primary></indexterm></para>
<variablelist>
<varlistentry>
<term><literal>\footnoterule</literal></term>
<listitem>
<para>Produces the rule separating the main text on a page from the page's
footnotes. Default dimensions: <literal>0.4pt</literal> thick (or wide), and
<literal>0.4\columnwidth</literal> long in the standard document classes (except
slides, where it does not appear).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\footnotesep</literal></term>
<listitem>
<para>The height of the strut placed at the beginning of the footnote. By
default, this is set to the normal strut for <literal>\footnotesize</literal>
fonts (see <xref linkend="Font-sizes"></xref>), therefore there is no extra space between
footnotes. This is ‘<literal>6.65pt</literal>’ for ‘<literal>10pt</literal>’, ‘<literal>7.7pt</literal>’ for
‘<literal>11pt</literal>’, and ‘<literal>8.4pt</literal>’ for ‘<literal>12pt</literal>’.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
</chapter>
<chapter label="10" id="Definitions">
<title>Definitions</title>
<para><indexterm role="cp"><primary>definitions</primary></indexterm>
&latex; has support for making new commands of many different kinds.</para>
<!-- xx everything in this chapter needs examples. -->
<sect1 label="10.1" id="\newcommand-&-\renewcommand">
<title><literal>\newcommand</literal> & <literal>\renewcommand</literal></title>
<para><indexterm role="fn"><primary>\newcommand</primary></indexterm><indexterm role="cp"><primary>commands, defining new ones</primary></indexterm><indexterm role="cp"><primary>defining a new command</primary></indexterm><indexterm role="cp"><primary>new commands, defining</primary></indexterm>
<literal>\newcommand</literal> and <literal>\renewcommand</literal> define and redefine a
command, respectively. Synopses:</para>
<screen>
\newcommand{<replaceable>cmd</replaceable>}[<replaceable>nargs</replaceable>]{<replaceable>defn</replaceable>}
\renewcommand{<replaceable>cmd</replaceable>}[<replaceable>nargs</replaceable>]{<replaceable>defn</replaceable>}
\newcommand{<replaceable>cmd</replaceable>}[<replaceable>nargs</replaceable>][<replaceable>default</replaceable>]{<replaceable>defn</replaceable>}
\renewcommand{<replaceable>cmd</replaceable>}[<replaceable>nargs</replaceable>][<replaceable>default</replaceable>]{<replaceable>defn</replaceable>}
</screen>
<variablelist>
<varlistentry>
<term><replaceable>cmd</replaceable></term>
<listitem>
<para>The command name beginning with <literal>\</literal>. For <literal>\newcommand</literal>, it
must not be already defined and must not begin with <literal>\end</literal>; for
<literal>\renewcommand</literal>, it must already be defined.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>nargs</replaceable></term>
<listitem>
<para>An optional integer from 1 to 9 specifying the number of arguments
that the command will take. The default is for the command to have no
arguments.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>default</replaceable></term>
<listitem>
<para>If this optional parameter is present, it means that the command's
first argument is optional. When the new command is called, the
default value of the optional argument (i.e., if it is not specified
in the call) is the string ‘<literal>def</literal>’.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>defn</replaceable></term>
<listitem>
<para>The text to be substituted for every occurrence of <literal>cmd</literal>; a
construct of the form <literal>#<replaceable>n</replaceable></literal> in <replaceable>defn</replaceable> is replaced by the
text of the <replaceable>n</replaceable>th argument.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 label="10.2" id="\newcounter">
<title><literal>\newcounter</literal></title>
<para><indexterm role="fn"><primary>\newcounter</primary></indexterm><indexterm role="cp"><primary>counters, defining new</primary></indexterm>
Synopsis:</para>
<screen>
\newcounter{<replaceable>cnt</replaceable>}[<replaceable>countername</replaceable>]
</screen>
<para>The <literal>\newcounter</literal> command defines a new counter named <replaceable>cnt</replaceable>.
The new counter is initialized to zero.</para>
<para>Given the optional argument <literal>[<replaceable>countername</replaceable>]</literal>, <replaceable>cnt</replaceable>
will be reset whenever <replaceable>countername</replaceable> is incremented.</para>
<para>See <xref linkend="Counters"></xref>, for more information about counters.</para>
</sect1>
<sect1 label="10.3" id="\newlength">
<title><literal>\newlength</literal></title>
<para><indexterm role="fn"><primary>\newlength</primary></indexterm><indexterm role="cp"><primary>lengths, defining new</primary></indexterm>
Synopsis:</para>
<screen>
\newlength{\<replaceable>arg</replaceable>}
</screen>
<para>The <literal>\newlength</literal> command defines the mandatory argument as a
<literal>length</literal> command with a value of <literal>0in</literal>. The argument must
be a control sequence, as in <literal>\newlength{\foo}</literal>. An error
occurs if <literal>\foo</literal> is already defined.</para>
<para>See <xref linkend="Lengths"></xref>, for how to set the new length to a nonzero value, and
for more information about lengths in general.</para>
</sect1>
<sect1 label="10.4" id="\newsavebox">
<title><literal>\newsavebox</literal></title>
<para><indexterm role="fn"><primary>\newsavebox</primary></indexterm>
Synopsis:</para>
<screen>
\newsavebox{<replaceable>cmd</replaceable>}
</screen>
<para>Defines <literal>\<replaceable>cmd</replaceable></literal>, which must be a command name not already
defined, to refer to a new bin for storing boxes.</para>
</sect1>
<sect1 label="10.5" id="\newenvironment-&-\renewenvironment">
<title><literal>\newenvironment</literal> & <literal>\renewenvironment</literal></title>
<para><indexterm role="fn"><primary>\newenvironment</primary></indexterm><indexterm role="fn"><primary>\renewenvironment</primary></indexterm><indexterm role="cp"><primary>environments, defining</primary></indexterm><indexterm role="cp"><primary>defining new environments</primary></indexterm><indexterm role="cp"><primary>redefining environments</primary></indexterm>
Synopses:</para>
<screen>
\newenvironment{<replaceable>env</replaceable>}[<replaceable>nargs</replaceable>]{<replaceable>begdef</replaceable>}{<replaceable>enddef</replaceable>}
\newenvironment{<replaceable>env</replaceable>}[<replaceable>nargs</replaceable>][<replaceable>default</replaceable>]{<replaceable>begdef</replaceable>}{<replaceable>enddef</replaceable>}
\renewenvironment{<replaceable>env</replaceable>}[<replaceable>nargs</replaceable>]{<replaceable>begdef</replaceable>}{<replaceable>enddef</replaceable>}
</screen>
<para>These commands define or redefine an environment <replaceable>env</replaceable>, that is,
<literal>\begin{<replaceable>env</replaceable>} … \end{<replaceable>env</replaceable>}</literal>.</para>
<variablelist>
<varlistentry>
<term><replaceable>env</replaceable></term>
<listitem>
<para>The name of the environment. For <literal>\newenvironment</literal>, <replaceable>env</replaceable>
must not be an existing environment, and the command <literal>\<replaceable>env</replaceable></literal>
must be undefined. For <literal>\renewenvironment</literal>, <replaceable>env</replaceable> must be
the name of an existing environment.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>nargs</replaceable></term>
<listitem>
<para>An integer from 1 to 9 denoting the number of arguments of
the newly-defined environment. The default is no arguments.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>default</replaceable></term>
<listitem>
<para>If this is specified, the first argument is optional, and <replaceable>default</replaceable>
gives the default value for that argument.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>begdef</replaceable></term>
<listitem>
<para>The text expanded at every occurrence of <literal>\begin{<replaceable>env</replaceable>}</literal>; a
construct of the form <literal>#<replaceable>n</replaceable></literal> in <replaceable>begdef</replaceable> is replaced by
the text of the <replaceable>n</replaceable>th argument.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>enddef</replaceable></term>
<listitem>
<para>The text expanded at every occurrence of <literal>\end{<replaceable>env</replaceable>}</literal>. It
may not contain any argument parameters.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 label="10.6" id="\newtheorem">
<title><literal>\newtheorem</literal></title>
<para><indexterm role="fn"><primary>\newtheorem</primary></indexterm><indexterm role="cp"><primary>theorems, defining</primary></indexterm><indexterm role="cp"><primary>defining new theorems</primary></indexterm></para>
<screen>
\newtheorem{<replaceable>newenv</replaceable>}{<replaceable>label</replaceable>}[<replaceable>within</replaceable>]
\newtheorem{<replaceable>newenv</replaceable>}[<replaceable>numbered_like</replaceable>]{<replaceable>label</replaceable>}
</screen>
<para>This command defines a theorem-like environment. Arguments:</para>
<variablelist>
<varlistentry>
<term><replaceable>newenv</replaceable></term>
<listitem>
<para>The name of the environment to be defined; must not be the name of an
existing environment or otherwise defined.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>label</replaceable></term>
<listitem>
<para>The text printed at the beginning of the environment, before the
number. For example, ‘<literal>Theorem</literal>’.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>numbered_like</replaceable></term>
<listitem>
<para>(Optional.) The name of an already defined theorem-like environment;
the new environment will be numbered just like <replaceable>numbered_like</replaceable>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>within</replaceable></term>
<listitem>
<para>(Optional.) The name of an already defined counter, a sectional unit.
The new theorem counter will be reset at the same time as the
<replaceable>within</replaceable> counter.</para>
</listitem>
</varlistentry>
</variablelist>
<para>At most one of <replaceable>numbered_like</replaceable> and <replaceable>within</replaceable> can be specified,
not both.</para>
</sect1>
<sect1 label="10.7" id="\newfont">
<title><literal>\newfont</literal></title>
<para><indexterm role="fn"><primary>\newfont</primary></indexterm><indexterm role="cp"><primary>fonts, new commands for</primary></indexterm><indexterm role="cp"><primary>defining new fonts</primary></indexterm>
Synopsis:</para>
<screen>
\newfont{<replaceable>cmd</replaceable>}{<replaceable>fontname</replaceable>}
</screen>
<para>Defines a control sequence <literal>\<replaceable>cmd</replaceable></literal>, which must not already
be defined, to make <replaceable>fontname</replaceable> be the current font. The file
looked for on the system is named <filename><replaceable>fontname</replaceable>.tfm</filename>.</para>
<para>This is a low-level command for setting up to use an individual font.
More commonly, fonts are defined in families through <filename>.fd</filename> files.</para>
</sect1>
<sect1 label="10.8" id="\protect">
<title><literal>\protect</literal></title>
<para><indexterm role="fn"><primary>\protect</primary></indexterm>
<indexterm role="cp"><primary>fragile commands</primary></indexterm><indexterm role="cp"><primary>moving arguments</primary></indexterm>Footnotes, line breaks, any command that has an optional argument, and
many more are so-called <firstterm>fragile</firstterm> commands. When a fragile
command is used in certain contexts, called <firstterm>moving arguments</firstterm>, it
must be preceded by <literal>\protect</literal>. In addition, any fragile
commands within the arguments must have their own <literal>\protect</literal>.</para>
<para>Some examples of moving arguments are <literal>\caption</literal>
(see <xref linkend="figure"></xref>), <literal>\thanks</literal> (see <xref linkend="\maketitle"></xref>), and
expressions in <literal>tabular</literal> and <literal>array</literal> environments
(see <xref linkend="tabular"></xref>).</para>
<para><indexterm role="cp"><primary>robust commands</primary></indexterm>Commands which are not fragile are called <firstterm>robust</firstterm>. They must not
be preceded by <literal>\protect</literal>.</para>
<para>See also:</para>
<screen>
<lineannotation><ulink url="http://www-h.eng.cam.ac.uk/help/tpl/textprocessing/teTeX/latex/latex2e-html/fragile.html">http://www-h.eng.cam.ac.uk/help/tpl/textprocessing/teTeX/latex/latex2e-html/fragile.html</ulink></lineannotation>
<lineannotation><ulink url="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=protect">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=protect</ulink></lineannotation>
</screen>
<!-- xx really need examples. -->
</sect1>
</chapter>
<chapter label="11" id="Counters">
<title>Counters</title>
<para><indexterm role="cp"><primary>counters, a list of</primary></indexterm><indexterm role="cp"><primary>variables, a list of</primary></indexterm>
Everything &latex; numbers for you has a counter associated with
it. The name of the counter is the same as the name of the environment
or command that produces the number, except with no <literal>\</literal>.
(<literal>enumi</literal>–<literal>enumiv</literal> are used for the nested enumerate
environment.) Below is a list of the counters used in &latex;'s
standard document classes to control numbering.</para>
<screen>
part paragraph figure enumi
chapter subparagraph table enumii
section page footnote enumiii
subsection equation mpfootnote enumiv
subsubsection
</screen>
<sect1 label="11.1" id="\alph-\Alph-\arabic-\roman-\Roman-\fnsymbol">
<title><literal>\alph \Alph \arabic \roman \Roman \fnsymbol</literal>: Printing counters</title>
<para>All of these commands take a single counter as an argument, for
instance, <literal>\alph{enumi}</literal>.</para>
<variablelist>
<varlistentry>
<term><literal>\alph</literal></term>
<listitem>
<para>prints <replaceable>counter</replaceable> using lowercase letters: `a', `b', ….</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\Alph</literal></term>
<listitem>
<para>uses uppercase letters: `A', `B', ….</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\arabic</literal></term>
<listitem>
<para>uses Arabic numbers: `1', `2', ….</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\roman</literal></term>
<listitem>
<para>uses lowercase roman numerals: `i', `ii', ….</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\roman</literal></term>
<listitem>
<para>uses uppercase roman numerals: `I', `II', ….</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\fnsymbol</literal></term>
<listitem>
<para>prints the value of <replaceable>counter</replaceable> in a specific sequence of nine
symbols (conventionally used for labeling footnotes). The value of
<replaceable>counter</replaceable> must be between 1 and 9, inclusive.</para>
<para>The symbols mostly aren't supported in Info, but here are the names:<literallayout>
asterix(*) dagger ddagger section-sign paragraph-sign parallel
double-asterix(**) double-dagger double-ddagger
</literallayout></para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 label="11.2" id="\usecounter">
<title><literal>\usecounter{<replaceable>counter</replaceable>}</literal></title>
<para><indexterm role="fn"><primary>\usecounter</primary></indexterm><indexterm role="cp"><primary>list items, specifying counter</primary></indexterm><indexterm role="cp"><primary>numbered items, specifying counter</primary></indexterm>
Synopsis:</para>
<screen>
\usecounter{<replaceable>counter</replaceable>}
</screen>
<para>The <literal>\usecounter</literal> command is used in the second argument of the
<literal>list</literal> environment to specify <replaceable>counter</replaceable> to be used to number
the list items.</para>
</sect1>
<sect1 label="11.3" id="\value">
<title><literal>\value{<replaceable>counter</replaceable>}</literal></title>
<para><indexterm role="fn"><primary>\value</primary></indexterm><indexterm role="cp"><primary>counters, getting value of</primary></indexterm>
Synopsis:</para>
<screen>
\value{<replaceable>counter</replaceable>}
</screen>
<para>The <literal>\value</literal> command produces the value of <replaceable>counter</replaceable>. It can
be used anywhere &latex; expects a number, for example:</para>
<screen>
\setcounter{myctr}{3}
\addtocounter{myctr}{1}
\hspace{\value{myctr}\parindent}
</screen>
</sect1>
<sect1 label="11.4" id="\setcounter">
<title><literal>\setcounter{<replaceable>counter</replaceable>}{<replaceable>value</replaceable>}</literal></title>
<para><indexterm role="fn"><primary>\setcounter</primary></indexterm><indexterm role="cp"><primary>counters, setting</primary></indexterm><indexterm role="cp"><primary>setting counters</primary></indexterm>
Synopsis:</para>
<screen>
\setcounter{<replaceable>\counter</replaceable>}{<replaceable>value</replaceable>}
</screen>
<para>The <literal>\setcounter</literal> command sets the value of <replaceable>\counter</replaceable> to the
<replaceable>value</replaceable> argument.</para>
</sect1>
<sect1 label="11.5" id="\addtocounter">
<title><literal>\addtocounter{<replaceable>counter</replaceable>}{<replaceable>value</replaceable>}</literal></title>
<para><indexterm role="fn"><primary>\addtocounter</primary></indexterm>
The <literal>\addtocounter</literal> command increments <replaceable>counter</replaceable> by the
amount specified by the <replaceable>value</replaceable> argument, which may be negative.</para>
</sect1>
<sect1 label="11.6" id="\refstepcounter">
<title><literal>\refstepcounter{<replaceable>counter</replaceable>}</literal></title>
<para><indexterm role="fn"><primary>\refstepcounter</primary></indexterm>
The <literal>\refstepcounter</literal> command works in the same way as
<literal>\stepcounter</literal> See <xref linkend="\stepcounter"></xref>, except it also defines the
current <literal>\ref</literal> value to be the result of <literal>\thecounter</literal>.</para>
</sect1>
<sect1 label="11.7" id="\stepcounter">
<title><literal>\stepcounter{<replaceable>counter</replaceable>}</literal></title>
<para><indexterm role="fn"><primary>\stepcounter</primary></indexterm>
The <literal>\stepcounter</literal> command adds one to <replaceable>counter</replaceable> and
resets all subsidiary counters.</para>
</sect1>
<sect1 label="11.8" id="\day-\month-\year">
<title><literal>\day \month \year</literal>: Predefined counters</title>
<para><indexterm role="fn"><primary>\day</primary></indexterm><indexterm role="fn"><primary>\month</primary></indexterm><indexterm role="fn"><primary>\year</primary></indexterm>
&latex; defines counters for the day of the month (<literal>\day</literal>,
1–31), month of the year (<literal>\month</literal>, 1–12), and year
(<literal>\year</literal>, Common Era). When &tex; starts up, they are
set to the current values on the system where &tex; is running. They
are not updated as the job progresses.</para>
<para>The related command <literal>\today</literal> produces a string representing the
current day (see <xref linkend="\today"></xref>).</para>
</sect1>
</chapter>
<chapter label="12" id="Lengths">
<title>Lengths</title>
<para><indexterm role="cp"><primary>lengths, defining and using</primary></indexterm>
A <literal>length</literal> is a measure of distance. Many &latex; commands take a
length as an argument.</para>
<sect1 label="12.1" id="\setlength">
<title><literal>\setlength{\<replaceable>len</replaceable>}{<replaceable>value</replaceable>}</literal></title>
<para><indexterm role="fn"><primary>\setlength</primary></indexterm><indexterm role="cp"><primary>lengths, setting</primary></indexterm>
The <literal>\setlength</literal> sets the value of <replaceable>\len</replaceable> to the <replaceable>value</replaceable>
argument, which can be expressed in any units that &latex;
understands, i.e., inches (<literal>in</literal>), millimeters (<literal>mm</literal>), points
(<literal>pt</literal>), big points (<literal>bp</literal>, etc.</para>
</sect1>
<sect1 label="12.2" id="\addtolength">
<title>\addtolength{<replaceable>\len</replaceable>}{<replaceable>amount</replaceable>}</title>
<para><indexterm role="fn"><primary>\addtolength</primary></indexterm><indexterm role="cp"><primary>lengths, adding to</primary></indexterm>
The <literal>\addtolength</literal> command increments a “length command”
<replaceable>\len</replaceable> by the amount specified in the <replaceable>amount</replaceable> argument, which
may be negative.</para>
</sect1>
<sect1 label="12.3" id="\settodepth">
<title><literal>\settodepth</literal></title>
<para><indexterm role="fn"><primary>\settodepth</primary></indexterm>
<literal>\settodepth{\gnat}{text}</literal></para>
<para>The <literal>\settodepth</literal> command sets the value of a <literal>length</literal> command
equal to the depth of the <literal>text</literal> argument.</para>
</sect1>
<sect1 label="12.4" id="\settoheight">
<title><literal>\settoheight</literal></title>
<para><indexterm role="fn"><primary>\settoheight</primary></indexterm>
<literal>\settoheight{\gnat}{text}</literal></para>
<para>The <literal>\settoheight</literal> command sets the value of a <literal>length</literal> command
equal to the height of the <literal>text</literal> argument.</para>
</sect1>
<sect1 label="12.5" id="\settowidth">
<title><literal>\settowidth{\<replaceable>len</replaceable>}{<replaceable>text</replaceable>}</literal></title>
<para><indexterm role="fn"><primary>\settowidth</primary></indexterm>
The <literal>\settowidth</literal> command sets the value of the command <replaceable>\len</replaceable>
to the width of the <replaceable>text</replaceable> argument.</para>
</sect1>
<sect1 label="12.6" id="Predefined-lengths">
<title>Predefined lengths</title>
<para><indexterm role="cp"><primary>lengths, predefined</primary></indexterm><indexterm role="cp"><primary>predefined lengths</primary></indexterm>
<literal>\width</literal>
<indexterm role="fn"><primary>\width</primary></indexterm>
<literal>\height</literal>
<indexterm role="fn"><primary>\height</primary></indexterm>
<literal>\depth</literal>
<indexterm role="fn"><primary>\depth</primary></indexterm>
<literal>\totalheight</literal>
<indexterm role="fn"><primary>\totalheight</primary></indexterm>
These length parameters can be used in the arguments of the box-making
commands (see <xref linkend="Boxes"></xref>). They specify the natural width etc. of the
text in the box. <literal>\totalheight</literal> equals <literal>\height</literal> +
<literal>\depth</literal>. To make a box with the text stretched to double the
natural size, e.g., say</para>
<para><literal>\makebox[2\width]{Get a stretcher}</literal></para>
</sect1>
</chapter>
<chapter label="13" id="Line-breaking">
<title>Line breaking</title>
<para><indexterm role="cp"><primary>line breaking</primary></indexterm><indexterm role="cp"><primary>breaking lines</primary></indexterm>
The first thing &latex; does when processing ordinary text is to
translate your input file into a sequence of glyphs and spaces. To
produce a printed document, this sequence must be broken into lines
(and these lines must be broken into pages).</para>
<para>&latex; usually does the line (and page) breaking for you, but in
some environments, you do the line breaking yourself with the
<literal>\\</literal> command, and you can always manually force breaks.</para>
<sect1 label="13.1" id="\\">
<title><literal>\\</literal>[*][<replaceable>morespace</replaceable>]</title>
<para><indexterm role="fn"><primary>\\ force line break</primary></indexterm><indexterm role="cp"><primary>new line, starting</primary></indexterm><indexterm role="cp"><primary>line break, forcing</primary></indexterm>
The <literal>\\</literal> command tells &latex; to start a new line. It has an
optional argument, <replaceable>morespace</replaceable>, that specifies how much extra
vertical space is to be inserted before the next line. This can be a
negative amount.</para>
<para>The <literal>\\*</literal> command is the same as the ordinary <literal>\\</literal> command
except that it tells &latex; not to start a new page after the line.</para>
</sect1>
<sect1 label="13.2" id="\obeycr-&-\restorecr">
<title><literal>\obeycr</literal> & <literal>\restorecr</literal></title>
<para><indexterm role="fn"><primary>\obeycr</primary></indexterm><indexterm role="fn"><primary>\restorecr</primary></indexterm><indexterm role="cp"><primary>new line, output as input</primary></indexterm>
The <literal>\obeycr</literal> command makes a return in the input file
(‘<literal>^^M</literal>’, internally) the same as <literal>\\</literal> (followed by
<literal>\relax</literal>). So each new line in the input will also be a new line
in the output.</para>
<para><literal>\restorecr</literal> restores normal line-breaking behavior.</para>
</sect1>
<sect1 label="13.3" id="\newline">
<title><literal>\newline</literal></title>
<para><indexterm role="fn"><primary>\newline</primary></indexterm><indexterm role="cp"><primary>new line, starting (paragraph mode)</primary></indexterm>
The <literal>\newline</literal> command breaks the line at the present point, with
no stretching of the text before it. It can only be used in paragraph
mode.</para>
</sect1>
<sect1 label="13.4" id="\--(hyphenation)">
<title><literal>\-</literal> (discretionary hyphen)</title>
<para><indexterm role="fn"><primary>\- (hyphenation)</primary></indexterm><indexterm role="cp"><primary>hyphenation, forcing</primary></indexterm>
The <literal>\-</literal> command tells &latex; that it may hyphenate the word at
that point. &latex; is very good at hyphenating, and it will usually
find most of the correct hyphenation points, and almost never use an
incorrect one. The <literal>\-</literal> command is used for the exceptional
cases.</para>
<para>When you insert <literal>\-</literal> commands in a word, the word will only be
hyphenated at those points and not at any of the hyphenation points
that &latex; might otherwise have chosen.</para>
</sect1>
<sect1 label="13.5" id="\fussy">
<title><literal>\fussy</literal></title>
<para><indexterm role="fn"><primary>\fussy</primary></indexterm>
The declaration <literal>\fussy</literal> (which is the default) makes &tex;
picky about line breaking. This usually avoids too much space between
words, at the cost of an occasional overfull box.</para>
<para>This command cancels the effect of a previous <literal>\sloppy</literal> command
(see <xref linkend="\sloppy"></xref>.</para>
</sect1>
<sect1 label="13.6" id="\sloppy">
<title><literal>\sloppy</literal></title>
<para>The declaration <literal>\sloppy</literal> makes &tex; less fussy about line
breaking. This will avoid overfull boxes, at the cost of loose
interword spacing.</para>
<para>Lasts until a <literal>\fussy</literal> command is issued (see <xref linkend="\fussy"></xref>).</para>
</sect1>
<sect1 label="13.7" id="\hyphenation">
<title><literal>\hyphenation</literal></title>
<para><indexterm role="fn"><primary>\hyphenation</primary></indexterm><indexterm role="cp"><primary>hyphenation, defining</primary></indexterm>
Synopsis:</para>
<screen>
\hyphenation{<replaceable>word-one</replaceable> <replaceable>word-two</replaceable>}
</screen>
<para>The <literal>\hyphenation</literal> command declares allowed hyphenation points
with a <literal>-</literal> character in the given words. The words are separated
by spaces. &tex; will only hyphenate if the word matches exactly, no
inflections are tried. Multiple <literal>\hyphenation</literal> commands
accumulate. Some examples (the default &tex; hyphenation patterns
misses the hyphenations in these words):</para>
<screen>
\hyphenation{ap-pen-dix col-umns data-base data-bases}
</screen>
</sect1>
<sect1 label="13.8" id="\linebreak-&-\nolinebreak">
<title><literal>\linebreak</literal> & <literal>\nolinebreak</literal></title>
<para><indexterm role="fn"><primary>\linebreak</primary></indexterm><indexterm role="fn"><primary>\nolinebreak</primary></indexterm><indexterm role="cp"><primary>line breaks, forcing</primary></indexterm><indexterm role="cp"><primary>line breaks, preventing</primary></indexterm>
Synopses:</para>
<screen>
\linebreak[<replaceable>priority</replaceable>]
\nolinebreak[<replaceable>priority</replaceable>]
</screen>
<para>By default, the <literal>\linebreak</literal> (<literal>\nolinebreak</literal>) command forces
(prevents) a line break at the current position. For
<literal>\linebreak</literal>, the spaces in the line are stretched out so that it
extends to the right margin as usual.</para>
<para>With the optional argument <replaceable>priority</replaceable>, you can convert the command
from a demand to a request. The <replaceable>priority</replaceable> must be a number from
0 to 4. The higher the number, the more insistent the request.</para>
</sect1>
</chapter>
<chapter label="14" id="Page-breaking">
<title>Page breaking</title>
<para><indexterm role="cp"><primary>page breaking</primary></indexterm><indexterm role="cp"><primary>breaking pages</primary></indexterm>
&latex; starts new pages asynchronously, when enough material has
accumulated to fill up a page. Usually this happens automatically,
but sometimes you may want to influence the breaks.</para>
<sect1 label="14.1" id="\cleardoublepage">
<title><literal>\cleardoublepage</literal></title>
<para><indexterm role="fn"><primary>\cleardoublepage</primary></indexterm><indexterm role="cp"><primary>starting on a right-hand page</primary></indexterm>
The <literal>\cleardoublepage</literal> command ends the current page and causes all
figures and tables that have so far appeared in the input to be printed.
In a two-sided printing style, it also makes the next page a right-hand
(odd-numbered) page, producing a blank page if necessary.</para>
</sect1>
<sect1 label="14.2" id="\clearpage">
<title><literal>\clearpage</literal></title>
<para><indexterm role="fn"><primary>\clearpage</primary></indexterm><indexterm role="cp"><primary>flushing floats and starting a page</primary></indexterm><indexterm role="cp"><primary>starting a new page and clearing floats</primary></indexterm>
The <literal>\clearpage</literal> command ends the current page and causes all
figures and tables that have so far appeared in the input to be printed.</para>
</sect1>
<sect1 label="14.3" id="\newpage">
<title><literal>\newpage</literal></title>
<para><indexterm role="fn"><primary>\newpage</primary></indexterm><indexterm role="cp"><primary>new page, starting</primary></indexterm><indexterm role="cp"><primary>starting a new page</primary></indexterm>
The <literal>\newpage</literal> command ends the current page, but does not clear
floats (see <literal>\clearpage</literal> above).</para>
</sect1>
<sect1 label="14.4" id="\enlargethispage">
<title><literal>\enlargethispage</literal></title>
<para><indexterm role="fn"><primary>\enlargethispage</primary></indexterm><indexterm role="cp"><primary>enlarge current page</primary></indexterm>
<literal>\enlargethispage{size}</literal></para>
<para><literal>\enlargethispage*{size}</literal></para>
<para>Enlarge the <literal>\textheight</literal> for the current page by the specified
amount; e.g. <literal>\enlargethispage{\baselineskip}</literal> will allow one
additional line.</para>
<para>The starred form tries to squeeze the material together on the page as
much as possible. This is normally used together with an explicit
<literal>\pagebreak</literal>.</para>
</sect1>
<sect1 label="14.5" id="\pagebreak-&-\nopagebreak">
<title><literal>\pagebreak</literal> & <literal>\nopagebreak</literal></title>
<para><indexterm role="fn"><primary>\pagebreak</primary></indexterm><indexterm role="fn"><primary>\nopagebreak</primary></indexterm><indexterm role="cp"><primary>page break, forcing</primary></indexterm><indexterm role="cp"><primary>page break, preventing</primary></indexterm>
Synopses:</para>
<screen>
\pagebreak[<replaceable>priority</replaceable>]
\nopagebreak[<replaceable>priority</replaceable>]
</screen>
<para>By default, the <literal>\pagebreak</literal> (<literal>\nopagebreak</literal>) command forces
(prevents) a page break at the current position. For
<literal>\linebreak</literal>, the vertical space on the page is stretched out
where possible so that it extends to the normal bottom margin.</para>
<para>With the optional argument <replaceable>priority</replaceable>, you can convert the
<literal>\pagebreak</literal> command from a demand to a request. The number must
be a number from 0 to 4. The higher the number, the more
insistent the request is.</para>
</sect1>
</chapter>
<chapter label="15" id="Making-paragraphs">
<title>Making paragraphs</title>
<para><indexterm role="cp"><primary>making paragraphs</primary></indexterm><indexterm role="cp"><primary>paragraphs</primary></indexterm>
A paragraph is ended by one or more completely blank lines—lines not
containing even a <literal>%</literal>. A blank line should not appear where a new
paragraph cannot be started, such as in math mode or in the argument of
a sectioning command.</para>
<sect1 label="15.1" id="\indent">
<title><literal>\indent</literal></title>
<para><indexterm role="fn"><primary>\indent</primary></indexterm><indexterm role="fn"><primary>\parindent</primary></indexterm><indexterm role="cp"><primary>indent, forcing</primary></indexterm>
<literal>\indent</literal> produces a horizontal space whose width equals the
width of the <literal>\parindent</literal> length, the normal paragraph
indentation. It is used to add paragraph indentation where it would
otherwise be suppressed.</para>
<para>The default value for <literal>\parindent</literal> is <literal>1em</literal> in two-column
mode, otherwise <literal>15pt</literal> for <literal>10pt</literal> documents, <literal>17pt</literal> for
<literal>11pt</literal>, and <literal>1.5em</literal> for <literal>12pt</literal>.</para>
</sect1>
<sect1 label="15.2" id="\noindent">
<title><literal>\noindent</literal></title>
<para><indexterm role="fn"><primary>\noindent</primary></indexterm><indexterm role="cp"><primary>indent, suppressing</primary></indexterm>
When used at the beginning of the paragraph, <literal>\noindent</literal>
suppresses any paragraph indentation. It has no effect when used in
the middle of a paragraph.</para>
</sect1>
<sect1 label="15.3" id="\parskip">
<title><literal>\parskip</literal></title>
<para><indexterm role="fn"><primary>\parskip</primary></indexterm><indexterm role="cp"><primary>vertical space before paragraphs</primary></indexterm>
<literal>\parskip</literal> is a rubber length defining extra vertical space added
before each paragraph. The default is <literal>0pt plus1pt</literal>.</para>
</sect1>
<sect1 label="15.4" id="Marginal-notes">
<title>Marginal notes</title>
<para><indexterm role="cp"><primary>marginal notes</primary></indexterm><indexterm role="cp"><primary>notes in the margin</primary></indexterm><indexterm role="cp"><primary>remarks in the margin</primary></indexterm><indexterm role="fn"><primary>\marginpar</primary></indexterm>
Synopsis:</para>
<screen>
\marginpar[<replaceable>left</replaceable>]{<replaceable>right</replaceable>}
</screen>
<para>The <literal>\marginpar</literal> command creates a note in the margin. The first
line of the note will have the same baseline as the line in the text
where the <literal>\marginpar</literal> occurs.</para>
<para>When you only specify the mandatory argument <replaceable>right</replaceable>, the text
will be placed</para>
<itemizedlist mark="bullet">
<listitem>
<para>in the right margin for one-sided layout;</para>
</listitem>
<listitem>
<para>in the outside margin for two-sided layout;</para>
</listitem>
<listitem>
<para>in the nearest margin for two-column layout.</para>
</listitem>
</itemizedlist>
<para><indexterm role="fn"><primary>\reversemarginpar</primary></indexterm><indexterm role="fn"><primary>\normalmarginpar</primary></indexterm>The command <literal>\reversemarginpar</literal> places subsequent marginal notes
in the opposite (inside) margin. <literal>\normalmarginpar</literal> places them
in the default position.</para>
<para>When you specify both arguments, <replaceable>left</replaceable> is used for the left
margin, and <replaceable>right</replaceable> is used for the right margin.</para>
<para>The first word will normally not be hyphenated; you can enable
hyphenation there by beginning the node with <literal>\hspace{0pt}</literal>.</para>
<para>These parameters affect the formatting of the note:</para>
<variablelist>
<varlistentry>
<term><literal>\marginparpush</literal></term>
<listitem>
<para>Minimum vertical space between notes; default ‘<literal>7pt</literal>’ for
‘<literal>12pt</literal>’ documents, ‘<literal>5pt</literal>’ else.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\marginparsep</literal></term>
<listitem>
<para>Horizontal space between the main text and the note; default
‘<literal>11pt</literal>’ for ‘<literal>10pt</literal>’ documents, ‘<literal>10pt</literal>’ else.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\marginparwidth</literal></term>
<listitem>
<para>Width of the note itself; default for a one-sided ‘<literal>10pt</literal>’ document
is ‘<literal>90pt</literal>’, ‘<literal>83pt</literal>’ for ‘<literal>11pt</literal>’, and ‘<literal>68pt</literal>’ for
‘<literal>12pt</literal>’; ‘<literal>17pt</literal>’ more in each case for a two-sided document.
In two column mode, the default is ‘<literal>48pt</literal>’.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
</chapter>
<chapter label="16" id="Math-formulas">
<title>Math formulas</title>
<para><indexterm role="cp"><primary>math formulas</primary></indexterm><indexterm role="cp"><primary>formulas, math</primary></indexterm><indexterm role="cp"><primary>math mode, entering</primary></indexterm>
<indexterm role="fn"><primary>math environment</primary></indexterm><indexterm role="fn"><primary>displaymath environment</primary></indexterm><indexterm role="fn"><primary>equation environment</primary></indexterm>There are three environments that put &latex; in math mode:</para>
<variablelist>
<varlistentry>
<term><literal>math</literal></term>
<listitem>
<para>For formulas that appear right in the text.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>displaymath</literal></term>
<listitem>
<para>For formulas that appear on their own line.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>equation</literal></term>
<listitem>
<para>The same as the displaymath environment except that it adds an equation
number in the right margin.</para>
</listitem>
</varlistentry>
</variablelist>
<para><indexterm role="fn"><primary>\(</primary></indexterm><indexterm role="fn"><primary>\)</primary></indexterm><indexterm role="fn"><primary>\[</primary></indexterm><indexterm role="fn"><primary>\]</primary></indexterm>The <literal>math</literal> environment can be used in both paragraph and LR mode,
but the <literal>displaymath</literal> and <literal>equation</literal> environments can be used
only in paragraph mode. The <literal>math</literal> and <literal>displaymath</literal>
environments are used so often that they have the following short forms:</para>
<screen>
\(...\) <lineannotation>instead of</lineannotation> \begin{math}...\end{math}
\[...\] <lineannotation>instead of</lineannotation> \begin{displaymath}...\end{displaymath}
</screen>
<para><indexterm role="fn"><primary>$</primary></indexterm>In fact, the <literal>math</literal> environment is so common that it has an even
shorter form:</para>
<screen>
$ ... $ <lineannotation>instead of</lineannotation> \(...\)
</screen>
<para><indexterm role="fn"><primary>\boldmath</primary></indexterm><indexterm role="fn"><primary>\unboldmath</primary></indexterm>The <literal>\boldmath</literal> command changes math letters and symbols to be in
a bold font. It is used <emphasis>outside</emphasis> of math mode. Conversely, the
<literal>\unboldmath</literal> command changes math glyphs to be in a normal font;
it too is used <emphasis>outside</emphasis> of math mode.</para>
<!-- xx own section? Math fonts? -->
<para><indexterm role="fn"><primary>\displaystyle</primary></indexterm>The <literal>\displaystyle</literal> declaration forces the size and style of the
formula to be that of <literal>displaymath</literal>, e.g., with limits above and
below summations. For example</para>
<screen>
$\displaystyle \sum_{n=0}^\infty x_n $
</screen>
<!-- xx see also \cal, \mathcal -->
<sect1 label="16.1" id="Subscripts-&-Superscripts">
<title>Subscripts & Superscripts</title>
<para><indexterm role="cp"><primary>superscript</primary></indexterm><indexterm role="cp"><primary>subscript</primary></indexterm><indexterm role="cp"><primary>exponent</primary></indexterm><indexterm role="fn"><primary>_</primary></indexterm><indexterm role="fn"><primary>^</primary></indexterm>
To get an expression <wordasword>exp</wordasword> to appear as a subscript, you just type
<literal>_{</literal><wordasword>exp</wordasword><literal>}</literal>. To get <wordasword>exp</wordasword> to appear as a
superscript, you type <literal>^{</literal><wordasword>exp</wordasword><literal>}</literal>. &latex; handles
superscripted superscripts and all of that stuff in the natural way.
It even does the right thing when something has both a subscript and a
superscript.</para>
</sect1>
<sect1 label="16.2" id="Math-symbols">
<title>Math symbols</title>
<para><indexterm role="cp"><primary>math symbols</primary></indexterm><indexterm role="cp"><primary>symbols, math</primary></indexterm><indexterm role="cp"><primary>greek letters</primary></indexterm>
&latex; provides almost any mathematical symbol you're likely to
need. The commands for generating them can be used only in math mode.
For example, if you include <literal>$\pi$</literal> in your source, you will get
the pi symbol (\pi) in your output.</para>
<variablelist>
<varlistentry>
<term><literal>\|</literal></term>
<listitem>
<para>\|</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\aleph</literal></term>
<listitem>
<para>\aleph</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\alpha</literal></term>
<listitem>
<para>\alpha</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\amalg</literal></term>
<listitem>
<para>\amalg (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\angle</literal></term>
<listitem>
<para>\angle</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\approx</literal></term>
<listitem>
<para>\approx (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\ast</literal></term>
<listitem>
<para>\ast (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\asymp</literal></term>
<listitem>
<para>\asymp (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\backslash</literal></term>
<listitem>
<para>\ (delimiter)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\beta</literal></term>
<listitem>
<para>\beta</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\bigcap</literal></term>
<listitem>
<para>\bigcap</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\bigcirc</literal></term>
<listitem>
<para>\bigcirc (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\bigcup</literal></term>
<listitem>
<para>\bigcup</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\bigodot</literal></term>
<listitem>
<para>\bigodot</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\bigoplus</literal></term>
<listitem>
<para>\bigoplus</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\bigotimes</literal></term>
<listitem>
<para>\bigotimes</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\bigtriangledown</literal></term>
<listitem>
<para>\bigtriangledown (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\bigtriangleup</literal></term>
<listitem>
<para>\bigtriangleup (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\bigsqcup</literal></term>
<listitem>
<para>\bigsqcup</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\biguplus</literal></term>
<listitem>
<para>\biguplus</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\bigcap</literal></term>
<listitem>
<para>\bigvee</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\bigwedge</literal></term>
<listitem>
<para>\bigwedge</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\bot</literal></term>
<listitem>
<para>\bot</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\bowtie</literal></term>
<listitem>
<para>\bowtie (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\Box</literal></term>
<listitem>
<para>(square open box symbol)
<!-- xx not in plain --></para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\bullet</literal></term>
<listitem>
<para><indexterm role="cp"><primary>bullet symbol</primary></indexterm>\bullet (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\cap</literal></term>
<listitem>
<para>\cap (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\cdot</literal></term>
<listitem>
<para>\cdot (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\chi</literal></term>
<listitem>
<para>\chi</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\circ</literal></term>
<listitem>
<para>\circ (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\clubsuit</literal></term>
<listitem>
<para>\clubsuit</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\cong</literal></term>
<listitem>
<para>\cong (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\coprod</literal></term>
<listitem>
<para>\coprod</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\cup</literal></term>
<listitem>
<para>\cup (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\dagger</literal></term>
<listitem>
<para>\dagger (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\dashv</literal></term>
<listitem>
<para>\dashv (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\ddagger</literal></term>
<listitem>
<para>\dagger (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\Delta</literal></term>
<listitem>
<para>\Delta</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\delta</literal></term>
<listitem>
<para>\delta</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\Diamond</literal></term>
<listitem>
<para>bigger \diamond
<!-- xx not in plain --></para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\diamond</literal></term>
<listitem>
<para>\diamond (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\diamondsuit</literal></term>
<listitem>
<para>\diamondsuit</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\div</literal></term>
<listitem>
<para>\div (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\doteq</literal></term>
<listitem>
<para>\doteq (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\downarrow</literal></term>
<listitem>
<para>\downarrow (delimiter)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\Downarrow</literal></term>
<listitem>
<para>\Downarrow (delimiter)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\ell</literal></term>
<listitem>
<para>\ell</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\emptyset</literal></term>
<listitem>
<para>\emptyset</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\epsilon</literal></term>
<listitem>
<para>\epsilon</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\equiv</literal></term>
<listitem>
<para>\equiv (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\eta</literal></term>
<listitem>
<para>\eta</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\exists</literal></term>
<listitem>
<para>\exists</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\flat</literal></term>
<listitem>
<para>\flat</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\forall</literal></term>
<listitem>
<para>\forall</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\frown</literal></term>
<listitem>
<para>\frown (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\Gamma</literal></term>
<listitem>
<para>\Gamma</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\gamma</literal></term>
<listitem>
<para>\gamma</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\ge</literal></term>
<listitem>
<para>\ge</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\geq</literal></term>
<listitem>
<para>\geq (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\gets</literal></term>
<listitem>
<para>\gets</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\gg</literal></term>
<listitem>
<para>\gg (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\hbar</literal></term>
<listitem>
<para>\hbar</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\heartsuit</literal></term>
<listitem>
<para>\heartsuit</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\hookleftarrow</literal></term>
<listitem>
<para>\hookleftarrow</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\hookrightarrow</literal></term>
<listitem>
<para>\hookrightarrow</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\iff</literal></term>
<listitem>
<para>\iff</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\Im</literal></term>
<listitem>
<para>\Im</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\in</literal></term>
<listitem>
<para>\in (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\infty</literal></term>
<listitem>
<para>\infty</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\int</literal></term>
<listitem>
<para>\int</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\iota</literal></term>
<listitem>
<para>\iota</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\Join</literal></term>
<listitem>
<para>condensed bowtie symbol (relation)
<!-- xx not in plain --></para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\kappa</literal></term>
<listitem>
<para>\kappa</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\Lambda</literal></term>
<listitem>
<para>\Lambda</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\lambda</literal></term>
<listitem>
<para>\lambda</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\land</literal></term>
<listitem>
<para>\land</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\langle</literal></term>
<listitem>
<para>\langle (delimiter)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\lbrace</literal></term>
<listitem>
<para>\lbrace (delimiter)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\lbrack</literal></term>
<listitem>
<para>\lbrack (delimiter)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\lceil</literal></term>
<listitem>
<para>\lceil (delimiter)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\le</literal></term>
<listitem>
<para>\le</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\leadsto</literal></term>
<!-- xx missing from plain -->
<listitem>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\Leftarrow</literal></term>
<listitem>
<para>\Leftarrow</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\leftarrow</literal></term>
<listitem>
<para>\leftarrow</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\leftharpoondown</literal></term>
<listitem>
<para>\leftharpoondown</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\leftharpoonup</literal></term>
<listitem>
<para>\leftharpoonup</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\Leftrightarrow</literal></term>
<listitem>
<para>\Leftrightarrow</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\leftrightarrow</literal></term>
<listitem>
<para>\leftrightarrow</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\leq</literal></term>
<listitem>
<para>\leq (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\lfloor</literal></term>
<listitem>
<para>\lfloor (delimiter)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\lhd</literal></term>
<listitem>
<para>(left-pointing arrow head)
<!-- xx not in plain --></para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\ll</literal></term>
<listitem>
<para>\ll (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\lnot</literal></term>
<listitem>
<para>\lnot</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\longleftarrow</literal></term>
<listitem>
<para>\longleftarrow</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\longleftrightarrow</literal></term>
<listitem>
<para>\longleftrightarrow</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\longmapsto</literal></term>
<listitem>
<para>\longmapsto</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\longrightarrow</literal></term>
<listitem>
<para>\longrightarrow</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\lor</literal></term>
<listitem>
<para>\lor</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\mapsto</literal></term>
<listitem>
<para>\mapsto</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\mho</literal></term>
<!-- xx not in plain -->
<listitem>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\mid</literal></term>
<listitem>
<para>\mid (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\models</literal></term>
<listitem>
<para>\models (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\mp</literal></term>
<listitem>
<para>\mp (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\mu</literal></term>
<listitem>
<para>\mu</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\nabla</literal></term>
<listitem>
<para>\nabla</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\natural</literal></term>
<listitem>
<para>\natural</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\ne</literal></term>
<listitem>
<para>\ne</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\nearrow</literal></term>
<listitem>
<para>\nearrow</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\neg</literal></term>
<listitem>
<para>\neg</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\neq</literal></term>
<listitem>
<para>\neq (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\ni</literal></term>
<listitem>
<para>\ni (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\not</literal></term>
<listitem>
<para>Overstrike a following operator with a /, as in \not=.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\notin</literal></term>
<listitem>
<para>\ni</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\nu</literal></term>
<listitem>
<para>\nu</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\nwarrow</literal></term>
<listitem>
<para>\nwarrow</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\odot</literal></term>
<listitem>
<para>\odot (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\oint</literal></term>
<listitem>
<para>\oint</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\Omega</literal></term>
<listitem>
<para>\Omega</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\omega</literal></term>
<listitem>
<para>\omega</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\ominus</literal></term>
<listitem>
<para>\ominus (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\oplus</literal></term>
<listitem>
<para>\oplus (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\oslash</literal></term>
<listitem>
<para>\oslash (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\otimes</literal></term>
<listitem>
<para>\otimes (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\owns</literal></term>
<listitem>
<para>\owns</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\parallel</literal></term>
<listitem>
<para>\parallel (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\partial</literal></term>
<listitem>
<para>\partial</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\perp</literal></term>
<listitem>
<para>\perp (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\phi</literal></term>
<listitem>
<para>\phi</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\Pi</literal></term>
<listitem>
<para>\Pi</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\pi</literal></term>
<listitem>
<para>\pi</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\pm</literal></term>
<listitem>
<para>\pm (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\prec</literal></term>
<listitem>
<para>\prec (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\preceq</literal></term>
<listitem>
<para>\preceq (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\prime</literal></term>
<listitem>
<para>\prime</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\prod</literal></term>
<listitem>
<para>\prod</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\propto</literal></term>
<listitem>
<para>\propto (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\Psi</literal></term>
<listitem>
<para>\Psi</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\psi</literal></term>
<listitem>
<para>\psi</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\rangle</literal></term>
<listitem>
<para>\rangle (delimiter)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\rbrace</literal></term>
<listitem>
<para>\rbrace (delimiter)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\rbrack</literal></term>
<listitem>
<para>\rbrack (delimiter)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\rceil</literal></term>
<listitem>
<para>\rceil (delimiter)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\Re</literal></term>
<listitem>
<para>\Re</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\rfloor</literal></term>
<listitem>
<para>\rfloor</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\rhd</literal></term>
<listitem>
<para>(binary operation)
<!-- xx not in plain @math{\rhd} --></para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\rho</literal></term>
<listitem>
<para>\rho</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\Rightarrow</literal></term>
<listitem>
<para>\Rightarrow</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\rightarrow</literal></term>
<listitem>
<para>\rightarrow</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\rightharpoondown</literal></term>
<listitem>
<para>\rightharpoondown</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\rightharpoonup</literal></term>
<listitem>
<para>\rightharpoonup</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\rightleftharpoons</literal></term>
<listitem>
<para>\rightleftharpoons</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\searrow</literal></term>
<listitem>
<para>\searrow</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\setminus</literal></term>
<listitem>
<para>\setminus (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\sharp</literal></term>
<listitem>
<para>\sharp</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\Sigma</literal></term>
<listitem>
<para>\Sigma</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\sigma</literal></term>
<listitem>
<para>\sigma</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\sim</literal></term>
<listitem>
<para>\sim (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\simeq</literal></term>
<listitem>
<para>\simeq (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\smallint</literal></term>
<listitem>
<para>\smallint</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\smile</literal></term>
<listitem>
<para>\smile (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\spadesuit</literal></term>
<listitem>
<para>\spadesuit</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\sqcap</literal></term>
<listitem>
<para>\sqcap (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\sqcup</literal></term>
<listitem>
<para>\sqcup (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\sqsubset</literal></term>
<listitem>
<para>(relation)
<!-- not in plain (@math{\sqsubset}) --></para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\sqsubseteq</literal></term>
<listitem>
<para>\sqsubseteq (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\sqsupset</literal></term>
<listitem>
<para>(relation)
<!-- not in plain (@math{\sqsupset}) --></para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\sqsupseteq</literal></term>
<listitem>
<para>\sqsupseteq (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\star</literal></term>
<listitem>
<para>\star (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\subset</literal></term>
<listitem>
<para>\subset (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\subseteq</literal></term>
<listitem>
<para>\subseteq (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\succ</literal></term>
<listitem>
<para>\succ (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\succeq</literal></term>
<listitem>
<para>\succeq (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\sum</literal></term>
<listitem>
<para>\sum</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\supset</literal></term>
<listitem>
<para>\supset (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\supseteq</literal></term>
<listitem>
<para>\supseteq (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\surd</literal></term>
<listitem>
<para>\surd</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\swarrow</literal></term>
<listitem>
<para>\swarrow</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\tau</literal></term>
<listitem>
<para>\tau</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\theta</literal></term>
<listitem>
<para>\theta</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\times</literal></term>
<listitem>
<para>\times (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\to</literal></term>
<listitem>
<para>\to</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\top</literal></term>
<listitem>
<para>\top</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\triangle</literal></term>
<listitem>
<para>\triangle</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\triangleleft</literal></term>
<listitem>
<para>\triangleleft (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\triangleright</literal></term>
<listitem>
<para>\triangleright (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\unlhd</literal></term>
<listitem>
<para>left-pointing arrowhead with line under (binary operation)
<!-- not in plain --></para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\unrhd</literal></term>
<listitem>
<para>right-pointing arrowhead with line under (binary operation)
<!-- not in plain --></para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\Uparrow</literal></term>
<listitem>
<para>\Uparrow (delimiter)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\uparrow</literal></term>
<listitem>
<para>\uparrow (delimiter)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\Updownarrow</literal></term>
<listitem>
<para>\Updownarrow (delimiter)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\updownarrow</literal></term>
<listitem>
<para>\updownarrow (delimiter)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\uplus</literal></term>
<listitem>
<para>\uplus (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\Upsilon</literal></term>
<listitem>
<para>\Upsilon</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\upsilon</literal></term>
<listitem>
<para>\upsilon</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\varepsilon</literal></term>
<listitem>
<para>\varepsilon</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\varphi</literal></term>
<listitem>
<para>\varphi</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\varpi</literal></term>
<listitem>
<para>\varpi</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\varrho</literal></term>
<listitem>
<para>\varrho</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\varsigma</literal></term>
<listitem>
<para>\varsigma</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\vartheta</literal></term>
<listitem>
<para>\vartheta</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\vdash</literal></term>
<listitem>
<para>\vdash (relation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\vee</literal></term>
<listitem>
<para>\vee (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\Vert</literal></term>
<listitem>
<para>\Vert (delimiter)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\vert</literal></term>
<listitem>
<para>\vert (delimiter)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\wedge</literal></term>
<listitem>
<para>\wedge (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\wp</literal></term>
<listitem>
<para>\wp</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\wr</literal></term>
<listitem>
<para>\wr (binary operation)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\Xi</literal></term>
<listitem>
<para>\Xi</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\xi</literal></term>
<listitem>
<para>\xi</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\zeta</literal></term>
<listitem>
<para>\zeta</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 label="16.3" id="Math-functions">
<title>Math functions</title>
<para><indexterm role="cp"><primary>math functions</primary></indexterm><indexterm role="cp"><primary>functions, math</primary></indexterm>
These commands produce roman function names in math mode with proper
spacing.</para>
<variablelist>
<varlistentry>
<term><literal>\arccos</literal></term>
<listitem>
<para>\arccos</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\arcsin</literal></term>
<listitem>
<para>\arcsin</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\arctan</literal></term>
<listitem>
<para>\arctan</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\arg</literal></term>
<listitem>
<para>\arg</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\bmod</literal></term>
<listitem>
<para>Binary modulo operator (x \bmod y)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\cos</literal></term>
<listitem>
<para>\cos</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\cosh</literal></term>
<listitem>
<para>\cosh</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\cot</literal></term>
<listitem>
<para>\cos</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\coth</literal></term>
<listitem>
<para>\cosh</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\csc</literal></term>
<listitem>
<para>\csc</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\deg</literal></term>
<listitem>
<para>\deg</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\det</literal></term>
<listitem>
<para>\deg</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\dim</literal></term>
<listitem>
<para>\dim</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\exp</literal></term>
<listitem>
<para>\exp</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\gcd</literal></term>
<listitem>
<para>\gcd</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\hom</literal></term>
<listitem>
<para>\hom</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\inf</literal></term>
<listitem>
<para>\inf</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\ker</literal></term>
<listitem>
<para>\ker</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\lg</literal></term>
<listitem>
<para>\lg</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\lim</literal></term>
<listitem>
<para>\lim</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\liminf</literal></term>
<listitem>
<para>\liminf</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\limsup</literal></term>
<listitem>
<para>\limsup</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\ln</literal></term>
<listitem>
<para>\ln</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\log</literal></term>
<listitem>
<para>\log</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\max</literal></term>
<listitem>
<para>\max</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\min</literal></term>
<listitem>
<para>\min</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\pmod</literal></term>
<listitem>
<para>parenthesized modulus, as in (\pmod 2^n - 1)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\Pr</literal></term>
<listitem>
<para>\Pr</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\sec</literal></term>
<listitem>
<para>\sec</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\sin</literal></term>
<listitem>
<para>\sin</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\sinh</literal></term>
<listitem>
<para>\sinh</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\sup</literal></term>
<listitem>
<para>\sup</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\tan</literal></term>
<listitem>
<para>\tan</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\tanh</literal></term>
<listitem>
<para>\tanh</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 label="16.4" id="Math-accents">
<title>Math accents</title>
<para><indexterm role="cp"><primary>math accents</primary></indexterm><indexterm role="cp"><primary>accents, mathematical</primary></indexterm>
&latex; provides a variety of commands for producing accented letters
in math. These are different from accents in normal text
(see <xref linkend="Accents"></xref>).</para>
<variablelist>
<varlistentry>
<term><literal>\acute</literal></term>
<listitem>
<para><indexterm role="cp"><primary>acute accent, math</primary></indexterm>Math acute accent: \acutex.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\bar</literal></term>
<listitem>
<para><indexterm role="cp"><primary>bar-over accent, math</primary></indexterm><indexterm role="cp"><primary>macron accent, math</primary></indexterm>Math bar-over accent: \barx.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\breve</literal></term>
<listitem>
<para><indexterm role="cp"><primary>breve accent, math</primary></indexterm>Math breve accent: \brevex.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\check</literal></term>
<listitem>
<para><indexterm role="cp"><primary>check accent, math</primary></indexterm><indexterm role="cp"><primary>hác<ek accent, math</primary></indexterm>Math hác<ek (check) accent: \checkx.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\ddot</literal></term>
<listitem>
<para><indexterm role="cp"><primary>double dot accent, math</primary></indexterm>Math dieresis accent: \ddotx.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\dot</literal></term>
<listitem>
<para><indexterm role="cp"><primary>overdot accent, math</primary></indexterm><indexterm role="cp"><primary>dot over accent, math</primary></indexterm>Math dot accent: \dotx.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\grave</literal></term>
<listitem>
<para><indexterm role="cp"><primary>grave accent, math</primary></indexterm>Math grave accent: \gravex.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\hat</literal></term>
<listitem>
<para><indexterm role="cp"><primary>hat accent, math</primary></indexterm><indexterm role="cp"><primary>circumflex accent, math</primary></indexterm>Math hat (circumflex) accent: \hatx.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\imath</literal></term>
<listitem>
<para><indexterm role="cp"><primary>dotless i, math</primary></indexterm>Math dotless i.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\jmath</literal></term>
<listitem>
<para><indexterm role="cp"><primary>dotless j, math</primary></indexterm>Math dotless j.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\tilde</literal></term>
<listitem>
<para><indexterm role="cp"><primary>tilde accent, math</primary></indexterm>Math tilde accent: \tildex.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\vec</literal></term>
<listitem>
<para><indexterm role="cp"><primary>vector symbol, math</primary></indexterm>Math vector symbol: \vecx.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\widehat</literal></term>
<listitem>
<para><indexterm role="cp"><primary>wide hat accent, math</primary></indexterm>Math wide hat accent: \widehatx+y.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\widehat</literal></term>
<listitem>
<para><indexterm role="cp"><primary>wide tile accent, math</primary></indexterm>Math wide tilde accent: \widetildex+y.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 label="16.5" id="Spacing-in-math-mode">
<title>Spacing in math mode</title>
<para><indexterm role="cp"><primary>spacing within math mode</primary></indexterm><indexterm role="cp"><primary>math mode, spacing</primary></indexterm>
In a <literal>math</literal> environment, &latex; ignores the spaces you type and
puts in the spacing according to the normal rules for mathematics
texts. If you want different spacing, &latex; provides the following
commands for use in math mode:</para>
<variablelist>
<varlistentry>
<term><literal>\;</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\;</primary></indexterm>A thick space (5\over18\,quad).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\:</literal></term>
<term><literal>\></literal></term>
<listitem>
<para><indexterm role="fn"><primary>\:</primary></indexterm><indexterm role="fn"><primary>\></primary></indexterm>Both of these produce a medium space (2\over9\,quad).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\,</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\,</primary></indexterm>A thin space (1\over6\,quad); not restricted to math mode.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\!</literal></term>
<listitem>
<para>A negative thin space (-1\over6\,quad).</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 label="16.6" id="Math-Miscellany">
<title>Math Miscellany</title>
<para><indexterm role="cp"><primary>math Miscellany</primary></indexterm></para>
<variablelist>
<varlistentry>
<term><literal>\*</literal></term>
<listitem>
<para><indexterm role="cp"><primary>discretionary multiplication</primary></indexterm><indexterm role="cp"><primary>multiplication symbol, discretionary line break</primary></indexterm>A “discretionary” multiplication symbol, at which a line break is
allowed.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\cdots</literal></term>
<listitem>
<para>A horizontal ellipsis with the dots raised to the center of the line.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\ddots</literal></term>
<listitem>
<para>A diagonal ellipsis: \ddots.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\frac{num}{den}</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\frac</primary></indexterm>Produces the fraction <literal>num</literal> divided by <literal>den</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\left <replaceable>delim1</replaceable> ... \right <replaceable>delim2</replaceable></literal></term>
<listitem>
<para><indexterm role="fn"><primary>\right</primary></indexterm><indexterm role="cp"><primary>null delimiter</primary></indexterm>The two delimiters need not match; ‘<literal>.</literal>’ acts as a null delimiter,
producing no output. The delimiters are sized according to the math
in between. Example: <literal>\left( \sum_i=1^10 a_i \right]</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\overbrace{<replaceable>text</replaceable>}</literal></term>
<listitem>
<para>Generates a brace over <replaceable>text</replaceable>.
For example, \overbracex+\cdots+x^k \rm\;times.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\overline{<replaceable>text</replaceable>}</literal></term>
<listitem>
<para>Generates a horizontal line over <replaceable>tex</replaceable>.
For exampe, \overlinex+y.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\sqrt[<replaceable>root</replaceable>]{arg}</literal></term>
<listitem>
<para>Produces the representation of the square root of <replaceable>arg</replaceable>. The
optional argument <replaceable>root</replaceable> determines what root to produce. For
example, the cube root of <literal>x+y</literal> would be typed as
<literal>$\sqrt[3]{x+y}$</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\stackrel{<replaceable>text</replaceable>}{<replaceable>relation</replaceable>}</literal></term>
<listitem>
<para>Puts <replaceable>text</replaceable> above <replaceable>relation</replaceable>. For example,
<literal>\stackrel{f}{\longrightarrow}</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\underbrace{math}</literal></term>
<listitem>
<para>Generates <replaceable>math</replaceable> with a brace underneath.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\underline{text}</literal></term>
<listitem>
<para>Causes <replaceable>text</replaceable>, which may be either math mode or not, to be
underlined.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\vdots</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\vdots</primary></indexterm>Produces a vertical ellipsis.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
</chapter>
<chapter label="17" id="Modes">
<title>Modes</title>
<para><indexterm role="cp"><primary>modes</primary></indexterm><indexterm role="cp"><primary>paragraph mode</primary></indexterm><indexterm role="cp"><primary>math mode</primary></indexterm><indexterm role="cp"><primary>left-to-right mode</primary></indexterm><indexterm role="cp"><primary>lR mode</primary></indexterm></para>
<para>When &latex; is processing your input text, it is always in one of three
modes:</para>
<itemizedlist mark="bullet">
<listitem>
<para>Paragraph mode</para>
</listitem>
<listitem>
<para>Math mode</para>
</listitem>
<listitem>
<para>Left-to-right mode, called LR mode for short</para>
</listitem>
</itemizedlist>
<para>&latex; changes mode only when it goes up or down a staircase to a
different level, though not all level changes produce mode changes.
Mode changes occur only when entering or leaving an environment, or when
&latex; is processing the argument of certain text-producing commands.</para>
<para>“Paragraph mode” is the most common; it's the one &latex; is in
when processing ordinary text. In that mode, &latex; breaks your
text into lines and breaks the lines into pages. &latex; is in
“math mode” when it's generating a mathematical formula. In “LR
mode”, as in paragraph mode, &latex; considers the output that it
produces to be a string of words with spaces between them. However,
unlike paragraph mode, &latex; keeps going from left to right; it
never starts a new line in LR mode. Even if you put a hundred words
into an <literal>\mbox</literal>, &latex; would keep typesetting them from left
to right inside a single box, and then complain because the resulting
box was too wide to fit on the line.</para>
<para>&latex; is in LR mode when it starts making a box with an <literal>\mbox</literal>
command. You can get it to enter a different mode inside the box - for
example, you can make it enter math mode to put a formula in the box.
There are also several text-producing commands and environments for
making a box that put &latex; in paragraph mode. The box make by one of
these commands or environments will be called a <literal>parbox</literal>. When
&latex; is in paragraph mode while making a box, it is said to be in
“inner paragraph mode”. Its normal paragraph mode, which it starts out
in, is called “outer paragraph mode”.</para>
</chapter>
<chapter label="18" id="Page-Styles">
<title>Page Styles</title>
<para><indexterm role="cp"><primary>styles, page</primary></indexterm><indexterm role="cp"><primary>page styles</primary></indexterm>
The <literal>\documentclass</literal> command determines the size and position of
the page's head and foot. The page style determines what goes in them.</para>
<sect1 label="18.1" id="\maketitle">
<title><literal>\maketitle</literal></title>
<para><indexterm role="cp"><primary>titles, making</primary></indexterm><indexterm role="fn"><primary>\maketitle</primary></indexterm>
The <literal>\maketitle</literal> command generates a title on a separate title
page—except in the <literal>article</literal> class, where the title is placed
at the top of the first page. Information used to produce the title
is obtained from the following declarations:</para>
<variablelist>
<varlistentry>
<term><literal>\author{<replaceable>name</replaceable> \and <replaceable>name2</replaceable>}</literal></term>
<listitem>
<para><indexterm role="cp"><primary>author, for titlepage</primary></indexterm><indexterm role="fn"><primary>\\ for <literal>\author</literal></primary></indexterm><indexterm role="fn"><primary>\and for <literal>\author</literal></primary></indexterm>The <literal>\author</literal> command declares the document author(s), where the
argument is a list of authors separated by <literal>\and</literal> commands. Use
<literal>\\</literal> to separate lines within a single author's entry—for
example, to give the author's institution or address.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\date{<replaceable>text</replaceable>}</literal></term>
<listitem>
<para><indexterm role="cp"><primary>date, for titlepage</primary></indexterm>The <literal>\date</literal> command declares <replaceable>text</replaceable> to be the document's
date. With no <literal>\date</literal> command, the current date (see <xref linkend="\today"></xref>)
is used.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\thanks{<replaceable>text</replaceable>}</literal></term>
<listitem>
<para><indexterm role="cp"><primary>thanks, for titlepage</primary></indexterm><indexterm role="cp"><primary>credit footnote</primary></indexterm>The <literal>\thanks</literal> command produces a <literal>\footnote</literal> to the title,
usually used for credit acknowledgements.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\title{<replaceable>text</replaceable>}</literal></term>
<listitem>
<para><indexterm role="cp"><primary>title, for titlepage</primary></indexterm><indexterm role="fn"><primary>\\ for <literal>\title</literal></primary></indexterm>The <literal>\title</literal> command declares <replaceable>text</replaceable> to be the title of the
document. Use <literal>\\</literal> to force a line break, as usual.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 label="18.2" id="\pagenumbering">
<title><literal>\pagenumbering</literal></title>
<para><indexterm role="fn"><primary>\pagenumbering</primary></indexterm><indexterm role="cp"><primary>page numbering style</primary></indexterm>
Synopsis:</para>
<screen>
\pagenumbering{<replaceable>style</replaceable>}
</screen>
<para>Specifies the style of page numbers, according to <replaceable>style</replaceable>:</para>
<variablelist>
<varlistentry>
<term><literal>arabic</literal></term>
<listitem>
<para>arabic numerals</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>roman</literal></term>
<listitem>
<para>lowercase Roman numerals</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>Roman</literal></term>
<listitem>
<para>uppercase Roman numerals</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>alph</literal></term>
<listitem>
<para>lowercase letters</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>Alph</literal></term>
<listitem>
<para>uppercase letters</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 label="18.3" id="\pagestyle">
<title><literal>\pagestyle</literal></title>
<para><indexterm role="fn"><primary>\pagestyle</primary></indexterm><indexterm role="cp"><primary>header style</primary></indexterm><indexterm role="cp"><primary>footer style</primary></indexterm><indexterm role="cp"><primary>running header and footer style</primary></indexterm>
Synopsis:</para>
<screen>
\pagestyle{<replaceable>style</replaceable>}
</screen>
<para>The <literal>\pagestyle</literal> command specifies how the headers and footers
are typeset from the current page onwards. Values for <replaceable>style</replaceable>:</para>
<variablelist>
<varlistentry>
<term><literal>plain</literal></term>
<listitem>
<para>Just a plain page number.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>empty</literal></term>
<listitem>
<para>Empty headers and footers, e.g., no page numbers.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>headings</literal></term>
<listitem>
<para>Put running headers on each page. The document style specifies what
goes in the headers.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>myheadings</literal></term>
<listitem>
<para>Custom headers, specified via the <literal>\markboth</literal> or the
<literal>\markright</literal> commands.</para>
</listitem>
</varlistentry>
</variablelist>
<para>Here are the descriptions of <literal>\markboth</literal> and <literal>\markright</literal>:</para>
<variablelist>
<varlistentry>
<term><literal>\markboth{<replaceable>left</replaceable>}{<replaceable>right</replaceable>}</literal></term>
<listitem>
<para>Sets both the left and the right heading. A “left-hand heading”
(<replaceable>left</replaceable>) is generated by the last <literal>\markboth</literal> command before
the end of the page, while a “right-hand heading” (<replaceable>right</replaceable> is
generated by the first <literal>\markboth</literal> or <literal>\markright</literal> that
comes on the page if there is one, otherwise by the last one before
the page.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\markright{<replaceable>right</replaceable>}</literal></term>
<listitem>
<para>Sets the right heading, leaving the left heading unchanged.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 label="18.4" id="\thispagestyle">
<title><literal>\thispagestyle{<replaceable>style</replaceable>}</literal></title>
<para><indexterm role="fn"><primary>\thispagestyle</primary></indexterm>
The <literal>\thispagestyle</literal> command works in the same manner as the
<literal>\pagestyle</literal> command (see previous section) except that it
changes to <replaceable>style</replaceable> for the current page only.</para>
</sect1>
</chapter>
<chapter label="19" id="Spaces">
<title>Spaces</title>
<para><indexterm role="cp"><primary>spaces</primary></indexterm>
&latex; has many ways to produce white (or filled) space.</para>
<para>Another space-producing command is <literal>\,</literal> to produce a “thin”
space (usually 1/6quad). It can be used in text mode, but is
more often useful in math mode (see <xref linkend="Spacing-in-math-mode"></xref>).</para>
<sect1 label="19.1" id="\hspace">
<title><literal>\hspace</literal></title>
<para><indexterm role="fn"><primary>\hspace</primary></indexterm>
Synopsis:</para>
<screen>
\hspace[*]{<replaceable>length</replaceable>}
</screen>
<para>The <literal>\hspace</literal> command adds horizontal space. The <replaceable>length</replaceable>
argument can be expressed in any terms that &latex; understands:
points, inches, etc. It is a rubber length. You can add both
negative and positive space with an <literal>\hspace</literal> command; adding
negative space is like backspacing.</para>
<para>&latex; normally removes horizontal space that comes at the beginning
or end of a line. To preserve this space, use the optional <literal>*</literal>
form.</para>
</sect1>
<sect1 label="19.2" id="\hfill">
<title><literal>\hfill</literal></title>
<para><indexterm role="fn"><primary>\hfill</primary></indexterm>The <literal>\hfill</literal> fill command produces a “rubber length” which has
no natural space but can stretch or shrink horizontally as far as
needed.</para>
<para><indexterm role="fn"><primary>\fill</primary></indexterm>The <literal>\fill</literal> parameter is the rubber length itself (technically,
the glue value ‘<literal>0pt plus1fill</literal>’); thus, <literal>\hspace\fill</literal> is
equivalent to <literal>\hfill</literal>.</para>
</sect1>
<sect1 label="19.3" id="\SPACE">
<title><literal>\SPACE</literal></title>
<para><indexterm role="fn"><primary>\SPACE</primary></indexterm><indexterm role="fn"><primary>\TAB</primary></indexterm><indexterm role="fn"><primary>\NEWLINE</primary></indexterm>
The <literal>\ </literal> (space) command produces a normal interword space. It's
useful after punctuation which shouldn't end a sentence. For example
<literal>Knuth's article in Proc.\ Amer.\ Math\. Soc.\ is fundamental</literal>.
It is also often used after control sequences, as in <literal>\TeX\ is a
nice system.</literal></para>
<para>In normal circumstances, <literal>\</literal><keycap>tab</keycap> and <literal>\</literal><keycap>newline</keycap>
are equivalent to <literal>\ </literal>.</para>
</sect1>
<sect1 label="19.4" id="\AT">
<title><literal>\@</literal></title>
<para><indexterm role="fn"><primary>\@</primary></indexterm>
The <literal>\@</literal> command makes the following punctuation character end a
sentence even if it normally would not. This is typically used after
a capital letter. Here are side-by-side examples with and without
<literal>\@</literal>:</para>
<screen>
… in C\@. Pascal, though …
… in C. Pascal, though …
</screen>
<para role="continues">produces</para>
<!-- Texinfo does it differently, but the result is the same. -->
<blockquote>
<para>… in C. Pascal, though …
… in C. Pascal, though …</para>
</blockquote>
</sect1>
<sect1 label="19.5" id="\thinspace">
<title><literal>\thinspace</literal></title>
<para><indexterm role="fn"><primary>\thinspace</primary></indexterm>
<literal>\thinspace</literal> produces an unbreakable and unstretchable space that
is 1/6 of an em. This is the proper space to use in nested quotes, as
in '”.</para>
</sect1>
<sect1 label="19.6" id="\/">
<title><literal>\/</literal></title>
<para><indexterm role="fn"><primary>\/</primary></indexterm>
The <literal>\/</literal> command produces an <firstterm>italic correction</firstterm>. This is a
small space defined by the font designer for a given character,
to avoid the character colliding with whatever follows. The italic
<wordasword>f</wordasword> character typically has a large italic correction value.</para>
<para>If the following character is a period or comma, it's not necessary to
insert an italic correction, since those punctuation symbols have a
very small height. However, with semicolons or colons, as well as
normal letters, it can help. Compare
<wordasword>f: f;</wordasword> (in the &tex; output, the `f's are nicely separated)
with <wordasword>f: f;</wordasword>.</para>
<para>Despite the name, roman characters can also have an italic
correction. Compare
pdf&tex; (in the &tex; output, there is a small space after the `f')
with pdf&tex;.</para>
</sect1>
<sect1 label="19.7" id="\hrulefill">
<title><literal>\hrulefill</literal></title>
<para><indexterm role="fn"><primary>\hrulefill</primary></indexterm>
The <literal>\hrulefill</literal> fill command produces a “rubber length” which can
stretch or shrink horizontally. It will be filled with a horizontal
rule.</para>
</sect1>
<sect1 label="19.8" id="\dotfill">
<title><literal>\dotfill</literal></title>
<para><indexterm role="fn"><primary>\dotfill</primary></indexterm>
The <literal>\dotfill</literal> command produces a “rubber length” that fills
with dots instead of just white space.</para>
<!-- xx undone -->
</sect1>
<sect1 label="19.9" id="\addvspace">
<title><literal>\addvspace</literal></title>
<para><indexterm role="fn"><primary>\addvspace</primary></indexterm><indexterm role="cp"><primary>vertical space</primary></indexterm><indexterm role="cp"><primary>space, inserting vertical</primary></indexterm>
<literal>\addvspace{length}</literal></para>
<para>The <literal>\addvspace</literal> command normally adds a vertical space of height
length. However, if vertical space has already been added to the same
point in the output by a previous <literal>\addvspace</literal> command, then this
command will not add more space than needed to make the natural length
of the total vertical space equal to <literal>length</literal>.</para>
</sect1>
<sect1 label="19.10" id="\bigskip-\medskip-\smallskip">
<title><literal>\bigskip \medskip \smallskip</literal></title>
<para>These commands produce a given amount of space.</para>
<variablelist>
<varlistentry>
<term><literal>\bigskip</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\bigskip</primary></indexterm><indexterm role="fn"><primary>\bigskipamount</primary></indexterm>The same as <literal>\vspace{bigskipamount}</literal>, ordinarily about one line
space (with stretch and shrink).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\medskip</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\medskip</primary></indexterm><indexterm role="fn"><primary>\medskipamount</primary></indexterm>The same as <literal>\vspace{medskipamount}</literal>, ordinarily
about half of a line space (with stretch and shrink).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\smallskip</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\smallskip</primary></indexterm><indexterm role="fn"><primary>\smallskipamount</primary></indexterm>The same as <literal>\vspace{smallskipamount}</literal>, ordinarily about a
quarter of a line space (with stretch and shrink).</para>
</listitem>
</varlistentry>
</variablelist>
<para>The <literal>\...amount</literal> parameters are determined by the document class.</para>
</sect1>
<sect1 label="19.11" id="\vfill">
<title><literal>\vfill</literal></title>
<para><indexterm role="fn"><primary>\vfill</primary></indexterm>
The <literal>\vfill</literal> fill command produces a rubber length (glue) which
can stretch or shrink vertically as far as needed. It's equivalent to
<literal>\vspace{\fill}</literal> (see <xref linkend="\hfill"></xref>).</para>
</sect1>
<sect1 label="19.12" id="\vspace">
<title><literal>\vspace[*]{<replaceable>length</replaceable>}</literal></title>
<para><indexterm role="fn"><primary>\vspace</primary></indexterm>
Synopsis:</para>
<screen>
\vspace[*]{<replaceable>length</replaceable>}
</screen>
<para>The <literal>\vspace</literal> command adds the vertical space <replaceable>length</replaceable>, i.e.,
a rubber length. <replaceable>length</replaceable> can be negative or positive.</para>
<para>Ordinarily, &latex; removes vertical space added by <literal>\vspace</literal> at
the top or bottom of a page. With the optional <literal>*</literal> argument, the
space is not removed.</para>
</sect1>
</chapter>
<chapter label="20" id="Boxes">
<title>Boxes</title>
<para><indexterm role="cp"><primary>boxes</primary></indexterm>
All the predefined length parameters (see <xref linkend="Predefined-lengths"></xref>) can be
used in the arguments of the box-making commands.</para>
<sect1 label="20.1" id="\mbox">
<title><literal>\mbox{<replaceable>text}</replaceable></literal></title>
<para><indexterm role="fn"><primary>\mbox</primary></indexterm>
<indexterm role="cp"><primary>hyphenation, preventing</primary></indexterm>The <literal>\mbox</literal> command creates a box just wide enough to hold the
text created by its argument. The <replaceable>text</replaceable> is not broken into
lines, so it can be used to prevent hyphenation.</para>
</sect1>
<sect1 label="20.2" id="\fbox-and-\framebox">
<title><literal>\fbox</literal> and <literal>\framebox</literal></title>
<para><indexterm role="fn"><primary>\fbox</primary></indexterm><indexterm role="fn"><primary>\framebox</primary></indexterm>
Synopses:</para>
<screen>
\fbox{<replaceable>text</replaceable>}
\framebox[<replaceable>width</replaceable>][<replaceable>position</replaceable>]{<replaceable>text</replaceable>}
</screen>
<para>The <literal>\fbox</literal> and <literal>\framebox</literal> commands are like <literal>\mbox</literal>,
except that they put a frame around the outside of the box being created.</para>
<para>In addition, the <literal>\framebox</literal> command allows for explicit
specification of the box width with the optional <replaceable>width</replaceable> argument
(a dimension), and positioning with the optional <replaceable>position</replaceable>
argument.
<!-- xxref -->
<indexterm role="fn"><primary>\fboxrule</primary></indexterm><indexterm role="fn"><primary>\fboxsep</primary></indexterm>Both commands produce a rule of thickness <literal>\fboxrule</literal> (default
‘<literal>.4pt</literal>’), and leave a space of <literal>\fboxsep</literal> (default
‘<literal>3pt</literal>’) between the rule and the contents of the box.</para>
<para>See <xref linkend="\framebox-(picture)"></xref>, for the <literal>\framebox</literal> command in the
<literal>picture</literal> environment.</para>
</sect1>
<sect1 label="20.3" id="lrbox">
<title><literal>lrbox</literal></title>
<para><indexterm role="fn"><primary>lrbox</primary></indexterm>
<literal>\begin{lrbox}{cmd} text \end{lrbox}</literal></para>
<para>This is the environment form of <literal>\sbox</literal>.</para>
<para>The text inside the environment is saved in the box <literal>cmd</literal>, which
must have been declared with <literal>\newsavebox</literal>.</para>
</sect1>
<sect1 label="20.4" id="\makebox">
<title><literal>\makebox</literal></title>
<para><indexterm role="fn"><primary>\makebox</primary></indexterm>
Synopsis:</para>
<screen>
\makebox[<replaceable>width</replaceable>][<replaceable>position</replaceable>]{<replaceable>text</replaceable>}
</screen>
<para>The <literal>\makebox</literal> command creates a box just wide enough to contain
the <replaceable>text</replaceable> specified. The width of the box is specified by the
optional <replaceable>width</replaceable> argument. The position of the text within the box
is determined by the optional <replaceable>position</replaceable> argument, which may take
the following values:</para>
<variablelist>
<varlistentry>
<term><literal>c</literal></term>
<listitem>
<para>Centered (default).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>l</literal></term>
<listitem>
<para>Flush left.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>r</literal></term>
<listitem>
<para>Flush right.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>s</literal></term>
<listitem>
<para>Stretch (justify) across entire <replaceable>width</replaceable>; <replaceable>text</replaceable> must contain
stretchable space for this to work.</para>
</listitem>
</varlistentry>
</variablelist>
<para><literal>\makebox</literal> is also used within the picture environment
see <xref linkend="\makebox-(picture)"></xref>.</para>
</sect1>
<sect1 label="20.5" id="\parbox">
<title><literal>\parbox</literal></title>
<para><indexterm role="fn"><primary>\parbox</primary></indexterm>
Synopsis:</para>
<screen>
\parbox[<replaceable>position</replaceable>][<replaceable>height</replaceable>][<replaceable>inner-pos</replaceable>]{<replaceable>width</replaceable>}{<replaceable>text</replaceable>}
</screen>
<para>The <literal>\parbox</literal> command produces a box whose contents are created
in <literal>paragraph</literal> mode. It should be used to make a box small
pieces of text, with nothing fancy inside. In particular, you
shouldn't use any paragraph-making environments inside a
<literal>\parbox</literal> argument. For larger pieces of text, including ones
containing a paragraph-making environment, you should use a
<literal>minipage</literal> environment (see <xref linkend="minipage"></xref>).</para>
<para><literal>\parbox</literal> has two mandatory arguments:</para>
<variablelist>
<varlistentry>
<term><replaceable>width</replaceable></term>
<listitem>
<para>the width of the parbox;</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>text</replaceable></term>
<listitem>
<para>the text that goes inside the parbox.</para>
</listitem>
</varlistentry>
</variablelist>
<para>The optional <replaceable>position</replaceable> argument allows you to align either the
top or bottom line in the parbox with the baseline of the surrounding
text (default is top).</para>
<para>The optional <replaceable>height</replaceable> argument overrides the natural height of the box.</para>
<para>The <replaceable>inner-pos</replaceable> argument controls the placement of the text inside
the box, as follows; if it is not specified, <replaceable>position</replaceable> is used.</para>
<variablelist>
<varlistentry>
<term><literal>t</literal></term>
<listitem>
<para>text is placed at the top of the box.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>c</literal></term>
<listitem>
<para>text is centered in the box.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>b</literal></term>
<listitem>
<para>text is placed at the bottom of the box.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>s</literal></term>
<listitem>
<para>stretch vertically; the text must contain vertically stretchable space
for this to work.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 label="20.6" id="\raisebox">
<title><literal>\raisebox</literal></title>
<para><indexterm role="fn"><primary>\raisebox</primary></indexterm>
Synopsis:</para>
<screen>
\raisebox{distance}[<replaceable>height</replaceable>][<replaceable>depth</replaceable>]{text}
</screen>
<para>The <literal>\raisebox</literal> command raises or lowers <replaceable>text</replaceable>. The first
mandatory argument specifies how high <replaceable>text</replaceable> is to be raised (or
lowered if it is a negative amount). <replaceable>text</replaceable> itself is processed
in LR mode.</para>
<para>The optional arguments <replaceable>height</replaceable> and <replaceable>depth</replaceable> are dimensions.
If they are specified, &latex; treats <replaceable>text</replaceable> as extending a
certain distance above the baseline (height) or below (depth),
ignoring its natural height and depth.</para>
</sect1>
<sect1 label="20.7" id="\savebox">
<title><literal>\savebox</literal></title>
<para><indexterm role="fn"><primary>\savebox</primary></indexterm>
Synopsis:</para>
<screen>
\savebox{<replaceable>\boxcmd</replaceable>}[<replaceable>width</replaceable>][<replaceable>pos</replaceable>]{<replaceable>text</replaceable>}
</screen>
<para>This command typeset <replaceable>text</replaceable> in a box just as with <literal>\makebox</literal>
(see <xref linkend="\makebox"></xref>), except that instead of printing the resulting box,
it saves it in the box labeled <replaceable>\boxcmd</replaceable>, which must have been
declared with <literal>\newsavebox</literal> (see <xref linkend="\newsavebox"></xref>).</para>
</sect1>
<sect1 label="20.8" id="\sbox">
<title><literal>\sbox{<replaceable>\boxcmd</replaceable>}{<replaceable>text</replaceable>}</literal></title>
<para><indexterm role="fn"><primary>\sbox</primary></indexterm>
Synopsis:</para>
<screen>
\sbox{<replaceable>\boxcmd</replaceable>}{<replaceable>text</replaceable>}
</screen>
<para><literal>\sbox</literal> types <replaceable>text</replaceable> in a box just as with <literal>\mbox</literal>
(see <xref linkend="\mbox"></xref>) except that instead of the resulting box being
included in the normal output, it is saved in the box labeled
<replaceable>\boxcmd</replaceable>. <replaceable>\boxcmd</replaceable> must have been previously declared with
<literal>\newsavebox</literal> (see <xref linkend="\newsavebox"></xref>).</para>
</sect1>
<sect1 label="20.9" id="\usebox">
<title><literal>\usebox{<replaceable>\boxcmd</replaceable></literal></title>
<para><indexterm role="fn"><primary>\usebox</primary></indexterm>
Synopsis:</para>
<screen>
\usebox{<replaceable>\boxcmd</replaceable>}
</screen>
<para><literal>\usebox</literal> producesthe box most recently saved in the bin
<replaceable>\boxcmd</replaceable> by a <literal>\savebox</literal> command (see <xref linkend="\savebox"></xref>).</para>
</sect1>
</chapter>
<chapter label="21" id="Special-insertions">
<title>Special insertions</title>
<para>&latex; provides commands for inserting characters that have a
special meaning do not correspond to simple characters you can type.</para>
<sect1 label="21.1" id="Reserved-characters">
<title>Reserved characters</title>
<para><indexterm role="cp"><primary>reserved characters</primary></indexterm><indexterm role="cp"><primary>characters, reserved</primary></indexterm>
The following characters play a special role in &latex; and are called
“reserved characters” or “special characters”.</para>
<screen>
# $ % & ~ _ ^ \ { }
</screen>
<para><indexterm role="fn"><primary>\#</primary></indexterm><indexterm role="fn"><primary>\$</primary></indexterm><indexterm role="fn"><primary>\%</primary></indexterm><indexterm role="fn"><primary>\&</primary></indexterm><indexterm role="fn"><primary>\_</primary></indexterm><indexterm role="fn"><primary>\{</primary></indexterm><indexterm role="fn"><primary>\}</primary></indexterm>Whenever you write one of these characters into your file, &latex;
will do something special. If you simply want the character to be
printed as itself, include a <literal>\</literal> in front of the character. For
example, <literal>\$</literal> will produce <literal>$</literal> in your output.</para>
<para><indexterm role="fn"><primary>\backslash</primary></indexterm>One exception to this rule is <literal>\</literal> itself, because <literal>\\</literal> has
its own special (context-dependent) meaning. A roman \ is produced by
typing <literal>$\backslash$</literal> in your file, and a typewriter <literal>\</literal> is
produced by using ‘<literal>\</literal>’ in a verbatim command (see <xref linkend="verbatim"></xref>).</para>
<para><indexterm role="fn"><primary>\~</primary></indexterm><indexterm role="fn"><primary>\^</primary></indexterm>Also, <literal>\~</literal> and <literal>\^</literal> place tilde and circumflex accents over
the following letter, as in õ and ô (see <xref linkend="Accents"></xref>); to get
a standalone <literal>~</literal> or <literal>^</literal>, you can again use a verbatim
command.</para>
<para><indexterm role="fn"><primary>\symbol</primary></indexterm><indexterm role="cp"><primary>accessing any character of a font</primary></indexterm>
Finally, you can access any character of the current font once you
know its number by using the <literal>\symbol</literal> command. For example, the
visible space character used in the <literal>\verb*</literal> command has the code
decimal 32, so it can be typed as <literal>\symbol{32}</literal>.</para>
<para>You can also specify octal numbers with <literal>'</literal> or hexadecimal numbers
with <literal>"</literal>, so the previous example could also be written as
<literal>\symbol{'40}</literal> or <literal>\symbol{"20}</literal>.</para>
</sect1>
<sect1 label="21.2" id="Text-symbols">
<title>Text symbols</title>
<para><indexterm role="cp"><primary>text symbols</primary></indexterm>&latex; provides commands to generate a number of non-letter symbols
in running text.</para>
<variablelist>
<varlistentry>
<term><literal>\copyright</literal></term>
<listitem>
<para><indexterm role="cp"><primary>copyright symbol</primary></indexterm>The copyright symbol, ©.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\dag</literal></term>
<listitem>
<para><indexterm role="cp"><primary>dagger, in text</primary></indexterm>The dagger symbol (in text).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\ddag</literal></term>
<listitem>
<para><indexterm role="cp"><primary>double dagger, in text</primary></indexterm>The double dagger symbol (in text).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\LaTeX</literal></term>
<listitem>
<para><indexterm role="cp"><primary>&latex; logo</primary></indexterm><indexterm role="cp"><primary>logo, &latex;</primary></indexterm>The &latex; logo.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\ldots</literal></term>
<listitem>
<para><indexterm role="cp"><primary>ellipsis</primary></indexterm>An ellipsis (three dots at the baseline): `…'. This
command also works in math mode.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\lq</literal></term>
<listitem>
<para><indexterm role="cp"><primary>left quote</primary></indexterm><indexterm role="cp"><primary>opening quote</primary></indexterm>Left (opening) quote: `.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\P</literal></term>
<listitem>
<para><indexterm role="cp"><primary>paragraph sign</primary></indexterm><indexterm role="cp"><primary>pilcrow</primary></indexterm>Paragraph sign (pilcrow).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\pounds</literal></term>
<listitem>
<para><indexterm role="cp"><primary>pounds symbol</primary></indexterm><indexterm role="cp"><primary>sterling symbol</primary></indexterm>English pounds sterling.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\rq</literal></term>
<listitem>
<para><indexterm role="cp"><primary>right quote</primary></indexterm><indexterm role="cp"><primary>closing quote</primary></indexterm>Right (closing) quote: '.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\S</literal></term>
<listitem>
<para><indexterm role="cp"><primary>section symbol</primary></indexterm>Section symbol.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\TeX</literal></term>
<listitem>
<para><indexterm role="cp"><primary>&tex; logo</primary></indexterm><indexterm role="cp"><primary>logo, &tex;</primary></indexterm>The &tex; logo.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 label="21.3" id="Accents">
<title>Accents</title>
<para><indexterm role="cp"><primary>accents</primary></indexterm><indexterm role="cp"><primary>characters, accented</primary></indexterm><indexterm role="cp"><primary>letters, accented</primary></indexterm>
&latex; has wide support for many of the world's scripts and
languages, through the <literal>babel</literal> package and related support. This
section does not attempt to cover all that support. It merely the
core &latex; commands for creating accented characters.</para>
<variablelist>
<varlistentry>
<term><literal>\"</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\" (umlaut accent)</primary></indexterm><indexterm role="cp"><primary>umlaut accent</primary></indexterm>Produces an umlaut, as in ö.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\'</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\' (acute accent)</primary></indexterm><indexterm role="cp"><primary>acute accent</primary></indexterm>Produces an acute accent, as in ó. In the <literal>tabbing</literal>
environment, pushes current column to the right of the previous column
(see <xref linkend="tabbing"></xref>).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\.</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\. (dot-over accent)</primary></indexterm><indexterm role="cp"><primary>dot accent</primary></indexterm><indexterm role="cp"><primary>dot-over accent</primary></indexterm>Produces a dot accent over the following, as in o..</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\=</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\= (macron accent)</primary></indexterm><indexterm role="cp"><primary>macron accent</primary></indexterm><indexterm role="cp"><primary>overbar accent</primary></indexterm><indexterm role="cp"><primary>bar-over accent</primary></indexterm>Produces a macron (overbar) accent over the following, as in o¯.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\^</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\^ (circumflex accent)</primary></indexterm><indexterm role="cp"><primary>circumflex accent</primary></indexterm><indexterm role="cp"><primary>hat accent</primary></indexterm>Produces a circumflex (hat) accent over the following, as in ô.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\`</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\` (grave accent)</primary></indexterm><indexterm role="cp"><primary>grave accent</primary></indexterm>Produces a grave accent over the following, as in ò. In the
<literal>tabbing</literal> environment, move following text to the right margin
(see <xref linkend="tabbing"></xref>).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\~</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\~ (tilde accent)</primary></indexterm><indexterm role="cp"><primary>tilde accent</primary></indexterm>Produces a tilde accent over the following, as in ñ.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\b</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\b (bar-under accent)</primary></indexterm><indexterm role="cp"><primary>bar-under accent</primary></indexterm>Produces a bar accent under the following, as in o_.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\c</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\c (cedilla accent)</primary></indexterm><indexterm role="cp"><primary>cedilla accent</primary></indexterm>Produces a cedilla accent under the following, as in
<!-- {c}. --></para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\d</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\d (dot-under accent)</primary></indexterm><indexterm role="cp"><primary>dot-under accent</primary></indexterm>Produces a dot accent under the following, as in .o.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\H</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\H (Hungarian umlaut accent)</primary></indexterm><indexterm role="cp"><primary>hungarian umlaut accent</primary></indexterm>Produces a long Hungarian umlaut accent over the following, as in o''.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\i</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\i (dotless i)</primary></indexterm><indexterm role="cp"><primary>dotless i</primary></indexterm>Produces a dotless i, as in `i'.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\j</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\j (dotless j)</primary></indexterm><indexterm role="cp"><primary>dotless j</primary></indexterm>Produces a dotless j, as in `j'.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\t</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\t (tie-after accent)</primary></indexterm><indexterm role="cp"><primary>tie-after accent</primary></indexterm>Produces a tie-after accent, as in `oo['.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\u</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\u (breve accent)</primary></indexterm><indexterm role="cp"><primary>breve accent</primary></indexterm>Produces a breve accent, as in `o('.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\v</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\v (breve accent)</primary></indexterm><indexterm role="cp"><primary>hacek accent</primary></indexterm><indexterm role="cp"><primary>check accent</primary></indexterm>Produces a hác<ek (check) accent, as in `o<'.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 label="21.4" id="Non-English-characters">
<title>Non-English characters</title>
<para><indexterm role="cp"><primary>special characters</primary></indexterm><indexterm role="cp"><primary>non-English characters</primary></indexterm><indexterm role="cp"><primary>characters, non-English</primary></indexterm><indexterm role="cp"><primary>letters, non-English</primary></indexterm>
Here are the basic &latex; commands for inserting characters commonly
used in languages other than English.</para>
<variablelist>
<varlistentry>
<term><literal>\aa</literal></term>
<term><literal>\AA</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\aa (å)</primary></indexterm><indexterm role="fn"><primary>\AA (Å)</primary></indexterm><indexterm role="cp"><primary>aring</primary></indexterm>å and Å.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\ae</literal></term>
<term><literal>\AE</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\ae (æ)</primary></indexterm><indexterm role="fn"><primary>\AE (Æ)</primary></indexterm><indexterm role="cp"><primary>ae ligature</primary></indexterm>æ and Æ.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\l</literal></term>
<term><literal>\L</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\l (/l)</primary></indexterm><indexterm role="fn"><primary>\L (/L)</primary></indexterm><indexterm role="cp"><primary>polish l</primary></indexterm>/l and /L.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\o</literal></term>
<term><literal>\O</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\o (ø)</primary></indexterm><indexterm role="fn"><primary>\O (Ø)</primary></indexterm><indexterm role="cp"><primary>oslash</primary></indexterm>ø and Ø.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\oe</literal></term>
<term><literal>\OE</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\oe (œ)</primary></indexterm><indexterm role="fn"><primary>\OE (Œ)</primary></indexterm><indexterm role="cp"><primary>oe ligature</primary></indexterm>œ and Œ.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>\ss</literal></term>
<listitem>
<para><indexterm role="fn"><primary>\ss (ß)</primary></indexterm><indexterm role="cp"><primary>es-zet German letter</primary></indexterm><indexterm role="cp"><primary>sharp S letters</primary></indexterm>ß.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 label="21.5" id="\rule">
<title><literal>\rule</literal></title>
<para><indexterm role="fn"><primary>\rule</primary></indexterm>
Synopsis:</para>
<screen>
\rule[<replaceable>raise</replaceable>]{<replaceable>width</replaceable>}{<replaceable>thickness</replaceable>}
</screen>
<para>The <literal>\rule</literal> command produces <firstterm>rules</firstterm>, that is, lines or
rectangles. The arguments are:</para>
<variablelist>
<varlistentry>
<term><replaceable>raise</replaceable></term>
<listitem>
<para>How high to raise the rule (optional).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>width</replaceable></term>
<listitem>
<para>The length of the rule (mandatory).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>thickness</replaceable></term>
<listitem>
<para>The thickness of the rule (mandatory).</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 label="21.6" id="\today">
<title><literal>\today</literal></title>
<para><indexterm role="fn"><primary>\today</primary></indexterm>
The <literal>\today</literal> command produces today's date, in the format
‘<literal><replaceable>month</replaceable> <replaceable>dd</replaceable>, <replaceable>yyyy</replaceable></literal>’; for example, `July 4, 1976'.
It uses the predefined counters <literal>\day</literal>, <literal>\month</literal>, and
<literal>\year</literal> (see <xref linkend="\day-\month-\year"></xref>) to do this. It is not
updated as the program runs.</para>
<para><indexterm role="cp"><primary><literal>datetime</literal> package</primary></indexterm>The <literal>datetime</literal> package, among others, can produce a wide variety
of other date formats.</para>
</sect1>
</chapter>
<chapter label="22" id="Splitting-the-input">
<title>Splitting the input</title>
<para><indexterm role="cp"><primary>splitting the input file</primary></indexterm><indexterm role="cp"><primary>input file</primary></indexterm>
A large document requires a lot of input. Rather than putting the whole
input in a single large file, it's more efficient to split it into
several smaller ones. Regardless of how many separate files you use,
there is one that is the root file; it is the one whose name you type
when you run &latex;.</para>
<sect1 label="22.1" id="\include">
<title><literal>\include</literal></title>
<para><indexterm role="fn"><primary>\include</primary></indexterm>
Synopsis:</para>
<screen>
\include{<replaceable>file</replaceable>}
</screen>
<para>If no <literal>\includeonly</literal> command is present, the <literal>\include</literal>
command executes <literal>\clearpage</literal> to start a new page
(see <xref linkend="\clearpage"></xref>), then reads <replaceable>file</replaceable>, then does another
<literal>\clearpage</literal>.</para>
<para>Given an <literal>\includeonly</literal> command, the <literal>\include</literal> actions are
only run if <replaceable>file</replaceable> is listed as an argument to
<literal>\includeonly</literal>. See the next section.</para>
<para><indexterm role="cp"><primary>nested <literal>\include</literal>, not allowed</primary></indexterm>The <literal>\include</literal> command may not appear in the preamble or in a file
read by another <literal>\include</literal> command.</para>
</sect1>
<sect1 label="22.2" id="\includeonly">
<title>\<literal>includeonly</literal></title>
<para><indexterm role="fn"><primary>\includeonly</primary></indexterm>
Synopsis:</para>
<screen>
\includeonly{<replaceable>file1</replaceable>,<replaceable>file2</replaceable>,...}
</screen>
<para>The <literal>\includeonly</literal> command controls which files will be read by
subsequent <literal>\include</literal> commands. The list of filenames is
comma-separated. Each <replaceable>file</replaceable> must exactly match a filename
specified in a <literal>\include</literal> command for the selection to be
effective.</para>
<para>This command can only appear in the preamble.</para>
</sect1>
<sect1 label="22.3" id="\input">
<title>\input</title>
<para><indexterm role="fn"><primary>\input</primary></indexterm>
Synopsis:</para>
<screen>
\input{<replaceable>file</replaceable>}
</screen>
<para>The <literal>\input</literal> command causes the specified <replaceable>file</replaceable> to be read
and processed, as if its contents had been inserted in the current
file at that point.</para>
<para>If <replaceable>file</replaceable> does not end in ‘<literal>.tex</literal>’ (e.g., ‘<literal>foo</literal>’ or
‘<literal>foo.bar</literal>’), it is first tried with that extension (‘<literal>foo.tex</literal>’
or ‘<literal>foo.bar.tex</literal>’). If that is not found, the original <replaceable>file</replaceable>
is tried (‘<literal>foo</literal>’ or ‘<literal>foo.bar</literal>’).</para>
</sect1>
</chapter>
<chapter label="23" id="Front/back-matter">
<title>Front/back matter</title>
<sect1 label="23.1" id="Tables-of-contents">
<title>Tables of contents</title>
<para><indexterm role="cp"><primary>table of contents, creating</primary></indexterm>
<indexterm role="fn"><primary>\tableofcontents</primary></indexterm>A table of contents is produced with the <literal>\tableofcontents</literal>
command. You put the command right where you want the table of
contents to go; &latex; does the rest for you. A previous run must
have generated a <filename>.toc</filename> file.</para>
<para>The <literal>\tableofcontents</literal> command produces a heading, but it does
not automatically start a new page. If you want a new page after the
table of contents, write a <literal>\newpage</literal> command after the
<literal>\tableofcontents</literal> command.</para>
<para><indexterm role="fn"><primary>\listoffigures</primary></indexterm><indexterm role="fn"><primary>\listoftables</primary></indexterm>The analogous commands <literal>\listoffigures</literal> and <literal>\listoftables</literal>
produce a list of figures and a list of tables, respectively.
Everything works exactly the same as for the table of contents.</para>
<para><indexterm role="fn"><primary>\nofiles</primary></indexterm>The command <literal>\nofiles</literal> overrides these commands, and
<emphasis>prevents</emphasis> any of these lists from being generated.</para>
<sect2 label="23.1.1" id="\addcontentsline">
<title>\addcontentsline</title>
<para><indexterm role="fn"><primary>\addcontentsline{<replaceable>ext</replaceable>}{<replaceable>unit</replaceable>}{<replaceable>text</replaceable>}</primary></indexterm><indexterm role="cp"><primary>table of contents entry, manually adding</primary></indexterm>
The <literal>\addcontentsline</literal>{<replaceable>ext</replaceable>}{<replaceable>unit</replaceable>}{<replaceable>text</replaceable>}
command adds an entry to the specified list or table where:</para>
<variablelist>
<varlistentry>
<term><replaceable>ext</replaceable></term>
<listitem>
<para>The extension of the file on which information is to be written,
typically one of: <literal>toc</literal> (table of contents), <literal>lof</literal> (list of
figures), or <literal>lot</literal> (list of tables).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>unit</replaceable></term>
<listitem>
<para>The name of the sectional unit being added, typically one of the
following, matching the value of the <replaceable>ext</replaceable> argument:</para>
<variablelist>
<varlistentry>
<term><literal>toc</literal></term>
<listitem>
<para>The name of the sectional unit: <literal>part</literal>, <literal>chapter</literal>,
<literal>section</literal>, <literal>subsection</literal>, <literal>subsubsection</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>lof</literal></term>
<listitem>
<para>For the list of figures.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>lot</literal></term>
<listitem>
<para>For the list of tables.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>entry</replaceable></term>
<listitem>
<para>The actual text of the entry.</para>
</listitem>
</varlistentry>
</variablelist>
<para><indexterm role="fn"><primary>\contentsline</primary></indexterm>What is written to the <filename>.<replaceable>ext</replaceable></filename> file is the
command <literal>\contentsline{<replaceable>unit</replaceable>}{<replaceable>name</replaceable>}</literal>.</para>
<!-- ?? how hardwired are these values? other unit names? -->
</sect2>
<sect2 label="23.1.2" id="\addtocontents">
<title>\addtocontents</title>
<para><indexterm role="fn"><primary>\addtocontents{<replaceable>ext</replaceable>}{<replaceable>text</replaceable>}</primary></indexterm>
The <literal>\addtocontents</literal>{<replaceable>ext</replaceable>}{<replaceable>text</replaceable>} command adds text
(or formatting commands) directly to the <filename>.<replaceable>ext</replaceable></filename> file that
generates the table of contents or lists of figures or tables.</para>
<variablelist>
<varlistentry>
<term><replaceable>ext</replaceable></term>
<listitem>
<para>The extension of the file on which information is to be written:
<filename>toc</filename> (table of contents), <filename>lof</filename> (list of figures), or
<filename>lot</filename> (list of tables).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>text</replaceable></term>
<listitem>
<para>The text to be written.</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>
<sect1 label="23.2" id="Glossaries">
<title>Glossaries</title>
<para><indexterm role="cp"><primary>glossaries</primary></indexterm>
<indexterm role="fn"><primary>\makeglossary</primary></indexterm>The command <literal>\makeglossary</literal> enables creating glossaries.</para>
<para><indexterm role="fn"><primary>\glossary</primary></indexterm><indexterm role="cp"><primary><filename>.glo</filename> file</primary></indexterm>The command <literal>\glossary{<replaceable>text</replaceable>}</literal> writes a glossary entry for
<replaceable>text</replaceable> to an auxiliary file with the <filename>.glo</filename> extension.</para>
<para><indexterm role="fn"><primary>\glossaryentry</primary></indexterm>Specifically, what gets written is the command
<literal>\glossaryentry{<replaceable>text</replaceable>}{<replaceable>pageno</replaceable>}</literal>, where
<replaceable>pageno</replaceable> is the current <literal>\thepage</literal> value.</para>
<para>The <literal>glossary</literal> package on CTAN provides support for fancier
glossaries.</para>
</sect1>
<sect1 label="23.3" id="Indexes">
<title>Indexes</title>
<para><indexterm role="cp"><primary>indexes</primary></indexterm>
<indexterm role="fn"><primary>\makeindex</primary></indexterm>The command <literal>\makeindex</literal> enables creating indexes. Put this in
the preamble.</para>
<para><indexterm role="fn"><primary>\index</primary></indexterm><indexterm role="cp"><primary><filename>.idx</filename> file</primary></indexterm>The command <literal>\index{<replaceable>text</replaceable>}</literal> writes an index entry for
<replaceable>text</replaceable> to an auxiliary file with the <filename>.idx</filename> extension.</para>
<para><indexterm role="fn"><primary>\indexentry</primary></indexterm>Specifically, what gets written is the command
<literal>\indexentry{<replaceable>text</replaceable>}{<replaceable>pageno</replaceable>}</literal>, where <replaceable>pageno</replaceable>
is the current <literal>\thepage</literal> value.</para>
<para><indexterm role="cp"><primary>`see' and `see also' index entries</primary></indexterm>To generate a index entry for `bar' that says `See foo', use a
vertical bar: <literal>\index{bar|see{foo}}</literal>. Use <literal>seealso</literal>
instead of <literal>see</literal> to make a `See also' entry.</para>
<para><indexterm role="fn"><primary>\seename</primary></indexterm><indexterm role="fn"><primary>\alsoname</primary></indexterm>The text `See' is defined by the macro <literal>\seename</literal>, and `See also'
by the macro <literal>\alsoname</literal>. These can be redefined for other
languages.</para>
<para><indexterm role="cp"><primary><command>makeindex</command> program</primary></indexterm><indexterm role="cp"><primary><command>xindy</command> program</primary></indexterm><indexterm role="cp"><primary><filename>.ind</filename> file</primary></indexterm>The generated <filename>.idx</filename> file is then sorted with an external
command, usually either <command>makeindex</command>
(<ulink url="http://mirror.ctan.org/indexing/makeindex">http://mirror.ctan.org/indexing/makeindex</ulink>) or (the
multi-lingual) <command>xindy</command> (<ulink url="http://xindy.sourceforge.net">http://xindy.sourceforge.net</ulink>).
This results in a <filename>.ind</filename> file, which can then be read to typeset
the index.</para>
<para><indexterm role="fn"><primary>printindex</primary></indexterm><indexterm role="cp"><primary><literal>makeidx</literal> package</primary></indexterm>The index is usually generated with the <literal>\printindex</literal> command.
This is defined in the <literal>makeidx</literal> package, so
<literal>\usepackage{makeidx}</literal> needs to be in the preamble.</para>
<para><indexterm role="fn"><primary>indexspace</primary></indexterm>The rubber length <literal>\indexspace</literal> is inserted before each new
letter in the printed index; its default value is ‘<literal>10pt plus5pt
minus3pt</literal>’.</para>
<para><indexterm role="cp"><primary><literal>showidx</literal> package</primary></indexterm>The <literal>showidx</literal> package causes each index entries to be shown in
the margin on the page where the entry appears. This can help in
preparing the index.</para>
<para><indexterm role="cp"><primary><literal>multind</literal> package</primary></indexterm>The <literal>multind</literal> package supports multiple indexes. See also the
&tex; FAQ entry on this topic,
<ulink url="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=multind">http://www.tex.ac.uk/cgi-bin/texfaq2html?label=multind</ulink>.</para>
</sect1>
</chapter>
<chapter label="24" id="Letters">
<title>Letters</title>
<para><indexterm role="cp"><primary>letters</primary></indexterm><indexterm role="cp"><primary>creating letters</primary></indexterm>
You can use &latex; to typeset letters, both personal and business. The
<literal>letter</literal> document class is designed to make a number of letters at
once, although you can make just one if you so desire.</para>
<para>Your <filename>.tex</filename> source file has the same minimum commands as the other
document classes, i.e., you must have the following commands as a
minimum:</para>
<screen>
\documentclass{letter}
\begin{document}
... letters ...
\end{document}
</screen>
<para>Each letter is a <literal>letter</literal> environment, whose argument is the name
and address of the recipient. For example, you might have:</para>
<screen>
\begin{letter}{Mr. Joe Smith\\ 2345 Princess St.
\\ Edinburgh, EH1 1AA}
...
\end{letter}
</screen>
<para>The letter itself begins with the <literal>\opening</literal> command. The text of
the letter follows. It is typed as ordinary &latex; input. Commands that
make no sense in a letter, like <literal>\chapter</literal>, do not work. The letter
closes with a <literal>\closing</literal> command.</para>
<para><indexterm role="fn"><primary>\\ for letters</primary></indexterm>After the <literal>closing</literal>, you can have additional material. The
<literal>\cc</literal> command produces the usual “cc: …”. There's also a
similar <literal>\encl</literal> command for a list of enclosures. With both these
commands, use <literal>\\</literal> to separate the items.</para>
<para>These commands are used with the <literal>letter</literal> class.</para>
<sect1 label="24.1" id="\address">
<title>\address{<replaceable>return-address}</replaceable></title>
<para><indexterm role="fn"><primary>\address</primary></indexterm>
The <literal>\address</literal> specifies the return address of a letter, as it
should appear on the letter and the envelope. Separate lines of the
address should be separated by <literal>\\</literal> commands.</para>
<para>If you do not make an <literal>\address</literal> declaration, then the letter
will be formatted for copying onto your organisation's standard
letterhead. (See <xref linkend="Overview"></xref>, for details on your local
implementation). If you give an <literal>\address</literal> declaration, then the
letter will be formatted as a personal letter.</para>
</sect1>
<sect1 label="24.2" id="\cc">
<title><literal>\cc</literal></title>
<para><indexterm role="fn"><primary>\cc</primary></indexterm><indexterm role="cp"><primary>cc list, in letters</primary></indexterm>
Synopsis:</para>
<screen>
\cc{<replaceable>name1</replaceable>\\<replaceable>name2</replaceable>}
</screen>
<para>Produce a list of <replaceable>name</replaceable>s the letter was copied to. Each name is
printed on a separate line.</para>
</sect1>
<sect1 label="24.3" id="\closing">
<title><literal>\closing</literal></title>
<para><indexterm role="fn"><primary>\closing</primary></indexterm><indexterm role="cp"><primary>letters, ending</primary></indexterm><indexterm role="cp"><primary>closing letters</primary></indexterm>
Synopsis:</para>
<screen>
\closing{text}
</screen>
<para>A letter closes with a <literal>\closing</literal> command, for example,</para>
<screen>
\closing{Best Regards,}
</screen>
</sect1>
<sect1 label="24.4" id="\encl">
<title><literal>\encl</literal></title>
<para><indexterm role="fn"><primary>\encl</primary></indexterm><indexterm role="cp"><primary>enclosure list</primary></indexterm>
Synopsis:</para>
<screen>
\encl{<replaceable>line1</replaceable>\\<replaceable>line2</replaceable>}
</screen>
<para>Declare a list of one more enclosures.</para>
</sect1>
<sect1 label="24.5" id="\location">
<title><literal>\location</literal></title>
<para><indexterm role="fn"><primary>\location</primary></indexterm>
<literal>\location{address}</literal></para>
<para>This modifies your organisation's standard address. This only appears
if the <literal>firstpage</literal> pagestyle is selected.</para>
</sect1>
<sect1 label="24.6" id="\makelabels">
<title><literal>\makelabels</literal></title>
<para><indexterm role="fn"><primary>\makelabels</primary></indexterm>
<literal>\makelabels{number}</literal></para>
<para>If you issue this command in the preamble, &latex; will create a sheet of
address labels. This sheet will be output before the letters.</para>
</sect1>
<sect1 label="24.7" id="\name">
<title><literal>\name</literal></title>
<para><indexterm role="fn"><primary>\name</primary></indexterm>
<literal>\name{June Davenport}</literal></para>
<para>Your name, used for printing on the envelope together with the return
address.</para>
</sect1>
<sect1 label="24.8" id="\opening">
<title><literal>\opening{<replaceable>text</replaceable>}</literal></title>
<para><indexterm role="fn"><primary>\opening</primary></indexterm><indexterm role="cp"><primary>letters, starting</primary></indexterm>
Synopsis:</para>
<screen>
\opening{<replaceable>text</replaceable>}
</screen>
<para>A letter begins with the <literal>\opening</literal> command. The mandatory
argument, <replaceable>text</replaceable>, is whatever text you wish to start your letter.
For instance:</para>
<screen>
\opening{Dear Joe,}
</screen>
</sect1>
<sect1 label="24.9" id="\ps">
<title><literal>\ps</literal></title>
<para><indexterm role="fn"><primary>\ps</primary></indexterm><indexterm role="cp"><primary>postscript, in letters</primary></indexterm>
Use the <literal>\ps</literal> command to start a postscript in a letter, after
<literal>\closing</literal>.</para>
</sect1>
<sect1 label="24.10" id="\signature">
<title><literal>\signature{<replaceable>text</replaceable>}</literal></title>
<para><indexterm role="fn"><primary>\signature</primary></indexterm>
Your name, as it should appear at the end of the letter underneath the
space for your signature. <literal>\\</literal> starts a new line within
<replaceable>text</replaceable> as usual.</para>
</sect1>
<sect1 label="24.11" id="\startbreaks">
<title><literal>\startbreaks</literal></title>
<para><indexterm role="fn"><primary>\startbreaks</primary></indexterm>
<literal>\startbreaks</literal></para>
<para>Used after a <literal>\stopbreaks</literal> command to allow page breaks again.</para>
</sect1>
<sect1 label="24.12" id="\stopbreaks">
<title><literal>\stopbreaks</literal></title>
<para><indexterm role="fn"><primary>\stopbreaks</primary></indexterm>
<literal>\stopbreaks</literal></para>
<para>Inhibit page breaks until a <literal>\startbreaks</literal> command occurs.</para>
</sect1>
<sect1 label="24.13" id="\telephone">
<title><literal>\telephone</literal></title>
<para><indexterm role="fn"><primary>\telephone</primary></indexterm>
<literal>\telephone{number}</literal></para>
<para>This is your telephone number. This only appears if the
<literal>firstpage</literal> pagestyle is selected.</para>
</sect1>
</chapter>
<chapter label="25" id="Terminal-Input/Output">
<title>Terminal Input/Output</title>
<para><indexterm role="cp"><primary>input/Output</primary></indexterm><indexterm role="cp"><primary>terminal Input/Output</primary></indexterm></para>
<sect1 label="25.1" id="\typein">
<title><literal>\typein[<replaceable>cmd</replaceable>]{<replaceable>msg</replaceable>}</literal></title>
<para><indexterm role="fn"><primary>\typein</primary></indexterm>
Synopsis:</para>
<screen>
\typein[<replaceable>\cmd</replaceable>]{<replaceable>msg</replaceable>}
</screen>
<para><literal>\typein</literal> prints <replaceable>msg</replaceable> on the terminal and causes &latex; to
stop and wait for you to type a line of input, ending with return. If
the optional <replaceable>\cmd</replaceable> argument is omitted, the typed input is
processed as if it had been included in the input file in place of the
<literal>\typein</literal> command. If the <replaceable>\cmd</replaceable> argument is present, it
must be a command name. This command name is then defined or
redefined to be the typed input.</para>
</sect1>
<sect1 label="25.2" id="\typeout">
<title><literal>\typeout{<replaceable>msg</replaceable>}</literal></title>
<para><indexterm role="fn"><primary>\typeout</primary></indexterm>
Synopsis:</para>
<screen>
\typeout{<replaceable>msg</replaceable>}
</screen>
<para>Prints <literal>msg</literal> on the terminal and in the <literal>log</literal> file.
Commands in <literal>msg</literal> that are defined with <literal>\newcommand</literal> or
<literal>\renewcommand</literal> (among others) are replaced by their definitions
before being printed.</para>
<para>&latex;'s usual rules for treating multiple spaces as a single space
and ignoring spaces after a command name apply to <literal>msg</literal>. A
<literal>\space</literal> command in <literal>msg</literal> causes a single space to be
printed, independent of surrounding spaces. A <literal>^^J</literal> in
<literal>msg</literal> prints a newline.</para>
</sect1>
</chapter>
<chapter label="26" id="Command-Line">
<title>Command Line</title>
<para><indexterm role="cp"><primary>command Line</primary></indexterm>
The input file specification indicates the file to be formatted;
&tex; uses <filename>.tex</filename> as a default file extension. If you omit the
input file entirely, &tex; accepts input from the terminal. You
specify command options by supplying a string as a parameter to the
command; e.g.</para>
<screen>
latex '\nonstopmode\input foo.tex'
</screen>
<para role="continues">will process <filename>foo.tex</filename> without pausing after every error.</para>
<para><indexterm role="cp"><primary>‘<literal>*</literal>’ prompt</primary></indexterm><indexterm role="cp"><primary>prompt, ‘<literal>*</literal>’</primary></indexterm><indexterm role="fn"><primary>\stop</primary></indexterm>If &latex; stops in the middle of the document and gives you a
‘<literal>*</literal>’ prompt, it is waiting for input. You can type <literal>\stop</literal>
(and return) and it will prematurely end the document.</para>
</chapter>
<appendix id="Document-templates">
<title>Document templates</title>
<para><indexterm role="cp"><primary>document templates</primary></indexterm>
Although not reference material, perhaps these document templates will
be useful.</para>
<sect1 id="book-template">
<title><literal>book</literal> template</title>
<screen>\documentclass{book}
\title{Book Class Template}
\author{Alex Author}
\begin{document}
\maketitle
\chapter{First}
Some text.
\chapter{Second}
Some other text.
\section{A subtopic}
The end.
\end{document}
</screen>
</sect1>
<sect1 id="beamer-template">
<title><literal>beamer</literal> template</title>
<para>The <literal>beamer</literal> class creates slides presentations.</para>
<screen>\documentclass{beamer}
\title{Beamer Class template}
\author{Alex Author}
\date{July 31, 2007}
\begin{document}
\maketitle
% without [fragile], any {verbatim} code gets mysterious errors.
\begin{frame}[fragile]
\frametitle{First Slide}
\begin{verbatim}
This is \verbatim!
\end{verbatim}
\end{frame}
\end{document}
</screen>
</sect1>
<sect1 id="tugboat-template">
<title><literal>tugboat</literal> template</title>
<para><citetitle>TUGboat</citetitle> is the journal of the &tex; Users Group,
<ulink url="http://tug.org/TUGboat">http://tug.org/TUGboat</ulink>.</para>
<screen>\documentclass{ltugboat} % ltugproc for proceedings
\usepackage{graphicx}
\usepackage{ifpdf}
\ifpdf
\usepackage[breaklinks,colorlinks,linkcolor=black,citecolor=black,
urlcolor=black]{hyperref}
\else
\usepackage{url}
\fi
\begin{document}
\title{Example \TUB\ Regular Article}
% repeat info for each author.
\author{First Last}
\address{Street Address \\ Town, Postal \\ Country}
\netaddress{user (at) example dot org}
\personalURL{http://example.org/~user/}
\maketitle
% The abstract comes after \maketitle in ltugboat.
\begin{abstract}
This is an example article for a regular \TUB{} issue.
\end{abstract}
\section{Introduction}
This is an example article for \TUB, from
\url{http://tug.org/TUGboat/location.html}.
We recommend the graphicx package for image inclusions, and the hyperref
package for active url's (in the \acro{PDF} output). \TUB\ is produced
using \acro{PDF} files exclusively, nowadays.
The \texttt{ltug*} classes provide these abbreviations, among many others:
{\small
\begin{verbatim}
\AllTeX \AMS \AmS \AmSLaTeX \AmSTeX \aw \AW
\BibTeX \CandT \CTAN \DTD \DVItoVDU \HTML
\ISBN \ISSN \JTeX \JoT \LAMSTeX \LaTeXe
\Mc \mf \MFB \mtex \pcMF \PCTeX \pcTeX \Pas
\PiC \PiCTeX \plain \POBox \PS
\SC \SGML \SliTeX \TANGLE \TB \TP \TUB \TUG
\tug \UG \UNIX \VAX \VorTeX \XeT \WEB \WEAVE
\Dash \dash \vellipsis \bull \cents \Dag
\careof \thinskip
\acro{FRED} -> {\sc fred} % please use!
\cs{fred} -> \fred
\env{fred} -> \begin{fred}
\meta{fred} -> <fred>
\nth{n} -> 1st, 2nd, ...
\sfrac{3/4} -> 3/4
\booktitle{Book of Fred}
\end{verbatim}
}
For more information, see the ltubguid document at:
\url{http://mirror.ctan.org/macros/latex/contrib/tugboat}
Email \verb|tugboat@tug.org| if problems or questions.
\bibliographystyle{plain} % we recommend the plain bibliography style
\nocite{book-minimal} % just making the bibliography non-empty
\bibliography{xampl} % xampl.bib comes with BibTeX
\makesignature % not in ltugproc
\end{document}
</screen>
</sect1>
</appendix>
<chapter label="" xreflabel="Concept Index" id="Concept-Index">
<title>Concept Index</title>
<index></index>
<!-- The name of the `Command Index' node must NOT be altered for ltx-help.el. -->
</chapter>
<chapter label="" xreflabel="Command Index" id="Command-Index">
<title>Command Index</title>
<index></index>
</chapter>
</book><!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-indent-step:1
sgml-indent-data:nil
End:
-->
|