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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2002 (1.67)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>glossaries.sty v 1.11: LaTeX2e Package to Assist Generating Glossaries</TITLE>
<META NAME="description" CONTENT="glossaries.sty v 1.11: LaTeX2e Package to Assist Generating Glossaries">
<META NAME="keywords" CONTENT="glossaries-manual">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<META NAME="Generator" CONTENT="LaTeX2HTML v2002">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
</HEAD>
<BODY >
<A NAME="top"></A>
<P>
<P>
<H1 ALIGN="CENTER">glossaries.sty v 1.11: LaTeX2e Package to Assist Generating Glossaries</H1>
<P ALIGN="CENTER"><STRONG>Nicola L.C. Talbot
<BR>
<BR>
School of Computing Sciences
<BR>
University of East Anglia
<BR>
Norwich. Norfolk
<BR>
NR4 7TJ. United Kingdom.
<BR><TT><A NAME="tex2html1"
HREF="http://theoval.cmp.uea.ac.uk/~nlct/">http://theoval.cmp.uea.ac.uk/~nlct/</A></TT></STRONG></P>
<P ALIGN="CENTER"><STRONG>2nd March 2008</STRONG></P>
<BR>
<H2><A NAME="SECTION00010000000000000000">
Contents</A>
</H2>
<!--Table of Contents-->
<UL>
<LI><A NAME="tex2html34"
HREF="glossaries-manual.html#SECTION00020000000000000000">Introduction</A>
<UL>
<LI><A NAME="tex2html35"
HREF="glossaries-manual.html#SECTION00021000000000000000">Generating the associated glossary files</A>
<LI><A NAME="tex2html36"
HREF="glossaries-manual.html#SECTION00022000000000000000">Troubleshooting</A>
</UL>
<BR>
<LI><A NAME="tex2html37"
HREF="glossaries-manual.html#SECTION00030000000000000000">A Quick Guide For The Impatient</A>
<LI><A NAME="tex2html38"
HREF="glossaries-manual.html#SECTION00040000000000000000">Overview</A>
<UL>
<LI><A NAME="tex2html39"
HREF="glossaries-manual.html#SECTION00041000000000000000">Package Options</A>
<LI><A NAME="tex2html40"
HREF="glossaries-manual.html#SECTION00042000000000000000">Defining Glossary Entries</A>
<LI><A NAME="tex2html41"
HREF="glossaries-manual.html#SECTION00043000000000000000">Number lists</A>
<LI><A NAME="tex2html42"
HREF="glossaries-manual.html#SECTION00044000000000000000">Links to Glossary Entries</A>
<LI><A NAME="tex2html43"
HREF="glossaries-manual.html#SECTION00045000000000000000">Adding an entry to the glossary without generating text</A>
<LI><A NAME="tex2html44"
HREF="glossaries-manual.html#SECTION00046000000000000000">Displaying a glossary</A>
<LI><A NAME="tex2html45"
HREF="glossaries-manual.html#SECTION00047000000000000000">Defining New Glossaries</A>
<LI><A NAME="tex2html46"
HREF="glossaries-manual.html#SECTION00048000000000000000">Acronyms</A>
<LI><A NAME="tex2html47"
HREF="glossaries-manual.html#SECTION00049000000000000000">Unsetting and resetting entry flags</A>
<LI><A NAME="tex2html48"
HREF="glossaries-manual.html#SECTION000410000000000000000">Glossary Styles</A>
<LI><A NAME="tex2html49"
HREF="glossaries-manual.html#SECTION000411000000000000000">Defining your own glossary style</A>
</UL>
<BR>
<LI><A NAME="tex2html50"
HREF="glossaries-manual.html#SECTION00050000000000000000">Index</A>
</UL>
<!--End of Table of Contents-->
<P>
<H1><A NAME="SECTION00020000000000000000">
Introduction</A>
</H1>
<P>
The <TT>glossaries</TT> package is provided to assist generating
glossaries. It has a certain amount of flexibility, allowing the user
to customize the format of the glossary and define multiple glossaries.
It also supports acronyms and glossary styles that include
symbols (in addition to a name and description) for glossary
entries. There is provision for loading a database of glossary terms
where only those terms used in the text are added to the glossary.
This package replaces the <TT>glossary</TT><A NAME="1800"></A> package which is now
obsolete.
<P>
As from version 1.08, the <TT>glossaries</TT> package now has
limited multi-lingual support, thanks to all the people who have sent
me the relevant translations either via email or via comp.text.tex.
However you must load <TT>babel</TT><A NAME="1804"></A> <I>before</I>
<TT>glossaries</TT> to enable this.
As from version 1.1, the <TT>glossaries</TT> package also supports
Till Tantau's <TT>translator</TT><A NAME="1810"></A> package provided it is loaded
before the <TT>glossaries</TT> package. This makes it easier to change
the default translations or add new dictionaries.
If you don't want to use the predefined translations, you can use the
package option <TT>translate=false</TT><A NAME="1821"></A> and supply your own translations.
<P>
This documentation is structured as follows: <A HREF="glossaries-manual.html#sec:quick">A Quick Guide For The Impatient</A> is for
people who want a few quick pointers of how to get started,
without having to read through lengthy descriptions,
and <A HREF="glossaries-manual.html#sec:overview">Overview</A> gives an overview of available commands
and their syntax.
<P>
<A HREF="glossaries-manual.html#top">Top</A>
<P>
<H2><A NAME="SECTION00021000000000000000"></A>
<A NAME="sec:makeglossaries"></A>
<BR>
Generating the associated glossary files
</H2>
<P>
The <TT>glossaries</TT> package comes with the Perl script
<TT>makeglossaries</TT><A NAME="1827"></A> which will run <TT>makeindex</TT><A NAME="1830"></A> on
all the glossary files using a customized <TT>makeindex</TT><A NAME="1833"></A>
<TT>.ist</TT><A NAME="1836"></A> style file (which is created by <TT>\makeglossaries</TT><A NAME="1838"></A>).
The relevant extensions are obtained from the
auxiliary file, so you should only pass the basename as the
argument. For example, if your document is called
<TT>myfile.tex</TT>, do:
<PRE>
latex myfile
makeglossaries myfile
latex myfile
</PRE>
You may need to explicitly load <TT>makeglossaries</TT><A NAME="1841"></A> into
Perl:
<PRE>
perl makeglossaries myfile
</PRE>
There is a batch file called <TT>makeglossaries.bat</TT> which
does this for Windows users.
<P>
If you don't have Perl installed, you will have to run
<TT>makeindex</TT><A NAME="1844"></A> for each glossary type you have defined.
For example, if you have used the <TT>acronym</TT><A NAME="1852"></A> package option
then you will have both a main glossary as well as a list of acronyms, so you
will need to do (assuming your document is called <TT>myfile.tex</TT>):
<PRE>
makeindex -s myfile.ist -t myfile.glg -o myfile.gls myfile.glo
makeindex -s myfile.ist -t myfile.alg -o myfile.acr myfile.acn
</PRE>
This requires remembering all extensions for each of the glossaries
defined in your document, so where possible you should use
<TT>makeglossaries</TT><A NAME="1856"></A> instead to reduce the possibility of error.
Don't pass all the glossary files in a single call to
<TT>makeindex</TT><A NAME="1859"></A> or it will merge all your glossaries into a
single glossary.
<P>
If any problems occur, remember to check the transcript files
(e.g. <TT>.glg</TT><A NAME="1862"></A> or <TT>.alg</TT><A NAME="1864"></A>) for messages.
<P>
<A HREF="glossaries-manual.html#top">Top</A>
<P>
<H2><A NAME="SECTION00022000000000000000">
Troubleshooting</A>
</H2>
<P>
The glossaries package comes with a minimal file called
<TT>minimalgls.tex</TT> which can be used for testing. This
should be located in <TT>texmf/doc/latex/glossaries/samples/</TT>. Further
information on debugging LaTeX code is available at
<TT><A NAME="tex2html2"
HREF="http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/">http://theoval.cmp.uea.ac.uk/~nlct/latex/minexample/</A></TT>.
<P>
There is a list of frequently asked questions for the
<TT>glossaries</TT> package available at
<TT><A NAME="tex2html3"
HREF="http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html">http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html</A></TT>.
<P>
<A HREF="glossaries-manual.html#top">Top</A>
<P>
<H1><A NAME="SECTION00030000000000000000"></A>
<A NAME="sec:quick"></A>
<BR>
A Quick Guide For The Impatient
</H1>
<P>
This section is for people who want a few quick pointers
of how to get started, without having to read through
lengthy descriptions.
<P>
<OL>
<LI>Load <TT>glossaries</TT> <I>after</I> <TT>hyperref</TT><A NAME="1874"></A>:
<PRE>
\usepackage{hyperref}
\usepackage{glossaries}
</PRE>
Similarly for the <TT>html</TT><A NAME="1877"></A> package:
<PRE>
\usepackage{html}
\usepackage{glossaries}
</PRE>
<P>
</LI>
<LI>Always use <TT>\makeglossaries</TT><A NAME="1880"></A> if you want the glossary
entries to be written to the glossary file:
<PRE>
\documentclass{article}
\usepackage{glossaries}
\makeglossaries
</PRE>
If you don't use <TT>\makeglossaries</TT><A NAME="1883"></A>, your glossaries will
not appear in the document!
<P>
</LI>
<LI>Use <TT>\printglossaries</TT><A NAME="1886"></A> to make your glossaries appear
in the document at that point. For example:
<PRE>
\maketitle
\printglossaries
\section{Introduction}
</PRE>
Note that only the glossary entries that have been used in the
document text will appear in the glossary.
<P>
</LI>
<LI>When you have created your document, run LaTeX on it,
then the Perl script <TT>makeglossaries</TT><A NAME="1889"></A>, then run LaTeX on it again:
<PRE>
latex myfile
makeglossaries myfile
latex myfile
</PRE>
(You may need to run LaTeX again if you have used the <TT>toc</TT><A NAME="1897"></A>
package option.)
If you use Windows, there is a batch file called
<TT>makeglossaries.bat</TT> which you can use, but you will
still need Perl installed.
<P>
</LI>
<LI>New glossaries can be defined using:
<P>
<TT>\newglossary</TT><A NAME="1901"></A><TT>[</TT><EM>log-ext</EM><TT>]{</TT><EM>label</EM><TT>}{</TT><EM>in-ext</EM><TT>}{</TT><EM>out-ext</EM><TT>}{</TT><EM>title</EM><TT>}</TT>
<P>
where <I>label</I> is an identifying label,
<I>in-ext</I> is the extension of the file to be created
by <TT>makeindex</TT><A NAME="1904"></A> (called by <TT>makeglossaries</TT><A NAME="1907"></A>),
<I>out-ext</I> is the extension of the file to be read by
<TT>makeindex</TT><A NAME="1910"></A> and <I>title</I> is the title for this
new glossary. The first optional argument <I>log-ext</I> specifies
the extension of the <TT>makeindex</TT><A NAME="1913"></A> transcript file. Example:
<PRE>
\newglossary[nlg]{notation}{not}{ntn}{Notation}
</PRE>
This glossary's label is <TT>notation</TT> and its title
will be Notation. If you use <TT>makeglossaries</TT><A NAME="1916"></A>, the
<TT>makeindex</TT><A NAME="1919"></A> transcript will be written to a file with the
extension <TT>.nlg</TT><A NAME="1922"></A>. If <I>log-ext</I> is omitted, the extension
<TT>.glg</TT><A NAME="1924"></A> will be used.
<P>
</LI>
<LI>Any new glossaries must be defined before
<TT>\makeglossaries</TT>
<PRE>
\documentclass{article}
\usepackage{glossaries}
\newglossary{notation}{not}{ntn}{Notation}
\makeglossaries
</PRE>
<P>
</LI>
<LI>If you use the <TT>acronym</TT><A NAME="1931"></A> package option, the
<TT>glossaries</TT> package
will automatically create a new glossary type labelled
<TT>acronym</TT>:
<PRE>
\usepackage[acronym]{glossaries}
</PRE>
<P>
</LI>
<LI>If your pages have a hyphen compositor (i.e. your page
numbers appear in the form 2-1), redefine <TT>\glscompositor</TT><A NAME="1936"></A>
<I>before</I> <TT>\makeglossaries</TT><A NAME="1939"></A>:
<PRE>
\documentclass{article}
\usepackage{glossaries}
\renewcommand{\glscompositor}{-}
\makeglossaries
</PRE>
<P>
</LI>
<LI>To add the glossaries to the table of contents use the
<TT>toc</TT><A NAME="1947"></A> package option:
<PRE>
\usepackage[toc]{glossaries}
</PRE>
<P>
</LI>
<LI>Define a new entry with:
<P>
<TT>\newglossaryentry</TT><A NAME="1951"></A><TT>{</TT><EM>label</EM><TT>}{</TT><EM>key-val list</EM><TT>}</TT>
<P>
The <I>key-val list</I> must at least contain a <TT>name</TT><A NAME="1954"></A>
key and a <TT>description</TT><A NAME="1957"></A> key.
For example:
<PRE>
\newglossaryentry{perl}{name=Perl,
description=A scripting language}
</PRE>
In this example, I have given the entry the label <TT>perl</TT>.
Whenever I want to use this entry, that is the label I need
to use to identify it.
<P>
</LI>
<LI>If the entry name starts with an accented letter, you will
need to group the first letter (otherwise it will cause a
problem for <TT>\Gls</TT><A NAME="1960"></A> and <TT>\Glspl</TT><A NAME="1963"></A>):
<PRE>
\newglossaryentry{elite}{name={{\'e}lite},
description={select group or class}}
</PRE>
<P>
</LI>
<LI>If you have multiple glossaries, use the <TT>type</TT><A NAME="1966"></A>
key to specify in which glossary the entry belongs. For example:
<PRE>
\newglossary{languages}{lan}{lng}{Index of Languages}
\makeglossaries
\newglossaryentry{perl}{name=Perl,
description=A scripting language,
type=languages}
</PRE>
If <TT>type</TT><A NAME="1969"></A> is omitted, the default glossary is used.
<P>
</LI>
<LI>Remember to group values that have a comma or equal sign.
For example:
<PRE>
\newglossaryentry{pagelist}{name=page list,
description={A list of individual pages or page ranges
(e.g.\ 1,2,4,7--9)}}
</PRE>
<P>
</LI>
<LI>Plural forms are assumed to be the singular form with an
"s" appended, unless otherwise specified. To specify an
irregular plural, use the <TT>plural</TT><A NAME="1972"></A> key. For example:
<PRE>
\newglossaryentry{matrix}{name=matrix,
description=rectangular array of quantities,
plural=matrices}
</PRE>
<P>
</LI>
<LI>The way the term appears in the main text can be different
from the way the term appears in the glossary:
<PRE>
\newglossaryentry{matrix}{name=Matrix,
description=rectangular array of quantities,
text=matrix,
plural=matrices}
</PRE>
In this example, the entry name appears as "Matrix" in the
glossary, and either "matrix" or "matrices" in the text.
<P>
</LI>
<LI>The way the term appears on first use can be different
to the way it appears subsequently:
<PRE>
\newglossaryentry{singmtx}{name=Singular Matrix,
description=A matrix with a zero determinant,
first=singular matrix (SM),
text=SM,
firstplural=singular matrices (SMs)}
</PRE>
In this example, the entry name appears as "Singular Matrix" in
the glossary, and in the text it appears as "singular matrix (SM)"
or "singular matrices (SMs)" the first time the entry is used,
and subsequently appears as "SM" or "SMs".
<P>
</LI>
<LI>The quick and easy way to define an acronym is to use:
<P>
<TT>\newacronym</TT><A NAME="1975"></A><TT>[</TT><EM>key-val list</EM><TT>]{</TT><EM>label</EM><TT>}{</TT><EM>abbrev</EM><TT>}{</TT><EM>long</EM><TT>}</TT>
<P>
For example:
<PRE>
\newacronym{svm}{SVM}{support vector machine}
</PRE>
This is equivalent to:
<PRE>
\newglossaryentry{svm}{type=\acronymtype,
name={SVM},
description={support vector machine},
text={SVM},
first={support vector machine (SVM)},
plural={SVMs},
firstplural={support vector machines (SVMs)}}
</PRE>
(The value of <TT>\acronymtype</TT><A NAME="1978"></A> varies depending on whether
the <TT>acronym</TT><A NAME="1986"></A> package option is used or not.
The optional argument <I>key-val list</I> can be used to
override any of the <TT>\newglossaryentry</TT><A NAME="1990"></A> keys; for
example, if the acronym has an irregular plural.)
<P>
</LI>
<LI>The font used to display the entry name in the glossary
is governed by <TT>\glsnamefont</TT><A NAME="1993"></A>. This can be redefined
as required. For example, to make the entry names appear
in a medium sans-serif font do:
<PRE>
\renewcommand{\glsnamefont}[1]{\textsf{\mdseries #1}}
</PRE>
Note that the list-like glossary styles defined in the
<TT>glossary-list</TT><A NAME="1996"></A> package place the entry name in
the optional argument to <TT>\item</TT><A NAME="1999"></A>, so they will
appear in bold, unless you redefine <TT>\glsnamefont</TT><A NAME="2002"></A> to counteract the
bold font.
<P>
</LI>
<LI>In the document use <TT>\gls</TT><A NAME="2005"></A><TT>{</TT><EM>label</EM><TT>}</TT>
to use a predefined term (this will also enter the term into
the associated glossary output file). For example:
<PRE>
A \gls{singmtx} is a matrix with a zero determinant.
</PRE>
<P>
</LI>
<LI>Other variations:
<UL>
<LI><TT>\Gls</TT><A NAME="2008"></A><TT>{</TT><EM>label</EM><TT>}</TT> : like <TT>\gls</TT>,
but with first letter in upper case
</LI>
<LI><TT>\GLS</TT><A NAME="2011"></A><TT>{</TT><EM>label</EM><TT>}</TT> : like <TT>\gls</TT>,
but all upper case.
</LI>
<LI><TT>\glspl</TT><A NAME="2014"></A><TT>{</TT><EM>label</EM><TT>}</TT> : use plural
</LI>
<LI><TT>\Glspl</TT><A NAME="2017"></A><TT>{</TT><EM>label</EM><TT>}</TT> : use plural with
first letter in upper case
</LI>
<LI><TT>\GLSpl</TT><A NAME="2020"></A><TT>{</TT><EM>label</EM><TT>}</TT> : use plural but
all upper case
</LI>
<LI><TT>\glslink</TT><A NAME="2023"></A><TT>{</TT><EM>label</EM><TT>}{</TT><EM>link text</EM><TT>}</TT> :
use <I>link text</I> to link to the given entry in the glossary.
</LI>
</UL>
For example, the following will produce the plural form with
the first letter in uppercase:
<PRE>
\Glspl{singmtx} are matrices with a zero determinant.
</PRE>
<P>
</LI>
<LI>Additional text can be appended to the link using the
end optional argument. For example, to form the possessive:
<PRE>
The \gls{singmtx}['s] dimensions \ldots
</PRE>
<P>
</LI>
<LI>The format of the associated entry number can be
changed using the <TT>format</TT><A NAME="2026"></A> key in the optional argument.
Note that the value of the <TT>format</TT><A NAME="2029"></A> key should be the
name of a command <I>without</I> the initial backslash. For
example:
<PRE>
The primary definition of \glspl[format=textbf]{singmtx}.
</PRE>
In this example the relevant glossary entry will have the
page number in bold (since it uses <TT>\textbf</TT>) but
it will no longer have a hyperlink (if hyperlinks are enabled.)
<P>
</LI>
<LI>The <TT>glossaries</TT> package provides commands to
change the font whilst ensuring that the number remains a
hyperlink. These are of the form <TT>\hyper</TT><I>xx</I> and
are equivalent to the standard font changing commands of the
form <TT>\text</TT><I>xx</I>, as well as <TT>\hyperemph</TT><A NAME="2033"></A>
(which uses <TT>\emph</TT><A NAME="2036"></A>.) For example:
<PRE>
The primary definition of \glspl[format=hyperbf]{singmtx}.
</PRE>
<P>
</LI>
<LI>Don't use declarations in <TT>format</TT><A NAME="2039"></A> as this can
cause unpredictable results, as there is no guarantee that the effect
will be localised to the required text.
<P>
</LI>
<LI>Entries can be added to the glossary without producing
any text using <TT>\glsadd</TT><A NAME="2042"></A><TT>{</TT><EM>label</EM><TT>}</TT> or
<TT>\glsaddall</TT><A NAME="2045"></A>. These commands also taken an optional
argument where you can specify the format. For example
<PRE>
\glsadd[format=hyperbf]{singmtx}
</PRE>
will add a line to the
glossary file for the specified term, but will not produce
any text where the command occurs.
<P>
</LI>
<LI>A number range can be entered using <code>format=(</code> and
<code>format=)</code> to mark the beginning and ending of the
range<A NAME="tex2html4"
HREF="#foot370"><SUP>1</SUP></A>. For example:
<PRE>
\glsadd[format=(]{singmtx}
This is a very long section all about \glspl{singmtx}.
% lots of text omitted
\glsadd[format=)]{singmtx}
</PRE>
This is equivalent to <TT>makeindex</TT><A NAME="2048"></A>'s <code>|(</code> and <code>|)</code>
formats.
<P>
</LI>
<LI>You can combine the range markers with a formatting command
(again without the preceding backslash). For example:
<PRE>
This is the start of a very long section all
about \glspl[format=(hyperbf]{singmtx}.
% lots of text omitted
This is the end a very long section all about
\glspl[format=)hyperbf]{singmtx}.
</PRE>
<P>
</LI>
<LI>Only those terms that have actually been used in the
document will be placed in the glossary. If you have defined
a term that doesn't appear in the document, then it means
you haven't used it in the text (either via <TT>\glslink</TT><A NAME="2051"></A>
or <TT>\gls</TT><A NAME="2054"></A> and related commands, or via <TT>\glsadd</TT><A NAME="2057"></A>
or <TT>\glsaddall</TT><A NAME="2060"></A>.)
<P>
</LI>
<LI>To change the sorting order, use the <TT>sort</TT><A NAME="2063"></A> key.
For example:
<PRE>
\newglossaryentry{universal}{name={\ensuremath{\mathcal{U}}},
description=The universal set,
sort=U}
</PRE>
<P>
</LI>
<LI>You don't need to escape <TT>makeindex</TT><A NAME="2066"></A>'s special characters:
<PRE>
\newglossaryentry{quote}{name={"},
description={Double quote character}}
\newglossaryentry{exclam}{name={!},
description={Exclamation mark}}
\newacronym{rna}{RNA}{ribonukleins\"aure}
</PRE>
<P>
</LI>
<LI>Associated symbols can also be specified, but whether the
symbol appears in the glossary depends on the glossary style.
For example:
<PRE>
\newglossaryentry{metre}{name={metre},
description={A metric measurement of length},
symbol={m}}
</PRE>
The predefined glossary styles that display the entry symbol
are: <TT>long4col</TT><A NAME="2069"></A>, <TT>long4colheader</TT><A NAME="2071"></A>,
<TT>long4colborder</TT><A NAME="2073"></A>, <TT>long4colheaderborder</TT><A NAME="2075"></A>,
<TT>super4col</TT><A NAME="2077"></A>, <TT>super4colheader</TT><A NAME="2079"></A>,
<TT>super4colborder</TT><A NAME="2081"></A> and <TT>super4colheaderborder</TT><A NAME="2083"></A>.
All the other styles supplied by this package ignore the associated
symbol.
<P>
</LI>
<LI>Glossary styles can be set using the <TT>style</TT><A NAME="2090"></A>
package option. For example:
<PRE>
\usepackage[style=long3col]{glossaries}
</PRE>
or using <TT>\glossarystyle</TT><A NAME="2094"></A><TT>{</TT><EM>style</EM><TT>}</TT>. For example:
<PRE>
\glossarystyle{altlist}
</PRE>
The predefined glossary styles provided by the <TT>glossaries</TT>
bundle are listed in <A HREF="glossaries-manual.html#sec:styles">Glossary Styles</A>.
<P>
</LI>
<LI>The list of numbers associated with each glossary entry
can be suppressed using the package option <TT>nonumberlist</TT><A NAME="2103"></A>:
<PRE>
\usepackage[nonumberlist]{glossaries}
</PRE>
<P>
</LI>
<LI>By default, the glossaries will appear in an unnumbered
chapter if chapters are defined, otherwise in an unnumbered
section. This can be changed using the <TT>section</TT><A NAME="2112"></A> package
option. For example, to make the glossaries appear in an unnumbered
section, even if chapters are defined, do:
<PRE>
\usepackage[section]{glossaries}
</PRE>
Other sectional units can also be specified as
<TT>section</TT><A NAME="2121"></A>=<I>value</I>. For example, to make the glossaries
appear in unnumbered subsections:
<PRE>
\usepackage[section=subsection]{glossaries}
</PRE>
<P>
</LI>
</OL>
<P>
<A HREF="glossaries-manual.html#top">Top</A>
<P>
<H1><A NAME="SECTION00040000000000000000"></A><A NAME="sec:overview"></A>
<BR>
Overview
</H1>
<P>
<H2><A NAME="SECTION00041000000000000000">
Package Options</A>
</H2>
<P>
The <TT>glossaries</TT> package options are as follows:
<DL>
<DT><STRONG><TT>toc</TT><A NAME="2134"></A></STRONG></DT>
<DD>Add the glossaries to the table of contents.
<P>
</DD>
<DT><STRONG><TT>numberline</TT><A NAME="2143"></A></STRONG></DT>
<DD>When used with <TT>toc</TT><A NAME="2152"></A>, this will
add <TT>\numberline</TT><code>{}</code> in the final argument of
<TT>\addcontentsline</TT>. This will align the table of contents entry
with the numbered section titles. Note that this option has no
effect if the <TT>toc</TT><A NAME="2161"></A> option is omitted. If <TT>toc</TT><A NAME="2170"></A> is
used without <TT>numberline</TT><A NAME="2179"></A>, the title will be aligned with
the section numbers rather than the section titles.
<P>
</DD>
<DT><STRONG><TT>acronym</TT><A NAME="2188"></A></STRONG></DT>
<DD>Make a separate glossary for acronyms.
<P>
</DD>
<DT><STRONG><TT>section</TT><A NAME="2197"></A></STRONG></DT>
<DD>This is a <I>key</I>=<I>value</I> option. Its
value should be the name of a sectional unit (e.g. chapter).
This will make the glossaries appear in the named sectional unit,
otherwise each glossary will appear in a chapter, if chapters
exists, otherwise in a section. Unnumbered sectional units will be used
by default. Example:
<PRE>
\usepackage[section=subsection]{glossaries}
</PRE>
You can omit the value if you want to use sections, i.e. <PRE>
\usepackage[section]{glossaries}
</PRE>
is equivalent to
<PRE>
\usepackage[section=section]{glossaries}
</PRE>
You can change this value later in the document using
<TT>\setglossarysection</TT><A NAME="2201"></A><TT>{</TT><EM>type</EM><TT>}</TT>.
<P>
</DD>
<DT><STRONG><TT>numberedsection</TT><A NAME="2209"></A></STRONG></DT>
<DD>The glossaries are placed in unnumbered sectional units by default,
but this can be changed using <TT>numberedsection</TT><A NAME="2218"></A>. This option can take
three possible values: <TT>false</TT><A NAME="2222"></A> (no
number, i.e. use starred form), <TT>nolabel</TT><A NAME="2224"></A>
(numbered, i.e. unstarred form, but not labelled) and
<TT>autolabel</TT><A NAME="2226"></A> (numbered with automatic
labelling). If <TT>numberedsection=autolabel</TT><A NAME="2235"></A> is used, each
glossary is given a label that matches the glossary type, so the
main (default) glossary is labelled <TT>main</TT>, the list of
acronyms is labelled <TT>acronym</TT><A NAME="tex2html5"
HREF="#foot1670"><SUP>2</SUP></A> and additional glossaries are labelled
using the value specified in the first mandatory argument to
<TT>\newglossary</TT>. For example, if you load <TT>glossaries</TT>
using:
<PRE>
\usepackage[section,numberedsection=autolabel]{glossaries}
</PRE>
then each glossary will appear in a numbered section, and can
be referenced using something like:
<PRE>
The main glossary is in section~\ref{main} and the list of
acronyms is in section~\ref{acronym}.
</PRE>
If you can't decide whether to have the acronyms in the main
glossary or a separate list of acronyms, you can use
<TT>\acronymtype</TT><A NAME="2247"></A> which is set to <TT>main</TT> if the
<TT>acronym</TT><A NAME="2255"></A> option is not used and is set to <TT>acronym</TT>
if the <TT>acronym</TT><A NAME="2264"></A> option is used. For example:
<PRE>
The list of acronyms is in section~\ref{\acronymtype}.
</PRE>
<P>
</DD>
<DT><STRONG><TT>style</TT><A NAME="2273"></A></STRONG></DT>
<DD>This is a <I>key</I>=<I>value</I> option. Its
value should be the name of the glossary style to use. Predefined
glossary styles are listed <A HREF="glossaries-manual.html#sec:styles">later</A>.
<P>
</DD>
<DT><STRONG><TT>nonumberlist</TT><A NAME="2282"></A></STRONG></DT>
<DD>This option will suppress the
associated number lists<A NAME="2285"></A> in the glossaries (see also
<A HREF="glossaries-manual.html#sec:numberlists">Number Lists</A>.)
<P>
</DD>
<DT><STRONG><TT>counter</TT><A NAME="2292"></A></STRONG></DT>
<DD>This is a <I>key</I>=<I>value</I> option. The
value should be the name of the default counter to use in the number
lists<A NAME="2295"></A>.
<P>
<A NAME="sanitize"></A>
</DD>
<DT><STRONG><TT>sanitize</TT><A NAME="2302"></A></STRONG></DT>
<DD>This is a <I>key</I>=<I>value</I> option whose
value is also a <I>key</I>=<I>value</I> list. By default, the
<TT>glossaries</TT> package sanitizes the values of the
<TT>name</TT><A NAME="2307"></A>, <TT>description</TT><A NAME="2310"></A> and <TT>symbol</TT><A NAME="2313"></A> keys used
when defining a new glossary entry. This may lead to unexpected results
if you try to display these values within the document text. This
sanitization can be switched off using the <TT>sanitize</TT><A NAME="2321"></A> package
option. For example, to switch off the sanitization for the
<TT>description</TT><A NAME="2325"></A> and <TT>name</TT><A NAME="2328"></A> keys, but not for the
<TT>symbol</TT><A NAME="2331"></A> key, do:
<PRE>
\usepackage[sanitize={name=false,description=false,%
symbol=true}]{glossaries}
</PRE>
<P>
<B>Note</B>: this sanitization only applies to the <TT>name</TT><A NAME="2334"></A>,
<TT>description</TT><A NAME="2337"></A> and <TT>symbol</TT><A NAME="2340"></A> keys. It doesn't apply
to any of the other keys (except the <TT>sort</TT><A NAME="2343"></A> key which is
always sanitized) so fragile commands contained in the value of
the other keys must always be protected using <TT>\protect</TT>.
Since the value of the <TT>text</TT><A NAME="2346"></A> key is obtained from the
<TT>name</TT><A NAME="2349"></A> key, you will still need to protect fragile commands
in the <TT>name</TT><A NAME="2352"></A> key if you don't use the <TT>text</TT><A NAME="2355"></A> key.
<P>
</DD>
<DT><STRONG><TT>babel</TT><A NAME="2363"></A></STRONG></DT>
<DD>This is a boolean key and is for use when
the <TT>glossaries</TT> package is used in conjunction with the
<TT>babel</TT><A NAME="2368"></A> package. The default is <TT>babel=true</TT><A NAME="2378"></A>, which
adds the glossary translations to <TT>babel</TT><A NAME="2380"></A>'s captions. If
you don't like the translations provided by the <TT>glossaries</TT>
package, you can set <TT>babel=false</TT><A NAME="2391"></A> and provide your own
translations.
<P>
</DD>
<DT><STRONG><TT>description</TT><A NAME="2398"></A></STRONG></DT>
<DD>This option changes the definition of
<TT>\newacronym</TT><A NAME="2402"></A> to allow a description. See <A HREF="glossaries-manual.html#sec:acronyms">later</A>
for further details.
<P>
</DD>
<DT><STRONG><TT>footnote</TT><A NAME="2410"></A></STRONG></DT>
<DD>This option changes the definition of
<TT>\newacronym</TT><A NAME="2414"></A> and the way that acronyms are displayed. See <A HREF="glossaries-manual.html#sec:acronyms">later</A>
for further details.
<P>
</DD>
<DT><STRONG><TT>smallcaps</TT><A NAME="2422"></A></STRONG></DT>
<DD>This option changes the definition of
<TT>\newacronym</TT><A NAME="2426"></A> and the way that acronyms are displayed. See <A HREF="glossaries-manual.html#sec:acronyms">later</A>
for further details.
<P>
</DD>
<DT><STRONG><TT>dua</TT><A NAME="2434"></A></STRONG></DT>
<DD>This option changes the definition of
<TT>\newacronym</TT><A NAME="2438"></A> so that acronyms are always expanded.
See <A HREF="glossaries-manual.html#sec:acronyms">later</A>
for further details.
<P>
</DD>
</DL>
<P>
<A HREF="glossaries-manual.html#top">Top</A>
<P>
<H2><A NAME="SECTION00042000000000000000"></A>
<A NAME="sec:newglosentry"></A>
<BR>
Defining Glossary Entries
</H2>
<P>
All glossary entries that are used in a document must be defined in
the preamble. Only those entries that occur in the document
(using any of the commands described in <A HREF="glossaries-manual.html#sec:glslink">Links to Glossary Entries</A> and
<A HREF="glossaries-manual.html#sec:glsadd">Adding an entry to the glossary without generating text</A>) will appear in the glossary. Each time an entry
is used in this way, a line is added to an associated glossary
(<TT>.glo</TT><A NAME="2444"></A>) file, which then needs to be converted into a
corresponding <TT>.gls</TT><A NAME="2446"></A> file which contains the typeset glossary
which is input by <TT>\printglossary</TT><A NAME="2448"></A> or
<TT>\printglossaries</TT><A NAME="2451"></A>. The Perl script <TT>makeglossaries</TT><A NAME="2454"></A>
can be used to call <TT>makeindex</TT><A NAME="2457"></A>, using a customised
<TT>.ist</TT><A NAME="2460"></A> style file, for each of the glossaries that are defined
in the document. Note that there should be no need for you to
explicitly edit or input any of these external files.
<P>
The command <TT>\makeglossaries</TT> must be placed in the preamble in
order to create the customised <TT>makeindex</TT><A NAME="2462"></A> <TT>.ist</TT><A NAME="2465"></A>
style file and to ensure that glossary entries are written to the
appropriate output file. If you omit <TT>\makeglossaries</TT> none of the
glossaries will be created. Note that if your page numbers use a
hyphen compositor, you must set this by redefining
<TT>\glscompositor</TT> <I>before</I>
using <TT>\makeglossaries</TT>:
<PRE>
\renewcommand*{\glscompositor}{-}
</PRE>
(The default value of <TT>\glscompositor</TT> is a full stop.)
<P>
New glossary entries are defined using the command:
<BR>
<BR><TT>\newglossaryentry{</TT><EM>label</EM><TT>}{</TT><EM>key-val list</EM><TT>}</TT>
<BR>
<BR>
The first
argument, <I>label</I>, must be a unique label with which to identify
this entry. The second argument, <I>key-val list</I>, is a
<I>key</I>=<I>value</I> list that supplies the relevant information
about this entry. There are two required fields: <TT>name</TT><A NAME="2467"></A> and
<TT>description</TT><A NAME="2470"></A>. Available fields are listed below:
<P>
<DL>
<DT><STRONG><TT>name</TT><A NAME="2473"></A></STRONG></DT>
<DD>The name of the entry (as it will appear in the
glossary).
<P>
</DD>
<DT><STRONG><TT>description</TT><A NAME="2476"></A></STRONG></DT>
<DD>A brief description of this term (to
appear in the glossary).
<P>
</DD>
<DT><STRONG><TT>text</TT><A NAME="2479"></A></STRONG></DT>
<DD>How this entry will appear in the document text
when using <TT>\gls</TT><A NAME="2482"></A> (or one of its uppercase variants). If this
field is omitted, the value of the <TT>name</TT><A NAME="2485"></A> key is used.
<P>
</DD>
<DT><STRONG><TT>first</TT><A NAME="2488"></A></STRONG></DT>
<DD>How the entry will appear in the document text
the first time it is used with <TT>\gls</TT><A NAME="2491"></A> (or one of its uppercase
variants). If this field is omitted, the value of the <TT>text</TT><A NAME="2494"></A>
key is used.
<P>
</DD>
<DT><STRONG><TT>plural</TT><A NAME="2497"></A></STRONG></DT>
<DD>How the entry will appear in the document text
when using <TT>\glspl</TT><A NAME="2500"></A> (or one of its uppercase variants).
If this field is omitted, the value is obtained by appending an
"s" to the value of the <TT>text</TT><A NAME="2503"></A> field.
<P>
</DD>
<DT><STRONG><TT>firstplural</TT><A NAME="2506"></A></STRONG></DT>
<DD>How the entry will appear in the document
text the first time it is used with <TT>\glspl</TT><A NAME="2509"></A> (or one of
its uppercase variants). If this field is omitted, the value is
obtained by appending an "s" to the value of the <TT>first</TT><A NAME="2512"></A>
field.
<P>
</DD>
<DT><STRONG><TT>symbol</TT><A NAME="2515"></A></STRONG></DT>
<DD>This field is provided to allow the user to
specify an associated symbol, but most glossary styles ignore
this value. If omitted, the value is set to <TT>\relax</TT>.
<P>
</DD>
<DT><STRONG><TT>sort</TT><A NAME="2518"></A></STRONG></DT>
<DD>This value indicates how <TT>makeindex</TT><A NAME="2521"></A>
should sort this entry. If omitted, the value is given by the
<TT>name</TT><A NAME="2524"></A> field. This value is equivalent to
<TT>makeindex</TT><A NAME="2527"></A>'s "actual" character (which is usually the
at-sign @ although the <TT>glossaries</TT> package uses a different
symbol).
<P>
</DD>
<DT><STRONG><TT>type</TT><A NAME="2531"></A></STRONG></DT>
<DD>This is the glossary type to which this entry
belongs. If omitted, the default glossary is assumed
(<TT>type=main</TT>). The list of acronyms type is given by
<TT>\acronymtype</TT><A NAME="2534"></A> which will either be <TT>main</TT> or
<TT>acronym</TT>, depending on whether the <TT>acronym</TT><A NAME="2542"></A> package
option was used.
</DD>
</DL>
Note that if the <TT>text</TT><A NAME="2546"></A> key (or the <TT>name</TT><A NAME="2549"></A> key, if the
<TT>text</TT><A NAME="2552"></A> key is omitted) starts with an accented letter,
you must group the accented letter, otherwise it will cause a
problem for <TT>\Gls</TT> and <TT>\Glspl</TT>. For example:
<PRE>
\newglossaryentry{elite}{name={{\'e}lite},
description={select group or class}}
</PRE>
(Likewise for the <TT>plural</TT><A NAME="2555"></A>, <TT>first</TT><A NAME="2558"></A> and
<TT>firstplural</TT><A NAME="2561"></A> keys.)
<P>
You can store all your glossary entry definitions in another
file, and use:
<BR>
<BR><TT>\loadglsentries[</TT><EM>type</EM><TT>]{</TT><EM>filename</EM><TT>}</TT>
<BR>
<BR>
where <I>filename</I> is the name of the file containing all the
<TT>\newglossaryentry</TT> commands. The optional argument
<I>type</I> is the name of the glossary to which those entries
should belong, for those entries where the <TT>type</TT><A NAME="2564"></A> key has
been omitted. Note that only those entries that have been used
in the text will appear in the relevant glossaries.
<P>
<A HREF="glossaries-manual.html#top">Top</A>
<P>
<H2><A NAME="SECTION00043000000000000000"></A>
<A NAME="sec:numberlists"></A>
<BR>
Number lists
</H2>
<P>
Each entry in the glossary has an associated <I>number list</I><A NAME="2570"></A>.
By default,
these numbers refer to the pages on which that entry has been used
(using any of the commands described in <A HREF="glossaries-manual.html#sec:glslink">Links to Glossary Entries</A>
and <A HREF="glossaries-manual.html#sec:glsadd">Adding an entry to the glossary without generating text</A>). The number list can be suppressed using
the <TT>nonumberlist</TT><A NAME="2577"></A> package option, or an alternative counter
can be set as the default using the <TT>counter</TT><A NAME="2586"></A> package option.
<P>
<A HREF="glossaries-manual.html#top">Top</A>
<P>
<H2><A NAME="SECTION00044000000000000000"></A>
<A NAME="sec:glslink"></A>
<BR>
Links to Glossary Entries
</H2>
<P>
Once you have defined a glossary entry using
<TT>\newglossaryentry</TT><A NAME="2593"></A>, you can refer to that entry in the
document using one of the commands listed in this section. The
text which appears at that point in the document when using
one of these commands is referred to as the
<I>link text</I><A NAME="2596"></A> (even if there are no hyperlinks).
<P>
The way the link text<A NAME="2597"></A> is displayed
depends on <TT>\glstextformat{</TT><EM>text</EM><TT>}</TT>.
For example, to make all link text<A NAME="2598"></A> appear in a sans-serif
font, do:
<PRE>
\renewcommand*{\glstextformat}[1]{\textsf{#1}}
</PRE>
<P>
The command:
<BR>
<BR><TT>\glslink[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}{</TT><EM>text</EM><TT>}</TT>
<BR>
<BR>
will place <I>text</I> in the document at that point and add
a line into the associated glossary file for the glossary entry
given by <I>label</I>. If hyperlinks are supported, <I>text</I>
will be a hyperlink to the relevant line in the glossary. The
optional argument <I>options</I> must be a <I>key</I>=<I>value</I>
list which can take any of the following keys:
<P>
<DL>
<DT><STRONG><TT>format</TT><A NAME="2600"></A></STRONG></DT>
<DD>This specifies how to format the
associated number for this entry in the glossary. This value is
equivalent to the <TT>makeindex</TT><A NAME="2603"></A> encap value, and (as with
<TT>\index</TT>) the value needs to be the name of a command <I>without</I>
the initial backslash. As with <TT>\index</TT>, the characters <code>(</code> and
<code>)</code> can also be used to specify the beginning and ending of a
number range. Again as with <TT>\index</TT>, the command should be the name
of a command which takes an argument (which will be the associated
number). Be careful not to use a declaration (such as <TT>\bfseries</TT>)
instead of a text block command (such as <TT>\textbf</TT>) as the effect is
not guaranteed to be localised. If you want to apply more than one
style to a given entry (e.g. <B>bold</B> and <I>italic</I>) you will
need to create a command that applies both formats, e.g.
<PRE>
\newcommand*{\textbfem}[1]{\textbf{\emph{#1}}}
</PRE>
and use that command.
<P>
If you are using hyperlinks and you want to change the font of the
hyperlink, don't use <TT>\hyperpage</TT> (provided by the <TT>hyperref</TT><A NAME="2606"></A>
package) as the numbers may not refer to a page number.
Instead, the <TT>glossaries</TT> package provides the following
number formats:
<DIV ALIGN="CENTER">
<TABLE CELLPADDING=3>
<TR><TD ALIGN="LEFT"><TT>hyperrm</TT></TD>
<TD ALIGN="LEFT">The number is a serif hyperlink to the relevant part of the
document</TD>
</TR>
<TR><TD ALIGN="LEFT"><TT>hypersf</TT></TD>
<TD ALIGN="LEFT">The number is a sans-serif hyperlink to the relevant part
of the document</TD>
</TR>
<TR><TD ALIGN="LEFT"><TT>hypertt</TT></TD>
<TD ALIGN="LEFT">The number is a monospaced hyperlink to the relevant part
of the document</TD>
</TR>
<TR><TD ALIGN="LEFT"><TT>hyperbf</TT></TD>
<TD ALIGN="LEFT">The number is a bold hyperlink to the relevant part of the
document</TD>
</TR>
<TR><TD ALIGN="LEFT"><TT>hypermd</TT></TD>
<TD ALIGN="LEFT">The number is a medium weight hyperlink to the relevant
part of the document</TD>
</TR>
<TR><TD ALIGN="LEFT"><TT>hyperit</TT></TD>
<TD ALIGN="LEFT">The number is an italic hyperlink to the relevant
part of the document</TD>
</TR>
<TR><TD ALIGN="LEFT"><TT>hypersl</TT></TD>
<TD ALIGN="LEFT">The number is a slanted hyperlink to the relevant
part of the document</TD>
</TR>
<TR><TD ALIGN="LEFT"><TT>hyperup</TT></TD>
<TD ALIGN="LEFT">The number is an upright hyperlink to the relevant
part of the document</TD>
</TR>
<TR><TD ALIGN="LEFT"><TT>hypersc</TT></TD>
<TD ALIGN="LEFT">The number is a small caps hyperlink to the relevant
part of the document</TD>
</TR>
<TR><TD ALIGN="LEFT"><TT>hyperemph</TT></TD>
<TD ALIGN="LEFT">The number is an emphasized hyperlink to the relevant
part of the document</TD>
</TR>
</TABLE>
</DIV>
Note that if the <TT>\hyperlink</TT> command hasn't been defined,
the <TT>hyper</TT><I>xx</I> formats are equivalent to the
analogous <TT>\text</TT><I>xx</I> font commands. If you want to
make a new format, you will need to define a command which takes
one argument and use that; for example, if you want the associated
number in the glossary to be in a bold sans-serif font, you can define a
command called, say, <TT>\hyperbsf</TT>:
<PRE>
\newcommand{\hyperbsf}[1]{\textbf{\hypersf{#1}}}
</PRE>
and then use <TT>hyperbsf</TT> as the value for the <TT>format</TT><A NAME="2610"></A>
key.
<P>
</DD>
<DT><STRONG><TT>counter</TT><A NAME="2613"></A></STRONG></DT>
<DD>This specifies which counter
to use for the associated number for this glossary entry. (See also
<A HREF="glossaries-manual.html#sec:numberlists">Number Lists</A>.)
<P>
</DD>
<DT><STRONG><TT>hyper</TT><A NAME="2616"></A></STRONG></DT>
<DD>This is a boolean key which can
be used to enable/disable the hyperlink to the relevant entry
in the glossary. (Note that setting <TT>hyper=true</TT> will have no
effect if <TT>\hyperlink</TT> has not been defined.) The default
value is <TT>hyper=true</TT>.
<P>
</DD>
</DL>
There is also a starred version:
<BR>
<BR><TT>\glslink*[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}{</TT><EM>text</EM><TT>}</TT>
<BR>
<BR>
which is equivalent to <TT>\glslink</TT>, except it sets
<TT>hyper=false</TT>.
<P>
The command:
<BR>
<BR><TT>\gls[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
is the same as <TT>\glslink</TT>, except that the link text<A NAME="2618"></A>
is determined from the values of the <TT>text</TT><A NAME="2620"></A> and
<TT>first</TT><A NAME="2623"></A> keys supplied when the entry was defined using
<TT>\newglossaryentry</TT><A NAME="2626"></A>. There are two uppercase variants:
<BR>
<BR>
<TT>\Gls[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
and
<BR>
<BR>
<TT>\GLS[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
which make the first letter of the link or all the link text
uppercase, respectively.
<P>
The final optional argument <I>insert</I>, allows you to insert
some additional text into the link text. By default, this will
append <I>insert</I> at the end of the link text. The first optional
argument <I>options</I> is the same as the optional argument to
<TT>\glslink</TT><A NAME="2629"></A>. As with <TT>\glslink</TT>, these commands also have
a starred version that disable the hyperlink.
<P>
There are also analogous plural forms:
<BR>
<BR>
<TT>\glspl[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
<TT>\Glspl[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
<TT>\GLSpl[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
These determine the link text from the <TT>plural</TT><A NAME="2632"></A> and
<TT>firstplural</TT><A NAME="2635"></A> keys supplied when the entry was first
defined. As before, these commands also have
a starred version that disable the hyperlink.
<P>
The command:
<BR>
<BR><TT>\glstext[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
is similar to <TT>\gls</TT><A NAME="2638"></A> except that it always uses the value
of the <TT>text</TT><A NAME="2641"></A> key and does not mark the entry as
having been used.
<P>
There are also analogous commands:
<BR>
<BR>
<TT>\Glstext[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
<TT>\GLStext[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
As before, these commands also have a starred version that disable
the hyperlink.
<P>
The command:
<BR>
<BR><TT>\glsfirst[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
is similar to <TT>\gls</TT><A NAME="2644"></A> except that it always uses the value
of the <TT>first</TT><A NAME="2647"></A> key and does not mark the entry as
having been used.
<P>
There are also analogous commands:
<BR>
<BR>
<TT>\Glsfirst[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
<TT>\GLSfirst[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
As before, these commands also have a starred version that disable
the hyperlink.
<P>
The command:
<BR>
<BR><TT>\glsplural[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
is similar to <TT>\gls</TT><A NAME="2650"></A> except that it always uses the value
of the <TT>plural</TT><A NAME="2653"></A> key and does not mark the entry as
having been used.
<P>
There are also analogous commands:
<BR>
<BR>
<TT>\Glsplural[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
<TT>\GLSplural[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
As before, these commands also have a starred version that disable
the hyperlink.
<P>
The command:
<BR>
<BR><TT>\glsfirstplural[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
is similar to <TT>\gls</TT><A NAME="2656"></A> except that it always uses the value
of the <TT>firstplural</TT><A NAME="2659"></A> key and does not mark the entry as
having been used.
<P>
There are also analogous commands:
<BR>
<BR>
<TT>\Glsfirstplural[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
<TT>\GLSfirstplural[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
As before, these commands also have a starred version that disable
the hyperlink.
<P>
The command:
<BR>
<BR><TT>\glsname[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
is similar to <TT>\gls</TT><A NAME="2662"></A> except that it always uses the value
of the <TT>name</TT><A NAME="2665"></A> key and does not mark the entry as
having been used. Note: if you want to use this command and the
<TT>name</TT><A NAME="2668"></A> key contains commands, you will have to disable the
<A HREF="glossaries-manual.html#sanitize">sanitization</A>
of the <TT>name</TT><A NAME="2671"></A> key and protect fragile commands.
<P>
There are also analogous commands:
<BR>
<BR>
<TT>\Glsname[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
<TT>\GLSname[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
As before, these commands also have a starred version that disable
the hyperlink.
<P>
The command:
<BR>
<BR><TT>\glssymbol[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
is similar to <TT>\gls</TT><A NAME="2674"></A> except that it always uses the value
of the <TT>symbol</TT><A NAME="2677"></A> key and does not mark the entry as
having been used. Note: if you want to use this command and the
<TT>symbol</TT><A NAME="2680"></A> key contains commands, you will have to disable the
<A HREF="glossaries-manual.html#sanitize">sanitization</A>
of the <TT>symbol</TT><A NAME="2683"></A> key and protect fragile commands.
<P>
There are also analogous commands:
<BR>
<BR>
<TT>\Glssymbol[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
<TT>\GLSsymbol[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
As before, these commands also have a starred version that disable
the hyperlink.
<P>
The command:
<BR>
<BR><TT>\glsdesc[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
is similar to <TT>\gls</TT><A NAME="2686"></A> except that it always uses the value
of the <TT>description</TT><A NAME="2689"></A> key and does not mark the entry as
having been used. Note: if you want to use this command and the
<TT>description</TT><A NAME="2692"></A> key contains commands, you will have to disable the
<A HREF="glossaries-manual.html#sanitize">sanitization</A>
of the <TT>description</TT><A NAME="2695"></A> key and protect fragile commands.
<P>
There are also analogous commands:
<BR>
<BR>
<TT>\Glsdesc[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
<TT>\GLSdesc[</TT><EM>options</EM><TT>]{</TT><EM>text</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
As before, these commands also have a starred version that disable
the hyperlink.
<P>
<P>
<A HREF="glossaries-manual.html#top">Top</A>
<P>
<H3><A NAME="SECTION00044100000000000000"></A>
<A NAME="sec:glsdisplay"></A>
<BR>
Changing the format of the link text
</H3>
<P>
The format of the link text<A NAME="2700"></A> for <TT>\gls</TT><A NAME="2702"></A>, <TT>\glspl</TT><A NAME="2705"></A>
and their uppercase variants is governed by two commands:
<TT>\glsdisplayfirst</TT>, which is used the
first time a glossary entry is used in the text and
<TT>\glsdisplay</TT>, which is used subsequently.
Both commands take four arguments: the first is either the singular or
plural form given by the <TT>text</TT><A NAME="2708"></A>, <TT>plural</TT><A NAME="2711"></A>,
<TT>first</TT><A NAME="2714"></A> or <TT>firstplural</TT><A NAME="2717"></A> keys (used when the term was
defined) depending on context; the second argument is the term's
description (as supplied by the <TT>description</TT><A NAME="2720"></A> key); the third
argument is the symbol associated with the term (as supplied by the
<TT>symbol</TT><A NAME="2723"></A> key) and the fourth argument is the additional text
supplied in the final optional argument to <TT>\gls</TT> or
<TT>\glspl</TT> (or their uppercase variants). The default definitions
of <TT>\glsdisplay</TT> and <TT>\glsdisplayfirst</TT> simply
print the first argument immediately followed by the fourth argument.
The remaining arguments are ignored.
<P>
For example, suppose you want a glossary of measurements and
units, you can use the <TT>symbol</TT><A NAME="2726"></A> key to store the unit:
<PRE>
\newglossaryentry{distance}{name=distance,
description={The length between two points},
symbol={km}}
</PRE>
and now suppose you want <code>\gls{distance}</code> to produce
"distance (km)" on first use, then you can redefine
<TT>\glsdisplayfirst</TT> as follows:
<PRE>
\renewcommand{\glsdisplayfirst}[4]{#1#4 (#3)}
</PRE>
Note that the additional text is placed after <code>#1</code>, so
<code>\gls{distance}['s]</code> will produce "distance's (km)"
rather than "distance (km)'s" which looks a bit odd (even though
it may be in the context of "the distance (km) is measured between
the two points" -- but in this instance it may be better not to
use a contraction).
<P>
Note also that all of the link text<A NAME="2728"></A> will be formatted according
to <TT>\glstextformat</TT><A NAME="2730"></A> (described earlier). So if you do, say:
<PRE>
\renewcommand{\glstextformat}[1]{\textbf{#1}}
\renewcommand{\glsdisplayfirst}[4]{#1#4 (#3)}
</PRE>
then <code>\gls{distance}</code> will produce "<B>distance (km)</B>".
<P>
If you have multiple glossaries, changing <TT>\glsdisplayfirst</TT> and
<TT>\glsdisplay</TT> will change the way entries for all of the
glossaries appear when using commands <TT>\gls</TT>, <TT>\glspl</TT> and their
uppercase variants. If you only
want the change to affect entries for a given glossary, then you need
to use <TT>\defglsdisplay</TT> and
<TT>\defglsdisplayfirst</TT> instead
of redefining <TT>\glsdisplay</TT> and <TT>\glsdisplayfirst</TT>.
<P>
Both <TT>\defglsdisplay</TT> and <TT>\defglsdisplayfirst</TT> take two arguments:
the first (which is optional) is the glossary name<A NAME="tex2html6"
HREF="#foot1718"><SUP>3</SUP></A> and the second is how the term should be
displayed when it is invoked using commands <TT>\gls</TT>,
<TT>\glspl</TT> and their uppercase variants. This is similar to the way <TT>\glsdisplayfirst</TT> was
redefined above.
<P>
For example, suppose you have created a new glossary called
<TT>notation</TT> and you want to change the way the entry is
displayed on first use so that it includes the symbol, you can
do:
<PRE>
\defglsdisplayfirst[notation]{#1#4 (denoted #3)}
</PRE>
Now suppose you have defined an entry as follows:
<PRE>
\newglossaryentry{set}{type=notation,
name=set,
description={A collection of objects},
symbol={$S$},
}
</PRE>
The first time you reference this entry using <TT>\gls</TT> it
will be displayed as: "set (denoted <I>S</I>)"
(similarly for <TT>\glspl</TT> and the uppercase variants).
<P>
Remember that if you use the <TT>symbol</TT><A NAME="2737"></A> key, you need to use a
glossary style that displays the symbol, as many of the styles ignore
it. In addition, if you want either the description or symbol to appear
in the link text<A NAME="2739"></A>, you will have to disable the
<A HREF="glossaries-manual.html#sanitize">sanitization</A>
of these keys and protect fragile commands.
<P>
<A HREF="glossaries-manual.html#top">Top</A>
<P>
<H3><A NAME="SECTION00044200000000000000">
Enabling and disabling hyperlinks to glossary entries</A>
</H3>
<P>
If you load the <TT>hyperref</TT><A NAME="2744"></A> or <TT>html</TT><A NAME="2747"></A> packages prior to
loading the <TT>glossaries</TT> package, commands such as <TT>\glslink</TT><A NAME="2751"></A>
and <TT>\gls</TT><A NAME="2754"></A>, described above, will automatically have hyperlinks
to the relevant glossary entry, unless the <TT>hyper</TT><A NAME="2757"></A>
option has been set to <TT>false</TT>. You can disable or enable links using:
<BR>
<BR><TT>\glsdisablehyper</TT>
<BR>
<BR>
and
<BR>
<BR><TT>\glsenablehyper</TT>
<BR>
<BR>
respectively. The effect can be localised by placing the commands
within a group. Note that you should only use <TT>\glsenablehyper</TT>
if the commands <TT>\hyperlink</TT><A NAME="2760"></A> and <TT>\hypertarget</TT><A NAME="2763"></A> have been
defined (for example, by the <TT>hyperref</TT><A NAME="2766"></A> package).
<P>
<H2><A NAME="SECTION00045000000000000000"></A>
<A NAME="sec:glsadd"></A>
<BR>
Adding an entry to the glossary without generating text
</H2>
<P>
It is possible to add a line in the glossary file without
generating any text at that point in the document using:
<BR>
<BR><TT>\glsadd[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}</TT>
<BR>
<BR>
This is similar to <TT>\glslink</TT><A NAME="2769"></A>, only it doesn't produce
any text (so therefore, there is no <TT>hyper</TT><A NAME="2772"></A> key
available in <I>options</I> but all the other options that can
be used with <TT>\glslink</TT> can be passed to <TT>\glsadd</TT>).
<P>
To add all entries that have been defined, use:
<BR>
<BR><TT>\glsaddall[</TT><EM>glossary list</EM><TT>]</TT>
<BR>
<BR>
If there are multiple glossaries, you can specify to add only
those entries which belong to the glossaries listed in
<I>glossary list</I> (which must be a comma separated list of
glossary names). For example:
<PRE>
\glsaddall[notation]
</PRE>
will add all the entries that have been defined for the glossary
labelled "notation".
<P>
<A HREF="glossaries-manual.html#top">Top</A>
<P>
<H2><A NAME="SECTION00046000000000000000">
Displaying a glossary</A>
</H2>
<P>
The command <TT>\printglossaries</TT> will display all the
defined glossaries. Note that no glossaries will appear until
you have either used the Perl script <TT>makeglossaries</TT><A NAME="2778"></A>
or have directly used <TT>makeindex</TT><A NAME="2781"></A> (as described in
<A HREF="glossaries-manual.html#sec:makeglossaries">Generating the Associated Glossary Files</A>). If the glossary still
does not appear after you re-LaTeX your document, check
the <TT>makeindex</TT><A NAME="2784"></A> log files to see if there is a problem.
Remember that you also need to use the command <TT>\makeglossaries</TT><A NAME="2787"></A> in
the preamble to enable the glossaries.
<P>
An individual glossary is displayed using:
<BR>
<BR><TT>\printglossary[</TT><EM>options</EM><TT>]</TT>
<BR>
<BR>
where <I>options</I> is a <I>key</I>=<I>value</I> list of options.
The following keys are available:
<DL>
<DT><STRONG><TT>type</TT><A NAME="2790"></A></STRONG></DT>
<DD>The value of this key
specifies which glossary to print. If omitted, the default
glossary is assumed. For example, to print the list of acronyms:
<PRE>
\printglossary[type=\acronymtype]
</PRE>
<P>
</DD>
<DT><STRONG><TT>title</TT><A NAME="2793"></A></STRONG></DT>
<DD>This is the glossary's
title (overriding the title specified when the glossary was
defined).
<P>
</DD>
<DT><STRONG><TT>toctitle</TT><A NAME="2796"></A></STRONG></DT>
<DD>This is the title
to use for the table of contents (if the <TT>toc</TT><A NAME="2804"></A> package
option has been used). If omitted, the glossary title is used.
<P>
</DD>
<DT><STRONG><TT>style</TT><A NAME="2808"></A></STRONG></DT>
<DD>This specifies which
glossary style to use for this glossary, overriding the effect
of the <TT>style</TT><A NAME="2816"></A> option or <TT>\glossarystyle</TT><A NAME="2820"></A>.
</DD>
</DL>
<P>
Information can be added to the start of the glossary by redefining
<TT>\glossarypreamble</TT>. For example:
<PRE>
\renewcommand{\glossarypreamble}{Numbers in italic indicate
primary definitions.}
</PRE>
This needs to be done before the glossary is displayed using
<TT>\printglossaries</TT> or <TT>\printglossary</TT>. Note that if you
want a different preamble for each glossary, you will need to
use a separate <TT>\printglossary</TT> for each glossary and change
the definition of <TT>\glossarypreamble</TT> between each glossary.
For example:
<PRE>
\renewcommand{\glossarypreamble}{Numbers in italic indicate
primary definitions.}
\printglossary
\renewcommand{\glossarypreamble}{}
\printglossary[type=acronym]
</PRE>
Alternatively, you can do something like:
<PRE>
\renewcommand{\glossarypreamble}{Numbers in italic indicate
primary definitions.\gdef\glossarypreamble{}}
\printglossaries
</PRE>
which will print the preamble text for the first glossary and
change the preamble to do nothing for subsequent glossaries.
(Note that <TT>\gdef</TT> is required as the glossary is placed within
a group.)
<P>
There is an analogous command
called <TT>\glossarypostamble</TT> which is placed at the end of each
glossary.
<P>
<A HREF="glossaries-manual.html#top">Top</A>
<P>
<H3><A NAME="SECTION00046100000000000000"></A>
<A NAME="sec:glsnamefont"></A>
<BR>
Changing the way the entry name appears in the glossary
</H3>
<P>
Within each glossary, each entry name is
formatted according to <TT>\glsnamefont</TT> which takes one argument: the
entry name. This command is always used regardless of the glossary
style. By default, <TT>\glsnamefont</TT> simply displays its argument in
whatever the surrounding font happens to be. This means that in the
list styles the name will appear in bold, since the name is placed in
the optional argument of <TT>\item</TT>, whereas in the tabular styles the
name will appear in the normal font.
<P>
For example, suppose you want all the entry names to appear in
medium weight small caps, then you can do:
<PRE>
\renewcommand{\glsnamefont}[1]{\textsc{\mdseries #1}}
</PRE>
<P>
<A HREF="glossaries-manual.html#top">Top</A>
<P>
<H2><A NAME="SECTION00047000000000000000">
Defining New Glossaries</A>
</H2>
<P>
A new glossary can be defined using:
<BR>
<BR><TT>\newglossary[</TT><EM>log-ext</EM><TT>]{</TT><EM>name</EM><TT>}{</TT><EM>in-ext</EM><TT>}{</TT><EM>out-ext</EM><TT>}{</TT><EM>title</EM><TT>}[</TT><EM>counter</EM><TT>]</TT>
<BR>
<BR>
where <I>name</I> is label to assign to this glossary. The arguments
<I>in-ext</I> and <I>out-ext</I> specify the extensions to give to the
input and output files for that glossary, <I>title</I> is the default
title for this new glossary and the final optional argument
<I>counter</I> specifies which counter to use for the associated number
lists<A NAME="2828"></A> (see also <A HREF="glossaries-manual.html#sec:numberlists">Number Lists</A>.) The
first optional argument specifies the extension for the
<TT>makeindex</TT><A NAME="2830"></A> transcript file (this information is only used by
<TT>makeglossaries</TT><A NAME="2833"></A> which picks up the information from the
auxiliary file.)
<P>
Note that the main (default) glossary is automatically created as:
<PRE>
\newglossary{main}{gls}{glo}{\glossaryname}
</PRE>
so it can be identified by the label <TT>main</TT>. Using the
<TT>acronym</TT><A NAME="2841"></A> package option is equivalent to:
<PRE>
\newglossary[alg]{acronym}{acr}{acn}{\acronymname}
</PRE>
so it can be identified by the label <TT>acronym</TT>. If you are
not sure whether the <TT>acronym</TT><A NAME="2850"></A> option has been used, you
can identify the list of acronyms by the command
<TT>\acronymtype</TT> which is set to
<TT>acronym</TT>, if the <TT>acronym</TT><A NAME="2859"></A> option has been used,
otherwise it is set to <TT>main</TT>.
<P>
<A HREF="glossaries-manual.html#top">Top</A>
<P>
<H2><A NAME="SECTION00048000000000000000"></A>
<A NAME="sec:acronyms"></A>
<BR>
Acronyms
</H2>
<P>
As you may have noticed in <A HREF="glossaries-manual.html#sec:newglosentry">Defining Glossary Entries</A>, when you
specify a new entry, you can specify alternate text to use when
the term is first used in the document. This provides a useful
means to define acronyms. The <TT>glossaries</TT> package defines
the command:
<BR>
<BR><TT>\newacronym[</TT><EM>key-val list</EM><TT>]{</TT><EM>label</EM><TT>}{</TT><EM>abbrv</EM><TT>}{</TT><EM>long</EM><TT>}</TT>
<BR>
<BR>
This is equivalent to:
<P>
<TT>
<TT>\newglossaryentry</TT></TT> <TT>{</TT><EM>label</EM><TT>}{type=<TT>\acronymtype</TT>,
<BR>
name=</TT> <TT>{</TT><EM>abbrv</EM><TT>},
<BR>
description=</TT> <TT>{</TT><EM>long</EM><TT>},
<BR>
text=</TT> <TT>{</TT><EM>abbrv</EM><TT>},
<BR>
first={</TT> <I>long</I><TT> (</TT> <I>abbrv</I><TT>)},
<BR>
plural={</TT> <I>abbrv</I><TT>s},
<BR>
firstplural={</TT> <I>long</I><TT>s (</TT> <I>abbrv</I><TT>s)},
<BR></TT> <I>key-val list</I><TT>}</TT>
<P>
As mentioned in the previous section, the command <TT>\acronymtype</TT> is
the name of the glossary in which the acronyms should appear. If the
<TT>acronym</TT><A NAME="2872"></A> package option has been used, this will be
<TT>acronym</TT>, otherwise it will be <TT>main</TT>. The acronyms can
then be used in exactly the same way as any other glossary entry.
For example, the following defines the acronym IDN:
<PRE>
\newacronym{idn}{IDN}{identification number}
</PRE>
This is equivalent to:
<PRE>
\newglossaryentry{idn}{type=\acronymtype,
name={IDN},
description={identification number},
text={IDN},
first={identification number (IDN)},
plural={IDNs},
firstplural={identification numbers (IDNs)}}
</PRE>
so <code>\gls{idn}</code> will produce "identification number (IDN)" on
first use and "IDN" on subsequent uses.
<P>
The <TT>glossaries</TT> package has options that change the
definition of <TT>\newacronym</TT><A NAME="2877"></A> for common acronym formats. These
options also change the way the link text is displayed for the
acronyms.
<P>
Table <A HREF="glossaries-manual.html#tab:acronymsettings">1</A> lists the package options and
how the keys are used to store <I>long</I> (the long form) and
<I>abbrv</I> (the short form). Note that the <TT>smallcaps</TT><A NAME="2885"></A>
option redefines <TT>\acronymfont</TT><A NAME="2889"></A> so that it sets its argument
in small captials otherwise <TT>\acronymfont</TT> simply displays its
argument in the surrounding font. Note also that if none of
the package options <TT>smallcaps</TT><A NAME="2897"></A>, <TT>description</TT><A NAME="2906"></A>
or <TT>footnote</TT><A NAME="2915"></A> are used, <TT>\acronymfont</TT> is not used, so
changing the definition of <TT>\acronymfont</TT> will have no effect
under such circumstances.
<P>
<BR><P></P>
<DIV ALIGN="CENTER">
<A NAME="tab:acronymsettings"></A>
<DIV ALIGN="CENTER">
<A NAME="1161"></A>
<TABLE CELLPADDING=3>
<CAPTION><STRONG>Table 1:</STRONG>
Package options governing acronyms and how the information
is stored in the glossary keys</CAPTION>
<TR><TH ALIGN="LEFT"><B>Package Option </B></TH>
<TD ALIGN="LEFT"><TT>first</TT><A NAME="2919"></A></TD>
<TD ALIGN="LEFT"><TT>text</TT><A NAME="2922"></A></TD>
<TD ALIGN="LEFT"><TT>description</TT><A NAME="2925"></A></TD>
<TD ALIGN="LEFT"><TT>symbol</TT><A NAME="2928"></A></TD>
</TR>
<TR><TD ALIGN="LEFT"><TT>description</TT><A NAME="2936"></A>,<TT>footnote</TT><A NAME="2945"></A></TD>
<TD ALIGN="LEFT"><I>abbrv</I></TD>
<TD ALIGN="LEFT"><I>abbrv</I></TD>
<TD ALIGN="LEFT">user supplied</TD>
<TD ALIGN="LEFT"><I>long</I></TD>
</TR>
<TR><TD ALIGN="LEFT"><TT>description</TT><A NAME="2954"></A>,<TT>dua</TT><A NAME="2963"></A></TD>
<TD ALIGN="LEFT"><I>long</I></TD>
<TD ALIGN="LEFT"><I>long</I></TD>
<TD ALIGN="LEFT">user supplied</TD>
<TD ALIGN="LEFT"><I>abbrv</I></TD>
</TR>
<TR><TD ALIGN="LEFT"><TT>description</TT><A NAME="2972"></A></TD>
<TD ALIGN="LEFT"><I>long</I></TD>
<TD ALIGN="LEFT"><I>abbrv</I></TD>
<TD ALIGN="LEFT">user supplied</TD>
<TD ALIGN="LEFT"><I>abbrv</I></TD>
</TR>
<TR><TD ALIGN="LEFT"><TT>footnote</TT><A NAME="2981"></A></TD>
<TD ALIGN="LEFT"><I>abbrv</I></TD>
<TD ALIGN="LEFT"><I>abbrv</I></TD>
<TD ALIGN="LEFT"><I>long</I></TD>
<TD ALIGN="LEFT"> </TD>
</TR>
<TR><TD ALIGN="LEFT"><TT>smallcaps</TT><A NAME="2990"></A></TD>
<TD ALIGN="LEFT"><I>long</I></TD>
<TD ALIGN="LEFT"><I>abbrv</I></TD>
<TD ALIGN="LEFT"><I>long</I></TD>
<TD ALIGN="LEFT"><I>abbrv</I></TD>
</TR>
<TR><TD ALIGN="LEFT"><TT>dua</TT><A NAME="2999"></A></TD>
<TD ALIGN="LEFT"><I>long</I></TD>
<TD ALIGN="LEFT"><I>long</I></TD>
<TD ALIGN="LEFT"><I>long</I></TD>
<TD ALIGN="LEFT"><I>abbrv</I></TD>
</TR>
<TR><TD ALIGN="LEFT">None of the above</TD>
<TD ALIGN="LEFT"><I>long</I> (<I>abbrv</I>)</TD>
<TD ALIGN="LEFT"><I>abbrv</I></TD>
<TD ALIGN="LEFT"><I>long</I></TD>
<TD ALIGN="LEFT"> </TD>
</TR>
</TABLE>
</DIV>
</DIV>
<BR>
<P>
Each of the package options <TT>smallcaps</TT><A NAME="3008"></A>, <TT>footnote</TT><A NAME="3017"></A>
and <TT>description</TT><A NAME="3026"></A> use <TT>\defglsdisplay</TT><A NAME="3030"></A> and
<TT>\defglsdisplayfirst</TT><A NAME="3033"></A> (described <A HREF="glossaries-manual.html#sec:glsdisplay">earlier</A>)
to change the way the link text is displayed.
<P>
<DL>
<DT><STRONG><TT>description</TT><A NAME="3041"></A>,<TT>footnote</TT><A NAME="3050"></A></STRONG></DT>
<DD>
When these two options are used together, the first use displays
the entry as:
<BR>
<BR><TT>\acronymfont{</TT><EM>abbrv</EM><TT>}</TT><I>insert</I><TT>\footnote{</TT><EM>long</EM><TT>}</TT>
<BR>
<BR>
while subsequent use displays the entry as:
<BR>
<BR><TT>\acronymfont{</TT><EM>abbrv</EM><TT>}</TT><I>insert</I>
<BR>
<BR>
where <I>insert</I> indicates the text supplied in the final
optional argument to <TT>\gls</TT>, <TT>\glspl</TT> or their uppercase
variants.
<P>
Note also that when these two package options are used (in the
given order), the <TT>glossaries</TT> package additionally implements the
<TT>sanitize</TT><A NAME="3060"></A> option using
<A NAME="3069"></A><A NAME="3076"></A><code>sanitize={description=false,symbol=false}</code>, so
remember to protect fragile commands when defining acronyms.
<P>
</DD>
<DT><STRONG>dua</STRONG></DT>
<DD>
The <TT>dua</TT><A NAME="3083"></A> package option always displays the expanded
form and so may not be used with <TT>footnote</TT><A NAME="3092"></A> or
<TT>smallcaps</TT><A NAME="3101"></A>. Both first use and subsequent use displays the
entry in the form:
<BR>
<BR><I>long</I><I>insert</I>
<BR>
<BR>
If the <TT>description</TT><A NAME="3110"></A> option is also used, the <TT>name</TT><A NAME="3114"></A>
key is set to the long form, otherwise the <TT>name</TT><A NAME="3117"></A> key is
set to the short form and the <TT>description</TT><A NAME="3120"></A> key is set to
the long form.
<P>
</DD>
<DT><STRONG><TT>description</TT><A NAME="3128"></A></STRONG></DT>
<DD>
This option displays the entry on first use as:
<BR>
<BR><I>long</I><I>insert</I> (<TT>\acronymfont{</TT><EM>abbrv</EM><TT>}</TT>)
<BR>
<BR>
while subsequent use displays the entry as:
<BR>
<BR><TT>\acronymfont{</TT><EM>abbrv</EM><TT>}</TT><I>insert</I>
<BR>
<BR>
Note also that if this package option is used, the <TT>glossaries</TT>
package additionally implements the option
<A NAME="3138"></A><code>sanitize={symbol=false}</code>, so
remember to protect fragile commands when defining acronyms.
<P>
</DD>
<DT><STRONG><TT>footnote</TT><A NAME="3145"></A></STRONG></DT>
<DD>
This option displays the entry on first use as:
<BR>
<BR><TT>\acronymfont{</TT><EM>abbrv</EM><TT>}</TT><I>insert</I><TT>\footnote{</TT><EM>long</EM><TT>}</TT>
<BR>
<BR>
while subsequent use displays the entry as:
<BR>
<BR><TT>\acronymfont{</TT><EM>abbrv</EM><TT>}</TT><I>insert</I>
<P>
Note also that if this package option is used, the <TT>glossaries</TT>
package additionally implements the option
<A NAME="3155"></A><code>sanitize={description=false}</code>, so
remember to protect fragile commands when defining acronyms.
<P>
</DD>
<DT><STRONG><TT>smallcaps</TT><A NAME="3162"></A></STRONG></DT>
<DD>
If neither the <TT>footnote</TT><A NAME="3171"></A> nor <TT>description</TT><A NAME="3180"></A> options
have been set, this option displays the entry on first use as:
<BR>
<BR><I>long</I><I>insert</I> (<TT>\acronymfont{</TT><EM>abbrv</EM><TT>}</TT>)
<BR>
<BR>
while subsequent use displays the entry as:
<BR>
<BR><TT>\acronymfont{</TT><EM>abbrv</EM><TT>}</TT><I>insert</I>
<BR>
<BR>
where <TT>\acronymfont</TT> is set to <TT>\textsc</TT>.
<P>
Note also that if this package option is used, the <TT>glossaries</TT>
package additionally implements the option
<A NAME="3190"></A><code>sanitize={symbol=false}</code>, so
remember to protect fragile commands when defining acronyms.
<P>
</DD>
<DT><STRONG>None of the above</STRONG></DT>
<DD>
If none of the package options <TT>smallcaps</TT><A NAME="3197"></A>, <TT>footnote</TT><A NAME="3206"></A>
or <TT>description</TT><A NAME="3215"></A> are used, then on first use the entry is
displayed as:
<BR>
<BR><I>long</I> (<I>abbrv</I>)<I>insert</I>
<BR>
<BR>
while subsequent use displays the entry as:
<BR>
<BR><TT>\acronymfont{</TT><EM>abbrv</EM><TT>}</TT><I>insert</I>
<BR>
<BR><I>abbrv</I><I>insert</I>
</DD>
</DL>
<P>
Recall from <A HREF="glossaries-manual.html#sec:glslink">earlier</A>
that you can access the values of individual keys using commands
like <TT>\glstext</TT><A NAME="3219"></A>, so it is possible to use these commands to
print just the long form or just the abbreviation without affecting
the flag that determines whether the entry has been used. However
the keys that store the long and short form vary depending on
the acronym style, so the <TT>glossaries</TT> package provides
commands that are set according to the package options. These are
as follows:
<BR>
<BR>
<P>
<TT>\acrshort[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<TT>\ACRshort[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<TT>\ACRshort[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
Print the abbreviated version with a hyperlink (if necessary) to the
relevant entry in the glossary. This is usually equivalent to
<TT>\glstext</TT><A NAME="3223"></A> (or its uppercase variants) but may additionally
put the link text within the argument to <TT>\acronymfont</TT><A NAME="3226"></A>.
<BR>
<BR>
<P>
<TT>\acrlong[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<TT>\ACRlong[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<TT>\ACRlong[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
Print the long version with a hyperlink (if necessary) to the
relevant entry in the glossary. This is may be equivalent to
<TT>\glsdesc</TT><A NAME="3229"></A>, <TT>\glssymbol</TT><A NAME="3232"></A> or <TT>\glsfirst</TT><A NAME="3235"></A> (or their uppercase
variants), depending on package options.
<BR>
<BR>
<P>
<TT>\acrfull[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<TT>\ACRfull[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<TT>\ACRfull[</TT><EM>options</EM><TT>]{</TT><EM>label</EM><TT>}[</TT><EM>insert</EM><TT>]</TT>
<BR>
<BR>
Print the long version followed by the abbreviation in brackets
with a hyperlink (if necessary) to the
relevant entry in the glossary.
<P>
Note that if you change the definition of <TT>\newacronym</TT><A NAME="3238"></A>, you
may additionally need to change the above commands as well as
the changing way the text is displayed using <TT>\defglsdisplay</TT><A NAME="3241"></A>
and <TT>\defglsdisplayfirst</TT><A NAME="3244"></A>.
<P>
<P>
<A HREF="glossaries-manual.html#top">Top</A>
<P>
<H2><A NAME="SECTION00049000000000000000">
Unsetting and resetting entry flags</A>
</H2>
<P>
When using commands such as <TT>\gls</TT><A NAME="3250"></A> it is possible that you may want
to use the value given by the <TT>first</TT><A NAME="3253"></A> key, even though you have
already used the glossary entry. Conversely, you may want to use the
value given by the <TT>text</TT><A NAME="3256"></A> key, even though you haven't used the
glossary entry. The former can be achieved by one of the following
commands:
<BR>
<BR><TT>\glsreset{</TT><EM>label</EM><TT>}</TT>
<BR><TT>\glslocalreset{</TT><EM>label</EM><TT>}</TT>
<BR>
<BR>
while the latter can be achieved by one of the following commands:
<BR>
<BR><TT>\glsunset{</TT><EM>label</EM><TT>}</TT>
<BR><TT>\glslocalunset{</TT><EM>label</EM><TT>}</TT>
<BR>
<BR>
You can determine whether an entry has been used using:
<BR>
<BR>
<TT>\ifglsused{</TT><EM>label</EM><TT>}{</TT><EM>true part</EM><TT>}{</TT><EM>false part</EM><TT>}</TT>
<BR>
<BR>
where <I>label</I> is the label of the required entry. If the
entry has been used, <I>true part</I> will be done, otherwise
<I>false part</I> will be done.
<P>
<A HREF="glossaries-manual.html#top">Top</A>
<P>
<H2><A NAME="SECTION000410000000000000000"></A>
<A NAME="sec:styles"></A>
<BR>
Glossary Styles
</H2>
The <TT>glossaries</TT> package comes with some pre-defined
glossary styles. These are as follows:
<DL>
<DT><STRONG>list</STRONG></DT>
<DD>The <TT>list</TT><A NAME="3263"></A> style uses the <TT>description</TT>
environment. The entry name is placed in the optional argument
of the <TT>\item</TT> command (so it will appear in bold by
default). The description follows, and then the associated number
list for that entry.
<P>
</DD>
<DT><STRONG>listgroup</STRONG></DT>
<DD>The <TT>listgroup</TT><A NAME="3266"></A> style is like
<TT>list</TT><A NAME="3268"></A> but the glossary groups have headings.
<P>
</DD>
<DT><STRONG>listhypergroup</STRONG></DT>
<DD>The <TT>listhypergroup</TT><A NAME="3270"></A> style is like
<TT>listgroup</TT><A NAME="3272"></A> but has a set of links to the glossary
groups.
<P>
</DD>
<DT><STRONG>altlist</STRONG></DT>
<DD>The <TT>altlist</TT><A NAME="3274"></A> style is like <TT>list</TT><A NAME="3276"></A>
but the description is placed on the following line.
<P>
</DD>
<DT><STRONG>altlistgroup</STRONG></DT>
<DD>The <TT>altlistgroup</TT><A NAME="3278"></A> style is like
<TT>altlist</TT><A NAME="3280"></A> but the glossary groups have headings.
<P>
</DD>
<DT><STRONG>altlisthypergroup</STRONG></DT>
<DD>The <TT>altlisthypergroup</TT><A NAME="3282"></A> style is like
<TT>altlistgroup</TT><A NAME="3284"></A> but has a set of links to the glossary
groups.
<P>
</DD>
<DT><STRONG>listdotted</STRONG></DT>
<DD>This style uses the <TT>description</TT>
environment. Each entry starts with <code>\item[]</code>, followed by the
name followed by a dotted line, followed by the description. Note that
this style ignores both the number list<A NAME="3286"></A> and the symbol. The
length <TT>\glslistdottedwidth</TT>
governs where the description should start.<A NAME="tex2html8"
HREF="#foot1409"><SUP>4</SUP></A>
<P>
</DD>
<DT><STRONG>long</STRONG></DT>
<DD>The <TT>long</TT><A NAME="3288"></A> style uses the <TT>longtable</TT>
environment (defined by the <TT>longtable</TT><A NAME="3291"></A> package). It has two
columns: the first column contains the entry's name and the second
column contains the description followed by the number list<A NAME="3293"></A>.
<P>
</DD>
<DT><STRONG>longborder</STRONG></DT>
<DD>The <TT>longborder</TT><A NAME="3295"></A> style is like
<TT>long</TT><A NAME="3297"></A> but has horizontal and vertical lines around it.
<P>
</DD>
<DT><STRONG>longheader</STRONG></DT>
<DD>The <TT>longheader</TT><A NAME="3299"></A> style is like
<TT>long</TT><A NAME="3301"></A> but has a header row.
<P>
</DD>
<DT><STRONG>longheaderborder</STRONG></DT>
<DD>The <TT>longheaderborder</TT><A NAME="3303"></A> style is
like <TT>longheader</TT><A NAME="3305"></A> but has horizontal and vertical lines
around it.
<P>
</DD>
<DT><STRONG>long3col</STRONG></DT>
<DD>The <TT>long3col</TT><A NAME="3307"></A> style is like
<TT>long</TT><A NAME="3309"></A> but has three columns. The first column contains
the entry's name, the second column contains the description
and the third column contains the number list<A NAME="3310"></A>.
<P>
</DD>
<DT><STRONG>long3colborder</STRONG></DT>
<DD>The <TT>long3colborder</TT><A NAME="3312"></A> style is like
the <TT>long3col</TT><A NAME="3314"></A> style but has horizontal and vertical
lines around it.
<P>
</DD>
<DT><STRONG>long3colheader</STRONG></DT>
<DD>The <TT>long3colheader</TT><A NAME="3316"></A> style is like
<TT>long3col</TT><A NAME="3318"></A> but has a header row.
<P>
</DD>
<DT><STRONG>long3colheaderborder</STRONG></DT>
<DD>The <TT>long3colheaderborder</TT><A NAME="3320"></A> style is
like <TT>long3colheader</TT><A NAME="3322"></A> but has horizontal and vertical lines
around it.
<P>
</DD>
<DT><STRONG>long4col</STRONG></DT>
<DD>The <TT>long4col</TT><A NAME="3324"></A> style is like
<TT>long3col</TT><A NAME="3326"></A> but has an additional column in which the
entry's associated symbol appears.
<P>
</DD>
<DT><STRONG>long4colborder</STRONG></DT>
<DD>The <TT>long4colborder</TT><A NAME="3328"></A> style is like
the <TT>long4col</TT><A NAME="3330"></A> style but has horizontal and vertical
lines around it.
<P>
</DD>
<DT><STRONG>long4colheader</STRONG></DT>
<DD>The <TT>long4colheader</TT><A NAME="3332"></A> style is like
<TT>long4col</TT><A NAME="3334"></A> but has a header row.
<P>
</DD>
<DT><STRONG>long4colheaderborder</STRONG></DT>
<DD>The <TT>long4colheaderborder</TT><A NAME="3336"></A> style is
like <TT>long4colheader</TT><A NAME="3338"></A> but has horizontal and vertical lines
around it.
<P>
</DD>
<DT><STRONG>super</STRONG></DT>
<DD>The <TT>super</TT><A NAME="3340"></A> style uses the <TT>supertabular</TT>
environment (defined by the <TT>supertabular</TT><A NAME="3343"></A> package). It has two
columns: the first column contains the entry's name and the second
column contains the description followed by the number list<A NAME="3345"></A>.
<P>
</DD>
<DT><STRONG>superborder</STRONG></DT>
<DD>The <TT>superborder</TT><A NAME="3347"></A> style is like
<TT>super</TT><A NAME="3349"></A> but has horizontal and vertical lines around it.
<P>
</DD>
<DT><STRONG>superheader</STRONG></DT>
<DD>The <TT>superheader</TT><A NAME="3351"></A> style is like
<TT>super</TT><A NAME="3353"></A> but has a header row.
<P>
</DD>
<DT><STRONG>superheaderborder</STRONG></DT>
<DD>The <TT>superheaderborder</TT><A NAME="3355"></A> style is
like <TT>superheader</TT><A NAME="3357"></A> but has horizontal and vertical lines
around it.
<P>
</DD>
<DT><STRONG>super3col</STRONG></DT>
<DD>The <TT>super3col</TT><A NAME="3359"></A> style is like
<TT>super</TT><A NAME="3361"></A> but has three columns. The first column contains
the entry's name, the second column contains the description
and the third column contains the <A NAME="3362"></A>.
<P>
</DD>
<DT><STRONG>super3colborder</STRONG></DT>
<DD>The <TT>super3colborder</TT><A NAME="3364"></A> style is like
the <TT>super3col</TT><A NAME="3366"></A> style but has horizontal and vertical
lines around it.
<P>
</DD>
<DT><STRONG>super3colheader</STRONG></DT>
<DD>The <TT>super3colheader</TT><A NAME="3368"></A> style is like
<TT>super3col</TT><A NAME="3370"></A> but has a header row.
<P>
</DD>
<DT><STRONG>super3colheaderborder</STRONG></DT>
<DD>The <TT>super3colheaderborder</TT><A NAME="3372"></A> style
is like <TT>super3colheader</TT><A NAME="3374"></A> but has horizontal and vertical
lines around it.
<P>
</DD>
<DT><STRONG>super4col</STRONG></DT>
<DD>The <TT>super4col</TT><A NAME="3376"></A> style is like
<TT>super3col</TT><A NAME="3378"></A> but has an additional column in which the
entry's associated symbol appears.
<P>
</DD>
<DT><STRONG>super4colborder</STRONG></DT>
<DD>The <TT>super4colborder</TT><A NAME="3380"></A> style is like
the <TT>super4col</TT><A NAME="3382"></A> style but has horizontal and vertical
lines around it.
<P>
</DD>
<DT><STRONG>super4colheader</STRONG></DT>
<DD>The <TT>super4colheader</TT><A NAME="3384"></A> style is like
<TT>super4col</TT><A NAME="3386"></A> but has a header row.
<P>
</DD>
<DT><STRONG>super4colheaderborder</STRONG></DT>
<DD>The <TT>super4colheaderborder</TT><A NAME="3388"></A> style
is like <TT>super4colheader</TT><A NAME="3390"></A> but has horizontal and vertical
lines around it.
<P>
</DD>
</DL>
<P>
The glossary style can be set using the <TT>style</TT><A NAME="3397"></A> package option
or using the <TT>style</TT><A NAME="3401"></A> key in the optional
argument to <TT>\printglossary</TT><A NAME="3404"></A> or using the command:
<BR>
<BR><TT>\glossarystyle{</TT><EM>style-name</EM><TT>}</TT>
<BR>
<BR>
<P>
All the styles except for the three- and four-column styles and the
<TT>listdotted</TT><A NAME="3407"></A> style use the command
<TT>\glspostdescription</TT> after the
description. This simply displays a full stop by default. To eliminate
this full stop (or replace it with something else, say a comma), you
will need to redefine <TT>\glspostdescription</TT> before the glossary is
displayed.
<P>
<A HREF="glossaries-manual.html#top">Top</A>
<P>
<H2><A NAME="SECTION000411000000000000000">
Defining your own glossary style</A>
</H2>
<P>
If the predefined styles don't fit your requirements, you can
define your own style using:
<BR>
<BR><TT>\newglossarystyle{</TT><EM>name</EM><TT>}{</TT><EM>definitions</EM><TT>}</TT>
<BR>
<BR>
where <I>name</I> is the name of the new glossary style (to be
used in <TT>\glossarystyle</TT>). The second argument <I>definitions</I>,
needs to redefine all of the following:
<P>
<DL>
<DT></DT>
<DD>
<TT>theglossary</TT>
<P>
This environment defines how the main body of the glossary should
be typeset. Note that this does not include the section heading,
the glossary preamble (defined by <TT>\glossarypreamble</TT>) or the
glossary postamble (defined by <TT>\glossarypostamble</TT>.) For example,
the <TT>list</TT><A NAME="3413"></A> style uses the <TT>description</TT> environment,
so the <TT>theglossary</TT> environment is simply redefined to begin
and end the <TT>description</TT> environment.
<P>
</DD>
<DT></DT>
<DD>
<TT>\glossaryheader</TT>
<P>
This macro indicates what to do at the start of the main body
of the glossary. Note that this is not the same as
<TT>\glossarypreamble</TT>, which should not be affected by changes in
the glossary style. The <TT>list</TT><A NAME="3418"></A> glossary style redefines
<TT>\glossaryheader</TT> to do nothing, whereas the <TT>longheader</TT><A NAME="3420"></A>
glossary style redefines <TT>\glossaryheader</TT> to do a header row.
<P>
</DD>
<DT></DT>
<DD>
<TT>\glsgroupheading{</TT><EM>label</EM><TT>}</TT>
<P>
This macro indicates what to do at the start of each logical block
within the main body of the glossary. The glossary is sub-divided into
twenty-eight logical blocks that are determined by the first character
of the <TT>sort</TT><A NAME="3422"></A> key (or <TT>name</TT><A NAME="3425"></A> key if the <TT>sort</TT><A NAME="3428"></A>
key is omitted). The sub-divisions are in the following order: symbols,
numbers, A, ..., Z. Note that the argument to <TT>\glsgroupheading</TT>
is a label <I>not</I> the group title. The group title can be obtained
via <TT>\glsgetgrouptitle{</TT><EM>label</EM><TT>}</TT>, and a navigation hypertarget can
be created using <TT>\glsnavhypertarget{</TT><EM>label</EM><TT>}</TT>. Most of the
predefined glossary styles redefine <TT>\glsgroupheading</TT> to simply
ignore its argument. The <TT>listhypergroup</TT><A NAME="3431"></A> style redefines
<TT>\glsgroupheading</TT> as follows:
<PRE>
\renewcommand*{\glsgroupheading}[1]{%
\item[\glsnavhypertarget{##1}{\glsgetgrouptitle{##1}}]}
</PRE>
See also <TT>\glsgroupskip</TT> below. (Note that command definitions within
<TT>\newglossarystyle</TT> must use <code>##1</code> etc instead of <code>#1</code> etc.)
<P>
</DD>
<DT></DT>
<DD>
<TT>\glsgroupskip</TT>
<P>
This macro determines what to do after one logical group but before
the header for the next logical group. The <TT>list</TT><A NAME="3433"></A> glossary
style simply redefines <TT>\glsgroupskip</TT> to be <TT>\indexspace</TT>.
<P>
</DD>
<DT></DT>
<DD>
<TT>\glossaryentryfield{</TT><EM>label</EM><TT>}{</TT><EM>formatted
name</EM><TT>}{</TT><EM>description</EM><TT>}{</TT><EM>symbol</EM><TT>}</TT>
<TT>{</TT><EM>number list</EM><TT>}</TT>
<P>
This macro indicates what to do for a given glossary entry.
Note that <I>formatted name</I> will always be in the form
<TT>\glsnamefont{</TT><EM>name</EM><TT>}</TT>. This allows the user to set a given
font for the entry name, regardless of the glossary style used.
Note that <I>label</I> is the label used when the glossary entry
was defined via either <TT>\newglossaryentry</TT> or <TT>\newacronym</TT>.
Each time you use a glossary entry it creates a
link<A NAME="tex2html9"
HREF="#foot1752"><SUP>5</SUP></A>
using <TT>\@glslink{</TT><EM>label</EM><TT>}{</TT><EM>text</EM><TT>}</TT> with the label
<TT>glo:</TT><I>label</I>. Your
new glossary style must therefore redefine <TT>\glossaryentryfield</TT>
so that it uses <TT>\@glstarget</TT><code>{</code><TT>glo:</TT><I>label</I><code>}</code><TT>{</TT><EM>text</EM><TT>}</TT>
to ensure the hyperlinks function correctly.<A NAME="tex2html10"
HREF="#foot1753"><SUP>6</SUP></A> For example, the
<TT>list</TT><A NAME="3435"></A> style defines <TT>\glossaryentryfield</TT> as follows:
<PRE>
\renewcommand*{\glossaryentryfield}[5]{%
\item[\@glstarget{glo:##1}{##2}] ##3\glspostdescription\space ##5}
</PRE>
<P>
Note also that <I>number list</I> will always be of the form
<BR>
<BR><TT>\glossaryentrynumbers</TT>{<TT>\relax</TT>
<BR><TT>\setentrycounter{</TT><EM>counter name</EM><TT>}\glsnumberformat{</TT><EM>number(s)</EM><TT>}</TT>}
<BR>
<BR>
where <I>number(s)</I>
may contain <TT>\delimN</TT> (to delimit individual numbers) and/or
<TT>\delimR</TT> (to indicate a range of numbers). There may be
multiple occurrences of
<TT>\setentrycounter{</TT><EM>counter name</EM><TT>}\glsnumberformat{</TT><EM>number(s)</EM><TT>}</TT>, but note
that the entire number list is enclosed within the argument
to <TT>\glossaryentrynumbers</TT><A NAME="3437"></A>. The user can redefine this to change
the way the entire number list is formatted, regardless of
the glossary style. However the most common use of
<TT>\glossaryentrynumbers</TT> is to provide a means of suppressing the
number list altogether. (In fact, the <TT>nonumberlist</TT><A NAME="3445"></A> option
redefines <TT>\glossaryentrynumbers</TT> to ignore its argument.)
Therefore, when you define a new glossary style, you don't need
to worry about whether the user has specified the
<TT>nonumberlist</TT><A NAME="3454"></A> package option.
</DD>
</DL>
<P>
<A HREF="glossaries-manual.html#top">Top</A>
<P>
<H3><A NAME="SECTION000411100000000000000">
Example: creating a completely new style</A>
</H3>
<P>
If you want a completely new style, you will need to redefine all
of the commands and environment listed above. You also need to
take care when using internal commands (commands whose name
contain the @ symbol). These should either be used in a <TT>.sty</TT>
file or must be placed within <TT>\makeatletter</TT> and <TT>\makeatother</TT>.
<P>
For example, suppose you want each entry to start with a bullet point.
This means that the glossary should be placed in the <TT>itemize</TT>
environment, so <TT>theglossary</TT> should start and end that
environment. Let's also suppose that you don't want anything between
the glossary groups (so <TT>\glsgroupheading</TT> and <TT>\glsgroupskip</TT>
should do nothing) and suppose you don't want anything to appear
immediately after <code>\begin{theglossary}</code> (so <TT>\glossaryheader</TT>
should do nothing). In addition, let's suppose the symbol should
appear in brackets after the name, followed by the description and
last of all the number list<A NAME="3462"></A> should appear within square brackets
at the end. Then you can create this new glossary style, called, say,
<TT>mylist</TT>, as follows:
<PRE>
\newglossarystyle{mylist}{%
% put the glossary in the itemize environment:
\renewenvironment{theglossary}{\begin{itemize}}{\end{itemize}}%
% have nothing after \begin{theglossary}:
\renewcommand*{\glossaryheader}{}%
% have nothing between glossary groups:
\renewcommand*{\glsgroupheading}[1]{}%
\renewcommand*{\glsgroupskip}{}%
% set how each entry should appear:
\renewcommand*{\glossaryentryfield}[5]{%
\item % bullet point
\@glstarget{glo:##1}{##2}% the entry name
\space (##4)% the symbol in brackets
\space ##3% the description
\space [##5]% the number list in square brackets
}%
}
</PRE>
<P>
<A HREF="glossaries-manual.html#top">Top</A>
<P>
<H3><A NAME="SECTION000411200000000000000">
Example: creating a new glossary style based on an
existing style</A>
</H3>
<P>
If you want to define a new style that is a slightly modified
version of an existing style, you can use <TT>\glossarystyle</TT>
within the second argument of <TT>\newglossarystyle</TT> followed by
whatever alterations you require. For example, suppose you want
a style like the <TT>list</TT><A NAME="3467"></A> style but you don't want the extra
vertical space created by <TT>\indexspace</TT> between groups, then you
can create a new glossary style called, say, <TT>mylist</TT> as
follows:
<PRE>
\newglossarystyle{mylist}{%
\glossarystyle{list}% base this style on the list style
\renewcommand{\glsgroupskip}{}% make nothing happen between groups
}
</PRE>
<P>
<A HREF="glossaries-manual.html#top">Top</A>
<P>
<P>
<BR>
<H2><A NAME="SECTION00050000000000000000">
Index</A>
</H2><DL COMPACT>
<DT><STRONG><TT>\acronymfont</TT></STRONG>
<DD><A HREF="glossaries-manual.html#2889">Acronyms</A>
| <A HREF="glossaries-manual.html#3226">Acronyms</A>
<DT><STRONG><TT>\acronymtype</TT></STRONG>
<DD><A HREF="glossaries-manual.html#1978">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2247">Package Options</A>
| <A HREF="glossaries-manual.html#2534">Defining Glossary Entries</A>
<DT><STRONG><TT>babel</TT></STRONG>
<DD><A HREF="glossaries-manual.html#1804">Introduction</A>
| <A HREF="glossaries-manual.html#2368">Package Options</A>
| <A HREF="glossaries-manual.html#2380">Package Options</A>
<DT><STRONG><TT>\defglsdisplay</TT></STRONG>
<DD><A HREF="glossaries-manual.html#3030">Acronyms</A>
| <A HREF="glossaries-manual.html#3241">Acronyms</A>
<DT><STRONG><TT>\defglsdisplayfirst</TT></STRONG>
<DD><A HREF="glossaries-manual.html#3033">Acronyms</A>
| <A HREF="glossaries-manual.html#3244">Acronyms</A>
<DT><STRONG><TT>\emph</TT></STRONG>
<DD><A HREF="glossaries-manual.html#2036">A Quick Guide For</A>
<DT><STRONG>file types</STRONG>
<DD><DL COMPACT>
<DT><STRONG>.alg</STRONG>
<DD><A HREF="glossaries-manual.html#1864">Generating the associated glossary</A>
<DT><STRONG>.glg</STRONG>
<DD><A HREF="glossaries-manual.html#1862">Generating the associated glossary</A>
| <A HREF="glossaries-manual.html#1924">A Quick Guide For</A>
<DT><STRONG>.glo</STRONG>
<DD><A HREF="glossaries-manual.html#2444">Defining Glossary Entries</A>
<DT><STRONG>.gls</STRONG>
<DD><A HREF="glossaries-manual.html#2446">Defining Glossary Entries</A>
<DT><STRONG>.ist</STRONG>
<DD><A HREF="glossaries-manual.html#1836">Generating the associated glossary</A>
| <A HREF="glossaries-manual.html#2460">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2465">Defining Glossary Entries</A>
<DT><STRONG>.nlg</STRONG>
<DD><A HREF="glossaries-manual.html#1922">A Quick Guide For</A>
</DL>
<DT><STRONG><TT>glossary</TT></STRONG>
<DD><A HREF="glossaries-manual.html#1800">Introduction</A>
<DT><STRONG>glossary styles</STRONG>
<DD><DL COMPACT>
<DT><STRONG>altlist</STRONG>
<DD><A HREF="glossaries-manual.html#3274">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3280">Glossary Styles</A>
<DT><STRONG>altlistgroup</STRONG>
<DD><A HREF="glossaries-manual.html#3278">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3284">Glossary Styles</A>
<DT><STRONG>altlisthypergroup</STRONG>
<DD><A HREF="glossaries-manual.html#3282">Glossary Styles</A>
<DT><STRONG>list</STRONG>
<DD><A HREF="glossaries-manual.html#3263">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3268">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3276">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3413">Defining your own glossary</A>
| <A HREF="glossaries-manual.html#3418">Defining your own glossary</A>
| <A HREF="glossaries-manual.html#3433">Defining your own glossary</A>
| <A HREF="glossaries-manual.html#3435">Defining your own glossary</A>
| <A HREF="glossaries-manual.html#3467">Example: creating a new</A>
<DT><STRONG>listdotted</STRONG>
<DD><A HREF="glossaries-manual.html#3407">Glossary Styles</A>
<DT><STRONG>listgroup</STRONG>
<DD><A HREF="glossaries-manual.html#3266">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3272">Glossary Styles</A>
<DT><STRONG>listhypergroup</STRONG>
<DD><A HREF="glossaries-manual.html#3270">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3431">Defining your own glossary</A>
<DT><STRONG>long</STRONG>
<DD><A HREF="glossaries-manual.html#3288">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3297">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3301">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3309">Glossary Styles</A>
<DT><STRONG>long3col</STRONG>
<DD><A HREF="glossaries-manual.html#3307">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3314">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3318">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3326">Glossary Styles</A>
<DT><STRONG>long3colborder</STRONG>
<DD><A HREF="glossaries-manual.html#3312">Glossary Styles</A>
<DT><STRONG>long3colheader</STRONG>
<DD><A HREF="glossaries-manual.html#3316">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3322">Glossary Styles</A>
<DT><STRONG>long3colheaderborder</STRONG>
<DD><A HREF="glossaries-manual.html#3320">Glossary Styles</A>
<DT><STRONG>long4col</STRONG>
<DD><A HREF="glossaries-manual.html#2069">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#3324">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3330">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3334">Glossary Styles</A>
<DT><STRONG>long4colborder</STRONG>
<DD><A HREF="glossaries-manual.html#2073">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#3328">Glossary Styles</A>
<DT><STRONG>long4colheader</STRONG>
<DD><A HREF="glossaries-manual.html#2071">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#3332">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3338">Glossary Styles</A>
<DT><STRONG>long4colheaderborder</STRONG>
<DD><A HREF="glossaries-manual.html#2075">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#3336">Glossary Styles</A>
<DT><STRONG>longborder</STRONG>
<DD><A HREF="glossaries-manual.html#3295">Glossary Styles</A>
<DT><STRONG>longheader</STRONG>
<DD><A HREF="glossaries-manual.html#3299">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3305">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3420">Defining your own glossary</A>
<DT><STRONG>longheaderborder</STRONG>
<DD><A HREF="glossaries-manual.html#3303">Glossary Styles</A>
<DT><STRONG>super</STRONG>
<DD><A HREF="glossaries-manual.html#3340">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3349">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3353">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3361">Glossary Styles</A>
<DT><STRONG>super3col</STRONG>
<DD><A HREF="glossaries-manual.html#3359">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3366">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3370">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3378">Glossary Styles</A>
<DT><STRONG>super3colborder</STRONG>
<DD><A HREF="glossaries-manual.html#3364">Glossary Styles</A>
<DT><STRONG>super3colheader</STRONG>
<DD><A HREF="glossaries-manual.html#3368">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3374">Glossary Styles</A>
<DT><STRONG>super3colheaderborder</STRONG>
<DD><A HREF="glossaries-manual.html#3372">Glossary Styles</A>
<DT><STRONG>super4col</STRONG>
<DD><A HREF="glossaries-manual.html#2077">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#3376">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3382">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3386">Glossary Styles</A>
<DT><STRONG>super4colborder</STRONG>
<DD><A HREF="glossaries-manual.html#2081">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#3380">Glossary Styles</A>
<DT><STRONG>super4colheader</STRONG>
<DD><A HREF="glossaries-manual.html#2079">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#3384">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3390">Glossary Styles</A>
<DT><STRONG>super4colheaderborder</STRONG>
<DD><A HREF="glossaries-manual.html#2083">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#3388">Glossary Styles</A>
<DT><STRONG>superborder</STRONG>
<DD><A HREF="glossaries-manual.html#3347">Glossary Styles</A>
<DT><STRONG>superheader</STRONG>
<DD><A HREF="glossaries-manual.html#3351">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3357">Glossary Styles</A>
<DT><STRONG>superheaderborder</STRONG>
<DD><A HREF="glossaries-manual.html#3355">Glossary Styles</A>
</DL>
<DT><STRONG><TT>glossary-list</TT></STRONG>
<DD><A HREF="glossaries-manual.html#1996">A Quick Guide For</A>
<DT><STRONG><TT>\glossaryentrynumbers</TT></STRONG>
<DD><A HREF="glossaries-manual.html#3437">Defining your own glossary</A>
<DT><STRONG><TT>\glossarystyle</TT></STRONG>
<DD><A HREF="glossaries-manual.html#2094">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2820">Displaying a glossary</A>
<DT><STRONG><TT>\gls</TT></STRONG>
<DD><A HREF="glossaries-manual.html#1960">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2005">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2008">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2011">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2054">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2482">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2491">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2638">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2644">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2650">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2656">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2662">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2674">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2686">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2702">Changing the format of</A>
| <A HREF="glossaries-manual.html#2754">Enabling and disabling hyperlinks</A>
| <A HREF="glossaries-manual.html#3250">Unsetting and resetting entry</A>
<DT><STRONG><TT>\glsadd</TT></STRONG>
<DD><A HREF="glossaries-manual.html#2042">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2057">A Quick Guide For</A>
<DT><STRONG><TT>\glsaddall</TT></STRONG>
<DD><A HREF="glossaries-manual.html#2045">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2060">A Quick Guide For</A>
<DT><STRONG><TT>\glscompositor</TT></STRONG>
<DD><A HREF="glossaries-manual.html#1936">A Quick Guide For</A>
<DT><STRONG><TT>\glsdesc</TT></STRONG>
<DD><A HREF="glossaries-manual.html#3229">Acronyms</A>
<DT><STRONG><TT>\glsfirst</TT></STRONG>
<DD><A HREF="glossaries-manual.html#3235">Acronyms</A>
<DT><STRONG><TT>\glslink</TT></STRONG>
<DD><A HREF="glossaries-manual.html#2023">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2051">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2629">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2751">Enabling and disabling hyperlinks</A>
| <A HREF="glossaries-manual.html#2769">Adding an entry to</A>
<DT><STRONG><TT>\glslink</TT> keys</STRONG>
<DD><DL COMPACT>
<DT><STRONG>counter</STRONG>
<DD><A HREF="glossaries-manual.html#2613">Links to Glossary Entries</A>
<DT><STRONG>format</STRONG>
<DD><A HREF="glossaries-manual.html#2026">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2029">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2039">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2600">Links to Glossary Entries</A>
<DT><STRONG>hyper</STRONG>
<DD><A HREF="glossaries-manual.html#2616">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2757">Enabling and disabling hyperlinks</A>
| <A HREF="glossaries-manual.html#2772">Adding an entry to</A>
</DL>
<DT><STRONG><TT>\glsnamefont</TT></STRONG>
<DD><A HREF="glossaries-manual.html#1993">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2002">A Quick Guide For</A>
<DT><STRONG><TT>\glspl</TT></STRONG>
<DD><A HREF="glossaries-manual.html#1963">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2014">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2017">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2020">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2500">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2509">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2705">Changing the format of</A>
<DT><STRONG><TT>\glssymbol</TT></STRONG>
<DD><A HREF="glossaries-manual.html#3232">Acronyms</A>
<DT><STRONG><TT>\glstext</TT></STRONG>
<DD><A HREF="glossaries-manual.html#3219">Acronyms</A>
| <A HREF="glossaries-manual.html#3223">Acronyms</A>
<DT><STRONG><TT>\glstextformat</TT></STRONG>
<DD><A HREF="glossaries-manual.html#2730">Changing the format of</A>
<DT><STRONG><TT>html</TT></STRONG>
<DD><A HREF="glossaries-manual.html#1877">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2747">Enabling and disabling hyperlinks</A>
<DT><STRONG><TT>\hyperemph</TT></STRONG>
<DD><A HREF="glossaries-manual.html#2033">A Quick Guide For</A>
<DT><STRONG><TT>\hyperlink</TT></STRONG>
<DD><A HREF="glossaries-manual.html#2760">Enabling and disabling hyperlinks</A>
<DT><STRONG><TT>hyperref</TT></STRONG>
<DD><A HREF="glossaries-manual.html#1874">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2606">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2744">Enabling and disabling hyperlinks</A>
| <A HREF="glossaries-manual.html#2766">Enabling and disabling hyperlinks</A>
<DT><STRONG><TT>\hypertarget</TT></STRONG>
<DD><A HREF="glossaries-manual.html#2763">Enabling and disabling hyperlinks</A>
<DT><STRONG><TT>\item</TT></STRONG>
<DD><A HREF="glossaries-manual.html#1999">A Quick Guide For</A>
<DT><STRONG>link text</STRONG>
<DD><A HREF="glossaries-manual.html#2596">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2597">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2598">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2618">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2700">Changing the format of</A>
| <A HREF="glossaries-manual.html#2728">Changing the format of</A>
| <A HREF="glossaries-manual.html#2739">Changing the format of</A>
<DT><STRONG><TT>longtable</TT></STRONG>
<DD><A HREF="glossaries-manual.html#3291">Glossary Styles</A>
<DT><STRONG><TT>makeglossaries</TT></STRONG>
<DD><A HREF="glossaries-manual.html#1827">Generating the associated glossary</A>
| <A HREF="glossaries-manual.html#1838">Generating the associated glossary</A>
| <A HREF="glossaries-manual.html#1841">Generating the associated glossary</A>
| <A HREF="glossaries-manual.html#1856">Generating the associated glossary</A>
| <A HREF="glossaries-manual.html#1880">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#1883">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#1889">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#1907">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#1916">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#1939">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2454">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2778">Displaying a glossary</A>
| <A HREF="glossaries-manual.html#2787">Displaying a glossary</A>
| <A HREF="glossaries-manual.html#2833">Defining New Glossaries</A>
<DT><STRONG><TT>makeindex</TT></STRONG>
<DD><A HREF="glossaries-manual.html#1830">Generating the associated glossary</A>
| <A HREF="glossaries-manual.html#1833">Generating the associated glossary</A>
| <A HREF="glossaries-manual.html#1844">Generating the associated glossary</A>
| <A HREF="glossaries-manual.html#1859">Generating the associated glossary</A>
| <A HREF="glossaries-manual.html#1904">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#1910">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#1913">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#1919">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2048">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2066">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2457">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2462">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2521">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2527">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2603">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2781">Displaying a glossary</A>
| <A HREF="glossaries-manual.html#2784">Displaying a glossary</A>
| <A HREF="glossaries-manual.html#2830">Defining New Glossaries</A>
<DT><STRONG><TT>\newacronym</TT></STRONG>
<DD><A HREF="glossaries-manual.html#1975">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2402">Package Options</A>
| <A HREF="glossaries-manual.html#2414">Package Options</A>
| <A HREF="glossaries-manual.html#2426">Package Options</A>
| <A HREF="glossaries-manual.html#2438">Package Options</A>
| <A HREF="glossaries-manual.html#2877">Acronyms</A>
| <A HREF="glossaries-manual.html#3238">Acronyms</A>
<DT><STRONG><TT>\newglossary</TT></STRONG>
<DD><A HREF="glossaries-manual.html#1901">A Quick Guide For</A>
<DT><STRONG><TT>\newglossaryentry</TT></STRONG>
<DD><A HREF="glossaries-manual.html#1951">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#1990">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2593">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2626">Links to Glossary Entries</A>
<DT><STRONG><TT>\newglossaryentry</TT> keys</STRONG>
<DD><DL COMPACT>
<DT><STRONG>description</STRONG>
<DD><A HREF="glossaries-manual.html#1957">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2310">Package Options</A>
| <A HREF="glossaries-manual.html#2325">Package Options</A>
| <A HREF="glossaries-manual.html#2337">Package Options</A>
| <A HREF="glossaries-manual.html#2476">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2470">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2689">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2692">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2695">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2720">Changing the format of</A>
| <A HREF="glossaries-manual.html#2925">Acronyms</A>
| <A HREF="glossaries-manual.html#3120">Acronyms</A>
<DT><STRONG>first</STRONG>
<DD><A HREF="glossaries-manual.html#2488">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2512">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2558">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2623">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2647">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2714">Changing the format of</A>
| <A HREF="glossaries-manual.html#2919">Acronyms</A>
| <A HREF="glossaries-manual.html#3253">Unsetting and resetting entry</A>
<DT><STRONG>firstplural</STRONG>
<DD><A HREF="glossaries-manual.html#2506">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2561">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2635">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2659">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2717">Changing the format of</A>
<DT><STRONG>format</STRONG>
<DD><A HREF="glossaries-manual.html#2610">Links to Glossary Entries</A>
<DT><STRONG>name</STRONG>
<DD><A HREF="glossaries-manual.html#1954">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2307">Package Options</A>
| <A HREF="glossaries-manual.html#2328">Package Options</A>
| <A HREF="glossaries-manual.html#2334">Package Options</A>
| <A HREF="glossaries-manual.html#2349">Package Options</A>
| <A HREF="glossaries-manual.html#2352">Package Options</A>
| <A HREF="glossaries-manual.html#2473">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2467">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2485">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2524">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2549">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2665">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2668">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2671">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#3114">Acronyms</A>
| <A HREF="glossaries-manual.html#3117">Acronyms</A>
| <A HREF="glossaries-manual.html#3425">Defining your own glossary</A>
<DT><STRONG>plural</STRONG>
<DD><A HREF="glossaries-manual.html#1972">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2497">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2555">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2632">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2653">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2711">Changing the format of</A>
<DT><STRONG>sort</STRONG>
<DD><A HREF="glossaries-manual.html#2063">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2343">Package Options</A>
| <A HREF="glossaries-manual.html#2518">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#3422">Defining your own glossary</A>
| <A HREF="glossaries-manual.html#3428">Defining your own glossary</A>
<DT><STRONG>symbol</STRONG>
<DD><A HREF="glossaries-manual.html#2313">Package Options</A>
| <A HREF="glossaries-manual.html#2331">Package Options</A>
| <A HREF="glossaries-manual.html#2340">Package Options</A>
| <A HREF="glossaries-manual.html#2515">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2677">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2680">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2683">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2723">Changing the format of</A>
| <A HREF="glossaries-manual.html#2726">Changing the format of</A>
| <A HREF="glossaries-manual.html#2737">Changing the format of</A>
| <A HREF="glossaries-manual.html#2928">Acronyms</A>
<DT><STRONG>text</STRONG>
<DD><A HREF="glossaries-manual.html#2346">Package Options</A>
| <A HREF="glossaries-manual.html#2355">Package Options</A>
| <A HREF="glossaries-manual.html#2479">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2494">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2503">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2546">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2552">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2620">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2641">Links to Glossary Entries</A>
| <A HREF="glossaries-manual.html#2708">Changing the format of</A>
| <A HREF="glossaries-manual.html#2922">Acronyms</A>
| <A HREF="glossaries-manual.html#3256">Unsetting and resetting entry</A>
<DT><STRONG>type</STRONG>
<DD><A HREF="glossaries-manual.html#1966">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#1969">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2531">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2564">Defining Glossary Entries</A>
</DL>
<DT><STRONG>number list</STRONG>
<DD><A HREF="glossaries-manual.html#2285">Package Options</A>
| <A HREF="glossaries-manual.html#2295">Package Options</A>
| <A HREF="glossaries-manual.html#2570">Number lists</A>
| <A HREF="glossaries-manual.html#2828">Defining New Glossaries</A>
| <A HREF="glossaries-manual.html#3286">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3293">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3310">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3345">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3362">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3462">Example: creating a completely</A>
<DT><STRONG>package options</STRONG>
<DD><DL COMPACT>
<DT><STRONG>acronym</STRONG>
<DD><A HREF="glossaries-manual.html#1852">Generating the associated glossary</A>
| <A HREF="glossaries-manual.html#1854">Generating the associated glossary</A>
| <A HREF="glossaries-manual.html#1931">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#1933">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#1986">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#1988">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2188">Package Options</A>
| <A HREF="glossaries-manual.html#2190">Package Options</A>
| <A HREF="glossaries-manual.html#2242">Package Options</A>
| <A HREF="glossaries-manual.html#2244">Package Options</A>
| <A HREF="glossaries-manual.html#2255">Package Options</A>
| <A HREF="glossaries-manual.html#2257">Package Options</A>
| <A HREF="glossaries-manual.html#2264">Package Options</A>
| <A HREF="glossaries-manual.html#2266">Package Options</A>
| <A HREF="glossaries-manual.html#2542">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2544">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#2841">Defining New Glossaries</A>
| <A HREF="glossaries-manual.html#2843">Defining New Glossaries</A>
| <A HREF="glossaries-manual.html#2850">Defining New Glossaries</A>
| <A HREF="glossaries-manual.html#2852">Defining New Glossaries</A>
| <A HREF="glossaries-manual.html#2859">Defining New Glossaries</A>
| <A HREF="glossaries-manual.html#2861">Defining New Glossaries</A>
| <A HREF="glossaries-manual.html#2872">Acronyms</A>
| <A HREF="glossaries-manual.html#2874">Acronyms</A>
<DT><STRONG>babel</STRONG>
<DD><A HREF="glossaries-manual.html#2363">Package Options</A>
| <A HREF="glossaries-manual.html#2365">Package Options</A>
| <A HREF="glossaries-manual.html#2376">Package Options</A>
| <A HREF="glossaries-manual.html#2389">Package Options</A>
<DD><DL COMPACT>
<DT><STRONG>false</STRONG>
<DD><A HREF="glossaries-manual.html#2391">Package Options</A>
<DT><STRONG>true</STRONG>
<DD><A HREF="glossaries-manual.html#2378">Package Options</A>
</DL>
<DT><STRONG>counter</STRONG>
<DD><A HREF="glossaries-manual.html#2292">Package Options</A>
| <A HREF="glossaries-manual.html#2294">Package Options</A>
| <A HREF="glossaries-manual.html#2586">Number lists</A>
| <A HREF="glossaries-manual.html#2588">Number lists</A>
<DT><STRONG>description</STRONG>
<DD><A HREF="glossaries-manual.html#2398">Package Options</A>
| <A HREF="glossaries-manual.html#2400">Package Options</A>
| <A HREF="glossaries-manual.html#2906">Acronyms</A>
| <A HREF="glossaries-manual.html#2908">Acronyms</A>
| <A HREF="glossaries-manual.html#2936">Acronyms</A>
| <A HREF="glossaries-manual.html#2938">Acronyms</A>
| <A HREF="glossaries-manual.html#2954">Acronyms</A>
| <A HREF="glossaries-manual.html#2956">Acronyms</A>
| <A HREF="glossaries-manual.html#2972">Acronyms</A>
| <A HREF="glossaries-manual.html#2974">Acronyms</A>
| <A HREF="glossaries-manual.html#3026">Acronyms</A>
| <A HREF="glossaries-manual.html#3028">Acronyms</A>
| <A HREF="glossaries-manual.html#3041">Acronyms</A>
| <A HREF="glossaries-manual.html#3043">Acronyms</A>
| <A HREF="glossaries-manual.html#3110">Acronyms</A>
| <A HREF="glossaries-manual.html#3112">Acronyms</A>
| <A HREF="glossaries-manual.html#3128">Acronyms</A>
| <A HREF="glossaries-manual.html#3130">Acronyms</A>
| <A HREF="glossaries-manual.html#3180">Acronyms</A>
| <A HREF="glossaries-manual.html#3182">Acronyms</A>
| <A HREF="glossaries-manual.html#3215">Acronyms</A>
| <A HREF="glossaries-manual.html#3217">Acronyms</A>
<DT><STRONG>dua</STRONG>
<DD><A HREF="glossaries-manual.html#2434">Package Options</A>
| <A HREF="glossaries-manual.html#2436">Package Options</A>
| <A HREF="glossaries-manual.html#2963">Acronyms</A>
| <A HREF="glossaries-manual.html#2965">Acronyms</A>
| <A HREF="glossaries-manual.html#2999">Acronyms</A>
| <A HREF="glossaries-manual.html#3001">Acronyms</A>
| <A HREF="glossaries-manual.html#3083">Acronyms</A>
| <A HREF="glossaries-manual.html#3085">Acronyms</A>
<DT><STRONG>footnote</STRONG>
<DD><A HREF="glossaries-manual.html#2410">Package Options</A>
| <A HREF="glossaries-manual.html#2412">Package Options</A>
| <A HREF="glossaries-manual.html#2915">Acronyms</A>
| <A HREF="glossaries-manual.html#2917">Acronyms</A>
| <A HREF="glossaries-manual.html#2945">Acronyms</A>
| <A HREF="glossaries-manual.html#2947">Acronyms</A>
| <A HREF="glossaries-manual.html#2981">Acronyms</A>
| <A HREF="glossaries-manual.html#2983">Acronyms</A>
| <A HREF="glossaries-manual.html#3017">Acronyms</A>
| <A HREF="glossaries-manual.html#3019">Acronyms</A>
| <A HREF="glossaries-manual.html#3050">Acronyms</A>
| <A HREF="glossaries-manual.html#3052">Acronyms</A>
| <A HREF="glossaries-manual.html#3092">Acronyms</A>
| <A HREF="glossaries-manual.html#3094">Acronyms</A>
| <A HREF="glossaries-manual.html#3145">Acronyms</A>
| <A HREF="glossaries-manual.html#3147">Acronyms</A>
| <A HREF="glossaries-manual.html#3171">Acronyms</A>
| <A HREF="glossaries-manual.html#3173">Acronyms</A>
| <A HREF="glossaries-manual.html#3206">Acronyms</A>
| <A HREF="glossaries-manual.html#3208">Acronyms</A>
<DT><STRONG>nonumberlist</STRONG>
<DD><A HREF="glossaries-manual.html#2103">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2105">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2282">Package Options</A>
| <A HREF="glossaries-manual.html#2284">Package Options</A>
| <A HREF="glossaries-manual.html#2577">Number lists</A>
| <A HREF="glossaries-manual.html#2579">Number lists</A>
| <A HREF="glossaries-manual.html#3445">Defining your own glossary</A>
| <A HREF="glossaries-manual.html#3447">Defining your own glossary</A>
| <A HREF="glossaries-manual.html#3454">Defining your own glossary</A>
| <A HREF="glossaries-manual.html#3456">Defining your own glossary</A>
<DT><STRONG>numberedsection</STRONG>
<DD><A HREF="glossaries-manual.html#2209">Package Options</A>
| <A HREF="glossaries-manual.html#2211">Package Options</A>
| <A HREF="glossaries-manual.html#2218">Package Options</A>
| <A HREF="glossaries-manual.html#2220">Package Options</A>
| <A HREF="glossaries-manual.html#2233">Package Options</A>
<DD><DL COMPACT>
<DT><STRONG>autolabel</STRONG>
<DD><A HREF="glossaries-manual.html#2235">Package Options</A>
| <A HREF="glossaries-manual.html#2226">Package Options</A>
<DT><STRONG>false</STRONG>
<DD><A HREF="glossaries-manual.html#2222">Package Options</A>
<DT><STRONG>nolabel</STRONG>
<DD><A HREF="glossaries-manual.html#2224">Package Options</A>
</DL>
<DT><STRONG>numberline</STRONG>
<DD><A HREF="glossaries-manual.html#2143">Package Options</A>
| <A HREF="glossaries-manual.html#2145">Package Options</A>
| <A HREF="glossaries-manual.html#2179">Package Options</A>
| <A HREF="glossaries-manual.html#2181">Package Options</A>
<DT><STRONG>sanitize</STRONG>
<DD><A HREF="glossaries-manual.html#2302">Package Options</A>
| <A HREF="glossaries-manual.html#2304">Package Options</A>
| <A HREF="glossaries-manual.html#2321">Package Options</A>
| <A HREF="glossaries-manual.html#2323">Package Options</A>
| <A HREF="glossaries-manual.html#3060">Acronyms</A>
| <A HREF="glossaries-manual.html#3062">Acronyms</A>
| <A HREF="glossaries-manual.html#3068">Acronyms</A>
| <A HREF="glossaries-manual.html#3075">Acronyms</A>
| <A HREF="glossaries-manual.html#3137">Acronyms</A>
| <A HREF="glossaries-manual.html#3154">Acronyms</A>
| <A HREF="glossaries-manual.html#3189">Acronyms</A>
<DD><DL COMPACT>
<DT><STRONG>description</STRONG>
<DD><A HREF="glossaries-manual.html#3069">Acronyms</A>
| <A HREF="glossaries-manual.html#3155">Acronyms</A>
<DT><STRONG>symbol</STRONG>
<DD><A HREF="glossaries-manual.html#3076">Acronyms</A>
| <A HREF="glossaries-manual.html#3138">Acronyms</A>
| <A HREF="glossaries-manual.html#3190">Acronyms</A>
</DL>
<DT><STRONG>section</STRONG>
<DD><A HREF="glossaries-manual.html#2112">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2114">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2121">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2123">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2197">Package Options</A>
| <A HREF="glossaries-manual.html#2199">Package Options</A>
<DT><STRONG>smallcaps</STRONG>
<DD><A HREF="glossaries-manual.html#2422">Package Options</A>
| <A HREF="glossaries-manual.html#2424">Package Options</A>
| <A HREF="glossaries-manual.html#2885">Acronyms</A>
| <A HREF="glossaries-manual.html#2887">Acronyms</A>
| <A HREF="glossaries-manual.html#2897">Acronyms</A>
| <A HREF="glossaries-manual.html#2899">Acronyms</A>
| <A HREF="glossaries-manual.html#2990">Acronyms</A>
| <A HREF="glossaries-manual.html#2992">Acronyms</A>
| <A HREF="glossaries-manual.html#3008">Acronyms</A>
| <A HREF="glossaries-manual.html#3010">Acronyms</A>
| <A HREF="glossaries-manual.html#3101">Acronyms</A>
| <A HREF="glossaries-manual.html#3103">Acronyms</A>
| <A HREF="glossaries-manual.html#3162">Acronyms</A>
| <A HREF="glossaries-manual.html#3164">Acronyms</A>
| <A HREF="glossaries-manual.html#3197">Acronyms</A>
| <A HREF="glossaries-manual.html#3199">Acronyms</A>
<DT><STRONG>style</STRONG>
<DD><A HREF="glossaries-manual.html#2090">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2092">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2273">Package Options</A>
| <A HREF="glossaries-manual.html#2275">Package Options</A>
| <A HREF="glossaries-manual.html#2816">Displaying a glossary</A>
| <A HREF="glossaries-manual.html#2818">Displaying a glossary</A>
| <A HREF="glossaries-manual.html#3397">Glossary Styles</A>
| <A HREF="glossaries-manual.html#3399">Glossary Styles</A>
<DT><STRONG>toc</STRONG>
<DD><A HREF="glossaries-manual.html#1897">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#1899">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#1947">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#1949">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2134">Package Options</A>
| <A HREF="glossaries-manual.html#2136">Package Options</A>
| <A HREF="glossaries-manual.html#2152">Package Options</A>
| <A HREF="glossaries-manual.html#2154">Package Options</A>
| <A HREF="glossaries-manual.html#2161">Package Options</A>
| <A HREF="glossaries-manual.html#2163">Package Options</A>
| <A HREF="glossaries-manual.html#2170">Package Options</A>
| <A HREF="glossaries-manual.html#2172">Package Options</A>
| <A HREF="glossaries-manual.html#2804">Displaying a glossary</A>
| <A HREF="glossaries-manual.html#2806">Displaying a glossary</A>
<DT><STRONG>translate</STRONG>
<DD><A HREF="glossaries-manual.html#1819">Introduction</A>
<DD><DL COMPACT>
<DT><STRONG>false</STRONG>
<DD><A HREF="glossaries-manual.html#1821">Introduction</A>
</DL>
</DL>
<DT><STRONG><TT>\printglossaries</TT></STRONG>
<DD><A HREF="glossaries-manual.html#1886">A Quick Guide For</A>
| <A HREF="glossaries-manual.html#2451">Defining Glossary Entries</A>
<DT><STRONG><TT>\printglossary</TT></STRONG>
<DD><A HREF="glossaries-manual.html#2448">Defining Glossary Entries</A>
| <A HREF="glossaries-manual.html#3404">Glossary Styles</A>
<DT><STRONG><TT>\printglossary</TT> keys</STRONG>
<DD><DL COMPACT>
<DT><STRONG>style</STRONG>
<DD><A HREF="glossaries-manual.html#2808">Displaying a glossary</A>
| <A HREF="glossaries-manual.html#3401">Glossary Styles</A>
<DT><STRONG>title</STRONG>
<DD><A HREF="glossaries-manual.html#2793">Displaying a glossary</A>
<DT><STRONG>toctitle</STRONG>
<DD><A HREF="glossaries-manual.html#2796">Displaying a glossary</A>
<DT><STRONG>type</STRONG>
<DD><A HREF="glossaries-manual.html#2790">Displaying a glossary</A>
</DL>
<DT><STRONG><TT>\setglossarysection</TT></STRONG>
<DD><A HREF="glossaries-manual.html#2201">Package Options</A>
<DT><STRONG><TT>supertabular</TT></STRONG>
<DD><A HREF="glossaries-manual.html#3343">Glossary Styles</A>
<DT><STRONG><TT>translator</TT></STRONG>
<DD><A HREF="glossaries-manual.html#1810">Introduction</A>
</DL>
<P>
<A HREF="glossaries-manual.html#top">Top</A>
<P>
<BR><HR><H4>Footnotes</H4>
<DL>
<DT><A NAME="foot370">...
range</A><A
HREF="glossaries-manual.html#tex2html4"><SUP>1</SUP></A></DT>
<DD>This is new to version 1.01
</DD>
<DT><A NAME="foot1670">...acronym</A><A
HREF="glossaries-manual.html#tex2html5"><SUP>2</SUP></A></DT>
<DD>if the
<TT>acronym</TT><A NAME="2242"></A> option is used, otherwise the list of
acronyms is the main glossary
</DD>
<DT><A NAME="foot1718">... name</A><A
HREF="glossaries-manual.html#tex2html6"><SUP>3</SUP></A></DT>
<DD><TT>main</TT> for the main
(default) glossary, <TT>\acronymtype</TT> for the list of acronyms, or the
name supplied in the first mandatory argument to <TT>\newglossary</TT> for
additional glossaries.
</DD>
<DT><A NAME="foot1409">... start.</A><A
HREF="glossaries-manual.html#tex2html8"><SUP>4</SUP></A></DT>
<DD>This style was
supplied by Axel Menzel.
</DD>
<DT><A NAME="foot1752">...
link</A><A
HREF="glossaries-manual.html#tex2html9"><SUP>5</SUP></A></DT>
<DD>if the document doesn't have hyperlinks enabled
<TT>\@glslink</TT> ignores the label and simply typesets the text.
</DD>
<DT><A NAME="foot1753">... correctly.</A><A
HREF="glossaries-manual.html#tex2html10"><SUP>6</SUP></A></DT>
<DD>again, if the
document doesn't support hyperlinks, <TT>\@glstarget</TT> will ignore
the label, and just typeset the text.
</DD>
</DL>
<BR><HR>
</BODY>
</HTML>
|
