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
|
\input texinfo @c -*-texinfo-*-
@c TODO More math symbols
@c $Id: latex2e.texi,v 1.216 1996/04/23 10:39:54 torsten Exp $
@tex
\gdef\LaTeX{{\rm L\kern-.36em\raise.3ex\hbox{\sc a}\kern-.15em%
T\kern-.1667em\lower.7ex\hbox{E}\kern-.125emX\kern.125em}}
\gdef\LaTeXe{{\rm L\kern-.36em\raise.3ex\hbox{\sc a}\kern-.15em%
T\kern-.1667em\lower.7ex\hbox{E}\kern-.125emX\kern.125em
2${}_{\textstyle\varepsilon}$}}
@end tex
@comment %**start of header (This is for running Texinfo on a region.)
@setfilename latex
@ifinfo
@settitle LaTeX2e help 1.6
@end ifinfo
@iftex
@settitle @LaTeXe help 1.6
@end iftex
@comment %**end of header (This is for running Texinfo on a region.)
@iftex
@finalout
@end iftex
@ifinfo
This file documents LaTeX2e, a document preparation system. LaTeX2e is a
macro package for TeX.
This is edition 1.6 of the LaTeX2e documentation, and is for the Texinfo
that is distributed as part of Version 19 of GNU Emacs. It uses version
2.134 or later of the texinfo.tex input file.
This is translated from LATEX.HLP 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 <stg@@dcs.ed.ac.uk>.
The LaTeX2e version was adapted from this by Torsten Martinsen
<bullestock@@dk-online.dk>.
Copyright 1988,1994 Free Software Foundation, Inc.
Copyright 1994-1996 Torsten Martinsen.
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.
@ignore
Permission is granted to process this file through TeX and print the
results, provided the printed document carries copying permission
notice identical to this one except for the removal of this paragraph
(this paragraph not being relevant to the printed manual).
@end ignore
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.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that the sections entitled ``Distribution'' and ``General Public
License'' may be included in a translation approved by the author instead
of in the original English.
@end ifinfo
@setchapternewpage odd
@titlepage
@sp 11
@comment A hack to get the LaTeX logo to appear big in the title.
@tex
\font\tempA = cmr10 scaled \magstep4
\font\tempB = cmr8 scaled \magstep4
\centerline{\tempA L\kern-.36em\raise.3ex\hbox{\tempB A}\kern-.15em%
T\kern-.1667em\lower.7ex\hbox{E}\kern-.125emX\kern.15em
2${}_{\textstyle\varepsilon}$}
@end tex
@sp 2
@center The macro package for @TeX
@sp 2
@center by
@center Leslie Lamport et al.
@sp 2
@center Edition 1.6
@sp 2
@center December 1994
@comment Include the Distribution inside the titlepage environment so
@comment that headings are turned off.
@page
@vskip 0pt plus 1filll
This is edition 1.6 of the LaTeX2e documentation, and is for the Texinfo
that is distributed as part of Version 19 of GNU Emacs. It uses version
2.134 or later of the @file{texinfo.tex} input file.
This is translated from LATEX.HLP v1.0a in the VMS Help Library.
This pre-translation version was written by George D. Greenwade of
Sam Houston State University. It has been edited to this form by Paul
Nothard of Edinburgh University.
The original (latex.texi and latex2.texi) was distributed by
Stephen Gilmore <stg@@dcs.ed.ac.uk>, August 26th 1993.
Version 1.1 was made by Piet van Oostrum <piet@@cs.ruu.nl> on Dec 14,
1993 by merging and cleaning up latex.texi and latex2.texi.
Versions 1.2 trough 1.6 by Torsten Martinsen <bullestock@@dk-online.dk>.
@sp 2
This Texinfo file may be copied and distributed in accordance with the
usual copying permissions of the Free Software Foundation. These
permissions are given in the General Public License section of the ``GNU
Emacs Manual''. This software comes with NO WARRANTY.
@sp 2
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.
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.
@end titlepage
@c The name of the `Command Index' node must NOT be altered
@c if ltx-help.el is to work
@node Top, Overview, (dir), (dir)
LaTeX2e is a document preparation system implemented as a macro package
for Donald E. Knuth's TeX typesetting program.
LaTeX was originally conceived by Leslie Lamport.
This is edition 1.6 of the LaTeX2e documentation.
@menu
* Overview:: What is LaTeX?
* Commands:: Commands within a LaTeX document.
* Parameters:: The command line.
* Command Index:: An alphabetical list of LaTeX commands.
* Concept Index:: An alphabetical list of concepts.
@end menu
@comment ****************************************
@comment ************** OVERVIEW ****************
@comment ****************************************
@comment LEVEL1
@node Overview, Commands, Top, Top
@comment node-name, next, previous, up
@chapter Overview of LaTeX and Local Guide
@cindex Overview of LaTeX
@cindex LaTeX overview
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:
@enumerate
@item
A ``Device Independent'', or @file{.dvi} file. This contains commands that
can be translated into commands for a variety of output devices. You
can view the output of LaTeX by using a program such as @code{xdvi},
which actually uses the @file{.dvi} file.
@item
A ``transcript'' or @file{.log} file that contains summary information and
diagnostic messages for any errors discovered in the input file.
@item
An ``auxiliary'' or @file{.aux} file. This is used by LaTeX itself, for
things such as sectioning.
@end enumerate
For a description of what goes on inside TeX, you should consult
@cite{The TeXbook} by Donald E. Knuth, ISBN 0-201-13448-9, published
jointly by the American Mathematical Society and Addison-Wesley
Publishing Company.
For a description of LaTeX, you should consult:
@cite{LaTeX: A Document Preparation System}, by Leslie Lamport,
Addison-Wesley Publishing Company, 2nd edition, 1994.
@cite{The LaTeX Companion}, by Michel Goossens, Frank Mittelbach, and
Alexander Samarin, Addison-Wesley, 1994.
@comment ****************************************
@comment ************** COMMANDS ****************
@comment ****************************************
@comment LEVEL1
@node Commands, Parameters, Overview, Top
@comment node-name, next, previous, up
@chapter Commands
A LaTeX command begins with the command name, which consists of a
@code{\} followed by either (a) a string of letters or (b) a single
non-letter. Arguments contained in square brackets, @code{[]}, are
optional while arguments contained in braces, @code{@{@}}, are required.
NOTE: LaTeX is case sensitive. Enter all commands in lower case
unless explicitly directed to do otherwise.
@menu
* Counters:: Internal counters used by LaTeX.
* Cross References:: Automatic referencing.
* Definitions:: Define your own commands etc.
* Document Classes:: Some of the various classes available.
* Environments:: Such as enumerate & itemize.
* Footnotes:: How to produce footnotes.
* Layout:: Controlling the page layout.
* Lengths:: The length commands.
* Letters:: The letter class.
* Line & Page Breaking:: How to insert pagebreaks etc.
* Making Paragraphs:: Paragraph commands.
* Margin Notes:: Putting remarks in the margin.
* Math Formulae:: How to create mathematical formulae.
* Modes:: Paragraph, Math or LR modes.
* Page Styles:: Various styles of page layout.
* Sectioning:: How to section properly.
* Spaces & Boxes:: All the associated commands.
* Special Characters:: Special reserved characters.
* Splitting the Input:: Dealing with big files by splitting.
* Starting & Ending:: The formal start & end layouts.
* Table of Contents:: How to create a table of contents.
* Terminal Input/Output:: User interaction.
* Typefaces:: Such as bold, italics etc.
@end menu
@comment ***************************************
@comment **** Command's LEVEL2 Starts Here. ****
@comment ***************************************
@comment *************************
@comment ******* Counters ********
@comment *************************
@comment LEVEL2
@node Counters, Cross References, Commands, Commands
@comment node-name, next, previous, up
@section Counters
@cindex Counters, a list of
@cindex Variables, a list of
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 @code{\}. (enumi -
enumiv are used for the nested enumerate environment.) Below is a list
of the counters used in LaTeX's standard document classes to control
numbering.
@example
part paragraph figure enumi
chapter subparagraph table enumii
section page footnote enumiii
subsection equation mpfootnote enumiv
subsubsection
@end example
@menu
* \addtocounter:: Add a quantity to a counter.
* \alph:: Print value of a counter using letters.
* \arabic:: Print value of a counter using numerals.
* \fnsymbol:: Print value of a counter using symbols.
* \newcounter:: Define a new counter.
* \refstepcounter:: Add to counter, resetting subsidiary counters.
* \roman:: Print value of a counter using roman numerals.
* \setcounter:: Set the value of a counter.
* \stepcounter:: Add to counter, resetting subsidiary counters.
* \usecounter:: Use a specified counter in a list environment.
* \value:: Use the value of a counter in an expression.
@end menu
@comment *******************
@comment ** \addtocounter **
@comment *******************
@comment LEVEL3
@node \addtocounter, \alph, Counters, Counters
@comment node-name, next, previous, up
@subsection \addtocounter
@findex \addtocounter
@code{\addtocounter@{counter@}@{value@}}
The @code{\addtocounter} command increments the @code{counter} by the
amount specified by the @code{value} argument. The @code{value}
argument can be negative.
@comment ************
@comment ** \alph ***
@comment ************
@comment LEVEL3
@node \alph, \arabic, \addtocounter, Counters
@comment node-name, next, previous, up
@subsection \alph
@findex \alph
@findex \Alph
@code{\alph@{counter@}}
This command causes the value of the @code{counter} to be printed in
alphabetic characters. The @code{\alph} command uses lower case
alphabetic alphabetic characters, i.e., @code{a, b, c...} while the
@code{\Alph} command uses upper case alphabetic characters, i.e.,
@code{A, B, C...}.
@comment **************
@comment ** \arabic ***
@comment **************
@comment LEVEL3
@node \arabic, \fnsymbol, \alph, Counters
@comment node-name, next, previous, up
@subsection \arabic
@findex \arabic
@code{\arabic@{counter@}}
The @code{\arabic} command causes the value of the @code{counter} to be
printed in Arabic numbers, i.e., @code{3}.
@comment ***************
@comment ** \fnsymbol **
@comment ***************
@comment LEVEL3
@node \fnsymbol, \newcounter, \arabic, Counters
@comment node-name, next, previous, up
@subsection \fnsymbol
@findex \fnsymbol
@code{\fnsymbol@{counter@}}
The @code{\fnsymbol} command causes the value of the @code{counter} to
be printed in a specific sequence of nine symbols that can be used for
numbering footnotes.
@iftex
eg. From 1-9:
@tex
$\ast$ $\dagger$ $\ddagger$ $\S$ $\P$ $\parallel$ $\ast \ast$ $\dagger
\dagger$ $\ddagger \ddagger$
@end tex
@end iftex
NB. @code{counter} must have a value between 1 and 9 inclusive.
@comment *****************
@comment ** \newcounter **
@comment *****************
@comment LEVEL3
@node \newcounter, \refstepcounter, \fnsymbol, Counters
@comment node-name, next, previous, up
@subsection \newcounter
@findex \newcounter
@cindex Counters, creating
@code{\newcounter@{foo@}[counter]}
The @code{\newcounter} command defines a new counter named @code{foo}.
The counter is initialized to zero.
The optional argument @code{[counter]} causes the counter @code{foo} to
be reset whenever the counter named in the optional argument is
incremented.
@comment *****************
@comment ** \refstepcounter **
@comment *****************
@comment LEVEL3
@node \refstepcounter, \roman, \newcounter, Counters
@comment node-name, next, previous, up
@subsection \refstepcounter
@findex \refstepcounter
@code{\refstepcounter@{counter@}}
The @code{\refstepcounter} command works like @code{\stepcounter}
@xref{\stepcounter}, except it also defines the current @code{\ref}
value to be the result of @code{\thecounter}.
@comment ************
@comment ** \roman **
@comment ************
@comment LEVEL3
@node \roman, \stepcounter, \refstepcounter, Counters
@comment node-name, next, previous, up
@subsection \roman
@findex \roman
@findex \Roman
@code{\roman@{counter@}}
This command causes the value of the @code{counter} to be printed in
Roman numerals. The @code{\roman} command uses lower case Roman
numerals, i.e., @code{i, ii, iii...}, while the @code{\Roman} command
uses upper case Roman numerals, i.e., @code{I, II, III...}.
@comment *****************
@comment ** \stepcounter **
@comment *****************
@comment LEVEL3
@node \stepcounter, \setcounter, \roman, Counters
@comment node-name, next, previous, up
@subsection \stepcounter
@findex \stepcounter
@code{\stepcounter@{counter@}}
The @code{\stepcounter} command adds one to the @code{counter} and
resets all subsidiary counters.
@comment *****************
@comment ** \setcounter **
@comment *****************
@comment LEVEL3
@node \setcounter, \usecounter, \stepcounter, Counters
@comment node-name, next, previous, up
@subsection \setcounter
@findex \setcounter
@cindex Counters, setting
@code{\setcounter@{counter@}@{value@}}
The @code{\setcounter} command sets the value of the @code{counter} to
that specified by the @code{value} argument.
@comment *****************
@comment ** \usecounter **
@comment *****************
@comment LEVEL3
@node \usecounter, \value, \setcounter, Counters
@comment node-name, next, previous, up
@subsection \usecounter
@findex \usecounter
@code{\usecounter@{counter@}}
The @code{\usecounter} command is used in the second argument of the
@code{list} environment to allow the counter specified to be used to
number the list items.
@comment ************
@comment ** \value **
@comment ************
@comment LEVEL3
@node \value, , \usecounter, Counters
@comment node-name, next, previous, up
@subsection \value
@findex \value
@cindex Counters, getting the value of
@code{\value@{counter@}}
The @code{\value} command produces the value of the @code{counter} named
in the mandatory argument. It can be used where LaTeX expects an
integer or number, such as the second argument of a @code{\setcounter}
or @code{\addtocounter} command, or in:
@example
\hspace@{\value@{foo@}\parindent@}
@end example
It is useful for doing arithmetic with counters.
@page
@comment *************************
@comment **** Cross References ***
@comment *************************
@comment LEVEL2
@node Cross References, Definitions, Counters, Commands
@comment node-name, next, previous, up
@section Cross References
@cindex Cross referencing
One reason for numbering things like figures and equations is to refer
the reader to them, as in ``See Figure 3 for more details.''
@menu
* \label:: Assign a symbolic name to a piece of text.
* \pageref:: Refer to a page number.
* \ref:: Refer to a section, figure or similar.
@end menu
@comment *************************
@comment **** \label *************
@comment *************************
@comment LEVEL3
@node \label, \pageref, Cross References, Cross References
@comment node-name, next, previous, up
@subsection \label
@findex \label
@code{\label@{key@}}
A @code{\label} command appearing in ordinary text assigns to the
@code{key} the number of the current sectional unit; one appearing
inside a numbered environment assigns that number to the @code{key}.
A @code{key} can consist of any sequence of letters, digits, or
punctuation characters. Upper and lowercase letters are different.
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. The prefixes conventionally used are
@itemize @bullet
@item
@code{cha}
for chapters
@item
@code{sec}
for lower-level sectioning commands
@item
@code{fig}
for figures
@item
@code{tab}
for tables
@item
@code{eq}
for equations
@end itemize
Thus, a label for a figure would look like @code{fig:bandersnatch}.
@comment *************************
@comment **** \pageref ***********
@comment *************************
@comment LEVEL3
@node \pageref, \ref, \label, Cross References
@comment node-name, next, previous, up
@subsection \pageref
@findex \pageref
@cindex Cross referencing using page number
@code{\pageref@{key@}}
The @code{\pageref} command produces the page number of the place in the
text where the corresponding @code{\label} command appears. ie. where
@code{\label@{key@}} appears.
@comment *************************
@comment **** \ref ***************
@comment *************************
@comment LEVEL3
@node \ref, , \pageref, Cross References
@comment node-name, next, previous, up
@subsection \ref
@findex \ref
@cindex Cross referencing using section number
@code{\ref@{key@}}
The @code{\ref} command produces the number of the sectional unit,
equation number, ... of the corresponding @code{\label} command.
@page
@comment *************************
@comment **** Definitions ********
@comment *************************
@comment LEVEL2
@node Definitions, Document Classes, Cross References , Commands
@comment node-name, next, previous, up
@section Definitions
@menu
* \newcommand:: Define a new command.
* \newenvironment:: Define a new environment.
* \newtheorem:: Define a new theorem-like environment.
* \newfont:: Define a new font name.
@end menu
@comment *************************
@comment **** \newcommand ********
@comment *************************
@comment LEVEL3
@node \newcommand, \newenvironment, Definitions, Definitions
@comment node-name, next, previous, up
@subsection \newcommand
@findex \newcommand
@cindex Commands, defining new ones
@cindex Defining a new command
@example
\newcommand@{cmd@}[args]@{definition@}
\newcommand@{cmd@}[args][default]@{definition@}
\renewcommand@{cmd@}[args]@{definition@}
\renewcommand@{cmd@}[args][default]@{definition@}
@end example
These commands define (or redefine) a command.
@table @code
@item cmd
A command name beginning with a @code{\}. For @code{\newcommand} it
must not be already defined and must not begin with @code{\end}; for
@code{\renewcommand} it must already be defined.
@item args
An integer from 1 to 9 denoting the number of arguments of the command
being defined. The default is for the command to have no arguments.
@item def
If this optional parameter is present, it means that the command's first
argument is optional. The default value of the optional argument is
@code{def}.
@item definition
The text to be substituted for every occurrence of @code{cmd}; a
parameter of the form @code{#n} in @code{cmd} is replaced by the text of
the nth argument when this substitution takes place.
@end table
@comment *************************
@comment **** \newenvironment ****
@comment *************************
@comment LEVEL3
@node \newenvironment, \newtheorem, \newcommand, Definitions
@comment node-name, next, previous, up
@subsection \newenvironment
@findex \newenvironment
@cindex Environments, defining
@cindex Defining new environments
@example
\newenvironment@{nam@}[args]@{begdef@}@{enddef@}
\newenvironment@{nam@}[args][default]@{begdef@}@{enddef@}
\renewenvironment@{nam@}[args]@{begdef@}@{enddef@}
@end example
These commands define or redefine an environment.
@table @code
@item nam
The name of the environment. For @code{\newenvironment} there must be
no currently defined environment by that name, and the command
@code{\nam} must be undefined. For @code{\renewenvironment} the
environment must already be defined.
@item args
An integer from 1 to 9 denoting the number of arguments of
the newly-defined environment. The default is no arguments.
@item default
If this is specified, the first argument is optional, and @code{default}
gives the default value for that argument.
@item begdef
The text substituted for every occurrence of @code{\begin@{nam@}}; a
parameter of the form @code{#n} in @code{cmd} is replaced by the text of
the nth argument when this substitution takes place.
@item enddef
The text substituted for every occurrence of @code{\end@{nam@}}. It may
not contain any argument parameters.
@end table
@comment *************************
@comment **** \newtheorem ********
@comment *************************
@comment LEVEL3
@node \newtheorem, \newfont, \newenvironment, Definitions
@comment node-name, next, previous, up
@subsection \newtheorem
@findex \newtheorem
@cindex Theorems, defining
@cindex Defining new theorems
@example
\newtheorem@{env_name@}@{caption@}[within]
\newtheorem@{env_name@}[numbered_like]@{caption@}
@end example
This command defines a theorem-like environment.
@table @code
@item env_name
The name of the environment to be defined. A string of letters. It must
not be the name of an existing environment or counter.
@item caption
The text printed at the beginning of the environment, right before the
number. This may simply say ``Theorem'', for example.
@item within
The name of an already defined counter, usually of a sectional unit.
Provides a means of resetting the new theorem counter @strong{within}
the sectional unit.
@item numbered_like
The name of an already defined theorem-like environment.
@end table
The @code{\newtheorem} command may have at most one optional argument.
@comment *************************
@comment **** \newfont ***********
@comment *************************
@comment LEVEL3
@node \newfont, , \newtheorem, Definitions
@comment node-name, next, previous, up
@subsection \newfont
@findex \newfont
@cindex Fonts, new commands for
@cindex Defining new fonts
@code{\newfont@{cmd@}@{font_name@}}
Defines the command name @code{cmd}, which must not be currently
defined, to be a declaration that selects the font named
@code{font_name} to be the current font.
@page
@comment *************************
@comment **** Document Classes ****
@comment *************************
@comment LEVEL2
@node Document Classes, Environments, Definitions, Commands
@comment node-name, next, previous, up
@section Document Classes
@cindex Document Classes
@cindex Classes of document
@cindex article class
@cindex report class
@cindex book class
@cindex letter class
@findex \documentclass
Valid LaTeX document classes include:
@itemize @bullet
@item
article
@item
report
@item
letter
@item
book
@item
slides
@end itemize
Other document classes are often available. @xref{Overview}, for details.
They are selected with the following command:
@code{\documentclass [options] @{class@}}
All the standard classes (except slides) accept the following options
for selecting the typeface size (10 pt is default):
10pt, 11pt, 12pt
All classes accept these options for selecting the paper size (default
is letter):
a4paper, a5paper, b5paper, letterpaper, legalpaper, executivepaper
Miscellaneous options:
@itemize @bullet
@item
landscape --- selects landscape format. Default is portrait.
@item
titlepage, notitlepage --- selects if there should be a separate title
page.
@item
leqno --- equation number on left side of equations. Default is right side.
@item
fleqn --- displayed formulas flush left. Default is centred.
@item
openbib --- use ``open'' bibliography format.
@item
draft, final --- mark/do not mark overfull boxes with a rule.
Default is final.
@end itemize
These options are not available with the slides class:
@itemize @bullet
@item
oneside, twoside --- selects one- or twosided layout. Default is
oneside, except for the book class.
@item
openright, openany --- determines if a chapter should start on a
right-hand page. Default is openright for book.
@item
onecolumn, twocolumn --- one or two columns. Defaults to one column.
@end itemize
The slides class offers the option @code{clock} for printing the time at
the bottom of each note.
If you specify more than one option, they must be separated by a comma.
Additional packages are loaded by a
@code{\usepackage[options]@{pkg@}}
@findex \usepackage
command. If you specify more than one package, they must be separated by
a comma.
@cindex Packages, loading
@cindex Loading additional packages
Any options given in the @code{\documentclass} command that are unknown
by the selected document class are passed on to the packages loaded with
@code{\usepackage}.
@cindex Global options
@cindex Options, global
@node Layout, Lengths, Footnotes, Commands
@comment node-name, next, previous, up
@cindex Layout commands
@section Layout
Miscellaneous commands for controlling the general layout of the page.
@menu
* \flushbottom:: Make all text pages the same height.
* \onecolumn:: Use one-column layout.
* \raggedbottom:: Allow text pages of differing height.
* \twocolumn:: Use two-column layout.
@end menu
@comment *************************
@comment **** \flushbottom *******
@comment *************************
@comment LEVEL3
@node \flushbottom, \onecolumn, , Layout
@comment node-name, next, previous, up
@subsection \flushbottom
@findex \flushbottom
The @code{\flushbottom} declaration makes all text pages the same
height, adding extra vertical space when necessary to fill out the page.
This is the standard if twocolumn mode is selected.
@comment *************************
@comment **** \onecolumn *********
@comment *************************
@comment LEVEL3
@node \onecolumn, \raggedbottom, \flushbottom, Layout
@comment node-name, next, previous, up
@subsection \onecolumn
@findex \onecolumn
The @code{\onecolumn} declaration starts a new page and produces
single-column output.
@comment *************************
@comment **** \raggedbottom ******
@comment *************************
@comment LEVEL3
@node \raggedbottom, \twocolumn, \onecolumn, Layout
@comment node-name, next, previous, up
@subsection \raggedbottom
@findex \raggedbottom
The @code{\raggedbottom} declaration makes all pages the height of the
text on that page. No extra vertical space is added.
@comment *************************
@comment **** \twocolumn *********
@comment *************************
@comment LEVEL3
@node \twocolumn, , \raggedbottom, Layout
@comment node-name, next, previous, up
@subsection \twocolumn
@findex \twocolumn
@cindex Multicolumn text
@code{\twocolumn[text]}
The @code{\twocolumn} declaration starts a new page and produces
two-column output. If the optional @code{text} argument is present, it
is typeset in one-column mode.
@page
@comment *************************
@comment **** Environments *******
@comment *************************
@comment LEVEL2
@node Environments, Footnotes, Document Classes, Commands
@comment node-name, next, previous, up
@section Environments
@cindex Environments
@findex \begin
@findex \end
LaTeX provides a number of different paragraph-making environments.
Each environment begins and ends in the same manner.
@example
\begin@{environment-name@}
.
.
.
\end@{environment-name@}
@end example
@menu
* array:: Math arrays.
* center:: Centred lines.
* description:: Labelled lists.
* enumerate:: Numbered lists.
* eqnarray:: Sequences of aligned equations.
* equation:: Displayed equation.
* figure:: Floating figures.
* flushleft:: Flushed left lines.
* flushright:: Flushed right lines.
* itemize:: Bulleted lists.
* letter:: Letters.
* list:: Generic list environment.
* minipage:: Miniature page.
* picture:: Picture with text, arrows, lines and circles.
* quotation:: Indented environment with paragraph indentation.
* quote:: Indented environment with no paragraph indentation.
* tabbing:: Align text arbitrarily.
* table:: Floating tables.
* tabular:: Align text in columns.
* thebibliography:: Bibliography or reference list.
* theorem:: Theorems, lemmas, etc.
* titlepage:: For hand crafted title pages.
* verbatim:: Simulating typed input.
* verse:: For poetry and other things.
@end menu
@comment *************************
@comment **** array **************
@comment *************************
@comment LEVEL3
@node array, center, Environments, Environments
@comment node-name, next, previous, up
@subsection array
@cindex Arrays, math
@findex array
@example
\begin@{array@}@{col1col2...coln@}
column 1 entry & column 2 entry ... & column n entry \\
.
.
.
\end@{array@}
@end example
Math arrays are produced with the array environment. It has a single
mandatory argument describing the number of columns and the alignment
within them. Each column, @code{coln}, is specified by a single letter
that tells how items in that row should be formatted.
@itemize @bullet
@item
@code{c} --- for centred
@item
@code{l} --- for flush left
@item
@code{r} --- for flush right
@end itemize
Column entries must be separated by an @code{&}. Column entries may
include other LaTeX commands. Each row of the array must be terminated
with the string @code{\\}.
Note that the @code{array} environment can only be used in math mode, so
normally it is used inside an @code{equation} environment.
@comment *************************
@comment **** center *************
@comment *************************
@comment LEVEL3
@node center, description, array, Environments
@comment node-name, next, previous, up
@subsection center
@findex center
@cindex Centering text, environment for
@example
\begin@{center@}
Text on line 1 \\
Text on line 2 \\
.
.
.
\end@{center@}
@end example
The @code{center} environment allows you to create a paragraph consisting of
lines that are centred within the left and right margins on the current
page. Each line must be terminated with the string @code{\\}.
@menu
* \centering:: The declaration form of the @code{center} environment.
@end menu
@comment *****************
@comment ** \centering ***
@comment *****************
@comment LEVEL4
@node \centering, , , center
@comment node-name, next, previous, up
@subsubsection \centering
@findex \centering
@cindex Centering text
@cindex Formatting Text
This declaration corresponds to the @code{center} environment. This
declaration can be used inside an environment such as @code{quote} or in
a @code{parbox}. The text of a figure or table can be centred on the
page by putting a @code{\centering} command at the beginning of the
figure or table environment.
Unlike the @code{center} environment, the @code{\centering} 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 @code{\end} command (of an
environment like quote) that ends the paragraph unit.
@comment *************************
@comment **** description ********
@comment *************************
@comment LEVEL3
@node description, enumerate, center, Environments
@comment node-name, next, previous, up
@subsection description
@findex description
@cindex Labelled lists, creating
@example
\begin@{description@}
\item [label] First item
\item [label] Second item
.
.
.
\end@{description@}
@end example
The @code{description} environment is used to make labelled lists. The
@code{label} is bold face and flushed right.
@comment *************************
@comment **** enumerate **********
@comment *************************
@comment LEVEL3
@node enumerate, eqnarray, description, Environments
@comment node-name, next, previous, up
@subsection enumerate
@findex enumerate
@cindex Lists of items, numbered
@example
\begin@{enumerate@}
\item First item
\item Second item
.
.
.
\end@{enumerate@}
@end example
The @code{enumerate} 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.
Each item of an enumerated list begins with an @code{\item} command.
There must be at least one @code{\item} command within the environment.
The @code{enumerate} environment uses the @code{enumi} through
@code{enumiv} counters (@pxref{Counters}). The type of numbering can be
changed by redefining @code{\theenumi} etc.
@comment *************************
@comment **** eqnarray ***********
@comment *************************
@comment LEVEL3
@node eqnarray, equation, enumerate, Environments
@comment node-name, next, previous, up
@subsection eqnarray
@findex eqnarray
@cindex Equations, aligning
@cindex Aligning Equations
@example
\begin@{eqnarray@}
math formula 1 \\
math formula 2 \\
.
.
.
\end@{eqnarray@}
@end example
The @code{eqnarray} environment is used to display a sequence of
equations or inequalities. It is very much like a three-column
@code{array} environment, with consecutive rows separated by @code{\\}
and consecutive items within a row separated by an @code{&}.
An equation number is placed on every line unless that line has a
@code{\nonumber} command.
@findex \lefteqn
The command @code{\lefteqn} is used for splitting long formulas across
lines. It typesets its argument in display style flush left in a box of
zero width.
@comment *************************
@comment **** equation ***********
@comment *************************
@comment LEVEL3
@node equation, figure, eqnarray, Environments
@comment node-name, next, previous, up
@subsection equation
@findex equation
@cindex Equations, environment for
@cindex Formulae, environment for
@example
\begin@{equation@}
math formula
\end@{equation@}
@end example
The @code{equation} environment centres your equation on the page and places
the equation number in the right margin.
@comment *************************
@comment **** figure *************
@comment *************************
@comment LEVEL3
@node figure, flushleft, equation, Environments
@comment node-name, next, previous, up
@subsection figure
@findex figure
@cindex Inserting figures
@example
\begin@{figure@}[placement]
body of the figure
\caption@{figure title@}
\end@{figure@}
@end example
@findex \caption
Figures are objects that are not part of the normal text, and are
usually ``floated'' to a convenient place, like the top of a page.
Figures will not be split between two pages.
The optional argument @code{[placement]} determines where LaTeX will try
to place your figure. There are four places where LaTeX can possibly
put a float:
@enumerate
@item
@code{h} (Here) - at the position in the text where the figure
environment appears.
@item
@code{t} (Top) - at the top of a text page.
@item
@code{b} (Bottom) - at the bottom of a text page.
@item
@code{p} (Page of floats) - on a separate float page, which is a page
containing no text, only floats.
@end enumerate
The standard report and article classes use the default placement
@code{tbp}.
The body of the figure is made up of whatever text, LaTeX commands, etc.
you wish. The @code{\caption} command allows you to title your figure.
@comment *************************
@comment **** flushleft **********
@comment *************************
@comment LEVEL3
@node flushleft, flushright, figure, Environments
@comment node-name, next, previous, up
@subsection flushleft
@findex flushleft
@cindex Left-justifying text, environment for
@cindex Ragged right text, environment for
@example
\begin@{flushleft@}
Text on line 1 \\
Text on line 2 \\
.
.
.
\end@{flushleft@}
@end example
The @code{flushleft} environment allows you to create a paragraph
consisting of lines that are flushed left, to the left-hand margin.
Each line must be terminated with the string @code{\\}.
@menu
* \raggedright:: The declaration form of the @code{flushleft} environment.
@end menu
@comment *****************
@comment * \raggedright **
@comment *****************
@comment LEVEL4
@node \raggedright, , , flushleft
@comment node-name, next, previous, up
@subsubsection \raggedright
@findex \raggedright
@cindex Ragged right text
@cindex Left-justifying text
@cindex Justification, ragged right
This declaration corresponds to the @code{flushleft} environment. This
declaration can be used inside an environment such as @code{quote} or in
a @code{parbox}.
Unlike the @code{flushleft} environment, the @code{\raggedright} 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 @code{\end} command (of an
environment like quote) that ends the paragraph unit.
@comment *************************
@comment **** flushright *********
@comment *************************
@comment LEVEL3
@node flushright, itemize, flushleft, Environments
@comment node-name, next, previous, up
@subsection flushright
@findex flushright
@cindex Ragged left text, environment for
@cindex Right-justifying text, environment for
@example
\begin@{flushright@}
Text on line 1 \\
Text on line 2 \\
.
.
.
\end@{flushright@}
@end example
The @code{flushright} environment allows you to create a paragraph
consisting of lines that are flushed right, to the right-hand margin.
Each line must be terminated with the string @code{\\}.
@menu
* \raggedleft:: The declaration form of the @code{flushright} environment.
@end menu
@comment *****************
@comment * \raggedleft ***
@comment *****************
@comment LEVEL4
@node \raggedleft, , , flushright
@comment node-name, next, previous, up
@subsubsection \raggedleft
@findex \raggedleft
@cindex Ragged left text
@cindex Justification, ragged left
@cindex Right-justifying text
This declaration corresponds to the @code{flushright} environment. This
declaration can be used inside an environment such as @code{quote} or in
a @code{parbox}.
Unlike the @code{flushright} environment, the @code{\raggedleft} 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 @code{\end} command (of an
environment like quote) that ends the paragraph unit.
@comment *************************
@comment **** itemize ************
@comment *************************
@comment LEVEL3
@node itemize, letter, flushright, Environments
@comment node-name, next, previous, up
@subsection itemize
@findex itemize
@findex \item
@cindex Lists of items
@example
\begin@{itemize@}
\item First item
\item Second item
.
.
.
\end@{itemize@}
@end example
The @code{itemize} environment produces a ``bulleted'' list. Itemizations
can be nested within one another, up to four levels deep. They can also
be nested within other paragraph-making environments.
Each item of an @code{itemized} list begins with an @code{\item} command.
There must be at least one @code{\item} command within the environment.
The @code{itemize} environment uses the @code{itemi} through
@code{itemiv} counters (@pxref{Counters}). The type of numbering can be
changed by redefining @code{\theitemi} etc.
@comment *************************
@comment **** letter ************
@comment *************************
@comment LEVEL3
@node letter, list, itemize, Environments
@comment node-name, next, previous, up
@subsection letter
@findex letter
This environment is used for creating letters. @xref{Letters}.
@comment *************************
@comment **** list ***************
@comment *************************
@comment LEVEL3
@node list, minipage, letter, Environments
@comment node-name, next, previous, up
@subsection list
@findex list
@cindex Lists of items, generic
The @code{list} 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.
@example
\begin@{list@}@{label@}@{spacing@}
\item First item
\item Second item
.
.
.
\end@{list@}
@end example
The @code{@{label@}} argument specifies how items should be labelled.
This argument is a piece of text that is inserted in a box to form the
label. This argument can and usually does contain other LaTeX commands.
The @code{@{spacing@}} argument contains commands to change the spacing
parameters for the list. This argument will most often be null, i.e.,
@code{@{@}}. This will select all default spacing which should suffice
for most cases.
@comment *************************
@comment **** minipage ***********
@comment *************************
@comment LEVEL3
@node minipage, picture, list, Environments
@comment node-name, next, previous, up
@subsection minipage
@findex minipage
@cindex Footnotes in figures
@cindex Figures, footnotes in
@cindex Minipage, creating a
@example
\begin@{minipage@}[position]@{width@}
text
\end@{minipage@}
@end example
The @code{minipage} environment is similar to a @code{\parbox} command.
It takes the same optional @code{position} argument and mandatory
@code{width} argument. You may use other paragraph-making environments
inside a minipage.
Footnotes in a @code{minipage} environment are handled in a way that is
particularly useful for putting footnotes in figures or tables. A
@code{\footnote} or @code{\footnotetext} command puts the footnote at
the bottom of the minipage instead of at the bottom of the page, and it
uses the @code{mpfootnote} counter instead of the ordinary
@code{footnote} counter @xref{Counters}.
NOTE: Don't put one minipage inside another if you are using footnotes;
they may wind up at the bottom of the wrong minipage.
@comment *************************
@comment **** picture ************
@comment *************************
@comment LEVEL3
@node picture, quotation, minipage, Environments
@comment node-name, next, previous, up
@subsection picture
@findex picture
@cindex Creating pictures
@cindex Pictures, creating
@example
\begin@{picture@}(width,height)(x offset,y offset)
.
.
picture commands
.
.
\end@{picture@}
@end example
The @code{picture} 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 @code{5}, @code{2.3} or @code{-3.1416}. A
coordinate specifies a length in multiples of the unit length
@code{\unitlength}, so if @code{\unitlength} has been set to @code{1cm},
then the coordinate 2.54 specifies a length of 2.54 centimetres. You
can change the value of @code{\unitlength} anywhere you want, using the
@code{\setlength} command, but strange things will happen if you try
changing it inside the picture environment.
A position is a pair of coordinates, such as @code{(2.4,-5)}, specifying
the point with x-coordinate @code{2.4} and y-coordinate @code{-5}.
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.
The @code{picture} environment has one mandatory argument, which is a
@code{position}. 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.
The @code{picture} environment also has an optional @code{position}
argument, following the @code{size} 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 @code{\unitlength}
has been set to @code{1mm}, the command
@example
\begin@{picture@}(100,200)(10,20)
@end example
produces a picture of width 100 millimetres and height 200
millimetres, 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 will omit the optional argument, leaving the origin
at the lower-left corner. If you then want to modify your picture by
shifting everything, you just add the appropriate optional argument.
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.
Everything that appears in a picture is drawn by the @code{\put}
command. The command
@example
\put (11.3,-.3)@{...@}
@end example
puts the object specified by @code{...} in the picture, with its
reference point at coordinates (11.3,-.3). The reference points for
various objects will be described below.
The @code{\put} command creates an @dfn{LR box}. You can put anything
in the text argument of the @code{\put} command that you'd put into the
argument of an @code{\mbox} and related commands. When you do this, the
reference point will be the lower left corner of the box.
Picture commands:
@menu
* \circle:: Draw a circle.
* \dashbox:: Draw a dashed box.
* \frame:: Draw a frame around an object.
* \framebox (picture):: Draw a box with a frame around it.
* \line:: Draw a straight line.
* \linethickness:: Set the line thickness.
* \makebox (picture):: Draw a box of the specified size.
* \multiput:: Draw multiple instances of an object.
* \oval:: Draw an ellipse.
* \put:: Place an object at a specified place.
* \shortstack:: Make a pile of objects.
* \vector:: Draw a line with an arrow.
@end menu
@comment *****************
@comment *** \circle *****
@comment *****************
@comment LEVEL4
@node \circle, \dashbox, , picture
@comment node-name, next, previous, up
@subsubsection \circle
@findex \circle
@code{\circle[*]@{diameter@}}
The @code{\circle} command produces a circle with a diameter as close to
the specified one as possible. If the @code{*}-form of the command is
used, LaTeX draws a solid circle.
Note that only circles up to 40 pt can be drawn.
@comment *****************
@comment *** \dashbox ****
@comment *****************
@comment LEVEL4
@node \dashbox, \frame, \circle, picture
@comment node-name, next, previous, up
@subsubsection \dashbox
@findex \dashbox
Draws a box with a dashed line.
@code{\dashbox@{dash_length@}(width,height)@{...@}}
The @code{\dashbox} has an extra argument which specifies the width of
each dash. A dashed box looks best when the @code{width} and
@code{height} are multiples of the @code{dash_length}.
@comment *****************
@comment *** \frame ******
@comment *****************
@comment LEVEL4
@node \frame, \framebox (picture), \dashbox, picture
@comment node-name, next, previous, up
@subsubsection \frame
@findex \frame
@code{\frame@{...@}}
The @code{\frame} command puts a rectangular frame around the object
specified in the argument. The reference point is the bottom left
corner of the frame. No extra space is put between the frame and the
object.
@comment **************************
@comment *** \framebox (picture) **
@comment **************************
@comment LEVEL4
@node \framebox (picture), \line, \frame, picture
@comment node-name, next, previous, up
@subsubsection \framebox
@findex \framebox
@code{\framebox(width,height)[position]@{...@}}
The @code{\framebox} command is exactly the same as the @code{\makebox}
command, except that it puts a frame around the outside of the box that
it creates.
The @code{framebox} command produces a rule of thickness
@code{\fboxrule}, and leaves a space @code{\fboxsep} between the rule
and the contents of the box.
@comment *****************
@comment *** \line *******
@comment *****************
@comment LEVEL4
@node \line, \linethickness, \framebox (picture), picture
@comment node-name, next, previous, up
@subsubsection \line
@findex \line
@code{\line(x slope,y slope)@{length@}}
The @code{\line} command draws a line of the specified @code{length} and
@code{slope}.
Note that LaTeX can only draw lines with slope = x/y, where x and y
have integer values from -6 through 6.
@comment ******************
@comment * \linethickness *
@comment ******************
@comment LEVEL4
@node \linethickness, \makebox (picture), \line, picture
@comment node-name, next, previous, up
@subsubsection \linethickness
@findex \linethickness
@code{\linethickness@{dimension@}}
Declares the thickness of horizontal and vertical lines in a picture
environment to be @code{dimension}, which must be a positive length. It
does not affect the thickness of slanted lines and circles, or the
quarter circles drawn by @code{\oval} to form the corners of an oval.
@comment *************************
@comment *** \makebox (picture) **
@comment *************************
@comment LEVEL4
@node \makebox (picture), \multiput, \linethickness, picture
@comment node-name, next, previous, up
@subsubsection \makebox
@findex \makebox (picture)
@code{\makebox(width,height)[position]@{...@}}
The @code{\makebox} command for the picture environment is similar to
the normal @code{\makebox} command except that you must specify a
@code{width} and @code{height} in multiples of @code{\unitlength}.
The optional argument, @code{[position]}, specifies the quadrant that
your text appears in. You may select up to two of the following:
@itemize @bullet
@item
@code{t} - Moves the item to the top of the rectangle
@item
@code{b} - Moves the item to the bottom
@item
@code{l} - Moves the item to the left
@item
@code{r} - Moves the item to the right
@end itemize
@xref{\makebox}.
@comment *****************
@comment *** \multiput ***
@comment *****************
@comment LEVEL4
@node \multiput, \oval, \makebox (picture), picture
@comment node-name, next, previous, up
@subsubsection \multiput
@findex \multiput
@code{\multiput(x coord,y coord)(delta x,delta y)@{number of copies@}@{object@}}
The @code{\multiput} command can be used when you are putting the same
object in a regular pattern across a picture.
@comment *****************
@comment *** \oval *****
@comment *****************
@comment LEVEL4
@node \oval, \put, \multiput, picture
@comment node-name, next, previous, up
@subsubsection \oval
@findex \oval
@code{\oval(width,height)[portion]}
The @code{\oval} command produces a rectangle with rounded corners. The
optional argument, @code{[portion]}, allows you to select part of the
oval.
@itemize @bullet
@item
@code{t} - Selects the top portion
@item
@code{b} - Selects the bottom portion
@item
@code{r} - Selects the right portion
@item
@code{l} - Selects the left portion
@end itemize
Note that the ``corners'' of the oval are made with quarter circles with
a maximum radius of 20 pt, so large ``ovals'' will look more like boxes
with rounded corners.
@comment *****************
@comment *** \put ********
@comment *****************
@comment LEVEL4
@node \put, \shortstack, \oval, picture
@comment node-name, next, previous, up
@subsubsection \put
@findex \put
@code{\put(x coord,y coord)@{ ... @}}
The @code{\put} command places the item specified by the mandatory
argument at the given coordinates.
@comment *****************
@comment *** \shortstack *
@comment *****************
@comment LEVEL4
@node \shortstack, \vector, \put, picture
@comment node-name, next, previous, up
@subsubsection \shortstack
@findex \shortstack
@code{\shortstack[position]@{... \\ ... \\ ...@}}
The @code{\shortstack} command produces a stack of objects. The valid
positions are:
@itemize @bullet
@item
@code{r} - Moves the objects to the right of the stack
@item
@code{l} - Moves the objects to the left of the stack
@item
@code{c} - Moves the objects to the centre of the stack (default)
@end itemize
@comment *****************
@comment *** \vector *****
@comment *****************
@comment LEVEL4
@node \vector, , \shortstack, picture
@comment node-name, next, previous, up
@subsubsection \vector
@findex \vector
@code{\vector(x slope,y slope)@{length@}}
The @code{\vector} command draws a line with an arrow of the specified
length and slope. The @code{x} and @code{y} values must lie between -4
and +4, inclusive.
@comment *************************
@comment **** quotation **********
@comment *************************
@comment LEVEL3
@node quotation, quote, picture, Environments
@comment node-name, next, previous, up
@subsection quotation
@findex quotation
@cindex Quoted text with paragraph indentation, displaying
@cindex Displaying quoted text with paragraph indentation
@example
\begin@{quotation@}
text
\end@{quotation@}
@end example
The margins of the @code{quotation} environment are indented on the left
and the right. The text is justified at both margins and there is
paragraph indentation. Leaving a blank line between text produces a new
paragraph.
@comment *************************
@comment **** quote **************
@comment *************************
@comment LEVEL3
@node quote, tabbing, quotation, Environments
@comment node-name, next, previous, up
@subsection quote
@findex quote
@cindex Quoted text, displaying
@cindex Displaying quoted text
@example
\begin@{quote@}
text
\end@{quote@}
@end example
The margins of the @code{quote} environment are indented on the left and
the right. The text is justified at both margins. Leaving a blank line
between text produces a new paragraph.
@comment *************************
@comment **** tabbing ************
@comment *************************
@comment LEVEL3
@node tabbing, table, quote, Environments
@comment node-name, next, previous, up
@subsection tabbing
@findex tabbing
@cindex Tab stops, using
@cindex Lining text up in columns using tab stops
@example
\begin@{tabbing@}
text \= more text \= still more text \= last text \\
second row \> \> more \\
.
.
.
\end@{tabbing@}
@end example
The @code{tabbing} environment provides a way to align text in columns.
It works by setting tab stops and tabbing to them much the way you do
with an ordinary typewriter.
It is best suited for cases where the width of each column is constant
and known in advance.
This environment can be broken across pages, unlike the @code{tabular}
environment.
The following commands can be used inside a @code{tabbing} enviroment:
@table @code
@item \=
@findex \=
Sets a tab stop at the current position.
@item \>
@findex \>
Advances to the next tab stop.
@item \<
@findex \<
This command allows you to put something to the left of the
local margin without changing the margin.
Can only be used at the start of the line.
@item \+
@findex \+
Moves the left margin of the next and all the
following commands one tab stop to the right.
@item \-
@findex \- (tabbing)
Moves the left margin of the next and all the
following commands one tab stop to the left.
@item \'
@findex \' (tabbing)
Moves everything that you have typed so far in the
current column, i.e. everything from the most recent @code{\>},
@code{\<}, @code{\'}, @code{\\}, or @code{\kill} command, to the right
of the previous column, flush against the current column's tab stop.
@item \`
@findex \` (tabbing)
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 @code{\`} command moves all the
text that follows it, up to the @code{\\} or @code{\end@{tabbing@}}
command that ends the line, to the right margin of the tabbing
environment. There must be no @code{\>} or @code{\'} command between
the @code{\`} and the command that ends the line.
@item \kill
@findex \kill
Sets tab stops without producing
text. Works just like @code{\\} except that it throws away the
current line instead of producing output for it. The effect of any
@code{\=}, @code{\+} or @code{\-} commands in that line remain in
effect.
@item \pushtabs
@findex \pushtabs
Saves all current tab stop positions. Useful for
temporarily changing tab stop positions in the middle of a
@code{tabbing} environment.
@item \poptabs
@findex \poptabs
Restores the tab stop positions saved by the last @code{\pushtabs}.
@item \a
@findex \a
In a @code{tabbing} environment, the commands @code{\=}, @code{\'} and
@code{\`} do not produce accents as normal. Instead, the commands
@code{\a=}, @code{\a'} and @code{\a`} are used.
@end table
This example typesets a Pascal function in a traditional format:
@example
\begin@{tabbing@}
function \= fact(n : integer) : integer;\\
\> begin \= \+ \\
\> if \= n $>$ 1 then \+ \\
fact := n * fact(n-1) \- \\
else \+ \\
fact := 1; \-\- \\
end;\\
\end@{tabbing@}
@end example
@comment *************************
@comment **** table **************
@comment *************************
@comment LEVEL3
@node table, tabular, tabbing, Environments
@comment node-name, next, previous, up
@subsection table
@findex table
@cindex Tables, creating
@cindex Creating tables
@example
\begin@{table@}[placement]
body of the table
\caption@{table title@}
\end@{table@}
@end example
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.
The optional argument @code{[placement]} determines where LaTeX will try
to place your table. There are four places where LaTeX can possibly put
a float:
@itemize @bullet
@item
@code{h} : Here - at the position in the text where the table
environment appears.
@item
@code{t} : Top - at the top of a text page.
@item
@code{b} : Bottom - at the bottom of a text page.
@item
@code{p} : Page of floats - on a separate float page, which is a page
containing no text, only floats.
@end itemize
The standard @code{report} and @code{article} classes use the default
placement @code{[tbp]}.
The body of the table is made up of whatever text, LaTeX commands, etc.,
you wish. The @code{\caption} command allows you to title your table.
@comment *************************
@comment **** tabular ************
@comment *************************
@comment LEVEL3
@node tabular, thebibliography, table, Environments
@comment node-name, next, previous, up
@subsection tabular
@findex tabular
@cindex Lines in tables
@cindex Lining text up in tables
@example
\begin@{tabular@}[pos]@{cols@}
column 1 entry & column 2 entry ... & column n entry \\
.
.
.
\end@{tabular@}
@end example
or
@example
\begin@{tabular*@}@{width@}[pos]@{cols@}
column 1 entry & column 2 entry ... & column n entry \\
.
.
.
\end@{tabular*@}
@end example
These environments produce a box consisting of a sequence of rows of
items, aligned vertically in columns. The mandatory and optional
arguments consist of:
@table @code
@item width
Specifies the width of the @code{tabular*} environment. There must be
rubber space between columns that can stretch to fill out the specified
width.
@item pos
Specifies the vertical position; default is alignment on the centre of
the environment.
@itemize @bullet
@item
@code{t} - align on top row
@item
@code{b} - align on bottom row
@end itemize
@item cols
Specifies the column formatting. It consists of a sequence of the
following specifiers, corresponding to the sequence of columns and
intercolumn material.
@itemize @bullet
@item
@code{l} - A column of left-aligned items.
@item
@code{r} - A column of right-aligned items.
@item
@code{c} - A column of centred items.
@item
@code{|} - A vertical line the full height and depth of the environment.
@item
@code{@@@{text@}} - This inserts @code{text} 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 @code{\extracolsep@{wd@}} command in an
@@-expression causes an extra space of width @code{wd} to appear to the
left of all subsequent columns, until countermanded by another
@code{\extracolsep} command. Unlike ordinary intercolumn space, this
extra space is not suppressed by an @@-expression. An
@code{\extracolsep} command can be used only in an @@-expression in the
@code{cols} argument.
@item
@code{p@{wd@}} - Produces a column with each item typeset in a parbox of
width @code{wd}, as if it were the argument of a @code{\parbox[t]@{wd@}}
command. However, a @code{\\} may not appear in the item, except in the
following situations:
@enumerate
@item
inside an environment like @code{minipage}, @code{array}, or @code{tabular}.
@item
inside an explicit @code{\parbox}.
@item
in the scope of a @code{\centering}, @code{\raggedright}, or @code{\raggedleft}
declaration. The latter declarations must appear inside braces or an
environment when used in a @code{p}-column element.
@end enumerate
@item
@code{*@{num@}@{cols@}} - Equivalent to @code{num} copies of
@code{cols}, where @code{num} is any positive integer and @code{cols} is
any list of column-specifiers, which may contain another
@code{*-expression}.
@end itemize
@end table
These commands can be used inside a @code{tabular} environment:
@menu
* \cline:: Draw a horizontal line spanning some columns.
* \hline:: Draw a horizontal line spanning all columns.
* \multicolumn:: Make an item spanning several columns.
* \vline:: Draw a vertical line.
@end menu
@comment *****************
@comment *** \cline ****
@comment *****************
@comment LEVEL4
@node \cline, \hline, , tabular
@comment node-name, next, previous, up
@subsubsection \cline
@findex \cline
@code{\cline@{i-j@}}
The @code{\cline} command draws horizontal lines across the columns
specified, beginning in column @code{i} and ending in column @code{j},
which are identified in the mandatory argument.
@comment *****************
@comment *** \hline ****
@comment *****************
@comment LEVEL4
@node \hline, \multicolumn, \cline, tabular
@comment node-name, next, previous, up
@subsubsection \hline
@findex \hline
The @code{\hline} command will draw a horizontal line the width of the
table. It's most commonly used to draw a line at the top, bottom, and
between the rows of the table.
@comment *****************
@comment ** \multicolumn *
@comment *****************
@comment LEVEL4
@node \multicolumn, \vline, \hline, tabular
@comment node-name, next, previous, up
@subsubsection \multicolumn
@findex \multicolumn
@code{\multicolumn@{cols@}@{pos@}@{text@}}
The @code{\multicolumn} is used to make an entry that spans several
columns. The first mandatory argument, @code{cols}, specifies the
number of columns to span. The second mandatory argument, @code{pos},
specifies the formatting of the entry; @code{c} for centred, @code{l}
for flushleft, @code{r} for flushright. The third mandatory argument,
@code{text}, specifies what text is to make up the entry.
@comment *****************
@comment *** \vline ****
@comment *****************
@comment LEVEL4
@node \vline, , \multicolumn, tabular
@comment node-name, next, previous, up
@subsubsection \vline
@findex \vline
The @code{\vline} command will draw a vertical line extending the full
height and depth of its row. An @code{\hfill} command can be used to
move the line to the edge of the column. It can also be used in an
@@-expression.
@comment *************************
@comment **** thebibliography ****
@comment *************************
@comment LEVEL3
@node thebibliography, theorem, tabular, Environments
@comment node-name, next, previous, up
@subsection thebibliography
@findex thebibliography
@cindex Bibliography, creating (manually)
@example
\begin@{thebibliography@}@{widest-label@}
\bibitem[label]@{cite_key@}
.
.
.
\end@{thebibliography@}
@end example
The @code{thebibliography} environment produces a bibliography or
reference list. In the @code{article} class, this reference list is
labelled ``References''; in the @code{report} class, it is labelled
``Bibliography''.
@itemize @bullet
@item
@code{widest-label}: Text that, when printed, is approximately as wide
as the widest item label produces by the @code{\bibitem} commands.
@end itemize
@menu
* \bibitem:: Specify a bibliography item.
* \cite:: Refer to a bibliography item.
* \nocite:: Include an item in the bibliography.
* Using BibTeX:: Automatic generation of bibliographies.
@end menu
@comment *****************
@comment *** \bibitem ****
@comment *****************
@comment LEVEL4
@node \bibitem, \cite, , thebibliography
@comment node-name, next, previous, up
@subsubsection \bibitem
@findex \bibitem
@code{\bibitem[label]@{cite_key@}}
The @code{\bibitem} command generates an entry labelled by @code{label}.
If the @code{label} argument is missing, a number is generated as the
@code{label}, using the @code{enumi} counter. The @code{cite_key} is
any sequence of letters, numbers, and punctuation symbols not containing
a comma. This command writes an entry on the @file{.aux} file
containing @code{cite_key} and the item's @code{label}. When this
@file{.aux} file is read by the @code{\begin@{document@}} command, the
item's @code{label} is associated with @code{cite_key}, causing the
reference to @code{cite_key} by a @code{\cite} command to produce the
associated @code{label}.
@comment *****************
@comment *** \cite *******
@comment *****************
@comment LEVEL4
@node \cite, \nocite, \bibitem, thebibliography
@comment node-name, next, previous, up
@subsubsection \cite
@findex \cite
@code{\cite[text]@{key_list@}}
The @code{key_list} argument is a list of citation keys. This command
generates an in-text citation to the references associated with the keys
in @code{key_list} by entries on the @file{.aux} file read by the
@code{\begin@{document@}} command.
The optional @code{text} argument will appear after the citation,
i.e. @code{\cite[p. 2]@{knuth@}} might produce `[Knuth, p. 2]'.
@comment *****************
@comment *** \nocite *****
@comment *****************
@comment LEVEL4
@node \nocite, Using BibTeX, \cite, thebibliography
@comment node-name, next, previous, up
@subsubsection \nocite
@findex \nocite
@code{\nocite@{key_list@}}
The @code{\nocite} command produces no text, but writes @code{key_list},
which is a list of one or more citation keys, on the @file{.aux} file.
@comment **********************
@comment *** Using BibTeX *****
@comment **********************
@comment LEVEL4
@node Using BibTeX, , \nocite, thebibliography
@comment node-name, next, previous, up
@subsubsection Using BibTeX
@cindex Using BibTeX
@cindex BibTeX, using
@cindex Bibliography, creating (automatically)
@findex \bibliographystyle
@findex \bibliography
If you use the BibTeX 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 @code{thebibliography}
environment. Instead, you include the lines
@example
\bibliographystyle@{style@}
\bibliography@{bibfile@}
@end example
where @code{style} refers to a file @code{style.bst}, which defines how
your citations will look. The standard styles distributed with BibTeX
are:
@table @code
@item alpha
Sorted alphabetically. Labels are formed from name of author and year of
publication.
@item plain
Sorted alphabetically. Labels are numeric.
@item unsrt
Like @code{plain}, but entries are in order of citation.
@item abbrv
Like @code{plain}, but more compact labels.
@end table
In addition, numerous other BibTeX style files exist tailored to the
demands of various publications.
The argument to @code{\bibliography} refers to the file
@code{bibfile.bib}, which should contain your database in BibTeX
format. Only the entries referred to via @code{\cite} and @code{\nocite}
will be listed in the bibliography.
@comment *************************
@comment **** theorem ************
@comment *************************
@comment LEVEL3
@node theorem, titlepage, thebibliography, Environments
@comment node-name, next, previous, up
@subsection theorem
@findex theorem
@cindex Theorems, typesetting
@example
\begin@{theorem@}
theorem text
\end@{theorem@}
@end example
The @code{theorem} environment produces ``Theorem x'' in boldface followed
by your theorem text.
@comment *************************
@comment **** titlepage **********
@comment *************************
@comment LEVEL3
@node titlepage, verbatim, theorem, Environments
@comment node-name, next, previous, up
@subsection titlepage
@findex titlepage
@cindex Making a title page
@cindex Title pages, creating
@example
\begin@{titlepage@}
text
\end@{titlepage@}
@end example
The @code{titlepage} 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
@code{\today} command comes in handy for title pages.
@findex \today
Note that you can use the @code{\maketitle} (@pxref{\maketitle}) command to
produce a standard title page.
@comment *************************
@comment **** verbatim ***********
@comment *************************
@comment LEVEL3
@node verbatim, verse, titlepage, Environments
@comment node-name, next, previous, up
@subsection verbatim
@findex verbatim
@cindex Simulating typed text
@cindex Typed text, simulating
@cindex Programs, typesetting
@cindex Computer programs, typesetting
@example
\begin@{verbatim@}
text
\end@{verbatim@}
@end example
The @code{verbatim} environment is a paragraph-making environment that
gets LaTeX to print exactly what you type in. It turns LaTeX into a
typewriter with carriage returns and blanks having the same effect that
they would on a typewriter.
@menu
* \verb:: The macro form of the @code{verbatim} environment.
@end menu
@comment *****************
@comment *** \verb *******
@comment *****************
@comment LEVEL4
@node \verb, , , verbatim
@comment node-name, next, previous, up
@subsubsection \verb
@findex \verb
@cindex Verbatim text
@code{\verb char literal_text char}
@code{\verb*char literal_text char}
Typesets @code{literal_text} exactly as typed, including special
characters and spaces, using a typewriter (@code{\tt}) type style.
There may be no space between @code{\verb} or @code{\verb*} and
@code{char} (space is shown here only for clarity). The @code{*-form}
differs only in that spaces are printed
@ifinfo
as a special character.
@end ifinfo
@iftex
as `\verb*| |'.
@end iftex
@comment *************************
@comment **** verse **************
@comment *************************
@comment LEVEL3
@node verse, , verbatim, Environments
@comment node-name, next, previous, up
@subsection verse
@findex verse
@cindex Poetry, an environment for
@example
\begin@{verse@}
text
\end@{verse@}
@end example
The @code{verse} environment is designed for poetry, though you may find
other uses for it.
The margins are indented on the left and the right. Separate the lines
of each stanza with @code{\\}, and use one or more blank lines to
separate the stanzas.
@page
@comment ************************************
@comment **** LEVEL2 Starts Here again. ****
@comment ************************************
@comment *************************
@comment **** Footnotes **********
@comment *************************
@comment LEVEL2
@node Footnotes, Layout, Environments, Commands
@comment node-name, next, previous, up
@section Footnotes
@cindex Footnotes, creating
Footnotes can be produced in one of two ways. They can be
produced with one command, the @code{\footnote} command. They can also
be produced with two commands, the @code{\footnotemark} and the
@code{\footnotetext} commands. See the specific command for information
on why you would use one over the other.
@menu
* \footnote:: Insert a footnote.
* \footnotemark:: Insert footnote mark only.
* \footnotetext:: Insert footnote text only.
@end menu
@comment **********************
@comment **** \footnote *******
@comment **********************
@comment LEVEL3
@node \footnote, \footnotemark, Footnotes, Footnotes
@comment node-name, next, previous, up
@subsection \footnote
@findex \footnote
@code{\footnote[number]@{text@}}
The @code{\footnote} command places the numbered footnote @code{text} at
the bottom of the current page. The optional argument, @code{number},
is used to change the default footnote number. This command can only be
used in outer paragraph mode; i.e., you cannot use it in sectioning
commands like @code{\chapter}, in figures, tables or in a @code{tabular}
environment.
@comment **********************
@comment **** \footnotemark ***
@comment **********************
@comment LEVEL3
@node \footnotemark, \footnotetext, \footnote, Footnotes
@comment node-name, next, previous, up
@subsection \footnotemark
@findex \footnotemark
The @code{\footnotemark} command puts the footnote @code{number} in the
text. This command can be used in inner paragraph mode. The text of
the footnote is supplied by the @code{\footnotetext} command.
This command can be used to produce several consecutive footnote markers
referring to the same footnote by using
@code{\footnotemark[\value@{footnote@}]}
after the first @code{\footnote} command.
@comment **********************
@comment **** \footnotetext ***
@comment **********************
@comment LEVEL3
@node \footnotetext, , \footnotemark, Footnotes
@comment node-name, next, previous, up
@subsection \footnotetext
@findex \footnotetext
@code{\footnotetext[number]@{text@}}
The @code{\footnotetext} command produces the @code{text} to be placed
at the bottom of the page. This command can come anywhere after the
@code{\footnotemark} command. The @code{\footnotetext} command must
appear in outer paragraph mode.
The optional argument, @code{number}, is used to change the default
footnote number.
@page
@comment *************************
@comment ******* Lengths *********
@comment *************************
@comment LEVEL2
@node Lengths, Letters, Layout, Commands
@comment node-name, next, previous, up
@section Lengths
@cindex Lengths, defining and using
A @code{length} is a measure of distance. Many LaTeX commands take a
length as an argument.
@menu
* \newlength:: Define a new length.
* \setlength:: Set the value of a length.
* \addtolength:: Add a quantity to a length.
* \settodepth:: Set a length to the depth of something.
* \settoheight:: Set a length to the height of something.
* \settowidth:: Set a length to the width of something.
* Predefined lengths:: Lengths that are, like, predefined.
@end menu
@comment **********************
@comment **** \newlength ******
@comment **********************
@comment LEVEL3
@node \newlength, \setlength, Lengths, Lengths
@comment node-name, next, previous, up
@subsection \newlength
@findex \newlength
@cindex Lengths, defining a new
@code{\newlength@{\gnat@}}
The @code{\newlength} command defines the mandatory argument,
@code{\gnat}, as a @code{length} command with a value of @code{0in}. An
error occurs if a @code{\gnat} command already exists.
@comment **********************
@comment **** \setlength ******
@comment **********************
@comment LEVEL3
@node \setlength, \addtolength, \newlength, Lengths
@comment node-name, next, previous, up
@subsection \setlength
@findex \setlength
@cindex Lengths, setting value of
@code{\setlength@{\gnat@}@{length@}}
The @code{\setlength} command is used to set the value of a
@code{length} command. The @code{length} argument can be expressed in
any terms of length LaTeX understands, i.e., inches (@code{in}),
millimetres (@code{mm}), points (@code{pt}), etc.
@comment **********************
@comment **** \addtolength ****
@comment **********************
@comment LEVEL3
@node \addtolength, \settodepth, \setlength, Lengths
@comment node-name, next, previous, up
@subsection \addtolength
@findex \addtolength
@cindex Lengths, adding to
@code{\addtolength@{\gnat@}@{length@}}
The @code{\addtolength} command increments a ``length command'' by the
amount specified in the @code{length} argument. It can be a negative
amount.
@comment **********************
@comment **** \settodepth *****
@comment **********************
@comment LEVEL3
@node \settodepth, \settoheight, \addtolength, Lengths
@comment node-name, next, previous, up
@subsection \settodepth
@findex \settodepth
@code{\settodepth@{\gnat@}@{text@}}
The @code{\settodepth} command sets the value of a @code{length} command
equal to the depth of the @code{text} argument.
@comment **********************
@comment **** \settoheight *****
@comment **********************
@comment LEVEL3
@node \settoheight, \settowidth, \settodepth, Lengths
@comment node-name, next, previous, up
@subsection \settoheight
@findex \settoheight
@code{\settoheight@{\gnat@}@{text@}}
The @code{\settoheight} command sets the value of a @code{length} command
equal to the height of the @code{text} argument.
@comment **********************
@comment **** \settowidth *****
@comment **********************
@comment LEVEL3
@node \settowidth, Predefined lengths, \settoheight, Lengths
@comment node-name, next, previous, up
@subsection \settowidth
@findex \settowidth
@code{\settowidth@{\gnat@}@{text@}}
The @code{\settowidth} command sets the value of a @code{length} command
equal to the width of the @code{text} argument.
@comment *****************************
@comment **** Predefined lengths *****
@comment *****************************
@comment LEVEL3
@node Predefined lengths, , \settowidth, Lengths
@comment node-name, next, previous, up
@subsection Predefined lengths
@cindex Lengths, predefined
@cindex Predefined lengths
@code{\width}
@findex \width
@code{\height}
@findex \height
@code{\depth}
@findex \depth
@code{\totalheight}
@findex \totalheight
These length parameters can be used in the arguments of the box-making
commands @xref{Spaces & Boxes}. They specify the natural width etc. of
the text in the box. @code{\totalheight} equals @code{\height} +
@code{\depth}. To make a box with the text stretched to double the
natural size, e.g., say
@code{\makebox[2\width]@{Get a stretcher@}}
@comment *************************
@comment ******* Letters *********
@comment *************************
@comment LEVEL2
@node Letters, Line & Page Breaking, Lengths, Commands
@comment node-name, next, previous, up
@section Letters
@cindex Letters
@cindex Creating letters
You can use LaTeX to typeset letters, both personal and business. The
@code{letter} document class is designed to make a number of letters at
once, although you can make just one if you so desire.
Your @file{.tex} source file has the same minimum commands as the other
document classes, i.e., you must have the following commands as a
minimum:
@example
\documentclass@{letter@}
\begin@{document@}
... letters ...
\end@{document@}
@end example
Each letter is a @code{letter} environment, whose argument is the name
and address of the recipient. For example, you might have:
@example
\begin@{letter@}@{Mr. Joe Smith\\ 2345 Princess St.
\\ Edinburgh, EH1 1AA@}
...
\end@{letter@}
@end example
The letter itself begins with the @code{\opening} command. The text of
the letter follows. It is typed as ordinary LaTeX input. Commands that
make no sense in a letter, like @code{\chapter}, do not work. The letter
closes with a @code{\closing} command.
After the @code{closing}, you can have additional material. The
@code{\cc} command produces the usual ``cc: ...''. There's also a similar
@code{\encl} command for a list of enclosures. With both these commands,
use @code{\\} to separate the items.
These commands are used with the @code{letter} class:
@menu
* \address:: Your return address.
* \cc:: Cc list.
* \closing:: Saying goodbye.
* \encl:: List of enclosed material.
* \location:: Your organisation's address.
* \makelabels:: Making address labels.
* \name:: Your name, for the return address.
* \opening:: Saying hello.
* \ps:: Adding a postscript.
* \signature:: Your signature.
* \startbreaks:: Allow page breaks.
* \stopbreaks:: Disallow page breaks.
* \telephone:: Your phone number.
@end menu
@comment **************
@comment ** \address **
@comment **************
@comment LEVEL4
@node \address, \cc, Letters, Letters
@comment node-name, next, previous, up
@subsection \address
@findex \address
@code{\address@{Return address@}}
The return address, as it should appear on the letter and the envelope.
Separate lines of the address should be separated by @code{\\} commands.
If you do not make an @code{\address} declaration, then the letter will
be formatted for copying onto your organisation's standard letterhead.
(@xref{Overview}, for details on your local implementation). If you
give an @code{\address} declaration, then the letter will be formatted
as a personal letter.
@comment *************
@comment ** \cc ******
@comment *************
@comment LEVEL3
@node \cc, \closing, \address, Letters
@comment node-name, next, previous, up
@subsection \cc
@findex \cc
@cindex Cc list
@code{\cc@{Kate Schechter\\Rob McKenna@}}
Generate a list of other persons the letter was sent to. Each name is
printed on a separate line.
@comment ******************
@comment ** \closing ******
@comment ******************
@comment LEVEL3
@node \closing, \encl, \cc, Letters
@comment node-name, next, previous, up
@subsection \closing
@findex \closing
@cindex Letters, ending
@code{\closing@{text@}}
The letter closes with a @code{\closing} command, i.e.,
@example
\closing@{Best Regards,@}
@end example
@comment ******************
@comment ** \encl ******
@comment ******************
@comment LEVEL3
@node \encl, \location, \closing, Letters
@comment node-name, next, previous, up
@subsection \encl
@findex \encl
@cindex Enclosed material
@code{\encl@{CV\\Certificates@}}
Generate a list of enclosed material.
@comment **************
@comment * \location **
@comment **************
@comment LEVEL4
@node \location, \makelabels, \encl, Letters
@comment node-name, next, previous, up
@subsection \location
@findex \location
@code{\location@{address@}}
This modifies your organisation's standard address. This only appears
if the @code{firstpage} pagestyle is selected.
@comment **************
@comment * \makelabels *
@comment **************
@comment LEVEL4
@node \makelabels, \name, \location, Letters
@comment node-name, next, previous, up
@subsection \makelabels
@findex \makelabels
@code{\makelabels@{number@}}
If you issue this command in the preamble, LaTeX will create a sheet of
address labels. This sheet will be output before the letters.
@comment ******************
@comment ** \name ******
@comment ******************
@comment LEVEL3
@node \name, \opening, \makelabels, Letters
@comment node-name, next, previous, up
@subsection \name
@findex \name
@code{\name@{June Davenport@}}
Your name, used for printing on the envelope together with the return
address.
@comment ******************
@comment ** \opening ******
@comment ******************
@comment LEVEL3
@node \opening, \ps, \name, Letters
@comment node-name, next, previous, up
@subsection \opening
@findex \opening
@cindex Letters, starting
@code{\opening@{text@}}
The letter begins with the @code{\opening} command. The mandatory
argument, @code{text}, is whatever text you wish to start your letter,
i.e.,
@example
\opening@{Dear Joe,@}
@end example
@comment ******************
@comment ** \ps ******
@comment ******************
@comment LEVEL3
@node \ps, \signature, \opening, Letters
@comment node-name, next, previous, up
@subsection \ps
@findex \ps
@code{\ps}
Use this command before a postscript.
@comment **************
@comment * \signature *
@comment **************
@comment LEVEL4
@node \signature, \startbreaks, \ps, Letters
@comment node-name, next, previous, up
@subsection \signature
@findex \signature
@code{\signature@{Harvey Swick@}}
Your name, as it should appear at the end of the letter underneath the
space for your signature. Items that should go on separate lines should
be separated by @code{\\} commands.
@comment ******************
@comment ** \startbreaks ******
@comment ******************
@comment LEVEL3
@node \startbreaks, \stopbreaks, \signature, Letters
@comment node-name, next, previous, up
@subsection \startbreaks
@findex \startbreaks
@code{\startbreaks}
Used after a @code{\stopbreaks} command to allow page breaks again.
@comment ******************
@comment ** \stopbreaks ******
@comment ******************
@comment LEVEL3
@node \stopbreaks, \telephone, \startbreaks, Letters
@comment node-name, next, previous, up
@subsection \stopbreaks
@findex \stopbreaks
@code{\stopbreaks}
Inhibit page breaks until a @code{\startbreaks} command occurs.
@comment **************
@comment * \telephone *
@comment **************
@comment LEVEL4
@node \telephone, , \stopbreaks, Letters
@comment node-name, next, previous, up
@subsection \telephone
@findex \telephone
@code{\telephone@{number@}}
This is your telephone number. This only appears if the
@code{firstpage} pagestyle is selected.
@page
@comment *************************
@comment * Line & Page Breaking **
@comment *************************
@comment LEVEL2
@node Line & Page Breaking, Making Paragraphs, Letters, Commands
@comment node-name, next, previous, up
@section Line & Page Breaking
@cindex Page Breaking
@cindex Line Breaking
@cindex Page Formatting
The first thing LaTeX does when processing ordinary text is to
translate your input file into a string of glyphs and spaces. To
produce a printed document, this string must be broken into lines, and
these lines must be broken into pages. In some environments, you do the
line breaking yourself with the @code{\\} command, but LaTeX usually
does it for you.
@menu
* \\:: Start a new line.
* \- (hyphenation):: Insert explicit hyphenation.
* \cleardoublepage:: Start a new right-hand page.
* \clearpage:: Start a new page.
* \enlargethispage:: Enlarge the current page a bit.
* \fussy:: Be fussy about line breaking.
* \hyphenation:: Tell LaTeX how to hyphenate a word.
* \linebreak:: Break the line.
* \newline:: Break the line prematurely.
* \newpage:: Start a new page.
* \nolinebreak:: Don't break the current line.
* \nopagebreak:: Don't make a page break here.
* \pagebreak:: Please make a page break here.
* \sloppy:: Be sloppy about line breaking.
@end menu
@comment ******************
@comment ****** \\ ********
@comment ******************
@comment LEVEL3
@node \\, \- (hyphenation), Line & Page Breaking, Line & Page Breaking
@comment node-name, next, previous, up
@subsection \\
@findex \\
@cindex New line, starting
@code{\\[*][extra-space]}
The @code{\\} command tells LaTeX to start a new line. It has an
optional argument, @code{extra-space}, that specifies how much extra
vertical space is to be inserted before the next line. This can be a
negative amount.
The @code{\\*} command is the same as the ordinary @code{\\} command
except that it tells LaTeX not to start a new page after the line.
@comment **********************
@comment ** \- (hyphenation) **
@comment **********************
@comment LEVEL3
@node \- (hyphenation), \cleardoublepage, \\, Line & Page Breaking
@comment node-name, next, previous, up
@subsection \-
@findex \- (hyphenation)
@cindex Hyphenation, forcing
The @code{\-} command tells LaTeX that it may hyphenate the word at that
point. LaTeX is very good at hyphenating, and it will usually find all
correct hyphenation points. The @code{\-} command is used for the
exceptional cases.
Note that when you insert @code{\-} 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.
@comment ********************
@comment * \cleardoublepage *
@comment ********************
@comment LEVEL3
@node \cleardoublepage, \clearpage, \- (hyphenation), Line & Page Breaking
@comment node-name, next, previous, up
@subsection \cleardoublepage
@findex \cleardoublepage
@cindex Starting on a right-hand page
The @code{\cleardoublepage} 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.
@comment ******************
@comment ** \clearpage ****
@comment ******************
@comment LEVEL3
@node \clearpage, \enlargethispage, \cleardoublepage, Line & Page Breaking
@comment node-name, next, previous, up
@subsection \clearpage
@findex \clearpage
@cindex Flushing a page
The @code{\clearpage} command ends the current page and causes all
figures and tables that have so far appeared in the input to be printed.
@comment ******************
@comment ** \enlargethispage **
@comment ******************
@comment LEVEL3
@node \enlargethispage, \fussy, \clearpage, Line & Page Breaking
@comment node-name, next, previous, up
@subsection \enlargethispage
@findex \enlargethispage
@cindex Enlarge current page
@code{\enlargethispage@{size@}}
@code{\enlargethispage*@{size@}}
Enlarge the @code{\textheight} for the current page by the specified
amount; e.g. @code{\enlargethispage@{\baselineskip@}} will allow one
additional line.
The starred form tries to squeeze the material together on the page as
much as possible. This is normally used together with an explicit
@code{\pagebreak}.
@node \fussy, \hyphenation, \enlargethispage, Line & Page Breaking
@comment node-name, next, previous, up
@subsection \fussy
@findex \fussy
@code{\fussy}
This declaration (which is the default) makes TeX more fussy about line
breaking. This can avoids too much space between words, but may produce
overfull boxes.
This command cancels the effect of a previous @code{\sloppy} command. @ref{\sloppy}
@comment ******************
@comment ** \hyphenation **
@comment ******************
@comment LEVEL3
@node \hyphenation, \linebreak, \fussy, Line & Page Breaking
@comment node-name, next, previous, up
@subsection \hyphenation
@findex \hyphenation
@cindex Hyphenation, defining
@code{\hyphenation@{words@}}
The @code{\hyphenation} command declares allowed hyphenation points,
where @code{words} is a list of words, separated by spaces, in which
each hyphenation point is indicated by a @code{-} character.
@comment ******************
@comment ** \linebreak ****
@comment ******************
@comment LEVEL3
@node \linebreak, \newline, \hyphenation, Line & Page Breaking
@comment node-name, next, previous, up
@subsection \linebreak
@findex \linebreak
@cindex Line breaks
@code{\linebreak[number]}
The @code{\linebreak} command tells LaTeX to break the current line at
the point of the command. With the optional argument, @code{number},
you can convert the @code{\linebreak} 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.
The @code{\linebreak} command causes LaTeX to stretch the line so it
extends to the right margin.
@comment ******************
@comment ** \newline ******
@comment ******************
@comment LEVEL3
@node \newline, \newpage, \linebreak, Line & Page Breaking
@comment node-name, next, previous, up
@subsection \newline
@findex \newline
@cindex New line, starting (paragraph mode)
The @code{\newline} command breaks the line right where it is. It can
only be used in paragraph mode.
@comment ******************
@comment ** \newpage ******
@comment ******************
@comment LEVEL3
@node \newpage, \nolinebreak, \newline, Line & Page Breaking
@comment node-name, next, previous, up
@subsection \newpage
@findex \newpage
@cindex New Page
The @code{\newpage} command ends the current page.
@comment ******************
@comment * \nolinebreak ***
@comment ******************
@comment LEVEL3
@node \nolinebreak, \nopagebreak, \newpage, Line & Page Breaking
@comment node-name, next, previous, up
@subsection \nolinebreak
@findex \nolinebreak
@code{\nolinebreak[number]}
The @code{\nolinebreak} command prevents LaTeX from breaking the current
line at the point of the command. With the optional argument,
@code{number}, you can convert the @code{\nolinebreak} 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.
@comment ******************
@comment ** \nopagebreak **
@comment ******************
@comment LEVEL3
@node \nopagebreak, \pagebreak, \nolinebreak, Line & Page Breaking
@comment node-name, next, previous, up
@subsection \nopagebreak
@findex \nopagebreak
@code{\nopagebreak[number]}
The @code{\nopagebreak} command prevents LaTeX from breaking the current
page at the point of the command. With the optional argument,
@code{number}, you can convert the @code{\nopagebreak} 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.
@comment ******************
@comment ** \pagebreak ****
@comment ******************
@comment LEVEL3
@node \pagebreak, \sloppy, \nopagebreak, Line & Page Breaking
@comment node-name, next, previous, up
@subsection \pagebreak
@findex \pagebreak
@cindex Page break, forcing
@code{\pagebreak[number]}
The @code{\pagebreak} command tells LaTeX to break the current page at
the point of the command. With the optional argument, @code{number},
you can convert the @code{\pagebreak} 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.
@node \sloppy, , \pagebreak, Line & Page Breaking
@comment node-name, next, previous, up
@subsection \sloppy
@findex \sloppy
@code{\sloppy}
This declaration makes TeX less fussy about line breaking. This can
prevent overfull boxes, but may leave too much space between words.
Lasts until a @code{\fussy} command is issued. @ref{\fussy}.
@page
@comment *************************
@comment *** Making Paragraphs ***
@comment *************************
@comment LEVEL2
@node Making Paragraphs, Margin Notes, Line & Page Breaking, Commands
@comment node-name, next, previous, up
@section Making Paragraphs
@cindex Making paragraphs
@cindex Paragraphs
A paragraph is ended by one or more completely blank lines --- lines not
containing even a @code{%}. 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.
@menu
* \indent:: Indent this paragraph.
* \noindent:: Do not indent this paragraph.
* \par:: Another way of writing a blank line.
@end menu
@comment ******************
@comment ** \indent *******
@comment ******************
@comment LEVEL3
@node \indent, \noindent, Making Paragraphs, Making Paragraphs
@comment node-name, next, previous, up
@subsection \indent
@findex \indent
@cindex Indent, forcing
@code{\indent}
This produces a horizontal space whose width equals the width of the
paragraph indentation. It is used to add paragraph indentation where it
would otherwise be suppressed.
@comment ******************
@comment ** \noindent *****
@comment ******************
@comment LEVEL3
@node \noindent, \par, \indent, Making Paragraphs
@comment node-name, next, previous, up
@subsection \noindent
@findex \noindent
@cindex Indent, suppressing
@code{\noindent}
When used at the beginning of the paragraph, it suppresses the paragraph
indentation. It has no effect when used in the middle of a paragraph.
@comment ******************
@comment ** \par **********
@comment ******************
@comment LEVEL3
@node \par, , \noindent, Making Paragraphs
@comment node-name, next, previous, up
@subsection \par
@findex \par
@cindex Paragraph, starting a new
Equivalent to a blank line; often used to make command or environment
definitions easier to read.
@page
@comment ********************
@comment *** Margin Notes ***
@comment ********************
@comment LEVEL2
@node Margin Notes, Math Formulae, Making Paragraphs, Commands
@comment node-name, next, previous, up
@section Margin Notes
@cindex Margin Notes
@cindex Notes in the margin
@cindex Remarks in the margin
The command @code{\marginpar[left]@{right@}} creates a note in the margin.
The first line will be at the same height as the line in the text where
the @code{\marginpar} occurs.
When you only specify the mandatory argument @code{right}, the text will
be placed
@itemize @bullet
@item
in the right margin for one-sided layout
@item
in the outside margin for two-sided layout
@item
in the nearest margin for two-column layout.
@end itemize
By issuing the command @code{\reversemarginpar}, you can force the marginal
notes to go into the opposite (inside) margin.
When you specify both arguments, @code{left} is used for the left
margin, and @code{right} is used for the right margin.
The first word will normally not be hyphenated; you can enable
hyphenation by prefixing the first word with a @code{\hspace@{0pt@}}
command.
@comment *************************
@comment **** Math Formulae ******
@comment *************************
@comment LEVEL2
@node Math Formulae, Modes, Margin Notes, Commands
@comment node-name, next, previous, up
@section Math Formulae
@cindex Math Formulae
@cindex Formulae, maths
@cindex Math mode, entering
@findex \(
@findex \)
@findex \[
@findex \]
@findex $
There are three environments that put LaTeX in math mode:
@table @code
@item math
For Formulae that appear right in the text.
@item displaymath
For Formulae that appear on their own line.
@item equation
The same as the displaymath environment except that it adds an equation
number in the right margin.
@end table
The @code{math} environment can be used in both paragraph and LR mode,
but the @code{displaymath} and @code{equation} environments can be used
only in paragraph mode. The @code{math} and @code{displaymath}
environments are used so often that they have the following short forms:
@example
\(...\) instead of \begin@{math@}...\end@{math@}
\[...\] instead of \begin@{displaymath@}...\end@{displaymath@}
@end example
In fact, the @code{math} environment is so common that it has an even
shorter form:
@example
$ ... $ instead of \(...\)
@end example
@cindex exponent
@menu
* Subscripts & Superscripts:: Also known as exponent or index.
* Math Symbols:: Various mathematical squiggles.
* Spacing in Math Mode:: Thick, medium, thin and negative spaces.
* Math Miscellany:: Stuff that doesn't fit anywhere else.
@end menu
@comment *****************************
@comment * Subscripts & Superscripts *
@comment *****************************
@comment LEVEL3
@node Subscripts & Superscripts, Math Symbols, Math Formulae, Math Formulae
@comment node-name, next, previous, up
@subsection Subscripts & Superscripts
@cindex Superscript
@cindex Subscript
@findex _
@findex ^
To get an expression @i{exp} to appear as a subscript, you just type
@code{_@{}@i{exp}@code{@}}. To get @i{exp} to appear as a superscript, you type
@code{^@{}@i{exp}@code{@}}. 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.
@comment ******************
@comment ** Math Symbols **
@comment ******************
@comment LEVEL3
@node Math Symbols, Spacing in Math Mode, Subscripts & Superscripts, Math Formulae
@comment node-name, next, previous, up
@subsection Math Symbols
@cindex Maths symbols
@cindex Symbols
@cindex Greek letters
@ifinfo
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 @code{$\pi$} in your source, you will get the
symbol ``pi'' in your output.
@end ifinfo
@iftex
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 @code{$\pi$} in your source, you will get the
symbol
@tex
$\pi$
@end tex
in your output.
@end iftex
@comment ************************
@comment * Spacing in Math Mode *
@comment ************************
@comment LEVEL3
@node Spacing in Math Mode, Math Miscellany, Math Symbols, Math Formulae
@comment node-name, next, previous, up
@subsection Spacing in Math Mode
@cindex Spacing, within Math mode
@cindex Math mode, spacing
In a @code{math} environment, LaTeX ignores the spaces you type and puts
in the spacing that it thinks is best. LaTeX formats mathematics the
way it's done in mathematics texts. If you want different spacing,
LaTeX provides the following four commands for use in math mode:
@findex \;
@findex \COLON
@findex \,
@findex \!
@enumerate
@item
@code{\;} - a thick space
@item
@code{\:} - a medium space
@item
@code{\,} - a thin space
@item
@code{\!} - a negative thin space
@end enumerate
@comment *******************
@comment * Math Miscellany *
@comment *******************
@comment LEVEL3
@node Math Miscellany, , Spacing in Math Mode, Math Formulae
@comment node-name, next, previous, up
@subsection Math Miscellany
@cindex Maths Miscellany
@table @code
@item \cdots
@findex \cdots
Produces a horizontal ellipsis where the dots are raised to the centre
of the line.
@iftex
eg.
@tex
$\cdots$
@end tex
@end iftex
@item \ddots
@findex \ddots
Produces a diagonal ellipsis.
@iftex
eg.
@tex
$\ddots$
@end tex
@end iftex
@item \frac@{num@}@{den@}
@findex \frac
Produces the fraction @code{num} divided by @code{den}.
@iftex
eg.
@tex
${1}\over{4}$
@end tex
@end iftex
@item \ldots
@findex \ldots
Produces an ellipsis. This command works in
any mode, not just math mode.
@iftex
eg.
@tex
$\ldots$
@end tex
@end iftex
@item \overbrace@{text@}
@findex \overbrace
Generates a brace over text.
@iftex
eg.
@tex
$\overbrace{x+\cdots+x}^{k \rm\;times}$
@end tex
@end iftex
@item \overline@{text@}
@findex \overline
Causes the argument text to be overlined.
@iftex
eg.
@tex
$\overline{x}$
@end tex
@end iftex
@item \sqrt[root]@{arg@}
@findex \sqrt
Produces the square root of its argument. The
optional argument, @code{root}, determines what root to produce, i.e.,
the cube root of @code{x+y} would be typed as @code{$\sqrt[3]@{x+y@}$}.
@iftex
eg.
@tex
$\sqrt{x-1}$
@end tex
@end iftex
@item \underbrace@{text@}
@findex \underbrace
Generates text with a brace underneath.
@iftex
eg.
@tex
$\underbrace{x+y+z}_{>\,0}$
@end tex
@end iftex
@item \underline@{text@}
@findex \underline
Causes the argument text to be underlined.
This command can also be used in paragraph and LR modes.
@iftex
eg.
@tex
$\underline{z}$
@end tex
@end iftex
@item \vdots
@findex \vdots
Produces a vertical ellipsis.
@iftex
eg.
@tex
$\vdots$
@end tex
@end iftex
@end table
@page
@comment *************************
@comment ******* Modes ***********
@comment *************************
@comment LEVEL2
@node Modes, Page Styles, Math Formulae, Commands
@comment node-name, next, previous, up
@section Modes
@cindex Modes
@cindex Paragraph mode
@cindex Math mode
@cindex Left-to-right mode
@cindex LR mode
When LaTeX is processing your input text, it is always in one of three
modes:
@itemize @bullet
@item
Paragraph mode
@item
Math mode
@item
Left-to-right mode, called LR mode for short
@end itemize
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.
``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 @code{\mbox}, 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.
LaTeX is in LR mode when it starts making a box with an @code{\mbox}
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 @code{parbox}. 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''.
@page
@comment *************************
@comment ***** Page Styles *******
@comment *************************
@comment LEVEL2
@node Page Styles, Sectioning, Modes, Commands
@comment node-name, next, previous, up
@section Page Styles
@cindex Styles, page
@cindex Page styles
The @code{\documentclass} command determines the size and position of
the page's head and foot. The page style determines what goes in them.
@menu
* \maketitle:: Generate a title page.
* \pagenumbering:: Set the style used for page numbers.
* \pagestyle:: Change the headings/footings style.
* \thispagestyle:: Change the headings/footings style for this page.
@end menu
@comment ******************
@comment ** \maketitle ****
@comment ******************
@comment LEVEL3
@node \maketitle, \pagenumbering, Page Styles, Page Styles
@comment node-name, next, previous, up
@subsection \maketitle
@cindex Title making
@findex \maketitle
@code{\maketitle}
The @code{\maketitle} command generates a title on a separate title page
- except in the @code{article} class, where the title normally goes at
the top of the first page. Information used to produce the title is
obtained from the following declarations:
@xref{Page Styles} for the commands to give the information.
@menu
* \author:: Who wrote this stuff?
* \date:: The date the document was created.
* \thanks:: A special form of footnote.
* \title:: How to set the document title.
@end menu
@comment ***********
@comment * \author *
@comment ***********
@comment LEVEL4
@node \author, \date, \maketitle, \maketitle
@comment node-name, next, previous, up
@subsection \author
@findex \author
@cindex Author, for titlepage
@code{\author@{names@}}
The @code{\author} command declares the author(s), where @code{names} is
a list of authors separated by @code{\and} commands. Use @code{\\} to
separate lines within a single author's entry -- for example, to give
the author's institution or address.
@comment ***********
@comment ** \date **
@comment ***********
@comment LEVEL4
@node \date, \thanks, \author, \maketitle
@comment node-name, next, previous, up
@subsection \date
@findex \date
@cindex Date, for titlepage
@code{\date@{text@}}
The @code{\date} command declares @i{text} to be the document's date. With
no @code{\date} command, the current date is used.
@comment ***********
@comment * \thanks *
@comment ***********
@comment LEVEL4
@node \thanks, \title, \date, \maketitle
@comment node-name, next, previous, up
@subsection \thanks
@findex \thanks
@cindex Thanks, for titlepage
@code{\thanks@{text@}}
The @code{\thanks} command produces a @code{\footnote} to the title.
@comment ***********
@comment * \title **
@comment ***********
@comment LEVEL4
@node \title, , \thanks, \maketitle
@comment node-name, next, previous, up
@subsection \title
@findex \title
@cindex Title, for titlepage
@code{\title@{text@}}
The @code{\title} command declares @code{text} to be the title. Use
@code{\\} to tell LaTeX where to start a new line in a long title.
@comment ******************
@comment * \pagenumbering *
@comment ******************
@comment LEVEL3
@node \pagenumbering, \pagestyle, \maketitle, Page Styles
@comment node-name, next, previous, up
@subsection \pagenumbering
@findex \pagenumbering
@cindex Page numbering
@code{\pagenumbering@{num_style@}}
Specifies the style of page numbers. Possible values of @code{num_style} are:
@itemize @bullet
@item
@code{arabic} - Arabic numerals
@item
@code{roman} - Lowercase Roman numerals
@item
@code{Roman} - Uppercase Roman numerals
@item
@code{alph} - Lowercase letters
@item
@code{Alph} - Uppercase letters
@end itemize
@comment ******************
@comment ** \pagestyle ****
@comment ******************
@comment LEVEL3
@node \pagestyle, \thispagestyle, \pagenumbering, Page Styles
@comment node-name, next, previous, up
@subsection \pagestyle
@findex \pagestyle
@code{\pagestyle@{option@}}
The @code{\pagestyle} command changes the style from the current page on
throughout the remainder of your document.
The valid options are:
@itemize @bullet
@item
@code{plain} - Just a plain page number.
@item
@code{empty} - Produces empty heads and feet - no page numbers.
@item
@code{headings} - Puts running headings on each page. The document
style specifies what goes in the headings.
@item
@code{myheadings} - You specify what is to go in the heading with the
@code{\markboth} or the @code{\markright} commands.
@end itemize
@menu
* \markboth:: Set left and right headings.
* \markright:: Set right heading only.
@end menu
@comment ***************
@comment ** \markboth **
@comment ***************
@comment LEVEL4
@node \markboth, \markright, \pagestyle, \pagestyle
@comment node-name, next, previous, up
@subsection \markboth
@findex \markboth
@example
\markboth@{left head@}@{right head@}
@end example
The @code{\markboth} command is used in
conjunction with the page style @code{myheadings} for setting
both the left and the right heading. You should note that a ``left-hand
heading'' is generated by the last @code{\markboth} command before the
end of the page, while a ``right-hand heading'' is generated by the first
@code{\markboth} or @code{\markright} that comes on the page if there is
one, otherwise by the last one before the page.
@comment ****************
@comment ** \markright **
@comment ****************
@comment LEVEL4
@node \markright, , \markboth, \pagestyle
@comment node-name, next, previous, up
@subsection \markright
@findex \markright
@example
\markright@{right head@}
@end example
The @code{\markright} command is used in conjunction with the page style
@code{myheadings} for setting the right heading, leaving the left
heading unchanged. You should note that a ``left-hand heading'' is
generated by the last @code{\markboth} command before the end of the
page, while a ``right-hand heading'' is generated by the first
@code{\markboth} or @code{\markright} that comes on the page if there is
one, otherwise by the last one before the page.
@comment ******************
@comment * \thispagestyle *
@comment ******************
@comment LEVEL3
@node \thispagestyle, , \pagestyle, Page Styles
@comment node-name, next, previous, up
@subsection \thispagestyle
@findex \thispagestyle
@code{\thispagestyle@{option@}}
The @code{\thispagestyle} command works in the same manner as the
@code{\pagestyle} command except that it changes the style for the
current page only.
@page
@comment *************************
@comment ***** Sectioning ********
@comment *************************
@comment LEVEL2
@node Sectioning, Spaces & Boxes, Page Styles, Commands
@comment node-name, next, previous, up
@section Sectioning
@cindex Sectioning
@findex \chapter
@findex \subsubsection
@findex \subsection
@findex \paragraph
@findex \subparagraph
Sectioning commands provide the means to structure your text into units.
@itemize @bullet
@item
@code{\part}
@item
@code{\chapter} (report and book class only)
@item
@code{\section}
@item
@code{\subsection}
@item
@code{\subsubsection}
@item
@code{\paragraph}
@item
@code{\subparagraph}
@end itemize
All sectioning commands take the same general form, i.e.,
@code{\chapter[optional]@{title@}}
In addition to providing the heading in the text, the mandatory argument
of the sectioning command can appear in two other places:
@enumerate
@item
The table of contents
@item
The running head at the top of the page
@end enumerate
You may not want the same thing to appear in these other two places as
appears in the text heading. To handle this situation, the sectioning
commands have an @code{optional} argument that provides the text for
these other two purposes.
All sectioning commands have @code{*}-forms that print a @i{title},
but do not include a number and do not make an entry in the table of
contents.
@findex \appendix
@cindex Appendix, creating
@code{\appendix}
The @code{\appendix} command changes the way sectional units are
numbered. The @code{\appendix} command generates no text and does not
affect the numbering of parts.
The normal use of this command is something like
@example
\chapter@{The First Chapter@}
@dots{}
\appendix
\chapter@{The First Appendix@}
@end example
@page
@comment *************************
@comment **** Spaces & Boxes *****
@comment *************************
@comment LEVEL2
@node Spaces & Boxes, Special Characters, Sectioning, Commands
@comment node-name, next, previous, up
@section Spaces & Boxes
@cindex Spaces
@cindex Boxes
All the predefined length parameters @xref{Predefined lengths} can be
used in the arguments of the box-making commands.
@menu
Horizontal space
* \dotfill:: Stretchable horizontal dots.
* \hfill:: Stretchable horizontal space.
* \hrulefill:: Stretchable horizontal rule.
* \hspace:: Fixed horizontal space.
Vertical space
* \addvspace:: Fixed vertical space.
* \bigskip:: Fixed vertical space.
* \medskip:: Fixed vertical space.
* \smallskip:: Fixed vertical space.
* \vfill:: Stretchable vertical space.
* \vspace:: Fixed vertical space.
Boxes
* \fbox:: Framebox.
* \framebox:: Framebox, adjustable position.
* lrbox:: An environment like \sbox.
* \makebox:: Box, adjustable position.
* \mbox:: Box.
* \newsavebox:: Declare a name for saving a box.
* \parbox:: Box with text in paragraph mode.
* \raisebox:: Raise or lower text.
* \rule:: Lines and squares.
* \savebox:: Like \makebox, but save the text for later use.
* \sbox:: Like \mbox, but save the text for later use.
* \usebox:: Print saved text.
@end menu
@comment ***************
@comment ** \dotfill ***
@comment ***************
@comment LEVEL3
@node \dotfill, \hfill, , Spaces & Boxes
@comment node-name, next, previous, up
@subsection \dotfill
@findex \dotfill
The @code{\dotfill} command produces a ``rubber length'' that produces dots
instead of just spaces.
@comment ***************
@comment ** \hfill *****
@comment ***************
@comment LEVEL3
@node \hfill, \hrulefill, \dotfill, Spaces & Boxes
@comment node-name, next, previous, up
@subsection \hfill
@findex \hfill
The @code{\hfill} fill command produces a ``rubber length'' which can
stretch or shrink horizontally. It will be filled with spaces.
@comment ****************
@comment ** \hrulefill **
@comment ****************
@comment LEVEL3
@node \hrulefill, \hspace, \hfill, Spaces & Boxes
@comment node-name, next, previous, up
@subsection \hrulefill
@findex \hrulefill
The @code{\hrulefill} fill command produces a ``rubber length'' which can
stretch or shrink horizontally. It will be filled with a horizontal
rule.
@comment ***************
@comment ** \hspace ****
@comment ***************
@comment LEVEL3
@node \hspace, \addvspace, \hrulefill, Spaces & Boxes
@comment node-name, next, previous, up
@subsection \hspace
@findex \hspace
@code{\hspace[*]@{length@}}
The @code{\hspace} command adds horizontal space. The length of the
space can be expressed in any terms that LaTeX understands, i.e.,
points, inches, etc. You can add negative as well as positive space
with an @code{\hspace} command. Adding negative space is like
backspacing.
LaTeX removes horizontal space that comes at the end of a line. If you
don't want LaTeX to remove this space, include the optional @code{*}
argument. Then the space is never removed.
@comment ****************
@comment ** \addvspace **
@comment ****************
@comment LEVEL3
@node \addvspace, \bigskip, \hspace, Spaces & Boxes
@comment node-name, next, previous, up
@subsection \addvspace
@findex \addvspace
@cindex Vertical space, inserting
@cindex Space, inserting vertical
@code{\addvspace@{length@}}
The @code{\addvspace} 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 @code{\addvspace} command, then this
command will not add more space than needed to make the natural length
of the total vertical space equal to @code{length}.
@comment ***************
@comment ** \bigskip ***
@comment ***************
@comment LEVEL3
@node \bigskip, \medskip, \addvspace, Spaces & Boxes
@comment node-name, next, previous, up
@subsection \bigskip
@findex \bigskip
The @code{\bigskip} command is equivalent to
@code{\vspace@{bigskipamount@}} where @code{bigskipamount} is determined
by the document class.
@comment ***************
@comment ** \medskip ***
@comment ***************
@comment LEVEL3
@node \medskip, \smallskip, \bigskip, Spaces & Boxes
@comment node-name, next, previous, up
@subsection \medskip
@findex \medskip
The @code{\medskip} command is equivalent to
@code{\vspace@{medskipamount@}} where @code{medskipamount} is determined
by the document class.
@comment ****************
@comment ** \smallskip **
@comment ****************
@comment LEVEL3
@node \smallskip, \vfill, \medskip, Spaces & Boxes
@comment node-name, next, previous, up
@subsection \smallskip
@findex \smallskip
@code{\smallskip}
The @code{\smallskip} command is equivalent to
@code{\vspace@{smallskipamount@}} where @code{smallskipamount} is
determined by the document class.
@comment ***************
@comment ** \vfill *****
@comment ***************
@comment LEVEL3
@node \vfill, \vspace, \smallskip, Spaces & Boxes
@comment node-name, next, previous, up
@subsection \vfill
@findex \vfill
The @code{\vfill} fill command produces a rubber length which can
stretch or shrink vertically.
@comment ***************
@comment ** \vspace ****
@comment ***************
@comment LEVEL3
@node \vspace, \fbox, \vfill, Spaces & Boxes
@comment node-name, next, previous, up
@subsection \vspace
@findex \vspace
@code{\vspace[*]@{length@}}
The @code{\vspace} command adds vertical space. The length of the space
can be expressed in any terms that LaTeX understands, i.e., points,
inches, etc. You can add negative as well as positive space with an
@code{\vspace} command.
LaTeX removes vertical space that comes at the end of a page. If you
don't want LaTeX to remove this space, include the optional @code{*}
argument. Then the space is never removed.
@comment ***************
@comment ** \fbox ******
@comment ***************
@comment LEVEL3
@node \fbox, \framebox, \vspace, Spaces & Boxes
@comment node-name, next, previous, up
@subsection \fbox
@findex \fbox
@code{\fbox@{text@}}
The @code{\fbox} command is exactly the same as the @code{\mbox}
command, except that it puts a frame around the outside of the box that
it creates.
@comment ***************
@comment ** \framebox **
@comment ***************
@comment LEVEL3
@node \framebox, lrbox, \fbox, Spaces & Boxes
@comment node-name, next, previous, up
@subsection \framebox
@findex \framebox
@code{\framebox[width][position]@{text@}}
The @code{\framebox} command is exactly the same as the @code{\makebox}
command, except that it puts a frame around the outside of the box that
it creates.
The framebox command produces a rule of thickness @code{\fboxrule}, and
leaves a space @code{\fboxsep} between the rule and the contents of the
box.
@comment ***************
@comment ** lrbox ****
@comment ***************
@comment LEVEL3
@node lrbox, \makebox, \framebox, Spaces & Boxes
@comment node-name, next, previous, up
@subsection lrbox
@findex lrbox
@code{\begin@{lrbox@}@{cmd@} text \end@{lrbox@}}
This is the environment form of @code{\sbox}.
The text inside the environment is saved in the box @code{cmd}, which
must have been declared with @code{\newsavebox}.
@comment **************
@comment ** \makebox **
@comment **************
@comment LEVEL3
@node \makebox, \mbox, lrbox, Spaces & Boxes
@comment node-name, next, previous, up
@subsection \makebox
@findex \makebox
@code{\makebox[width][position]@{text@}}
The @code{\makebox} command creates a box just wide enough to contain
the @code{text} specified. The width of the box is specified by the
optional @code{width} argument. The position of the text within the box
is determined by the optional @code{position} argument.
@itemize @bullet
@item
@code{c} --- centred (default)
@item
@code{l} --- flushleft
@item
@code{r} --- flushright
@item
@code{s} --- stretch from left to right margin. The text must contain
stretchable space for this to work.
@end itemize
@xref{\makebox (picture)}.
@comment ***************
@comment ** \mbox ******
@comment ***************
@comment LEVEL3
@node \mbox, \newsavebox, \makebox, Spaces & Boxes
@comment node-name, next, previous, up
@subsection \mbox
@findex \mbox
@code{\mbox@{text@}}
The @code{\mbox} command creates a box just wide enough to hold the text
created by its argument.
Use this command to prevent text from being split across lines.
@comment ****************
@comment ** \newsavebox *
@comment ****************
@comment LEVEL3
@node \newsavebox, \parbox, \mbox, Spaces & Boxes
@comment node-name, next, previous, up
@subsection \newsavebox
@findex \newsavebox
@code{\newsavebox@{cmd@}}
Declares @code{cmd}, which must be a command name that is not already
defined, to be a bin for saving boxes.
@comment ***************
@comment ** \parbox ****
@comment ***************
@comment LEVEL3
@node \parbox, \raisebox, \newsavebox, Spaces & Boxes
@comment node-name, next, previous, up
@subsection \parbox
@findex \parbox
@code{\parbox[position][height][inner-pos]@{width@}@{text@}}
A @code{parbox} is a box whose contents are created in @code{paragraph}
mode. The @code{\parbox} has two mandatory arguments:
@itemize @bullet
@item
@code{width} - specifies the width of the parbox, and
@item
@code{text} - the text that goes inside the parbox.
@end itemize
LaTeX will position a @code{parbox} so its centre lines up with the centre of
the text line. The optional @i{position} argument allows you
to line up either the top or bottom line in the parbox (default is top).
If the @i{height} argument is not given, the box will have the natural
height of the text.
The @i{inner-pos} argument controls the placement of the text inside the
box. If it is not specified, @i{position} is used.
@itemize @bullet
@item
@code{t} --- text is placed at the top of the box.
@item
@code{c} --- text is centred in the box.
@item
@code{b} --- text is placed at the bottom of the box.
@item
@code{s} --- stretch vertically. The text must contain
vertically stretchable space for this to work.
@end itemize
A @code{\parbox} command is used for a parbox containing a small piece
of text, with nothing fancy inside. In particular, you shouldn't use
any of the paragraph-making environments inside a @code{\parbox}
argument. For larger pieces of text, including ones containing a
paragraph-making environment, you should use a @code{minipage}
environment @xref{minipage}.
@comment ***************
@comment ** \raisebox **
@comment ***************
@comment LEVEL3
@node \raisebox, \rule, \parbox, Spaces & Boxes
@comment node-name, next, previous, up
@subsection \raisebox
@findex \raisebox
@code{\raisebox@{distance@}[extend-above][extend-below]@{text@}}
The @code{\raisebox} command is used to raise or lower text. The first
mandatory argument specifies how high the text is to be raised (or
lowered if it is a negative amount). The text itself is processed in
@code{LR mode}.
Sometimes it's useful to make LaTeX think something has a different
size than it really does - or a different size than LaTeX would
normally think it has. The @code{\raisebox} command lets you tell
LaTeX how tall it is.
The first optional argument, @code{extend-above}, makes LaTeX think
that the text extends above the line by the amount specified. The
second optional argument, @code{extend-below}, makes LaTeX think that
the text extends below the line by the amount specified.
@comment ***************
@comment ** \rule ******
@comment ***************
@comment LEVEL3
@node \rule, \savebox, \raisebox, Spaces & Boxes
@comment node-name, next, previous, up
@subsection \rule
@findex \rule
@code{\rule[raise-height]@{width@}@{thickness@}}
The @code{\rule} command is used to produce horizontal lines. The
arguments are defined as follows:
@itemize @bullet
@item
@code{raise-height} - specifies how high to raise the rule (optional)
@item
@code{width} - specifies the length of the rule (mandatory)
@item
@code{thickness} - specifies the thickness of the rule (mandatory)
@end itemize
@comment ***************
@comment ** \savebox ***
@comment ***************
@comment LEVEL3
@node \savebox, \sbox, \rule, Spaces & Boxes
@comment node-name, next, previous, up
@subsection \savebox
@findex \savebox
@example
\savebox@{cmd@}[width][pos]@{text@}
@end example
This command typeset @code{text} in a box just as for @code{\makebox}.
However, instead of printing the resulting box, it saves it in bin
@code{cmd}, which must have been declared with @code{\newsavebox}.
@comment ***************
@comment ** \sbox ******
@comment ***************
@comment LEVEL3
@node \sbox, \usebox, \savebox, Spaces & Boxes
@comment node-name, next, previous, up
@subsection \sbox
@findex \sbox
@code{\sbox@{text@}}
This commands typeset @code{text} in a box just as for @code{\mbox}.
However, instead of printing the resulting box, it saves it in bin
@code{cmd}, which must have been declared with @code{\newsavebox}.
@comment ***************
@comment ** \usebox ****
@comment ***************
@comment LEVEL3
@node \usebox, , \sbox, Spaces & Boxes
@comment node-name, next, previous, up
@subsection \usebox
@findex \usebox
@code{\usebox@{cmd@}}
Prints the box most recently saved in bin @code{cmd} by a
@code{\savebox} command.
@page
@comment *************************
@comment ** Special Characters ***
@comment *************************
@comment LEVEL2
@node Special Characters, Splitting the Input, Spaces & Boxes, Commands
@comment node-name, next, previous, up
@section Special Characters
@cindex Special Characters
@cindex Characters, special
@cindex Reserved Characters
@cindex Characters, reserved
The following characters play a special role in LaTeX and are called
``special printing characters'', or simply ``special characters''.
@example
# $ % & ~ _ ^ \ @{ @}
@end example
Whenever you put one of these special characters into your file, you are
doing something special. If you simply want the character to be printed
just as any other letter, include a @code{\} in front of the character.
For example, @code{\$} will produce @code{$} in your output.
One exception to this rule is the @code{\} itself because @code{\\} has
its own special meaning. A @code{\} is produced by typing
@code{$\backslash$} in your file.
Also, @code{\~} means `place a tilde accent over the following letter',
so you will probably want to use @code{\verb} instead.
@findex \backslash
@findex \symbol
@cindex Accessing any character of a font
In addition, you can access any character of a font once you know its
number by using the @code{\symbol} command. For example, the character
used for displaying spaces in the @code{\verb*} command has the code
decimal 32, so it can be typed as @code{\symbol@{32@}}.
You can also specify octal numbers with @code{'} or hexadecimal numbers
with @code{"}, so the previous example could also be written as
@code{\symbol@{'40@}} or @code{\symbol@{"20@}}.
@comment *************************
@comment ** Splitting the Input **
@comment *************************
@comment LEVEL2
@node Splitting the Input, Starting & Ending, Special Characters, Commands
@comment node-name, next, previous, up
@section Splitting the Input
@cindex Splitting the input file
@cindex Input file, splitting
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.
@menu
* \include:: Conditionally include a file.
* \includeonly:: Determine which files are included.
* \input:: Unconditionally include a file.
@end menu
@comment ***************
@comment ** \include ***
@comment ***************
@comment LEVEL3
@node \include, \includeonly, Splitting the Input, Splitting the Input
@comment node-name, next, previous, up
@subsection \include
@findex \include
@code{\include@{file@}}
The @code{\include} command is used in conjunction with the
@code{\includeonly} command for selective inclusion of files. The
@code{file} argument is the first name of a file, denoting
@file{file.tex}. If @code{file} is one the file names in the file list
of the @code{\includeonly} command or if there is no @code{\includeonly}
command, the @code{\include} command is equivalent to
@example
\clearpage \input@{file@} \clearpage
@end example
except that if the file @file{file.tex} does not exist, then a warning
message rather than an error is produced. If the file is not in the
file list, the @code{\include} command is equivalent to @code{\clearpage}.
The @code{\include} command may not appear in the preamble or in a file
read by another @code{\include} command.
@comment *******************
@comment ** \includeonly ***
@comment *******************
@comment LEVEL3
@node \includeonly, \input, \include, Splitting the Input
@comment node-name, next, previous, up
@subsection \includeonly
@findex \includeonly
@code{\includeonly@{}@i{file_list}@code{@}}
The @code{\includeonly} command controls which files will be read in by
an @code{\include} command. @i{file_list} should be a comma-separated
list of filenames. Each filename must match exactly a filename specified
in a @code{\include} command. This command can only appear in the
preamble.
@comment ***************
@comment ** \input *****
@comment ***************
@comment LEVEL3
@node \input, , \includeonly, Splitting the Input
@comment node-name, next, previous, up
@subsection \input
@findex \input
@code{\input@{file@}}
The @code{\input} command causes the indicated @code{file} to be read and
processed, exactly as if its contents had been inserted in the current
file at that point. The file name may be a complete file name with
extension or just a first name, in which case the file @file{file.tex}
is used.
@page
@comment *************************
@comment *** Starting & Ending ***
@comment *************************
@comment LEVEL2
@node Starting & Ending, Table of Contents, Splitting the Input, Commands
@comment node-name, next, previous, up
@section Starting & Ending
@cindex Starting & Ending
@cindex Ending & Starting
Your input file must contain the following commands as a minimum:
@example
\documentclass@{class@}
\begin@{document@}
... your text goes here ...
\end@{document@}
@end example
where the @code{class} selected is one of the valid classes for LaTeX.
@xref{Document Classes} (and @pxref{Overview}), for details of the
various document classes available locally.
You may include other LaTeX commands between the @code{\documentclass}
and the @code{\begin@{document@}} commands (i.e., in the `preamble').
@page
@comment *************************
@comment *** Table of Contents ***
@comment *************************
@comment LEVEL2
@node Table of Contents, Terminal Input/Output, Starting & Ending, Commands
@comment node-name, next, previous, up
@section Table of Contents
@cindex Table of Contents, creating
A table of contents is produced with the
@code{\tableofcontents}
@findex \tableofcontents
command. You put the command right where you want the table of contents
to go; LaTeX does the rest for you. It produces a heading, but it does
not automatically start a new page. If you want a new page after the
table of contents, include a @code{\newpage} command after the
@code{\tableofcontents} command.
There are similar commands
@code{\listoffigures}
@findex \listoffigures
and
@code{\listoftables}
@findex \listoftables
for producing a list of figures and a list of tables, respectively.
Everything works exactly the same as for the table of contents.
NOTE: If you want any of these items to be generated, you cannot have
the
@code{\nofiles}
@findex \nofiles
command in your document.
@menu
* \addcontentsline:: Add an entry to table of contents etc.
* \addtocontents:: Add text directly to table of contents file etc.
@end menu
@comment ********************
@comment * \addcontentsline *
@comment ********************
@comment LEVEL3
@node \addcontentsline, \addtocontents, Table of Contents, Table of Contents
@comment node-name, next, previous, up
@subsection \addcontentsline
@findex \addcontentsline
@code{\addcontentsline@{file@}@{sec_unit@}@{entry@}}
The @code{\addcontentsline} command adds an entry to the specified list
or table where:
@itemize @bullet
@item
@code{file} is the extension of the file on which information is to be
written: @code{toc} (table of contents), @code{lof} (list of figures),
or @code{lot} (list of tables).
@item
@code{sec_unit} controls the formatting of the entry. It should be one
of the following, depending upon the value of the file argument:
@enumerate
@item
@code{toc} --- the name of the sectional unit, such as part or subsection.
@item
@code{lof} --- figure
@item
@code{lot} --- table
@end enumerate
@item
@code{entry} is the text of the entry.
@end itemize
@comment ******************
@comment * \addtocontents *
@comment ******************
@comment LEVEL3
@node \addtocontents, , \addcontentsline, Table of Contents
@comment node-name, next, previous, up
@subsection \addtocontents
@findex \addtocontents
@code{\addtocontents@{file@}@{text@}}
The @code{\addtocontents} command adds text (or formatting commands) directly
to the file that generates the table of contents or list of figures or
tables.
@itemize @bullet
@item
@code{file} is the extension of the file on which information is to be
written: @code{toc} (table of contents), @code{lof} (list of figures),
or @code{lot} (list of tables).
@item
@code{text} is the information to be written.
@end itemize
@page
@comment *************************
@comment * Terminal Input/Output *
@comment *************************
@comment LEVEL2
@node Terminal Input/Output, Typefaces, Table of Contents, Commands
@comment node-name, next, previous, up
@section Terminal Input/Output
@cindex Input/Output
@cindex Terminal Input/Output
@menu
* \typein:: Read text from the terminal.
* \typeout:: Write text to the terminal.
@end menu
@comment **************
@comment * \typein ****
@comment **************
@comment LEVEL3
@node \typein, \typeout, , Terminal Input/Output
@comment node-name, next, previous, up
@subsection \typein
@findex \typein
@code{\typein[cmd]@{msg@}}
Prints @code{msg} on the terminal and causes LaTeX to stop and wait for
you to type a line of input, ending with return. If the @code{cmd}
argument is missing, the typed input is processed as if it had been
included in the input file in place of the @code{\typein} command. If
the @code{cmd} argument is present, it must be a command name. This
command name is then defined or redefined to be the typed input.
@comment **************
@comment * \typeout ***
@comment **************
@comment LEVEL3
@node \typeout, , \typein, Terminal Input/Output
@comment node-name, next, previous, up
@subsection \typeout
@findex \typeout
@code{\typeout@{msg@}}
Prints @code{msg} on the terminal and in the @code{log} file. Commands
in @code{msg} that are defined with @code{\newcommand} or
@code{\renewcommand} are replaced by their definitions before being
printed.
LaTeX's usual rules for treating multiple spaces as
a single space and ignoring spaces after a command name apply to
@code{msg}. A @code{\space} command in @code{msg} causes a single space
to be printed. A @code{^^J} in @code{msg} prints a newline.
@page
@comment *************************
@comment ***** Typefaces *********
@comment *************************
@comment LEVEL2
@node Typefaces, , Terminal Input/Output, Commands
@comment node-name, next, previous, up
@section Typefaces
@cindex Typefaces
@cindex Fonts
The @code{typeface} is specified by giving the ``size'' and ``style''. A
typeface is also called a ``font''.
@menu
* Styles:: Select roman, italics etc.
* Sizes:: Select point size.
* Low-level font commands:: Commands for wizards.
@end menu
@comment **************
@comment ** Styles ****
@comment **************
@comment LEVEL3
@node Styles, Sizes, Typefaces, Typefaces
@comment node-name, next, previous, up
@subsection \Styles
@cindex Font Styles
@cindex Typeface Styles
@cindex Styles of text
The following type style commands are supported by LaTeX.
These commands are used like @code{\textit@{italics text@}}. 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.
The declaration forms are cumulative; i.e., you can say
@code{\sffamily\bfseries} to get sans serif boldface.
You can also use the environment form of the declaration forms; e.g.
@code{\begin@{ttfamily@}...\end@{ttfamily@}}.
@table @code
@item \textrm (\rmfamily)
@findex \textrm
@findex \rmfamily
Roman.
@item \textit (\itshape)
@findex \textit
@findex \itshape
@item \emph
@findex \emph
Emphasis (toggles between \textit and \textrm).
@item \textmd (\mdseries)
@findex \textmd
@findex \mdseries
Medium weight (default). The opposite of boldface.
@item \textbf (\bfseries)
@findex \textbf
@findex \bfseries
Boldface.
@item \textup (\upshape)
@findex \textup
@findex \upshape
Upright (default). The opposite of slanted.
@item \textsl (\slshape)
@findex \textsl
@findex \slshape
Slanted.
@item \textsf (\sffamily)
@findex \textsf
@findex \sffamily
Sans serif.
@item \textsc (\scshape)
@findex \textsc
@findex \scshape
Small caps.
@item \texttt (\ttfamily)
@findex \texttt
@findex \ttfamily
Typewriter.
@item \textnormal (\normalfont)
@findex \textnormal
@findex \normalfont
Main document font.
@item \mathrm
@findex \mathrm
Roman, for use in math mode.
@item \mathbf
@findex \mathbf
Boldface, for use in math mode.
@item \mathsf
@findex \mathsf
Sans serif, for use in math mode.
@item \mathtt
@findex \mathtt
Typewriter, for use in math mode.
@item \mathit
@findex \mathit
Italics, for use in math mode, e.g. variable names with several letters.
@item \mathnormal
@findex \mathnormal
For use in math mode, e.g. inside another type style declaration.
@item \mathcal
@findex \mathcal
`Calligraphic' letters, for use in math mode.
@end table
In addition, the command
@code{\mathversion@{bold@}}
@findex \mathversion
can be used for switching to bold letters and symbols in
formulas. @code{\mathversion@{normal@}} restores the default.
@comment **************
@comment ** Sizes *****
@comment **************
@comment LEVEL3
@node Sizes, Low-level font commands, Styles, Typefaces
@comment node-name, next, previous, up
@subsection Sizes
@cindex Font Sizes
@cindex Typeface Sizes
@cindex Sizes of text
The following standard type size commands are supported by LaTeX.
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; e.g.
@code{\begin@{tiny@}...\end@{tiny@}}.
@table @code
@item \tiny
@findex \tiny
@item \scriptsize
@findex \scriptsize
@item \footnotesize
@findex \footnotesize
@item \small
@findex \small
@item \normalsize
@findex \normalsize
(default)
@item \large
@findex \large
@item \Large
@findex \Large
@item \LARGE
@findex \LARGE
@item \huge
@findex \huge
@item \Huge
@findex \Huge
@end table
@comment ********************************
@comment ** Low-level font commands *****
@comment ********************************
@comment LEVEL3
@node Low-level font commands, , Sizes, Typefaces
@comment node-name, next, previous, up
@subsection Low-level font commands
@cindex Low-level font commands
@cindex Font commands, low-level
These commands are primarily intended for writers of macros and
packages. The commands listed here are only a subset of the available
ones. For full details, you should consult Chapter 7 of @cite{The LaTeX
Companion}.
@table @code
@item \fontencoding@{enc@}
@findex \fontencoding
Select font encoding. Valid encodings include @code{OT1} and @code{T1}.
@item \fontfamily@{family@}
@findex \fontfamily
Select font family. Valid families include:
@itemize @bullet
@item @code{cmr} for Computer Modern Roman
@item @code{cmss} for Computer Modern Sans Serif
@item @code{cmtt} for Computer Modern Typewriter
@end itemize
and numerous others.
@item \fontseries@{series@}
@findex \fontseries
Select font series. Valid series include:
@itemize @bullet
@item @code{m} Medium (normal)
@item @code{b} Bold
@item @code{c} Condensed
@item @code{bc} Bold condensed
@item @code{bx} Bold extended
@end itemize
and various other combinations.
@item \fontshape@{shape@}
@findex \fontshape
Select font shape. Valid shapes are:
@itemize @bullet
@item @code{n} Upright (normal)
@item @code{it} Italic
@item @code{sl} Slanted (oblique)
@item @code{sc} Small caps
@item @code{ui} Upright italics
@item @code{ol} Outline
@end itemize
The two last shapes are not available for most font families.
@item \fontsize@{size@}@{skip@}
@findex \fontsize
Set font size. The first parameter is the font size to switch to; the
second is the @code{\baselineskip} to use. The unit of both parameters
defaults to pt. A rule of thumb is that the baselineskip should be 1.2
times the font size.
@item \selectfont
@findex \selectfont
The changes made by calling the four font commands described above do
not come into effect until @code{\selectfont} is called.
@item \usefont@{enc@}@{family@}@{series@}@{shape@}
@findex \usefont
Equivalent to calling @code{\fontencoding}, @code{\fontfamily},
@code{\fontseries} and @code{\fontshape} with the given parameters, followed by @code{\selectfont}.
@end table
@page
@comment ****************************************
@comment ************* PARAMETERS ***************
@comment ****************************************
@comment LEVEL1
@node Parameters, Concept Index, Commands, Top
@comment node-name, next, previous, up
@chapter Parameters
The input file specification indicates the file to be formatted; TeX
uses @file{.tex} 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.
@code{latex ``\scrollmode\input foo.tex''}
will process @file{foo.tex} without pausing after every error.
Output files are always created in the current directory. When you fail
to specify an input file name, TeX bases the output names on the file
specification associated with the logical name TEX_OUTPUT, typically
@code{texput.log}.
@page
@comment ***************************
@comment ******* INDICES ********
@comment ***************************
@comment LEVEL1
@node Concept Index, Command Index, Parameters, Top
@comment node-name, next, previous, up
@unnumbered Concept Index
@printindex cp
@comment LEVEL1
@node Command Index, , Concept Index, Top
@comment node-name, next, previous, up
@unnumbered Command Index
@printindex fn
@contents
@bye
|