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
|
<a
id="top"></a><?xml version="1.0" encoding="iso-8859-1" ?>
<!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: a guide for beginners</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta name="generator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/)" />
<meta name="originator" content="TeX4ht (http://www.cse.ohio-state.edu/~gurari/TeX4ht/)" />
<!-- xhtml,fn-in,css-in -->
<meta name="src" content="glossariesbegin.tex" />
<meta name="date" content="2011-04-13 19:40: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;}
.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;}
.cmss-10{ font-family: sans-serif;}
.cmss-10{ font-family: sans-serif;}
.cmtt-9{font-size:90%;font-family: monospace;}
.cmtt-9{font-family: monospace;}
.cmti-10{ font-style: italic;}
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%;}
table.multicols { width:100%; margin-left:1em; margin-top:1em; margin-bottom:1em; }
div.important { background-color:red; }
/* end css.sty */
-->
</style>
</head><body
>
<div class="maketitle">
<h2 class="titleHead">The glossaries package: 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">2011-04-12</span></div>
</div>
<div
class="abstract"
>
<div class="center"
>
<!--l. 26--><p class="noindent" >
</p><!--l. 26--><p class="noindent" ><span
class="cmbx-9">Abstract</span></p></div>
<!--l. 27--><p class="indent" > <span
class="cmr-9">This document is a brief guide to the </span><span
class="cmss-9">glossaries </span><span
class="cmr-9">package for beginners who</span>
<span
class="cmr-9">find the size of the main user manual daunting and, as such, it only covers</span>
<span
class="cmr-9">the basics. For more advanced topics, see the </span><a
href="glossaries-user.html" ><span
class="cmr-9">main user manual</span></a><span
class="cmr-9">.</span>
</p>
</div>
<h3 class="likesectionHead"><a
id="x1-1000"></a>Contents</h3>
<div class="tableofcontents">
<span class="sectionToc" >1 <a
href="#x1-20001" id="QQ2-1-2">What Do I Need?</a></span>
<br /> <span class="sectionToc" >2 <a
href="#x1-30002" id="QQ2-1-3">Getting Started</a></span>
<br /> <span class="sectionToc" >3 <a
href="#x1-40003" id="QQ2-1-4">Defining a Term or Symbol</a></span>
<br /> <span class="sectionToc" >4 <a
href="#x1-50004" id="QQ2-1-5">Using a Term</a></span>
<br /> <span class="sectionToc" >5 <a
href="#x1-60005" id="QQ2-1-6">Acronyms</a></span>
<br /> <span class="sectionToc" >6 <a
href="#x1-70006" id="QQ2-1-7">Displaying the Glossary or List of Acronyms</a></span>
</div>
<!--l. 35--><p class="noindent" >
</p>
<h3 class="sectionHead"><span class="titlemark">1 </span> <a
id="x1-20001"></a>What Do I Need?</h3>
<!--l. 38--><p class="noindent" >You need to have the <span
class="cmss-10">glossaries </span>package installed. You also need to have the following
packages installed: <span
class="cmss-10">ifthen</span><a
id="dx1-2001"></a>, <span
class="cmss-10">xkeyval</span><a
id="dx1-2002"></a> (at least version 2.5f), <span
class="cmss-10">xfor</span><a
id="dx1-2003"></a>, <span
class="cmss-10">amsgen</span><a
id="dx1-2004"></a> and <span
class="cmss-10">etoolbox</span><a
id="dx1-2005"></a>. You
may also need <span
class="cmss-10">longtable</span><a
id="dx1-2006"></a>, <span
class="cmss-10">supertabular</span><a
id="dx1-2007"></a> and <span
class="cmss-10">array</span><a
id="dx1-2008"></a>, depending on what glossary style you
want to use. All these packages can be downloaded from CTAN if you don’t
have them installed. See <a
href="http://www.tex.ac.uk/cgi-bin/texfaq2html?label=installthings" >“Installing things on a (La)TeX System”</a> for further
assistance.
</p><!--l. 49--><p class="indent" > In addition, you need an indexing application. The <span
class="cmss-10">glossaries</span><a
id="dx1-2009"></a> package is configured to
use either <span
class="cmtt-10">makeindex</span><a
id="dx1-2010"></a> or <span
class="cmtt-10">xindy</span><a
id="dx1-2011"></a>. <span
class="cmtt-10">Makeindex</span><a
id="dx1-2012"></a> should be available on all <span class="TEX">T<span
class="E">E</span>X</span> systems. It’s
possible you may not have <span
class="cmtt-10">xindy</span><a
id="dx1-2013"></a> installed, but it can be downloaded from the <a
href="http://www.xindy.org/" >xindy
home page</a>. MiKTeX users may find the <a
href="http://www.latex-community.org/forum/viewtopic.php?f=51&t=5383" >Xindy for MiKTeX</a> thread on the LaTeX
Community Forum helpful.
</p><!--l. 57--><p class="indent" > The <span
class="cmss-10">glossaries</span><a
id="dx1-2014"></a> package provides a helper Perl script called <span
class="cmtt-10">makeglossaries</span><a
id="dx1-2015"></a> which
will act as an interface to <span
class="cmtt-10">makeindex</span><a
id="dx1-2016"></a> or <span
class="cmtt-10">xindy</span><a
id="dx1-2017"></a>. If you want to use <span
class="cmtt-10">makeglossaries</span><a
id="dx1-2018"></a> or
<span
class="cmtt-10">xindy</span><a
id="dx1-2019"></a>, you need to have Perl installed. If you don’t have Perl installed, you can still use
<span
class="cmss-10">glossaries </span>but you can only use it with <span
class="cmtt-10">makeindex</span><a
id="dx1-2020"></a>.
</p><!--l. 64--><p class="noindent" >
</p>
<!--l. 64--><p class="noindent" ><a
href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">2 </span> <a
id="x1-30002"></a>Getting Started</h3>
<!--l. 67--><p class="noindent" >The most obvious things to do is to remember to load the <span
class="cmss-10">glossaries</span><a
id="dx1-3001"></a> package:
</p>
<div class="verbatim" id="verbatim-1">
\usepackage{glossaries}
</div>
<!--l. 71--><p class="nopar" >
</p><!--l. 72--><p class="indent" > <div class="important" title="Important Note"> Note that the <span
class="cmss-10">glossaries </span>package must be loaded <span
class="cmti-10">after </span>the <span
class="cmss-10">hyperref</span><a
id="dx1-3002"></a> package
(contrary to the general advice that <span
class="cmss-10">hyperref</span><a
id="dx1-3003"></a> should be loaded last). The <span
class="cmss-10">glossaries</span><a
id="dx1-3004"></a>
package should also be loaded after <span
class="cmss-10">html</span><a
id="dx1-3005"></a>, <span
class="cmss-10">inputenc</span><a
id="dx1-3006"></a>, <span
class="cmss-10">babel</span><a
id="dx1-3007"></a> and <span
class="cmss-10">ngerman</span><a
id="dx1-3008"></a>. </div>
</p><!--l. 78--><p class="noindent" >
</p><!--l. 80--><p class="indent" > If you want to use <span
class="cmtt-10">xindy</span><a
id="dx1-3009"></a> rather than <span
class="cmtt-10">makeindex</span><a
id="dx1-3010"></a> to sort the glossaries, you need to
specify this in the package options:
</p>
<div class="verbatim" id="verbatim-2">
\usepackage[xindy]{glossaries}
</div>
<!--l. 84--><p class="nopar" > Other package options are described in <a
href="glossaries-user.html#sec:pkgopts" >Package Options</a> in the main <span
class="cmss-10">glossaries</span><a
id="dx1-3011"></a> user
manual.
</p><!--l. 89--><p class="indent" > Next, you need to enable the creation of the various external files that are required
by the indexing application. This is done using:
</p><!--l. 92--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\makeglossaries </span></div><hr>
</p><!--l. 93--><p class="noindent" >
</p><!--l. 95--><p class="noindent" >
</p>
<!--l. 95--><p class="noindent" ><a
href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">3 </span> <a
id="x1-40003"></a>Defining a Term or Symbol</h3>
<!--l. 98--><p class="noindent" >You must define terms or symbols before you can use them in the document. This is
best done in the preamble. Each term is defined using:
</p><!--l. 102--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\newglossaryentry{</span><span
class="cmsy-10">⟨</span><span
class="cmti-10">label</span><span
class="cmsy-10">⟩</span><span
class="cmtt-10">}{</span><span
class="cmsy-10">⟨</span><span
class="cmti-10">settings</span><span
class="cmsy-10">⟩</span><span
class="cmtt-10">} </span></div><hr>
</p><!--l. 103--><p class="noindent" >
where <span
class="cmsy-10">⟨</span><span
class="cmti-10">label</span><span
class="cmsy-10">⟩ </span>is a unique label used to identify the term. The second argument,
<span
class="cmsy-10">⟨</span><span
class="cmti-10">settings</span><span
class="cmsy-10">⟩</span>, is a key=value comma separated list that is used to set the required
information for the term. A full list of available keys can be found in <a
href="glossaries-user.html#sec:newglosentry" >Defining Glossary
Entries</a> in the main <span
class="cmss-10">glossaries</span><a
id="dx1-4001"></a> user manual. The principle keys are <span
class="cmss-10">name</span><a
id="dx1-4002"></a> and
<span
class="cmss-10">description</span><a
id="dx1-4003"></a>.
</p><!--l. 113--><p class="indent" > For example, to define the term “electrolyte”:
</p>
<div class="verbatim" id="verbatim-3">
\newglossaryentry{electrolyte}{name=electrolyte,
 <br />description={solution able to conduct electric current}}
