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
|
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!--http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd-->
<html xmlns="http://www.w3.org/1999/xhtml"
>
<head><title>The glossaries package v4.19: a guide for beginners</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="TeX4ht (http://www.tug.org/tex4ht/)" />
<meta name="originator" content="TeX4ht (http://www.tug.org/tex4ht/)" />
<!-- xhtml,fn-in,css-in,uni-html4,utf8 -->
<meta name="src" content="glossariesbegin.tex" />
<meta name="date" content="2015-11-22 15:07:00" />
<style type="text/css">
<!--
/* start css.sty */
.cmr-17{font-size:170%;}
.cmr-12{font-size:120%;}
.cmr-9{font-size:90%;}
.cmbx-9{font-size:90%; font-weight: bold;}
.cmbx-9{ font-weight: bold;}
.cmss-9{font-size:90%; font-family: sans-serif;}
.cmss-9{ font-family: sans-serif;}
.cmtt-10{font-family: monospace;}
.cmtt-10{font-family: monospace;}
.cmtt-10{font-family: monospace;}
.cmss-10{ font-family: sans-serif;}
.cmss-10{ font-family: sans-serif;}
.cmti-10{ font-style: italic;}
.cmtt-9{font-size:90%;font-family: monospace;}
.cmtt-9{font-family: monospace;}
.cmtt-9{font-family: monospace;}
.cmitt-10{font-family: monospace; font-style: italic;}
.cmbx-10{ font-weight: bold;}
.cmbx-10{ font-weight: bold;}
.cmsy-9{font-size:90%;}
p.noindent { text-indent: 0em }
td p.noindent { text-indent: 0em; margin-top:0em; }
p.nopar { text-indent: 0em; }
p.indent{ text-indent: 1.5em }
@media print {div.crosslinks {visibility:hidden;}}
a img { border-top: 0; border-left: 0; border-right: 0; }
center { margin-top:1em; margin-bottom:1em; }
td center { margin-top:0em; margin-bottom:0em; }
.Canvas { position:relative; }
img.math{vertical-align:middle;}
li p.indent { text-indent: 0em }
li p:first-child{ margin-top:0em; }
li p:last-child, li div:last-child { margin-bottom:0.5em; }
li p~ul:last-child, li p~ol:last-child{ margin-bottom:0.5em; }
.enumerate1 {list-style-type:decimal;}
.enumerate2 {list-style-type:lower-alpha;}
.enumerate3 {list-style-type:lower-roman;}
.enumerate4 {list-style-type:upper-alpha;}
div.newtheorem { margin-bottom: 2em; margin-top: 2em;}
.obeylines-h,.obeylines-v {white-space: nowrap; }
div.obeylines-v p { margin-top:0; margin-bottom:0; }
.overline{ text-decoration:overline; }
.overline img{ border-top: 1px solid black; }
td.displaylines {text-align:center; white-space:nowrap;}
.centerline {text-align:center;}
.rightline {text-align:right;}
div.verbatim {font-family: monospace; white-space: nowrap; text-align:left; clear:both; }
.fbox {padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; }
div.fbox {display:table}
div.center div.fbox {text-align:center; clear:both; padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; }
div.minipage{width:100%;}
div.center, div.center div.center {text-align: center; margin-left:1em; margin-right:1em;}
div.center div {text-align: left;}
div.flushright, div.flushright div.flushright {text-align: right;}
div.flushright div {text-align: left;}
div.flushleft {text-align: left;}
.underline{ text-decoration:underline; }
.underline img{ border-bottom: 1px solid black; margin-bottom:1pt; }
.framebox-c, .framebox-l, .framebox-r { padding-left:3.0pt; padding-right:3.0pt; text-indent:0pt; border:solid black 0.4pt; }
.framebox-c {text-align:center;}
.framebox-l {text-align:left;}
.framebox-r {text-align:right;}
span.thank-mark{ vertical-align: super }
span.footnote-mark sup.textsuperscript, span.footnote-mark a sup.textsuperscript{ font-size:80%; }
div.footnotes{border-top:solid 1px black; border-bottom:solid 1px black; padding-bottom:1ex; padding-top:0.5ex; margin-right:15%; margin-top:2ex; font-style:italic; font-size:85%;}
div.footnotes p{margin-top:0; margin-bottom:0; text-indent:0;}
div.tabular, div.center div.tabular {text-align: center; margin-top:0.5em; margin-bottom:0.5em; }
table.tabular td p{margin-top:0em;}
table.tabular {margin-left: auto; margin-right: auto;}
td p:first-child{ margin-top:0em; }
td p:last-child{ margin-bottom:0em; }
div.td00{ margin-left:0pt; margin-right:0pt; }
div.td01{ margin-left:0pt; margin-right:5pt; }
div.td10{ margin-left:5pt; margin-right:0pt; }
div.td11{ margin-left:5pt; margin-right:5pt; }
table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; }
td.td00{ padding-left:0pt; padding-right:0pt; }
td.td01{ padding-left:0pt; padding-right:5pt; }
td.td10{ padding-left:5pt; padding-right:0pt; }
td.td11{ padding-left:5pt; padding-right:5pt; }
table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; }
.hline hr, .cline hr{ height : 1px; margin:0px; }
.tabbing-right {text-align:right;}
span.TEX {letter-spacing: -0.125em; }
span.TEX span.E{ position:relative;top:0.5ex;left:-0.0417em;}
a span.TEX span.E {text-decoration: none; }
span.LATEX span.A{ position:relative; top:-0.5ex; left:-0.4em; font-size:85%;}
span.LATEX span.TEX{ position:relative; left: -0.4em; }
div.float, div.figure {margin-left: auto; margin-right: auto;}
div.float img {text-align:center;}
div.figure img {text-align:center;}
.marginpar {width:20%; float:right; text-align:left; margin-left:auto; margin-top:0.5em; font-size:85%; text-decoration:underline;}
.marginpar p{margin-top:0.4em; margin-bottom:0.4em;}
table.equation {width:100%;}
.equation td{text-align:center; }
td.equation { margin-top:1em; margin-bottom:1em; }
td.equation-label { width:5%; text-align:center; }
td.eqnarray4 { width:5%; white-space: normal; }
td.eqnarray2 { width:5%; }
table.eqnarray-star, table.eqnarray {width:100%;}
div.eqnarray{text-align:center;}
div.array {text-align:center;}
div.pmatrix {text-align:center;}
table.pmatrix {width:100%;}
span.pmatrix img{vertical-align:middle;}
div.pmatrix {text-align:center;}
table.pmatrix {width:100%;}
span.bar-css {text-decoration:overline;}
img.cdots{vertical-align:middle;}
.partToc a, .partToc, .likepartToc a, .likepartToc {line-height: 200%; font-weight:bold; font-size:110%;}
.index-item, .index-subitem, .index-subsubitem {display:block}
div.caption {text-indent:-2em; margin-left:3em; margin-right:1em; text-align:left;}
div.caption span.id{font-weight: bold; white-space: nowrap; }
h1.partHead{text-align: center}
p.bibitem { text-indent: -2em; margin-left: 2em; margin-top:0.6em; margin-bottom:0.6em; }
p.bibitem-p { text-indent: 0em; margin-left: 2em; margin-top:0.6em; margin-bottom:0.6em; }
.paragraphHead, .likeparagraphHead { margin-top:2em; font-weight: bold;}
.subparagraphHead, .likesubparagraphHead { font-weight: bold;}
.quote {margin-bottom:0.25em; margin-top:0.25em; margin-left:1em; margin-right:1em; text-align:justify;}
.verse{white-space:nowrap; margin-left:2em}
div.maketitle {text-align:center;}
h2.titleHead{text-align:center;}
div.maketitle{ margin-bottom: 2em; }
div.author, div.date {text-align:center;}
div.thanks{text-align:left; margin-left:10%; font-size:85%; font-style:italic; }
.quotation {margin-bottom:0.25em; margin-top:0.25em; margin-left:1em; }
.abstract p {margin-left:5%; margin-right:5%;}
div.abstract {width:100%;}
.alltt P { margin-bottom : 0em; margin-top : 0em; }
.alltt { margin-bottom : 1em; margin-top : 1em; }
div.tabular, div.center div.tabular {text-align: center; margin-top:0.5em; margin-bottom:0.5em; }
table.tabular td p{margin-top:0em;}
table.tabular {margin-left: auto; margin-right: auto;}
td p:first-child{ margin-top:0em; }
td p:last-child{ margin-bottom:0em; }
div.td00{ margin-left:0pt; margin-right:0pt; }
div.td01{ margin-left:0pt; margin-right:5pt; }
div.td10{ margin-left:5pt; margin-right:0pt; }
div.td11{ margin-left:5pt; margin-right:5pt; }
table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; }
td.td00{ padding-left:0pt; padding-right:0pt; }
td.td01{ padding-left:0pt; padding-right:5pt; }
td.td10{ padding-left:5pt; padding-right:0pt; }
td.td11{ padding-left:5pt; padding-right:5pt; }
table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; }
.hline hr, .cline hr{ height : 1px; margin:0px; }
div.array {text-align:center;}
.equation td{text-align:center; }
.equation-star td{text-align:center; }
table.equation-star { width:100%; }
table.equation { width:100%; }
table.align, table.alignat, table.xalignat, table.xxalignat, table.flalign {width:100%; margin-left:5%; white-space: nowrap;}
table.align-star, table.alignat-star, table.xalignat-star, table.flalign-star {margin-left:auto; margin-right:auto; white-space: nowrap;}
td.align-label { width:5%; text-align:center; }
td.align-odd { text-align:right; padding-right:0.3em;}
td.align-even { text-align:left; padding-right:0.6em;}
table.multline, table.multline-star {width:100%;}
td.gather {text-align:center; }
table.gather {width:100%;}
div.gather-star {text-align:center;}
table[rules] {border-left:solid black 0.4pt; border-right:solid black 0.4pt; }
div.longtable{text-align:center;}
.supertabular {text-align:center}
div.important { border : solid red; }
div.verbatim { font-family: monospace; white-space: nowrap; text-align:left; clear:both; padding-top: 2ex; padding-bottom: 2ex;}
/* end css.sty */
-->
</style>
</head><body
>
<div class="maketitle"><a
id="top"></a>
<h2 class="titleHead">The glossaries package v4.19: a guide for beginners</h2>
<div class="author" ><span
class="cmr-12">Nicola L.C. Talbot</span></div><br />
<div class="date" ><span
class="cmr-12">2015-11-22</span></div>
</div>
<div
class="abstract"
>
<div class="center"
>
<!--l. 46--><p class="noindent" >
</p><!--l. 46--><p class="noindent" ><span
class="cmbx-9">Abstract</span></p></div>
<!--l. 47--><p class="indent" > <span
class="cmr-9">The </span><span
class="cmss-9">glossaries </span><span
class="cmr-9">package is very flexible, but this means that it has a</span><span
class="cmr-9"> lot</span>
<span
class="cmr-9">options, and since a user guide is supposed to provide a complete list of all</span>
<span
class="cmr-9">the high-level user commands, the main user manual is quite big. This can</span>
<span
class="cmr-9">be rather daunting for beginners, so this document is a brief introduction</span>
<span
class="cmr-9">just to help get you started. If you find yourself saying, “Yeah, but how can</span>
<span
class="cmr-9">I do</span><span
class="cmr-9">…?” then it’s time to move on to the </span><a
href="glossaries-user.html" ><span
class="cmr-9">main user manual</span></a><span
class="cmr-9">.</span>
</p><!--l. 56--><p class="indent" > <span
class="cmr-9">I’ve made some statements in this document that don’t actually tell you</span>
<span
class="cmr-9">the full truth, but it would clutter the document and cause confusion if I</span>
<span
class="cmr-9">keep writing “except when </span><span
class="cmr-9">…” or “but you can also do this, that or the other”</span>
<span
class="cmr-9">or “you can do it this way but you can also do it that way, but that way</span>
<span
class="cmr-9">may cause complications under certain circumstances”.</span>
</p>
</div>
<h3 class="likesectionHead"><a
id="x1-1000"></a>Contents</h3>
<div class="tableofcontents">
<span class="sectionToc" >1 <a
href="#sec:start" id="QQ2-1-2">Getting Started</a></span>
<br /> <span class="sectionToc" >2 <a
href="#sec:defterm" id="QQ2-1-3">Defining Terms</a></span>
<br /> <span class="sectionToc" >3 <a
href="#sec:useterm" id="QQ2-1-4">Using Entries</a></span>
<br /> <span class="sectionToc" >4 <a
href="#sec:printglossaries" id="QQ2-1-5">Displaying a List of Entries</a></span>
<br /> <span class="sectionToc" >5 <a
href="#sec:glosstyle" id="QQ2-1-7">Customising the Glossary</a></span>
<br /> <span class="sectionToc" >6 <a
href="#sec:multigloss" id="QQ2-1-8">Multiple Glossaries</a></span>
<br /> <span class="sectionToc" >7 <a
href="#sec:hyperref" id="QQ2-1-9">glossaries and hyperref</a></span>
<br /> <span class="sectionToc" >8 <a
href="#sec:xr" id="QQ2-1-10">Cross-References</a></span>
<br /> <span class="sectionToc" >9 <a
href="#sec:moreinfo" id="QQ2-1-11">Further Information</a></span>
</div>
<!--l. 66--><p class="noindent" >
</p>
<!--l. 66--><p class="noindent" ><a
href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">1 </span> <a
id="sec:start"></a>Getting Started</h3>
<!--l. 69--><p class="noindent" >As with all packages, you need to load <span
class="cmss-10">glossaries </span>with <span
class="cmtt-10">\usepackage</span>, but there are
certain packages that must be loaded before <span
class="cmss-10">glossaries</span>, <span
class="cmti-10">if </span>they are required: <span
class="cmss-10">hyperref</span><a
id="dx1-2001"></a>,
<span
class="cmss-10">babel</span><a
id="dx1-2002"></a>, <span
class="cmss-10">polyglossia</span><a
id="dx1-2003"></a>, <span
class="cmss-10">inputenc</span><a
id="dx1-2004"></a> and <span
class="cmss-10">fontenc</span><a
id="dx1-2005"></a>. (You don’t have to load these packages, but if
you want them, you must load them before <span
class="cmss-10">glossaries</span>.)
</p><!--l. 76--><p class="indent" > <div class="important" title="Important Note"> If you require multilingual support you must also install the relevant language
module. Each language module is called <span
class="cmtt-10">glossaries-</span>⟨<span
class="cmti-10">language</span>⟩, where ⟨<span
class="cmti-10">language</span>⟩ is the
root language name. For example, <span
class="cmtt-10">glossaries-french </span>or <span
class="cmtt-10">glossaries-german</span>. If a
language module is required, the <span
class="cmss-10">glossaries </span>package will automatically try to load it and
will give a warning if the module isn’t found. </div>
</p><!--l. 84--><p class="noindent" >
</p><!--l. 86--><p class="indent" > Once you have loaded <span
class="cmss-10">glossaries</span>, you need to define your terms in the preamble and
then you can use them throughout the document. Here’s a simple example:
</p>
<div class="verbatim" id="verbatim-1">
\documentclass{article}
 <br />\usepackage{glossaries}
 <br />\newglossaryentry{ex}{name={sample},description={an example}}
 <br />\begin{document}
 <br />Here’s my \gls{ex} term.
 <br />\end{document}