</div>
<!--l. 117--><p class="nopar" > In the above example, the label and the name happen to be the same. In the next
example, the name contains a ligature but the label doesn’t:
</p>
<div class="verbatim" id="verbatim-4">
\newglossaryentry{oesophagus}{name=\oe sophagus,
 <br />description={canal from mouth to stomach},
 <br />plural=\oe sophagi}
</div>
<!--l. 125--><p class="nopar" > In this case the label is <span
class="cmtt-10">oesophagus</span>. Note that in this case, the plural has to be
specified using the <span
class="cmss-10">plural</span><a
id="dx1-4004"></a> key since it isn’t formed by simply appending the letter
“s”.
</p><!--l. 130--><p class="indent" > When you define terms, it is important to remember that they will be sorted by an
external application that doesn’t interpret <span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> commands. <span
class="cmtt-10">Xindy</span><a
id="dx1-4005"></a> is a little more
<span class="TEX">T<span
class="E">E</span>X</span>-aware than <span
class="cmtt-10">makeindex</span><a
id="dx1-4006"></a>, but for this example they will both mis-sort
<span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\oe</span><span
class="cmtt-10"> sophagus</span></span></span>. Xindy will ignore the <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\oe␣</span></span></span> part and will sort it according to <span
class="cmtt-10">sophagus</span>,
so it will be placed with the terms starting with an “s”. <span
class="cmtt-10">Makeindex</span><a
id="dx1-4007"></a>, on the other hand,
will sort it according to <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\oe␣sophagus</span></span></span> which starts with a symbol (the backslash), so it
will end up in the symbol group. You therefore need to specify how to sort the
term:
</p>
<div class="verbatim" id="verbatim-5">
\newglossaryentry{oesophagus}{name=\oe sophagus,
 <br />description={canal from mouth to stomach},
 <br />plural=\oe sophagi,
 <br />sort=oesophagus}