</div>
<!--l. 99--><p class="nopar" > This produces: <spacer type=vertical size=10><span class="obeylines-h">
<br />Here’s my sample term.
<br /><spacer type=vertical size=10></span>
Here’s another example:
</p>
<div class="verbatim" id="verbatim-2">
\documentclass{article}
 <br />\usepackage{glossaries}
 <br />\setacronymstyle{long-short}
 <br />\newacronym{svm}{SVM}{support vector machine}
 <br />\begin{document}
 <br />First use: \gls{svm}. Second use: \gls{svm}.
 <br />\end{document}
</div>
<!--l. 117--><p class="nopar" > This produces: <spacer type=vertical size=10><span class="obeylines-h">
<br />First use: support vector machine (SVM). Second use: SVM.
<br /><spacer type=vertical size=10></span>
In this case, the text produced by <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\gls{svm}</span></span></span> changed after the first use. The first use
produced the long form followed by the short form in parentheses because I set the
acronym style to <span
class="cmtt-10">long-short</span>. I suggest you try the above two examples to
make sure you have the package correctly installed. If you get an <span
class="cmtt-10">undefined</span>
<span
class="cmtt-10">control sequence </span>error, check that the version number at the top of this
document matches the version you have installed. (Open the <span
class="cmtt-10">.log </span>file and search
for the line that starts with <span
class="cmtt-10">Package: glossaries </span>followed by a date and
version.)
</p><!--l. 133--><p class="indent" > If you like, you can put all your definitions in another file (for example, <span
class="cmtt-10">defns.tex</span>)
and load that file in the preamble using <span
class="cmtt-10">\loadglsentries </span>with the filename as the
argument. For example:
</p>
<div class="verbatim" id="verbatim-3">
\loadglsentries{defns}
</div>
<!--l. 138--><p class="nopar" >
</p><!--l. 140--><p class="indent" > Don’t try inserting formatting commands into the definitions as they can interfere
with the underlying mechanism. Instead, the formatting should be done by the style.
For example, suppose I want to replace <span
class="cmtt-10">SVM </span>in the above to <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\textsc{svm}</span></span></span>, then I need
to select a style that uses <span
class="cmtt-10">\textsc</span>, like this:
</p>
<div class="verbatim" id="verbatim-4">
\documentclass{article}
 <br />\usepackage{glossaries}
 <br />\setacronymstyle{long-sc-short}
 <br />\newacronym{svm}{svm}{support vector machine}
 <br />\begin{document}
 <br />First use: \gls{svm}. Second use: \gls{svm}.
 <br />\end{document}
</div>
<!--l. 157--><p class="nopar" >
</p><!--l. 159--><p class="indent" > As you can hopefully see from the above examples, there are two main ways of
defining a term. In both cases, the term is given a label. In the first case the label
was <span
class="cmtt-10">ex </span>and in the second case the label was <span
class="cmtt-10">svm</span>. The label is just a way of
identifying the term (like the standard <span
class="cmtt-10">\label</span>/<span
class="cmtt-10">\ref </span>mechanism). It’s best to
just use the following alphanumerics in the labels: <span
class="cmtt-10">a</span>, …, <span
class="cmtt-10">z</span>, <span
class="cmtt-10">A</span>, …, <span
class="cmtt-10">Z</span>, <span
class="cmtt-10">0</span>, …, <span
class="cmtt-10">9</span>.
Sometimes you can also use punctuation characters but not if another package (such
as <span
class="cmss-10">babel</span><a
id="dx1-2006"></a>) meddles with them. Don’t try using any characters outside of the
basic Latin set (for example, é or ß) or things will go horribly wrong. This
warning only applies to the label. It doesn’t apply to the text that appears in the
document.
</p><!--l. 173--><p class="indent" > <div class="important" title="Important Note"> Don’t use <span
class="cmtt-10">\gls </span>in chapter or section headings as it can have some unpleasant
side-effects. Instead use <span
class="cmtt-10">\glsentrytext </span>for regular entries and one of <span
class="cmtt-10">\glsentryshort</span>,
<span
class="cmtt-10">\glsentrylong </span>or <span
class="cmtt-10">\glsentryfull </span>for acronyms. </div>
</p><!--l. 178--><p class="noindent" >
</p><!--l. 180--><p class="indent" > The above examples are reasonably straightforward. The difficulty comes if you
want to display a sorted list of all the entries you have used in the document. The
<span
class="cmss-10">glossaries </span>package provides three options: use <span class="TEX">T<span
class="E">E</span>X</span> to perform the sorting; use
<span
class="cmtt-10">makeindex </span>to perform the sorting; use <span
class="cmtt-10">xindy </span>to perform the sorting.
</p><!--l. 187--><p class="indent" > The first option (using <span class="TEX">T<span
class="E">E</span>X</span>) is the simplest and easiest method, but it’s inefficient
and the sorting is done according to the English alphabet. To use this method, add
<span
class="cmtt-10">\makenoidxglossaries </span>to the preamble and put <span
class="cmtt-10">\printnoidxglossaries </span>at the place
where you want your glossary. For example:
</p>
<div class="verbatim" id="verbatim-5">
\documentclass{article}
 <br />\usepackage{glossaries}
 <br />\makenoidxglossaries
 <br />\newglossaryentry{potato}{name={potato},plural={potatoes},
 <br /> description={starchy tuber}}
 <br />\newglossaryentry{cabbage}{name={cabbage},
 <br /> description={vegetable with thick green or purple leaves}}
 <br />\newglossaryentry{carrot}{name={carrot},
 <br /> description={orange root}}
 <br />\begin{document}
 <br />Chop the \gls{cabbage}, \glspl{potato} and \glspl{carrot}.
 <br />\printnoidxglossaries
 <br />\end{document}
</div>
<!--l. 213--><p class="nopar" > Try this out and run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> (or pdf<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>) <span
class="cmti-10">twice</span>. The first run won’t show the
glossary. It will only appear on the second run. The glossary has a vertical gap between
the “carrot” term and the “potato” term. This is because the entries in the glossaries
are grouped according to their first letter. If you don’t want this gap, just add
<span
class="cmtt-10">nogroupskip </span>to the package options:
</p>
<div class="verbatim" id="verbatim-6">
\usepackage[nogroupskip]{glossaries}
</div>
<!--l. 222--><p class="nopar" > If you try out this example you may also notice that the description is followed by a
full stop (period) and a number. The number is the location in the document where the
entry was used, so you can lookup the term in the glossary and be directed to the
relevant pages. It may be that you don’t want this back-reference, in which case you can
suppress it using the <span
class="cmtt-10">nonumberlist </span>package option:
</p>
<div class="verbatim" id="verbatim-7">
\usepackage[nonumberlist]{glossaries}
</div>
<!--l. 231--><p class="nopar" > If you don’t like the terminating full stop, you can suppress that with the <span
class="cmtt-10">nopostdot</span>
package option:
</p>
<div class="verbatim" id="verbatim-8">
\usepackage[nopostdot]{glossaries}
</div>
<!--l. 236--><p class="nopar" >
</p><!--l. 238--><p class="indent" > You may have noticed that I’ve used another command in the above example:
<span
class="cmtt-10">\glspl</span>. This displays the plural form. By default, this is just the singular form with the
letter “s” appended, but in the case of “potato” I had to specify the correct plural using
the <span
class="cmtt-10">plural </span>key.
</p><!--l. 244--><p class="indent" > As I mentioned earlier, using <span class="TEX">T<span
class="E">E</span>X</span> to sort the entries is the simplest but least
efficient method. If you have a large glossary or if your terms contain non-Latin or
extended Latin characters, then you will have a much faster build time if you use
<span
class="cmtt-10">makeindex </span>or <span
class="cmtt-10">xindy</span>. If you are using extended Latin or non-Latin characters, then
<span
class="cmtt-10">xindy </span>is the recommended method. These two methods are described in more detail in
<a
href="#sec:printglossaries"><span
class="cmsy-10">§</span>4 </a><a
href="#sec:printglossaries">Displaying a List of Entries<!--tex4ht:ref: sec:printglossaries --></a>.
</p><!--l. 253--><p class="indent" > The rest of this document briefly describes the main commands provided by the
<span
class="cmss-10">glossaries </span>package.
</p><!--l. 256--><p class="noindent" >
</p>
<!--l. 256--><p class="noindent" ><a
href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">2 </span> <a
id="sec:defterm"></a>Defining Terms</h3>
<!--l. 259--><p class="noindent" >When you use the <span
class="cmss-10">glossaries</span><a
id="dx1-3001"></a> package, you need to define glossary entries in the
document preamble. These entries could be a word, phrase, acronym or symbol.
They’re usually accompanied by a description, which could be a short sentence or an
in-depth explanation that spans multiple paragraphs. The simplest method of defining
an entry is to use:
</p><!--l. 266--><p class="indent" > <hr><div title="Definition"></p><div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">\newglossaryentry{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">}</span>
<br /><span class="verb"><span
class="cmtt-10">{</span></span>
<br /><span
class="cmtt-10"> </span><span
class="cmtt-10"> name={</span>⟨<span
class="cmitt-10">name</span>⟩<span
class="cmtt-10">},</span>
<br /><span
class="cmtt-10"> </span><span
class="cmtt-10"> description={</span>⟨<span
class="cmitt-10">description</span>⟩<span
class="cmtt-10">},</span>
<br /><span
class="cmtt-10"> </span><span
class="cmtt-10"> </span>⟨<span
class="cmitt-10">other</span><span
class="cmitt-10"> options</span>⟩
<br /><span class="verb"><span
class="cmtt-10">}</span></span>
</div>
</div> </div><hr>
<!--l. 274--><p class="noindent" >
where ⟨<span
class="cmti-10">label</span>⟩ is a unique label that identifies this entry. (Don’t include the angle brackets ⟨
⟩. They just indicate the parts of the code you need to change when you use
this command in your document.) The ⟨<span
class="cmti-10">name</span>⟩ is the word, phrase or symbol
you are defining, and ⟨<span
class="cmti-10">description</span>⟩ is the description to be displayed in the
glossary.
</p><!--l. 282--><p class="indent" > This command is a “short” command, which means that ⟨<span
class="cmti-10">description</span>⟩ can’t
contain a paragraph break. If you have a long description, you can instead
use:
</p><!--l. 286--><p class="indent" > <hr><div title="Definition"></p><div class="alltt">
<div class="obeylines-v">
<span
class="cmtt-10">\longnewglossaryentry{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">}</span>
<br /><span class="verb"><span
class="cmtt-10">{</span></span>
<br /><span
class="cmtt-10"> </span><span
class="cmtt-10"> name={</span>⟨<span
class="cmitt-10">name</span>⟩<span
class="cmtt-10">},</span>
<br /><span
class="cmtt-10"> </span><span
class="cmtt-10"> </span>⟨<span
class="cmitt-10">other</span><span
class="cmitt-10"> options</span>⟩
<br /><span class="verb"><span
class="cmtt-10">}</span></span>
<br /><span
class="cmtt-10">{</span>⟨<span
class="cmitt-10">description</span>⟩<span
class="cmtt-10">}</span>
</div>
</div> </div><hr>
<!--l. 294--><p class="noindent" >
</p><!--l. 296--><p class="indent" > Examples:
</p><ol class="enumerate1" >
<li
class="enumerate" id="x1-3003x1">Define the term “set” with the label <span
class="cmtt-10">set</span>:
<div class="verbatim" id="verbatim-9">
\newglossaryentry{set}
 <br />{
 <br />  name={set},
 <br />  description={a collection of objects}
 <br />}
</div>
<!--l. 305--><p class="nopar" >
</p></li>
<li
class="enumerate" id="x1-3005x2">Define the symbol <span
class="cmsy-10">∅ </span>with the label <span
class="cmtt-10">emptyset</span>:
<div class="verbatim" id="verbatim-10">
\newglossaryentry{emptyset}
 <br />{
 <br />  name={\ensuremath{\emptyset}},
 <br />  description={the empty set}
 <br />}
</div>
<!--l. 315--><p class="nopar" >
</p></li>
<li
class="enumerate" id="x1-3007x3">Define the phrase “Fish Age” with the label <span
class="cmtt-10">fishage</span>:
<div class="verbatim" id="verbatim-11">
\longnewglossaryentry{fishage}
 <br />{name={Fish Age}}
 <br />{%
 <br />  A common name for the Devonian geologic period
 <br />  spanning from the end of the Silurian Period to
 <br />  the beginning of the Carboniferous Period.
 <br />  This age was known for its remarkable variety of
 <br />  fish species.
 <br />}
</div>
<!--l. 330--><p class="nopar" > (The percent character discards the end of line character that would otherwise
cause an unwanted space to appear at the start of the description.)
</p></li>
<li
class="enumerate" id="x1-3009x4">Take care if the first letter is an extended Latin or non-Latin character (either
specified via a command such as <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\’e</span></span></span> or explicitly via the <span
class="cmss-10">inputenc</span><a
id="dx1-3010"></a> package such
as <span
class="cmtt-10">é</span>). This first letter must be placed in a group:
<div class="verbatim" id="verbatim-12">
\newglossaryentry{elite}
 <br />{
 <br />  name={{\’e}lite},
 <br />  description={select group or class}
 <br />}
</div>
<!--l. 346--><p class="nopar" > or </p><div class="alltt">
<div class="obeylines-v">
<span class="verb"><span
class="cmtt-10">\newglossaryentry{elite}</span></span>
<br /><span class="verb"><span
class="cmtt-10">{</span></span>
<br /><span
class="cmtt-10"> </span><span
class="cmtt-10"> name=</span><span class="verb"><span
class="cmtt-10">{{</span></span><span
class="cmtt-10">é</span><span class="verb"><span
class="cmtt-10">}lite}</span></span><span
class="cmtt-10">,</span>
<br /><span
class="cmtt-10"> </span><span
class="cmtt-10"> description=</span><span class="verb"><span
class="cmtt-10">{select</span><span
class="cmtt-10"> group</span><span
class="cmtt-10"> or</span><span
class="cmtt-10"> class}</span></span>
<br /><span class="verb"><span
class="cmtt-10">}</span></span>
</div>
</div></li></ol>
<!--l. 356--><p class="noindent" >(For further details, see the section <a
href="mfirstuc-manual.html" >“UTF-8”</a> in the <span
class="cmss-10">mfirstuc</span><a
id="dx1-3011"></a> user manual.)
</p><!--l. 360--><p class="indent" > Acronyms (or other abbreviations) can be defined using
</p><!--l. 362--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\newacronym{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">}{</span>⟨<span
class="cmitt-10">short</span>⟩<span
class="cmtt-10">}{</span>⟨<span
class="cmitt-10">long</span>⟩<span
class="cmtt-10">} </span></div><hr>
</p><!--l. 363--><p class="noindent" >
where ⟨<span
class="cmti-10">label</span>⟩ is the label (as with the <span
class="cmtt-10">\newglossaryentry </span>and the <span
class="cmtt-10">\longnewglossaryentry</span>
commands), ⟨<span
class="cmti-10">short</span>⟩ is the short form and ⟨<span
class="cmti-10">long</span>⟩ is the long form. For example, the
following defines an abbreviation:
</p>
<div class="verbatim" id="verbatim-13">
\newacronym{svm}{svm}{support vector machine}
</div>
<!--l. 370--><p class="nopar" > This defines a glossary entry with the label <span
class="cmtt-10">svm</span>. By default, the ⟨<span
class="cmti-10">name</span>⟩ is
set to ⟨<span
class="cmti-10">short</span>⟩ (“svm” in the above example) and the ⟨<span
class="cmti-10">description</span>⟩ is set to ⟨<span
class="cmti-10">long</span>⟩
(“support vector machine” in the above example). If, instead, you want to
be able to specify your own description you can do this using the optional
argument:
</p>
<div class="verbatim" id="verbatim-14">
\newacronym
 <br /> [description={statistical pattern recognition technique}]
 <br /> {svm}{svm}{support vector machine}
</div>
<!--l. 381--><p class="nopar" >
</p><!--l. 383--><p class="indent" > Before you define your acronyms (or other types of abbreviations), you need to
specify which style to use with
</p><!--l. 386--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\setacronymstyle{</span>⟨<span
class="cmitt-10">style name</span>⟩<span
class="cmtt-10">} </span></div><hr>
</p><!--l. 387--><p class="noindent" >
where ⟨<span
class="cmti-10">style name</span>⟩ is the name of the style. There are a number of predefined styles,
such as: <span
class="cmtt-10">long-short </span>(on first use display the long form with the short form in
parentheses); <span
class="cmtt-10">short-long </span>(on first use display the short form with the long form in
parentheses); <span
class="cmtt-10">long-short-desc </span>(like <span
class="cmtt-10">long-short </span>but you need to specify the
description); or <span
class="cmtt-10">short-long-desc </span>(like <span
class="cmtt-10">short-long </span>but you need to specify the
description). There are some other styles as well that use <span
class="cmtt-10">\textsc </span>to typeset the
acronym or that use a footnote on first use. See the main user guide for further
details.
</p><!--l. 399--><p class="indent" > There are other keys you can use when you define an entry. For example, the <span
class="cmtt-10">name</span>
key used above indicates how the term should appear in the list of entries (glossary). If
the term should appear differently when you reference it in the document, you need to
use the <span
class="cmtt-10">text </span>key as well.
</p><!--l. 405--><p class="indent" > For example:
</p>
<div class="verbatim" id="verbatim-15">
\newglossaryentry{latinalph}
 <br />{
 <br />  name={Latin Alphabet},
 <br />  text={Latin alphabet},
 <br />  description={alphabet consisting of the letters
 <br />  a, \ldots, z, A, \ldots, Z}
 <br />}
</div>
<!--l. 414--><p class="nopar" > This will appear in the text as “Latin alphabet” but will be listed in the glossary as
“Latin Alphabet”.
</p><!--l. 418--><p class="indent" > Another commonly used key is <span
class="cmtt-10">plural </span>for specifying the plural of the term. This
defaults to the value of the <span
class="cmtt-10">text </span>key with an “s” appended, but if this is incorrect, just
use the <span
class="cmtt-10">plural </span>key to override it:
</p>
<div class="verbatim" id="verbatim-16">
\newglossaryentry{oesophagus}
 <br />{
 <br />  name={{\oe}sophagus},
 <br />  plural={{\oe}sophagi},
 <br />  description={canal from mouth to stomach}
 <br />}
</div>
<!--l. 429--><p class="nopar" > (Remember from earlier that the initial ligature <span
class="cmtt-10">\oe </span>needs to be grouped.)
</p><!--l. 433--><p class="indent" > The plural forms for acronyms can be specified using the <span
class="cmtt-10">longplural </span>and
<span
class="cmtt-10">shortplural </span>keys. For example:
</p>
<div class="verbatim" id="verbatim-17">
\newacronym
 <br /> [longplural={diagonal matrices}]
 <br /> {dm}{DM}{diagonal matrix}
</div>
<!--l. 439--><p class="nopar" > If omitted, the defaults are again obtained by appending an “s” to the singular
versions.
</p><!--l. 443--><p class="indent" > It’s also possible to have both a name and a corresponding symbol. Just use the
<span
class="cmtt-10">name </span>key for the name and the <span
class="cmtt-10">symbol </span>key for the symbol. For example:
</p>
<div class="verbatim" id="verbatim-18">
\newglossaryentry{emptyset}
 <br />{
 <br />  name={empty set},
 <br />  symbol={\ensuremath{\emptyset}},
 <br />  description={the set containing no elements}
 <br />}
</div>
<!--l. 453--><p class="nopar" >
</p><!--l. 455--><p class="noindent" >
</p>
<!--l. 455--><p class="noindent" ><a
href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">3 </span> <a
id="sec:useterm"></a>Using Entries</h3>
<!--l. 458--><p class="noindent" >Once you have defined your entries, as described above, you can reference them in your
document. There are a number of commands to do this, but the most common one
is:
</p><!--l. 462--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\gls{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">} </span></div><hr>
</p><!--l. 463--><p class="noindent" >
where ⟨<span
class="cmti-10">label</span>⟩ is the label you assigned to the entry when you defined it. For example,
<span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\gls{fishage}</span></span></span> will display “Fish Age” in the text (given the definition from the
previous section).
</p><!--l. 468--><p class="indent" > If you are using the <span
class="cmss-10">hyperref</span><a
id="dx1-4001"></a> package (remember to load it before <span
class="cmss-10">glossaries</span>) <span
class="cmtt-10">\gls</span>
will create a hyperlink to the corresponding entry in the glossary. If you want to
suppress the hyperlink for a particular instance, use the starred form <span
class="cmtt-10">\gls* </span>for
example, <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\gls*{fishage}</span></span></span>. The other commands described in this section all have a
similar starred form.
</p><!--l. 475--><p class="indent" > If the entry was defined as an acronym (using <span
class="cmtt-10">\newacronym </span>described above), then
<span
class="cmtt-10">\gls </span>will display the full form the first time it’s used and just the short form on
subsequent use. For example, if the acronym style is set to <span
class="cmtt-10">long-short</span>, then
<span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\gls{svm}</span></span></span> will display “support vector machine (svm)” the first time it’s used, but the
next occurrence of <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\gls{svm}</span></span></span> will just display “svm”.
</p><!--l. 483--><p class="indent" > If you want the plural form, you can use:
</p><!--l. 485--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\glspl{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">} </span></div><hr>
</p><!--l. 486--><p class="noindent" >
instead of <span
class="cmtt-10">\gls{</span>⟨<span
class="cmti-10">label</span>⟩<span
class="cmtt-10">}</span>. For example, <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\glspl{set}</span></span></span> displays “sets”.
</p><!--l. 490--><p class="indent" > If the term appears at the start of a sentence, you can convert the first letter to
upper case using:
</p><!--l. 493--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\Gls{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">} </span></div><hr>
</p><!--l. 494--><p class="noindent" >
for the singular form or
</p><!--l. 497--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\Glspl{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">} </span></div><hr>
</p><!--l. 498--><p class="noindent" >
for the plural form. For example:
</p>
<div class="verbatim" id="verbatim-19">
\Glspl{set} are collections.
</div>
<!--l. 502--><p class="nopar" > produces “Sets are collections”.
</p><!--l. 505--><p class="indent" > If you’ve specified a symbol using the <span
class="cmtt-10">symbol </span>key, you can display it using:
</p><!--l. 508--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\glssymbol{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">} </span></div><hr>
</p><!--l. 509--><p class="noindent" >
</p><!--l. 511--><p class="noindent" >
</p>
<!--l. 511--><p class="noindent" ><a
href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">4 </span> <a
id="sec:printglossaries"></a>Displaying a List of Entries</h3>
<!--l. 514--><p class="noindent" >In <a
href="#sec:start"><span
class="cmsy-10">§</span>1 </a><a
href="#sec:start">Getting Started<!--tex4ht:ref: sec:start --></a> I mentioned that there are three options you can choose from to
create your glossary. Here they are again in a little more detail:
</p><!--l. 518--><p class="indent" >
</p><dl class="description"><dt class="description">
</dt><dd
class="description"><a
id="option1"></a><span
class="cmbx-10">Option</span><span
class="cmbx-10"> 1</span>:
<!--l. 521--><p class="noindent" >This is the simplest option but it’s slow and if you want a sorted list, it
doesn’t work for non-Latin alphabets.
</p><!--l. 524--><p class="noindent" >
</p><ol class="enumerate1" >
<li
class="enumerate" id="x1-5002x1">Add <span
class="cmtt-10">\makenoidxglossaries </span>to your preamble (before you start
defining your entries, as described in <a
href="#sec:defterm"><span
class="cmsy-10">§</span>2 </a><a
href="#sec:defterm">Defining Terms<!--tex4ht:ref: sec:defterm --></a>).
</li>
<li
class="enumerate" id="x1-5004x2">Put
<!--l. 531--><p class="noindent" ><hr><div title="Definition"><span
class="cmtt-10">\printnoidxglossary[sort=</span>⟨<span
class="cmitt-10">order</span>⟩<span
class="cmtt-10">,</span>⟨<span
class="cmitt-10">other options</span>⟩<span
class="cmtt-10">] </span></div><hr>
</p><!--l. 532--><p class="noindent" >
where you want your list of entries to appear. The sort ⟨<span
class="cmti-10">order</span>⟩ may be one of:
<span
class="cmtt-10">word </span>(word ordering), <span
class="cmtt-10">letter </span>(letter ordering), <span
class="cmtt-10">case </span>(case-sensitive letter
ordering), <span
class="cmtt-10">def </span>(in order of definition) or <span
class="cmtt-10">use </span>(in order of use). Alternatively,
use
</p><!--l. 539--><p class="noindent" ><hr><div title="Definition"><span
class="cmtt-10">\printnoidxglossaries </span></div><hr>
</p><!--l. 540--><p class="noindent" >
to display all your glossaries (if you have more than one). This command
doesn’t have any arguments.
</p></li>
<li
class="enumerate" id="x1-5006x3">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> twice on your document. (As you would do to make a table of
contents appear.) For example, click twice on the “typeset” or “build” or
“PDF<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span>” button in your editor.</li></ol>
</dd><dt class="description">
</dt><dd
class="description"><a
id="option2"></a><span
class="cmbx-10">Option</span><span
class="cmbx-10"> 2</span>:
<!--l. 551--><p class="noindent" >This option uses an application called <span
class="cmtt-10">makeindex </span>to sort the entries. This
application comes with all modern <span class="TEX">T<span
class="E">E</span>X</span> distributions, but it’s hard-coded for the
non-extended Latin alphabet. This process involves making <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> write the
glossary information to a temporary file which <span
class="cmtt-10">makeindex </span>reads. Then <span
class="cmtt-10">makeindex</span>
writes a new file containing the code to typeset the glossary. <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> then reads
this file on the next run.
</p><!--l. 559--><p class="noindent" >
</p><ol class="enumerate1" >
<li
class="enumerate" id="x1-5008x1">Add <span
class="cmtt-10">\makeglossaries </span>to your preamble (before you start defining your
entries).
</li>
<li
class="enumerate" id="x1-5010x2">Put
<!--l. 565--><p class="noindent" ><hr><div title="Definition"><span
class="cmtt-10">\printglossary[</span>⟨<span
class="cmitt-10">options</span>⟩<span
class="cmtt-10">] </span></div><hr>
</p><!--l. 566--><p class="noindent" >
where you want your list of entries (glossary) to appear. (The <span
class="cmtt-10">sort </span>key isn’t
available in ⟨<span
class="cmti-10">options</span>⟩.) Alternatively, use
</p><!--l. 571--><p class="noindent" ><hr><div title="Definition"><span
class="cmtt-10">\printglossaries </span></div><hr>
</p><!--l. 572--><p class="noindent" >
which will display all glossaries (if you have more than one). This command
doesn’t have any arguments.
</p></li>
<li
class="enumerate" id="x1-5012x3">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> on your document. This creates files with the extensions <span
class="cmtt-10">.glo</span>
and <span
class="cmtt-10">.ist </span>(for example, if your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> document is called <span
class="cmtt-10">myDoc.tex</span>, then
you’ll have two extra files called <span
class="cmtt-10">myDoc.glo </span>and <span
class="cmtt-10">myDoc.ist</span>). If you look at
your document at this point, you won’t see the glossary as it hasn’t been
created yet.
</li>
<li
class="enumerate" id="x1-5014x4">Run <span
class="cmtt-10">makeindex </span>with the <span
class="cmtt-10">.glo </span>file as the input file and the <span
class="cmtt-10">.ist </span>file as the
style so that it creates an output file with the extension <span
class="cmtt-10">.gls</span>. If you have
access to a terminal or a command prompt (for example, the MSDOS
command prompt for Windows users or the bash console for Unix-like users)
then you need to run the command:
<div class="verbatim" id="verbatim-20">
makeindex -s myDoc.ist -o myDoc.gls myDoc.glo
</div>
<!--l. 591--><p class="nopar" > (Replace <span
class="cmtt-10">myDoc </span>with the base name of your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> document file. Avoid
spaces in the file name.) If you don’t know how to use the command
prompt, then you can probably access <span
class="cmtt-10">makeindex </span>via your text editor,
but each editor has a different method of doing this, so I can’t
give a general description. You will have to check your editor’s
manual.
</p><!--l. 599--><p class="noindent" >The default sort is word order (“sea lion” comes before “seal”). If you want
letter ordering you need to add the <span
class="cmtt-10">-l </span>switch:
</p>
<div class="verbatim" id="verbatim-21">
makeindex -l -s myDoc.ist -o myDoc.gls myDoc.glo
</div>
<!--l. 605--><p class="nopar" >
</p></li>
<li
class="enumerate" id="x1-5016x5">Once you have successfully completed the previous step, you can now run
<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> on your document again.</li></ol>
</dd><dt class="description">
</dt><dd
class="description"><a
id="option3"></a><span
class="cmbx-10">Option</span><span
class="cmbx-10"> 3</span>:
<!--l. 613--><p class="noindent" >This option uses an application called <span
class="cmtt-10">xindy </span>to sort the entries. This application
is more flexible than <span
class="cmtt-10">makeindex </span>and is able to sort extended Latin or non-Latin
alphabets. It comes with <span class="TEX">T<span
class="E">E</span>X</span> Live but not with MiK<span class="TEX">T<span
class="E">E</span>X</span>. Since <span
class="cmtt-10">xindy </span>is a Perl
script, if you are using MiK<span class="TEX">T<span
class="E">E</span>X</span> you will not only need to install <span
class="cmtt-10">xindy</span>, you
will also need to install Perl. In a similar way to <a
href="#option2">Option 2</a>, this option
involves making <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> write the glossary information to a temporary
file which <span
class="cmtt-10">xindy </span>reads. Then <span
class="cmtt-10">xindy </span>writes a new file containing the
code to typeset the glossary. <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> then reads this file on the next
run.
</p><!--l. 625--><p class="noindent" >
</p><ol class="enumerate1" >
<li
class="enumerate" id="x1-5018x1">Add the <span
class="cmtt-10">xindy </span>option to the <span
class="cmss-10">glossaries</span><a
id="dx1-5019"></a> package option list:
<div class="verbatim" id="verbatim-22">
\usepackage[xindy]{glossaries}
</div>
<!--l. 630--><p class="nopar" >
</p></li>
<li
class="enumerate" id="x1-5021x2">Add <span
class="cmtt-10">\makeglossaries </span>to your preamble (before you start defining your
entries).
</li>
<li
class="enumerate" id="x1-5023x3">Put
<!--l. 637--><p class="noindent" ><hr><div title="Definition"><span
class="cmtt-10">\printglossary[</span>⟨<span
class="cmitt-10">options</span>⟩<span
class="cmtt-10">] </span></div><hr>
</p><!--l. 638--><p class="noindent" >
where you want your list of entries (glossary) to appear. (The <span
class="cmtt-10">sort </span>key isn’t
available in ⟨<span
class="cmti-10">options</span>⟩.) Alternatively, use
</p><!--l. 643--><p class="noindent" ><hr><div title="Definition"><span
class="cmtt-10">\printglossaries </span></div><hr>
</p><!--l. 644--><p class="noindent" >
</p></li>
<li
class="enumerate" id="x1-5025x4">Run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> on your document. This creates files with the extensions <span
class="cmtt-10">.glo</span>
and <span
class="cmtt-10">.xdy </span>(for example, if your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> document is called <span
class="cmtt-10">myDoc.tex</span>, then
you’ll have two extra files called <span
class="cmtt-10">myDoc.glo </span>and <span
class="cmtt-10">myDoc.xdy</span>). If you look at
your document at this point, you won’t see the glossary as it hasn’t been
created yet.
</li>
<li
class="enumerate" id="x1-5027x5">Run <span
class="cmtt-10">xindy </span>with the <span
class="cmtt-10">.glo </span>file as the input file and the <span
class="cmtt-10">.xdy </span>file as
a module so that it creates an output file with the extension <span
class="cmtt-10">.gls</span>.
You also need to set the language name and input encoding. If you
have access to a terminal or a command prompt (for example, the
MSDOS command prompt for Windows users or the bash console for
Unix-like users) then you need to run the command (all on one
line):
<div class="verbatim" id="verbatim-23">
xindy  -L english -C utf8 -I xindy -M myDoc
 <br />-t myDoc.glg -o myDoc.gls myDoc.glo
</div>
<!--l. 664--><p class="nopar" > (Replace <span
class="cmtt-10">myDoc </span>with the base name of your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> document file. Avoid
spaces in the file name. If necessary, also replace <span
class="cmtt-10">english </span>with the name of
your language and <span
class="cmtt-10">utf8 </span>with your input encoding.) If you don’t know how to
use the command prompt, then you can probably access <span
class="cmtt-10">xindy </span>via your text
editor, but each editor has a different method of doing this, so I can’t
give a general description. You will have to check your editor’s
manual.
</p><!--l. 674--><p class="noindent" >The default sort is word order (“sea lion” comes before “seal”). If you
want letter ordering you need to add the <span
class="cmtt-10">order=letter </span>package
option:
</p>
<div class="verbatim" id="verbatim-24">
\usepackage[xindy,order=letter]{glossaries}
</div>
<!--l. 680--><p class="nopar" >
</p></li>
<li
class="enumerate" id="x1-5029x6">Once you have successfully completed the previous step, you can now run
<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> on your document again.
</li></ol>
</dd></dl>
<!--l. 689--><p class="indent" > For Options <a
href="#option2">2</a> and <a
href="#option3">3</a>, it can be difficult to remember all the parameters required for
<span
class="cmtt-10">makeindex </span>or <span
class="cmtt-10">xindy</span>, so the <span
class="cmss-10">glossaries</span><a
id="dx1-5030"></a> package provides a script called <span
class="cmtt-10">makeglossaries</span>
that reads the <span
class="cmtt-10">.aux </span>file to determine what settings you have used and will then run
<span
class="cmtt-10">makeindex </span>or <span
class="cmtt-10">xindy</span>. Again, this is a command line application and can be run in
a terminal or command prompt. For example, if your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> document is in the file
<span
class="cmtt-10">myDoc.tex</span>, then run:
</p>
<div class="verbatim" id="verbatim-25">
makeglossaries myDoc
</div>
<!--l. 700--><p class="nopar" > (Replace <span
class="cmtt-10">myDoc </span>with the base name of your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> document file. Avoid
spaces in the file name.) If you don’t know how to use the command prompt,
you can probably access <span
class="cmtt-10">makeglossaries </span>via your text editor. Check your
editor’s manual for advice. If you are using <span
class="cmtt-10">arara </span>then you can just use the
directives:
</p>
<div class="verbatim" id="verbatim-26">
 arara: pdflatex
 <br /> arara: makeglossaries
 <br /> arara: pdflatex
</div>
<!--l. 710--><p class="nopar" >
</p><!--l. 712--><p class="indent" > The <span
class="cmtt-10">makeglossaries </span>script is written in Perl, so you need a Perl interpreter
installed. If you are using a Unix-like operating system then you most likely have one
installed. If you are using Windows with the <span class="TEX">T<span
class="E">E</span>X</span> Live distribution, then you can use
the Perl interpreter that comes with <span class="TEX">T<span
class="E">E</span>X</span> Live. If you are using Windows and
MiK<span class="TEX">T<span
class="E">E</span>X</span> then you need to install a Perl distribution for Windows. If you are
using <a
href="#option3">Option 3</a>, then you need to do this anyway as <span
class="cmtt-10">xindy </span>is also written in
Perl. If you are using <a
href="#option2">Option 2</a> and can’t work out how to install Perl (or
for some reason don’t want to install it) then just use <span
class="cmtt-10">makeindex </span>directly, as
described above, or you can use a Lua alternative to <span
class="cmtt-10">makeglossaries </span>called
<span
class="cmtt-10">makeglossaries-lite.lua</span>:
</p>
<div class="verbatim" id="verbatim-27">
makeglossaries-lite.lua myDoc
</div>
<!--l. 726--><p class="nopar" >
</p><!--l. 728--><p class="indent" > As a last resort you can try the package option <span
class="cmtt-10">automake</span>:
</p>
<div class="verbatim" id="verbatim-28">
\usepackage[automake]{glossaries}
</div>
<!--l. 731--><p class="nopar" > This will attempt to use <span class="TEX">T<span
class="E">E</span>X</span>’s <span
class="cmtt-10">\write18 </span>mechanism to run <span
class="cmtt-10">makeindex </span>or <span
class="cmtt-10">xindy</span>. It
probably won’t work for <span
class="cmtt-10">xindy </span>and won’t work at all if the shell escape has been
disabled in your <span class="TEX">T<span
class="E">E</span>X</span> distribution. Most <span class="TEX">T<span
class="E">E</span>X</span> distributions will allow a restricted shell
escape, which will only allow trusted applications to be run. If the <span
class="cmtt-10">automake </span>option is
successful, you will still need to run <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> twice for the glossaries to be
displayed.
</p><!--l. 741--><p class="indent" > When sorting the entries, the string comparisons are made according to each entry’s
<span
class="cmtt-10">sort </span>key. If this is omitted, the <span
class="cmtt-10">name </span>key is used. For example, recall the earlier
definition:
</p>
<div class="verbatim" id="verbatim-29">
\newglossaryentry{elite}
 <br />{
 <br />  name={{\’e}lite},
 <br />  description={select group or class}
 <br />}
</div>
<!--l. 751--><p class="nopar" > No <span
class="cmtt-10">sort </span>key was used, so it’s set to the same as the <span
class="cmtt-10">name </span>key: <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">{\’e}lite</span></span></span>. How this is
interpreted depends on which option you have used:
</p><dl class="description"><dt class="description">
<a
href="#option1"><span
class="cmbx-10">Option</span><span
class="cmbx-10"> 1</span></a><span
class="cmbx-10">:</span> </dt><dd
class="description">By default, the accent command will be stripped so the sort value will
be <span
class="cmtt-10">elite</span>. This will put the entry in the “E” letter group. However if you
use the <span
class="cmss-10">sanitizesort=true</span><a
id="dx1-5031"></a> package option, the sort value will be interpreted
as the sequence of characters: <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\</span></span></span> <span
class="cmtt-10">’ e l i t </span>and <span
class="cmtt-10">e</span>. This will place this entry
before the “A” letter group since it starts with a symbol.
</dd><dt class="description">
<a
href="#option2"><span
class="cmbx-10">Option</span><span
class="cmbx-10"> 2</span></a><span
class="cmbx-10">:</span> </dt><dd
class="description">The sort key will be interpreted the sequence of characters: <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">{</span></span></span> <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\</span></span></span> <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">’</span></span></span> <span
class="cmtt-10">e </span><span class="obeylines-h"><span class="verb"><span
class="cmtt-10">}</span></span></span>
<span
class="cmtt-10">l i t </span>and <span
class="cmtt-10">e</span>. The first character is an opening curly brace <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">{</span></span></span> so <span
class="cmtt-10">makeindex</span>
will put this entry in the “symbols” group.
</dd><dt class="description">
<a
href="#option3"><span
class="cmbx-10">Option</span><span
class="cmbx-10"> 3</span></a><span
class="cmbx-10">:</span> </dt><dd
class="description"><span
class="cmtt-10">xindy </span>disregards <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> commands so it sorts on <span
class="cmtt-10">elite</span>, which puts
this entry in the “E” group.</dd></dl>
<!--l. 776--><p class="indent" > If the <span
class="cmss-10">inputenc</span><a
id="dx1-5032"></a> package is used and the entry is defined as: </p><div class="alltt">
<div class="obeylines-v">
<span class="verb"><span
class="cmtt-10">\newglossaryentry{elite}</span></span>
<br /><span class="verb"><span
class="cmtt-10">{</span></span>
<br /><span
class="cmtt-10"> </span><span
class="cmtt-10"> name=</span><span class="verb"><span
class="cmtt-10">{{</span></span><span
class="cmtt-10">é</span><span class="verb"><span
class="cmtt-10">}lite},</span></span>
<br /><span
class="cmtt-10"> </span><span
class="cmtt-10"> description=</span><span class="verb"><span
class="cmtt-10">{select</span><span
class="cmtt-10"> group</span><span
class="cmtt-10"> or</span><span
class="cmtt-10"> class}</span></span>
<br /><span class="verb"><span
class="cmtt-10">}</span></span>
</div>
</div> then:
<dl class="description"><dt class="description">
<a
href="#option1"><span
class="cmbx-10">Option</span><span
class="cmbx-10"> 1</span></a><span
class="cmbx-10">:</span> </dt><dd
class="description">By default the sort value will be interpreted as <span
class="cmtt-10">elite </span>so the entry will
be put in the “E” letter group. If you use the <span
class="cmss-10">sanitizesort=true</span><a
id="dx1-5033"></a> package option,
the sort value will be interpreted as <span
class="cmtt-10">é</span><span
class="cmtt-10">lite </span>where é has been sanitized (so
it’s no longer an active character) which will put this entry before the “A”
letter group.
</dd><dt class="description">
<a
href="#option2"><span
class="cmbx-10">Option</span><span
class="cmbx-10"> 2</span></a><span
class="cmbx-10">:</span> </dt><dd
class="description"><span
class="cmtt-10">makeindex </span>doesn’t recognise <span
class="cmtt-10">é</span> as a letter so it will be put in the
symbols group.
</dd><dt class="description">
<a
href="#option3"><span
class="cmbx-10">Option</span><span
class="cmbx-10"> 3</span></a><span
class="cmbx-10">:</span> </dt><dd
class="description"><span
class="cmtt-10">xindy </span>will correctly recognise the sort value <span
class="cmtt-10">é</span><span
class="cmtt-10">lite </span>and will place it
in whatever letter group is appropriate for the given language setting. (In
English, this would just be the “E” letter group.)</dd></dl>
<!--l. 802--><p class="indent" > Therefore if you have extended Latin or non-Latin characters, your best option is to
use <span
class="cmtt-10">xindy </span>(<a
href="#option3">Option 3</a>) with the <span
class="cmss-10">inputenc</span><a
id="dx1-5034"></a> package. If you use <span
class="cmtt-10">makeindex </span>(<a
href="#option2">Option 2</a>) you
need to specify the <span
class="cmtt-10">sort </span>key like this:
</p>
<div class="verbatim" id="verbatim-30">
\newglossaryentry{elite}
 <br />{
 <br />  name={{\’e}lite},
 <br />  sort={elite},
 <br />  description={select group or class}
 <br />}
</div>
<!--l. 813--><p class="nopar" > If you use <a
href="#option1">Option 1</a>, you may or may not need to use the <span
class="cmtt-10">sort </span>key, but you will need
to be careful about fragile commands in the <span
class="cmtt-10">name </span>key if you don’t set the <span
class="cmtt-10">sort</span>
key.
</p><!--l. 818--><p class="indent" > <a
href="#x1-50351">Table 1</a> summarises the main pros and cons of three options described
above.
</p>
<div class="table">
<!--l. 821--><p class="indent" > <a
id="x1-50351"></a></p><hr class="float" /><div class="float"
>
<div class="caption"
><span class="id">Table 1: </span><span
class="content">Glossary Options: Pros and Cons</span></div><!--tex4ht:label?: x1-50351 -->
<div class="tabular"> <table id="TBL-2" class="tabular"
cellspacing="0" cellpadding="0"
><colgroup id="TBL-2-1g"><col
id="TBL-2-1" /><col
id="TBL-2-2" /><col
id="TBL-2-3" /><col
id="TBL-2-4" /></colgroup><tr
style="vertical-align:baseline;" id="TBL-2-1-"><td style="white-space:wrap; text-align:left;" id="TBL-2-1-1"
class="td11"> <!--l. 827--><p class="noindent" > </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-2"
class="td11"> <a
href="#option1"><span
class="cmbx-10">Option</span><span
class="cmbx-10"> 1</span></a> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-3"
class="td11"> <a
href="#option2"><span
class="cmbx-10">Option</span><span
class="cmbx-10"> 2</span></a> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-1-4"
class="td11"> <a
href="#option3"><span
class="cmbx-10">Option</span><span
class="cmbx-10"> 3</span></a> </td>
</tr><tr
style="vertical-align:baseline;" id="TBL-2-2-"><td style="white-space:wrap; text-align:left;" id="TBL-2-2-1"
class="td11"> <!--l. 828--><p class="noindent" >Requires
an
external
application? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-2"
class="td11"> <span
class="pzdr-">✘ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-3"
class="td11"> <span
class="pzdr-">✔ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-2-4"
class="td11"> <span
class="pzdr-">✔ </span></td>
</tr><tr
style="vertical-align:baseline;" id="TBL-2-3-"><td style="white-space:wrap; text-align:left;" id="TBL-2-3-1"
class="td11"> <!--l. 830--><p class="noindent" >Requires
Perl? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-2"
class="td11"> <span
class="pzdr-">✘ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-3"
class="td11"> <span
class="pzdr-">✘ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-3-4"
class="td11"> <span
class="pzdr-">✔ </span></td>
</tr><tr
style="vertical-align:baseline;" id="TBL-2-4-"><td style="white-space:wrap; text-align:left;" id="TBL-2-4-1"
class="td11"> <!--l. 832--><p class="noindent" >Can
sort
extended
Latin
or
non-Latin
alphabets? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-2"
class="td11"> <span
class="pzdr-">✘</span><sup class="textsuperscript"><span
class="cmsy-9">†</span></sup> </td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-3"
class="td11"> <span
class="pzdr-">✘ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-4-4"
class="td11"> <span
class="pzdr-">✔ </span></td>
</tr><tr
style="vertical-align:baseline;" id="TBL-2-5-"><td style="white-space:wrap; text-align:left;" id="TBL-2-5-1"
class="td11"> <!--l. 835--><p class="noindent" >Efficient
sort
algorithm? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-2"
class="td11"> <span
class="pzdr-">✘ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-3"
class="td11"> <span
class="pzdr-">✔ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-5-4"
class="td11"> <span
class="pzdr-">✔ </span></td>
</tr><tr
style="vertical-align:baseline;" id="TBL-2-6-"><td style="white-space:wrap; text-align:left;" id="TBL-2-6-1"
class="td11"> <!--l. 837--><p class="noindent" >Can
form
ranges
in
the
location
lists? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-2"
class="td11"> <span
class="pzdr-">✘ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-3"
class="td11"> <span
class="pzdr-">✔ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-6-4"
class="td11"> <span
class="pzdr-">✔ </span></td>
</tr><tr
style="vertical-align:baseline;" id="TBL-2-7-"><td style="white-space:wrap; text-align:left;" id="TBL-2-7-1"
class="td11"> <!--l. 839--><p class="noindent" >Can
have
non-standard
locations? </p></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-2"
class="td11"> <span
class="pzdr-">✔ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-3"
class="td11"> <span
class="pzdr-">✘ </span></td><td style="white-space:nowrap; text-align:center;" id="TBL-2-7-4"
class="td11"> <span
class="pzdr-">✔ </span></td>
</tr></table></div>
<!--l. 843--><p class="noindent" ><sup class="textsuperscript"><span
class="cmsy-9">†</span></sup> Strips standard <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> accents so, for example, <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\AA</span></span></span> is treated the same as
A.
</p>
</div><hr class="endfloat" />
</div>
<!--l. 847--><p class="noindent" ><a
href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">5 </span> <a
id="sec:glosstyle"></a>Customising the Glossary</h3>
<!--l. 850--><p class="noindent" >The default glossary style uses the <span
class="cmss-10">description</span><a
id="dx1-6001"></a><a
id="dx1-6002"></a> environment to display the entry list.
Each entry name is set in the optional argument of <span
class="cmtt-10">\item </span>which means that it will
typically be displayed in bold. You can switch to medium weight by redefining
<span
class="cmtt-10">\glsnamefont</span>:
</p>
<div class="verbatim" id="verbatim-31">
\renewcommand*{\glsnamefont}[1]{\textmd{#1}}
</div>
<!--l. 857--><p class="nopar" >
</p><!--l. 859--><p class="indent" > By default, a full stop is appended to the description. To prevent this from
happening use the <span
class="cmtt-10">nopostdot </span>package option:
</p>
<div class="verbatim" id="verbatim-32">
\usepackage[nopostdot]{glossaries}
</div>
<!--l. 863--><p class="nopar" >
</p><!--l. 865--><p class="indent" > By default, a location list is displayed for each entry. This refers to the document
locations (for example, the page number) where the entry has been referenced. If you
use Options <a
href="#option2">2</a> or <a
href="#option3">3</a> described in <a
href="#sec:printglossaries"><span
class="cmsy-10">§</span>4 </a><a
href="#sec:printglossaries">Displaying a List of Entries<!--tex4ht:ref: sec:printglossaries --></a> location ranges will be
compressed. For example, if an entry was used on pages 1, 2 and 3, with Options <a
href="#option2">2</a>
or <a
href="#option3">3</a> the location list will appear as 1–3, but with <a
href="#option1">Option 1</a> it will appear as 1, 2, 3. If
you don’t want the locations displayed you can hide them using the <span
class="cmtt-10">nonumberlist</span>
package option:
</p>
<div class="verbatim" id="verbatim-33">
\usepackage[nonumberlist]{glossaries}
</div>
<!--l. 875--><p class="nopar" >
</p><!--l. 877--><p class="indent" > Entries are grouped according to the first letter of each entry’s <span
class="cmtt-10">sort </span>key. By default
a vertical gap is placed between letter groups. You can suppress this with the
<span
class="cmtt-10">nogroupskip </span>package option:
</p>
<div class="verbatim" id="verbatim-34">
\usepackage[nogroupskip]{glossaries}
</div>
<!--l. 883--><p class="nopar" >
</p><!--l. 885--><p class="indent" > If the default style doesn’t suit your document, you can change the style
using:
</p><!--l. 888--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\setglossarystyle{</span>⟨<span
class="cmitt-10">style name</span>⟩<span
class="cmtt-10">} </span></div><hr>
</p><!--l. 889--><p class="noindent" >
There are a number of predefined styles. Glossaries can vary from a list of symbols
with a terse description to a list of words or phrases with descriptions that span
multiple paragraphs, so there’s no “one style fits all” solution. You need to choose
a style that suits your document.
</p><!--l. 896--><p class="indent" > Examples:
</p><ol class="enumerate1" >
<li
class="enumerate" id="x1-6004x1">You have entries where the name is a symbol and the description is a brief phrase
or short sentence. Try one of the “mcol” styles defined in the <span
class="cmss-10">glossary-mcols</span><a
id="dx1-6005"></a>
package. For example:
<div class="verbatim" id="verbatim-35">
\usepackage[nogroupskip,nopostdot]{glossaries}
 <br />\usepackage{glossary-mcols}
 <br />\setglossarystyle{mcolindex}
</div>
<!--l. 905--><p class="nopar" >
</p></li>
<li
class="enumerate" id="x1-6007x2">You have entries where the name is a word or phrase and the description spans
multiple paragraphs. Try one of the “altlist” styles. For example:
<div class="verbatim" id="verbatim-36">
\usepackage[nopostdot]{glossaries}
 <br />\setglossarystyle{altlist}
</div>
<!--l. 913--><p class="nopar" >
</p></li>
<li
class="enumerate" id="x1-6009x3">You have entries where the name is a single word, the description is
brief, and an associated symbol has been set. Use one of the styles that
display the symbol (not all of them do). For example, one of the tabular
styles:
<div class="verbatim" id="verbatim-37">
\usepackage[nopostdot,nonumberlist]{glossaries}
 <br />\setglossarystyle{long4col}
</div>
<!--l. 922--><p class="nopar" > or one of the “tree” styles:
</p>
<div class="verbatim" id="verbatim-38">
\usepackage[nopostdot,nonumberlist]{glossaries}
 <br />\setglossarystyle{tree}
</div>
<!--l. 927--><p class="nopar" ></p></li></ol>
<!--l. 930--><p class="indent" > If your glossary consists of a list of acronyms and you also want to specify
a description as well as the long form, then you need to use an acronym style that
will suit the glossary style. For example, use the <span
class="cmtt-10">long-short-desc </span>acronym
style:
</p>
<div class="verbatim" id="verbatim-39">
\setacronymstyle{long-short-desc}
</div>
<!--l. 936--><p class="nopar" > Define the acronyms with a description:
</p>
<div class="verbatim" id="verbatim-40">
\newacronym
 <br /> [description={statistical pattern recognition technique}]
 <br /> {svm}{svm}{support vector machine}
</div>
<!--l. 942--><p class="nopar" > Choose a glossary style that suits wide entry names:
</p>
<div class="verbatim" id="verbatim-41">
\setglossarystyle{altlist}
</div>
<!--l. 946--><p class="nopar" >
</p><!--l. 948--><p class="noindent" >
</p>
<!--l. 948--><p class="noindent" ><a
href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">6 </span> <a
id="sec:multigloss"></a>Multiple Glossaries</h3>
<!--l. 951--><p class="noindent" >The <span
class="cmss-10">glossaries</span><a
id="dx1-7001"></a> package predefines a default <span
class="cmtt-10">main </span>glossary. When you define an entry
(using one of the commands described in <a
href="#sec:defterm"><span
class="cmsy-10">§</span>2 </a><a
href="#sec:defterm">Defining Terms<!--tex4ht:ref: sec:defterm --></a>), that entry is
automatically assigned to the default glossary, unless you indicate otherwise using the
<span
class="cmtt-10">type </span>key. However you first need to make sure the desired glossary has been defined.
This is done using:
</p><!--l. 958--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\newglossary[</span>⟨<span
class="cmitt-10">glg</span>⟩<span
class="cmtt-10">]{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">}{</span>⟨<span
class="cmitt-10">gls</span>⟩<span
class="cmtt-10">}{</span>⟨<span
class="cmitt-10">glo</span>⟩<span
class="cmtt-10">}{</span>⟨<span
class="cmitt-10">title</span>⟩<span
class="cmtt-10">} </span></div><hr>
</p><!--l. 959--><p class="noindent" >
The ⟨<span
class="cmti-10">label</span>⟩ is a label that uniquely identifies this new glossary. As with other types of
identifying labels, be careful not to use active characters in ⟨<span
class="cmti-10">label</span>⟩. The final
argument ⟨<span
class="cmti-10">title</span>⟩ is the section or chapter heading used by <span
class="cmtt-10">\printglossary </span>or
<span
class="cmtt-10">\printnoidxglossary</span>. The other arguments indicate the file extensions used by
<span
class="cmtt-10">makeindex</span>/<span
class="cmtt-10">xindy </span>(described in <a
href="#sec:printglossaries"><span
class="cmsy-10">§</span>4 </a><a
href="#sec:printglossaries">Displaying a List of Entries<!--tex4ht:ref: sec:printglossaries --></a>). If you use
<a
href="#option1">Option 1</a> described above, the ⟨<span
class="cmti-10">glg</span>⟩, ⟨<span
class="cmti-10">gls</span>⟩ and ⟨<span
class="cmti-10">glo</span>⟩ arguments are ignored, in which
case you may prefer to use the starred version where you don’t specify the
extensions:
</p><!--l. 972--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\newglossary*{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">}{</span>⟨<span
class="cmitt-10">title</span>⟩<span
class="cmtt-10">} </span></div><hr>
</p><!--l. 973--><p class="noindent" >
</p><!--l. 975--><p class="indent" > In the case of Options <a
href="#option2">2</a> or <a
href="#option3">3</a>, all glossary definitions must come before
<span
class="cmtt-10">\makeglossaries</span>.
</p><!--l. 978--><p class="indent" > Since it’s quite common for documents to have both a list of terms and a list of
acronyms, the <span
class="cmss-10">glossaries</span><a
id="dx1-7002"></a> package provides the package option <span
class="cmtt-10">acronym </span>(or <span
class="cmtt-10">acronyms</span>),
which is a convenient shortcut for
</p>
<div class="verbatim" id="verbatim-42">
\newglossary[alg]{acronym}{acr}{acn}{\acronymname}
</div>
<!--l. 984--><p class="nopar" > The option also changes the behaviour of <span
class="cmtt-10">\newacronym </span>so that acronyms are
automatically put in the list of acronyms instead of the main glossary.
</p><!--l. 989--><p class="indent" > For example, suppose you want a main glossary for terms, a list of acronyms and
a list of notation:
</p>
<div class="verbatim" id="verbatim-43">
\usepackage[acronyms]{glossaries}
 <br />\newglossary[nlg]{notation}{not}{ntn}{Notation}
</div>
<!--l. 994--><p class="nopar" > After <span
class="cmtt-10">\makeglossaries </span>(or <span
class="cmtt-10">\makenoidxglossaries</span>) you can define the entries in the
preamble. For example:
</p>
<div class="verbatim" id="verbatim-44">
\newglossaryentry{gls:set}
 <br />{% This entry goes in the ‘main’ glossary
 <br />  name=set,
 <br />  description={A collection of distinct objects}
 <br />}
 <br /> This entry goes in the ‘acronym’ glossary:
 <br />\newacronym{svm}{svm}{support vector machine}
 <br />\newglossaryentry{not:set}
 <br />{% This entry goes in the ‘notation’ glossary:
 <br />  type=notation,
 <br />  name={\ensuremath{\mathcal{S}}},
 <br />  description={A set},
 <br />  sort={S}}
</div>
<!--l. 1013--><p class="nopar" > or if you don’t like using <span
class="cmtt-10">\ensuremath</span>:
</p>
<div class="verbatim" id="verbatim-45">
\newglossaryentry{not:set}
 <br />{% This entry goes in the ‘notation’ glossary:
 <br />  type=notation,
 <br />  name={$\mathcal{S}$},
 <br />  text={\mathcal{S}},
 <br />  description={A set},
 <br />  sort={S}}
</div>
<!--l. 1023--><p class="nopar" >
</p><!--l. 1025--><p class="indent" > Each glossary is displayed using:
</p><!--l. 1027--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\printnoidxglossary[type=</span>⟨<span
class="cmitt-10">type</span>⟩<span
class="cmtt-10">] </span></div><hr>
</p><!--l. 1028--><p class="noindent" >
(<a
href="#option1">Option 1</a>) or
</p><!--l. 1031--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\printglossary[type=</span>⟨<span
class="cmitt-10">type</span>⟩<span
class="cmtt-10">] </span></div><hr>
</p><!--l. 1032--><p class="noindent" >
(Options <a
href="#option2">2</a> and <a
href="#option3">3</a>). Where ⟨<span
class="cmti-10">type</span>⟩ is the glossary label. If the type is omitted the default
<span
class="cmtt-10">main </span>glossary is assumed.
</p><!--l. 1036--><p class="indent" > There’s a convenient shortcut that will display all the defined glossaries:
</p><!--l. 1039--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\printnoidxglossaries </span></div><hr>
</p><!--l. 1040--><p class="noindent" >
(<a
href="#option1">Option 1</a>) or
</p><!--l. 1043--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\printglossaries </span></div><hr>
</p><!--l. 1044--><p class="noindent" >
(Options <a
href="#option2">2</a> and <a
href="#option3">3</a>).
</p><!--l. 1047--><p class="indent" > If you use <a
href="#option1">Option 1</a>, you don’t need to do anything else. If you use Options <a
href="#option2">2</a> or <a
href="#option3">3</a>
with the <span
class="cmtt-10">makeglossaries </span>Perl script, you similarly don’t need to do anything else. If
you use Options <a
href="#option2">2</a> or <a
href="#option3">3</a> without the <span
class="cmtt-10">makeglossaries </span>Perl script then you need to make
sure you run <span
class="cmtt-10">makeindex</span>/<span
class="cmtt-10">xindy </span><span
class="cmti-10">for each defined glossary</span>. The ⟨<span
class="cmti-10">gls</span>⟩ and ⟨<span
class="cmti-10">glo</span>⟩ arguments of
<span
class="cmtt-10">\newglossary </span>specify the file extensions to use instead of <span
class="cmtt-10">.gls </span>and <span
class="cmtt-10">.glo</span>. The optional
argument ⟨<span
class="cmti-10">glg</span>⟩ is the file extension for the transcript file. This should be different for each
glossary in case you need to check for <span
class="cmtt-10">makeindex</span>/<span
class="cmtt-10">xindy </span>errors or warnings if things go
wrong.
</p><!--l. 1060--><p class="indent" > For example, suppose you have three glossaries in your document (<span
class="cmtt-10">main</span>, <span
class="cmtt-10">acronym</span>
and <span
class="cmtt-10">notation</span>), specified using:
</p>
<div class="verbatim" id="verbatim-46">
\usepackage[acronyms]{glossaries}
 <br />\newglossary[nlg]{notation}{not}{ntn}{Notation}
</div>
<!--l. 1066--><p class="nopar" > Then (assuming your <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> document is in a file called <span
class="cmtt-10">myDoc.tex</span>):
</p><!--l. 1070--><p class="indent" >
</p><dl class="description"><dt class="description">
</dt><dd
class="description"><a
href="#option2">Option 2</a>:
<!--l. 1073--><p class="noindent" >You need to run <span
class="cmtt-10">makeindex </span>three times:
</p>
<div class="verbatim" id="verbatim-47">
makeindex -t myDoc.glg -s myDoc.ist -o myDoc.gls myDoc.glo
 <br />makeindex -t myDoc.alg -s myDoc.ist -o myDoc.acr myDoc.acn
 <br />makeindex -t myDoc.nlg -s myDoc.ist -o myDoc.not myDoc.ntn
</div>
<!--l. 1078--><p class="nopar" >
</p></dd><dt class="description">
</dt><dd
class="description"><a
href="#option3">Option 3</a>:
<!--l. 1082--><p class="noindent" >You need to run <span
class="cmtt-10">xindy </span>three times (be careful not to insert line breaks where the
line has wrapped.)
</p>
<div class="verbatim" id="verbatim-48">
xindy  -L english -C utf8 -I xindy -M myDoc -t myDoc.glg
 <br />-o myDoc.gls myDoc.glo
 <br />xindy  -L english -C utf8 -I xindy -M myDoc -t myDoc.alg
 <br />-o myDoc.acr myDoc.acn
 <br />xindy  -L english -C utf8 -I xindy -M myDoc -t myDoc.nlg
 <br />-o myDoc.not myDoc.ntn
</div>
<!--l. 1091--><p class="nopar" ></p></dd></dl>
<!--l. 1094--><p class="noindent" >
</p>
<!--l. 1094--><p class="noindent" ><a
href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">7 </span> <a
id="sec:hyperref"></a><span
class="cmss-10">glossaries </span>and <span
class="cmss-10">hyperref</span></h3>
<!--l. 1097--><p class="noindent" >Take care if you use the <span
class="cmss-10">glossaries</span><a
id="dx1-8001"></a> package with <span
class="cmss-10">hyperref</span><a
id="dx1-8002"></a>. Contrary to the usual
advice that <span
class="cmss-10">hyperref</span><a
id="dx1-8003"></a> should be loaded last, <span
class="cmss-10">glossaries</span><a
id="dx1-8004"></a> must be loaded <span
class="cmti-10">after</span>
<span
class="cmss-10">hyperref</span><a
id="dx1-8005"></a>:
</p>
<div class="verbatim" id="verbatim-49">
\usepackage[colorlinks]{hyperref}
 <br />\usepackage{glossaries}
</div>
<!--l. 1104--><p class="nopar" > If you use <span
class="cmss-10">hyperref</span><a
id="dx1-8006"></a> make sure you use PDF<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> rather than the <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> to DVI
engine. The DVI format can’t break hyperlinks across a line so long glossary
entries (such as the full form of acronyms) won’t line wrap with the DVI engine.
Also, hyperlinks in sub- or superscripts aren’t correctly sized with the DVI
format.
</p><!--l. 1111--><p class="indent" > By default, if the <span
class="cmss-10">hyperref</span><a
id="dx1-8007"></a> package has been loaded, commands like <span
class="cmtt-10">\gls </span>will form
a hyperlink to the relevant entry in the glossary. If you to disable this for <span
class="cmti-10">all </span>your
glossaries, then use
</p><!--l. 1116--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\glsdisablehyper </span></div><hr>
</p><!--l. 1117--><p class="noindent" >
If you want hyperlinks suppressed for entries in specific glossaries, then use the
<span
class="cmtt-10">nohypertypes </span>package option. For example, if you don’t want hyperlinks for entries in
the <span
class="cmtt-10">acronym </span>and <span
class="cmtt-10">notation </span>glossaries but you do want them for entries in the <span
class="cmtt-10">main</span>
glossary, then do:
</p>
<div class="verbatim" id="verbatim-50">
\usepackage[colorlinks]{hyperref}
 <br />\usepackage[acronym,nohypertypes={acronym,notation}]{glossaries}
 <br />\newglossary[nlg]{notation}{not}{ntn}{Notation}
</div>
<!--l. 1127--><p class="nopar" >
</p><!--l. 1129--><p class="indent" > If you want the hyperlinks suppressed the first time an entry is used, but you want
hyperlinks for subsequence references then use the <span
class="cmtt-10">hyperfirst=false </span>package
option:
</p>
<div class="verbatim" id="verbatim-51">
\usepackage[colorlinks]{hyperref}
 <br />\usepackage[hyperfirst=false]{glossaries}
</div>
<!--l. 1135--><p class="nopar" >
</p><!--l. 1137--><p class="indent" > Take care not to use non-expandable commands in PDF bookmarks. This
isn’t specific to the <span
class="cmss-10">glossaries</span><a
id="dx1-8008"></a> package but is a limitation of PDF bookmarks.
Non-expandable commands include commands like <span
class="cmtt-10">\gls</span>, <span
class="cmtt-10">\glspl</span>, <span
class="cmtt-10">\Gls </span>and <span
class="cmtt-10">\Glspl</span>.
The <span
class="cmss-10">hyperref</span><a
id="dx1-8009"></a> package provides a way of specifying alternative text for the PDF
bookmarks via <span
class="cmtt-10">\texorpdfstring</span>. For example:
</p>
<div class="verbatim" id="verbatim-52">
\section{The \texorpdfstring{\gls{fishage}}{Fish Age}}
</div>
<!--l. 1145--><p class="nopar" > However, it’s not a good idea to use commands like <span
class="cmtt-10">\gls </span>in a section heading as
you’ll end up with the table of contents in your location list. Instead you can
use
</p><!--l. 1150--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\glsentrytext{</span>⟨<span
class="cmitt-10">label</span>⟩<span
class="cmtt-10">} </span></div><hr>
</p><!--l. 1151--><p class="noindent" >
This is expandable provided that the <span
class="cmtt-10">text </span>key doesn’t contain non-expandable code.
For example, the following works:
</p>
<div class="verbatim" id="verbatim-53">
\section{The \glsentrytext{fishage}}
</div>
<!--l. 1156--><p class="nopar" > and it doesn’t put the table of contents in the location list.
</p><!--l. 1159--><p class="noindent" >
</p>
<!--l. 1159--><p class="noindent" ><a
href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">8 </span> <a
id="sec:xr"></a>Cross-References</h3>
<!--l. 1162--><p class="noindent" >You can add a reference to another entry in a location list using the <span
class="cmtt-10">see={</span>⟨<span
class="cmti-10">label</span>⟩<span
class="cmtt-10">} </span>key
when you define an entry. The referenced entry must also be defined.
</p><!--l. 1166--><p class="indent" > For example:
</p>
<div class="verbatim" id="verbatim-54">
\longnewglossaryentry{devonian}{name={Devonian}}%
 <br />{%
 <br />  The geologic period spanning from the end of the
 <br />  Silurian Period to the beginning of the Carboniferous Period.
 <br />  This age was known for its remarkable variety of
 <br />  fish species.
 <br />}
 <br />\newglossaryentry{fishage}
 <br />{
 <br />  name={Fish Age},
 <br />  description={Common name for the Devonian period},
 <br />  see={devonian}
 <br />}
</div>
<!--l. 1183--><p class="nopar" > The cross-reference will appear as “<span
class="cmti-10">see </span>Devonian”. You can change the “see” tag using
the format <span
class="cmtt-10">see=[</span>⟨<span
class="cmti-10">tag</span>⟩<span
class="cmtt-10">]</span>⟨<span
class="cmti-10">label</span>⟩. For example:
</p>
<div class="verbatim" id="verbatim-55">
\newglossaryentry{latinalph}
 <br />{
 <br />  name={Latin alphabet},
 <br />  description={alphabet consisting of the letters
 <br />  a, \ldots, z, A, \ldots, Z},
 <br />  see=[see also]{exlatinalph}
 <br />}
 <br />\newglossaryentry{exlatinalph}
 <br />{
 <br />   name={extended Latin alphabet},
 <br />   description={The Latin alphabet extended to include
 <br />   other letters such as ligatures or diacritics.}
 <br />}
</div>
<!--l. 1201--><p class="nopar" > If you use the <span
class="cmtt-10">see </span>key in the optional argument of <span
class="cmtt-10">\newacronym</span>, make sure you
enclose the value in braces. For example:
</p>
<div class="verbatim" id="verbatim-56">
\newacronym{ksvm}{ksvm}{kernel support vector machine}
 <br />\newacronym
 <br /> [see={[see also]{ksvm}}]
 <br /> {svm}{svm}{support vector machine}
</div>
<!--l. 1210--><p class="nopar" >
</p><!--l. 1212--><p class="indent" > Since the cross-reference appears in the location list, if you suppress the location list
using the <span
class="cmtt-10">nonumberlist </span>package option, then the cross-reference will also be
suppressed.
</p><!--l. 1216--><p class="noindent" >
</p>
<!--l. 1216--><p class="noindent" ><a
href="#top">Top</a><h2 class="sectionHead"></p><h3 class="sectionHead"><span class="titlemark">9 </span> <a
id="sec:moreinfo"></a>Further Information</h3>
<!--l. 1219--><p class="noindent" >Further information can be found in the main <span
class="cmss-10">glossaries</span><a
id="dx1-10001"></a> <a
href="glossaries-user.html" >user manual</a> or in the <a
href="http://www.dickimaw-books.com/faqs/glossariesfaq.html" >glossaries
FAQ</a>. There is also an <a
href="http://www.latex-community.org/index.php?option=com_content&view=article&id=263:glossaries-nomenclature-lists-of-symbols-and-acronyms&catid=55:latex-general&Itemid=114" >article on the glossaries package</a> on the <a
href="http://www.latex-community.org/" ><span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> Community’s</a>
Know How section and a chapter on the <span
class="cmss-10">glossaries</span><a
id="dx1-10002"></a> package in <a
href="http://www.dickimaw-books.com/latex/thesis/" >Using <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> to Write a
PhD Thesis</a>. </p>
</body></html>
|