</div>
<!--l. 145--><p class="nopar" > Note, however, that if you use the <span
class="cmss-10">inputenc</span><a
id="dx1-4008"></a> package and <span
class="cmtt-10">xindy</span><a
id="dx1-4009"></a>, you can use the
encoded character <span
class="cmtt-10">œ </span>rather than <span
class="cmtt-10">\oe </span>and <span
class="cmtt-10">xindy</span><a
id="dx1-4010"></a> will sort it correctly:
</p>
<div class="verbatim" id="verbatim-6">
\newglossaryentry{oesophagus}{name=œsophagus,
 <br />description={canal from mouth to stomach},
 <br />plural=œsophagi}
</div>
<!--l. 153--><p class="nopar" >
</p><!--l. 155--><p class="indent" > If the name starts with an accented character, the first character must be
grouped:
</p>
<div class="verbatim" id="verbatim-7">
\newglossaryentry{elite}{name={\’e}lite,
 <br />description={select group of people},
 <br />sort=elite}
</div>
<!--l. 161--><p class="nopar" > or
</p>
<div class="verbatim" id="verbatim-8">
\newglossaryentry{elite}{name={é}lite,
 <br />description={select group of people}}
</div>
<!--l. 166--><p class="nopar" >
</p><!--l. 168--><p class="indent" > The name can also be a symbol, but you will also need to specify the sort key. For
example:
</p>
<div class="verbatim" id="verbatim-9">
\newglossaryentry{pi}{name={\ensuremath{\pi}},
 <br />description={ratio of circumference of circle to its
 <br />diameter},sort=pi}
</div>
<!--l. 174--><p class="nopar" > It’s also possible to have a name and a symbol. For example:
</p>
<div class="verbatim" id="verbatim-10">
\newglossaryentry{set}{name=set,
 <br />description={a collection of objects},
 <br />symbol={\ensuremath{\mathcal{S}}}}
</div>
<!--l. 180--><p class="nopar" > Note, however, that not all glossary styles display the symbol in the glossary.
</p><!--l. 184--><p class="noindent" >
</p>
<!--l. 184--><p class="noindent" ><a
href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">4 </span> <a
id="x1-50004"></a>Using a Term</h3>
<!--l. 187--><p class="noindent" >Once you have defined a term, you can use it in the document. The <span
class="cmss-10">glossaries</span><a
id="dx1-5001"></a>
package provides a number of commands that are described in <a
href="glossaries-user.html#sec:glslink" >Links to Glossary
Entries</a> in the main <span
class="cmss-10">glossaries</span><a
id="dx1-5002"></a> user manual. Here, I shall just cover the main
commands:
</p><!--l. 193--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\gls{</span><span
class="cmsy-10">⟨</span><span
class="cmti-10">label</span><span
class="cmsy-10">⟩</span><span
class="cmtt-10">} </span></div><hr>
</p><!--l. 194--><p class="noindent" >
This prints the term associated with <span
class="cmsy-10">⟨</span><span
class="cmti-10">label</span><span
class="cmsy-10">⟩</span>. Using the example in the previous section,
<span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\gls{oesophagus}</span></span></span> will display œsophagus. If the <span
class="cmss-10">hyperref</span><a
id="dx1-5003"></a> package has also
been loaded, the term will also be hyperlinked to the relevant entry in the
glossary.
</p><!--l. 201--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\glspl{</span><span
class="cmsy-10">⟨</span><span
class="cmti-10">label</span><span
class="cmsy-10">⟩</span><span
class="cmtt-10">} </span></div><hr>
</p><!--l. 202--><p class="noindent" >
This prints the plural of the term associated with <span
class="cmsy-10">⟨</span><span
class="cmti-10">label</span><span
class="cmsy-10">⟩</span>, so <span class="obeylines-h"><span class="verb"><span
class="cmtt-10">\glspl{oesophagus}</span></span></span> will
display œsophagi. Again, the text will be a hyperlink to the relevant entry in the
glossary, if hyperlinks are defined.
</p><!--l. 208--><p class="indent" > There are also versions that convert the first character to upper case if you need to
start a sentence with a term:
</p><!--l. 211--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\Gls{</span><span
class="cmsy-10">⟨</span><span
class="cmti-10">label</span><span
class="cmsy-10">⟩</span><span
class="cmtt-10">} </span></div><hr>
</p><!--l. 212--><p class="noindent" >
and
</p><!--l. 215--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\Glspl{</span><span
class="cmsy-10">⟨</span><span
class="cmti-10">label</span><span
class="cmsy-10">⟩</span><span
class="cmtt-10">} </span></div><hr>
</p><!--l. 216--><p class="noindent" >
For example:
</p>
<div class="verbatim" id="verbatim-11">
\Glspl{electrolyte} usually exist as solutions of salts,
 <br />bases or acids.
</div>
<!--l. 221--><p class="nopar" >
</p><!--l. 223--><p class="indent" > Note that these commands all have two optional arguments that aren’t discussed
here, but they are described in <a
href="glossaries-user.html#sec:glslink" >Links to Glossary Entries</a> in the main <span
class="cmss-10">glossaries</span><a
id="dx1-5004"></a> user
manual.
</p><!--l. 228--><p class="indent" > <div class="important" title="Important Note"> Don’t use these commands in moving arguments, such as those used by <span
class="cmtt-10">\chapter</span>,
<span
class="cmtt-10">\section </span>and <span
class="cmtt-10">\caption</span>. </div>
</p><!--l. 231--><p class="noindent" >
You can, instead, use commands such as
</p><!--l. 234--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\glsentrytext{</span><span
class="cmsy-10">⟨</span><span
class="cmti-10">label</span><span
class="cmsy-10">⟩</span><span
class="cmtt-10">} </span></div><hr>
</p><!--l. 235--><p class="noindent" >
See <a
href="glossaries-user.html#sec:glsnolink" >Using Glossary Terms Without Links</a> in the main <span
class="cmss-10">glossaries</span><a
id="dx1-5005"></a> user manual.
</p><!--l. 239--><p class="noindent" >
</p>
<!--l. 239--><p class="noindent" ><a
href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">5 </span> <a
id="x1-60005"></a>Acronyms</h3>
<!--l. 242--><p class="noindent" >The <span
class="cmss-10">glossaries</span><a
id="dx1-6001"></a> package also allows you to define acronyms. By default, acronyms will be
added to the main glossary, but if you use the <span
class="cmss-10">acronym</span><a
id="dx1-6002"></a> package option, acronyms will
be placed in a separate list of acronyms:
</p>
<div class="verbatim" id="verbatim-12">
\usepackage[acronym]{glossaries}
</div>
<!--l. 248--><p class="nopar" > There are other options that govern how acronyms appear. For further details, see
<a
href="glossaries-user.html#sec:acronyms" >Acronyms</a> in the main <span
class="cmss-10">glossaries</span><a
id="dx1-6003"></a> user manual.
</p><!--l. 253--><p class="indent" > Acronyms must be defined before use and are defined using:
</p><!--l. 255--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\newacronym{</span><span
class="cmsy-10">⟨</span><span
class="cmti-10">label</span><span
class="cmsy-10">⟩</span><span
class="cmtt-10">}{</span><span
class="cmsy-10">⟨</span><span
class="cmti-10">abbrv</span><span
class="cmsy-10">⟩</span><span
class="cmtt-10">}{</span><span
class="cmsy-10">⟨</span><span
class="cmti-10">full</span><span
class="cmsy-10">⟩</span><span
class="cmtt-10">} </span></div><hr>
</p><!--l. 256--><p class="noindent" >
where <span
class="cmsy-10">⟨</span><span
class="cmti-10">label</span><span
class="cmsy-10">⟩ </span>is the label identifying the acronym, <span
class="cmsy-10">⟨</span><span
class="cmti-10">abbrv</span><span
class="cmsy-10">⟩ </span>is the abbreviated form and
<span
class="cmsy-10">⟨</span><span
class="cmti-10">full</span><span
class="cmsy-10">⟩ </span>is the fully expanded text. For example:
</p>
<div class="verbatim" id="verbatim-13">
\newacronym{label}{svm}{support vector machine}
</div>
<!--l. 262--><p class="nopar" >
</p><!--l. 264--><p class="indent" > Once the acronym is defined, it can be used in the same way as any other glossary
term with commands such as <span
class="cmtt-10">\gls </span>and <span
class="cmtt-10">\glspl</span>. On first use, the default will display
<span
class="cmsy-10">⟨</span><span
class="cmti-10">full</span><span
class="cmsy-10">⟩ </span>(<span
class="cmsy-10">⟨</span><span
class="cmti-10">abbrv</span><span
class="cmsy-10">⟩</span>). On subsequent use, only the abbreviation will appear. For
example:
</p>
<div class="verbatim" id="verbatim-14">
A \gls{svm} was implemented.
</div>
<!--l. 271--><p class="nopar" > If this is the first time this term has been used, the above would produce:
<spacer type=vertical size=10><span class="obeylines-h">
<br />A support vector machine (svm) was implemented.
<br /><spacer type=vertical size=10></span>
otherwise it would produce: <spacer type=vertical size=10><span class="obeylines-h">
<br />A svm was implemented.
<br /><spacer type=vertical size=10></span>
You can reset an acronym so that the next use fully expands it again using:
</p><!--l. 284--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\glsreset{</span><span
class="cmsy-10">⟨</span><span
class="cmti-10">label</span><span
class="cmsy-10">⟩</span><span
class="cmtt-10">} </span></div><hr>
</p><!--l. 285--><p class="noindent" >
or you can reset all acronyms using
</p><!--l. 288--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\glsresetall </span></div><hr>
</p><!--l. 289--><p class="noindent" >
For further details on resetting and unsetting acronyms, see <a
href="glossaries-user.html#sec:glsunset" >Unsetting and Resetting
Entry Flags</a> in the main <span
class="cmss-10">glossaries</span><a
id="dx1-6004"></a> user manual.
</p><!--l. 295--><p class="noindent" >
</p>
<!--l. 295--><p class="noindent" ><a
href="#top">Top</a></p><h3 class="sectionHead"><span class="titlemark">6 </span> <a
id="x1-70006"></a>Displaying the Glossary or List of Acronyms</h3>
<!--l. 298--><p class="noindent" >In order to display the sorted list of terms, you first need to use
</p><!--l. 301--><p class="indent" > <hr><div title="Definition"><span
class="cmtt-10">\printglossaries </span></div><hr>
</p><!--l. 302--><p class="noindent" >
at the place where you want the glossary and list of acronyms to appear. Note that
<span
class="cmtt-10">\printglossaries </span>won’t produce any text the first time you create your document,
as an external indexing application needs to be used to sort and collate the
entries. Creating the completed document is therefore <span
class="cmti-10">at least </span>a three step
process.
</p><!--l. 310--><p class="indent" > Suppose your document is called <span
class="cmtt-10">myDoc.tex</span>, then you need to:
</p><ol class="enumerate1" >
<li
class="enumerate" id="x1-7002x1">Build/<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> your document, either by clicking on an appropriate button in
your front-end/text editor or by typing the following at a terminal/command
prompt:
<div class="verbatim" id="verbatim-15">
latex myDoc
</div>
<!--l. 318--><p class="nopar" >
</p></li>
<li
class="enumerate" id="x1-7004x2">Run the indexing application on the external file(s) created by the <span
class="cmss-10">glossaries</span><a
id="dx1-7005"></a>
package. If you have used the <span
class="cmss-10">xindy</span><a
id="dx1-7006"></a> package option, you must use <span
class="cmtt-10">xindy</span><a
id="dx1-7007"></a>,
otherwise you must use <span
class="cmtt-10">makeindex</span><a
id="dx1-7008"></a>. The <span
class="cmss-10">glossaries</span><a
id="dx1-7009"></a> package comes with a
convenient Perl wrapper that calls the appropriate indexing application the
required number of times with the required options. If you have Perl installed, all
you need to do is type
<div class="verbatim" id="verbatim-16">
makeglossaries myDoc
</div>
<!--l. 329--><p class="nopar" > in a terminal or command prompt. If you are using a front-end (such as WinEdt
or TeXnicCenter) and you want it to automatically run makeglossaries
when you build your document, you will need to consult the front-end’s
documentation.
</p><!--l. 335--><p class="noindent" >If you don’t have Perl installed, you will need to call <span
class="cmtt-10">makeindex</span><a
id="dx1-7010"></a> or <span
class="cmtt-10">xindy</span><a
id="dx1-7011"></a>
explicitly. This is more complicated and is described in <a
href="glossaries-user.html#sec:makeglossaries" >Generating the Associated
Glossary Files</a> in the main <span
class="cmss-10">glossaries</span><a
id="dx1-7012"></a> user manual.
</p></li>
<li
class="enumerate" id="x1-7014x3">Once you have successfully run the indexing application, you need to
build/<span class="LATEX">L<span class="A">A</span><span class="TEX">T<span
class="E">E</span>X</span></span> your document again (see step 1).</li></ol>
<!--l. 344--><p class="noindent" >Note that sometimes you may have to repeat steps 2 and 3.
</p><!--l. 346--><p class="indent" > The appearance of the glossary depends on the glossary style in use. The default
style uses the <span
class="cmss-10">description</span><a
id="dx1-7015"></a><a
id="dx1-7016"></a> environment, but there are many other styles available. These
are described in <a
href="glossaries-user.html#sec:styles" >Glossary Styles</a> in the main <span
class="cmss-10">glossaries</span><a
id="dx1-7017"></a> user manual. By default, a
number or list of numbers will appear after each entry in the glossary. This indicates
the page (or pages) on which the term was used. This list can be suppressed using the
<span
class="cmss-10">nonumberlist</span><a
id="dx1-7018"></a> package option:
</p>
<div class="verbatim" id="verbatim-17">
\usepackage[nonumberlist]{glossaries}
</div>
<!--l. 357--><p class="nopar" >
</p><!--l. 359--><p class="indent" > Further information can be found in the main <span
class="cmss-10">glossaries</span><a
id="dx1-7019"></a> <a
href="glossaries-user.html" >user manual</a> and 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.
</p><!--l. 365--><p class="noindent" ><a
href="#top">Top</a></p>
</body></html>
|
