summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/glossaries/CHANGES
blob: 14187b28faec95e6e9d6306135b4af08fd67577c (plain)
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
glossaries change log:

v3.01:

   * made commands like \glslink, \gls and \acrshort robust

   * Fixed bugs in commands like \acrfullpl which was missing the
     plural in some cases.

   * Removed \acronymfont from \acrfullformat as it's already used
     in the second argument passed to that command. (Causes a 
     problem with the "smaller" option.)

v3.0 (Major changes):

   * Documentation has been restructured:

     - glossaries-user: main user manual
     - glossariesbegin: cut-down introduction for beginners
     - mfirstuc-manual: user manual for mfirstuc package
     - glossaries.pdf: documented code for advanced users
     - glossary2glossaries: upgrading from glossary.sty to glossaries.sty

   * Added new package options:

     - entrycounter : number main (level 0) entries in the glossary.

     - counterwithin : set parent counter for the entry counter.

     - subentrycounter : number level 1 entries in the glossary.

     - sort : set the sort order to 
              - standard alphabetical (sort=standard),
              - order of definition (sort=def) 
              - order of use (sort=use)

     - seeautonumberlist : automatically activates the number list
                           for entries that use the "see" key.

     - savewrites : minimise number of \newwrite

     - compatible-2.07 :

         bug fixes in v3.0 have cause compatibility problems. This 
         package option will restore the old behaviour but bugs will 
         remain.  (Should mostly only effect documents that used
         \noist with a custom Xindy style file.)

   * \printglossary sets \currentglossary to the current glossary's
     label. (Allows custom glossary styles access to the glossary
     type.)

   * Modified internal workings of acronyms and:

     - Added starred versions of \acrshort etc.

     - Added "long", "short", "longplural" and "shortplural" keys
       (Reserved for use with \newacronym.)

     - Added analogous "longaccess", "shortaccess", "longpluralaccess"
       and "shortpluralaccess" keys for \newacronym in 
       glossaries-accsupp.sty

   * Added \glsseeitemformat to customise the text given in the link
     created by \glsseeitem.

   * \newglossaryentry key "nonumberlist" now boolean.

   * added debugging commands \showgloname etc.

   * now loads etoolbox:

     - replaced \DeclareRobustCommand with \newrobustcmd

     - replaced \@ifundefined with \ifcsundef

     - replaced \let...\undefined with \undef...

   * Bug Fixes:

     - now works with equation counter in amsmath's align
       environment.

     - Mixed counters now work with xindy option.

     - Fixed hyperlinks in location numbers where \theH<counter>
       has a prefix not present in \the<counter>.

     - If title specified in \printglossary but toctitle hasn't
       been specified, make toctitle same as supplied title.

     - \newglossaryentry "see" key and \glssee now sanitize and escape 
       special characters before writing to output file. (Allows
       user to redefine \seename any point before \printglossary or
       \printglossaries.)

     - \glshyperlink: Changed the default value of the optional argument
                      to \glsentrytext instead of \glsentryname.

   * mfirstuc.sty (v1.05):

     - added \glsmakefirstuc (replaces \@gls@makefirstuc) to make
       it easier to customise.

   makeglossaries (v2.02):

   * now displays version number on startup unless -q

   * added more diagnostics to give more helpful messages than
     those supplied by xindy or makeindex.

v2.07:

   * Fixed bug that ignored format key in \glsadd

   makeglossaries:

   * Fixed bug causing failure to process aux files containing \@input

v2.06:
   * Added \altnewglossary

   * added facility to customise acronyms if the predefined styles
     don't fit the user's requirements.

   * Serbian dictionary added (provided by Zoran Filipovic)

   makeglossaries:

   * Scans aux file for \@input in case \printglossary is in an
     imported file.

v2.05:
   * Fixed error in .ist file and in \glsdisp caused by a 
     misplace brace. (Patch provided by Sergiu Dotenco).

v2.04:
   * Improved support for multiple lists of acronyms.

   * Fixed bug that caused \glsadd to ignore counter option

   * Fixed bug that causes babel to override translator's definition
     of \glossaryname.

   * Added user1, ... , user6 keys.

   * Added polyglossia support

   * makeglossaries now creates stub output file if input file is
     empty

  glossaries-accsupp v0.2:
   * Added access keys.

   * Added support for acronyms.

  mfirstuc v1.04: 
   * fixed bug occurring when initial control sequence
     in the argument of \makefirstuc has more than one 
     argument.

v2.03:
   * Added check to see if \glossarymark has been defined

   * makeglossaries - failed file test messages printed to
     stdout instead of stderr (so that it doesn't interrupt
     latexmk).

   * Fixed bug when entries used at the start of a paragraph.

   * Added package option hyperfirst (boolean option to suppress
     hyperlink on first use).

   * Added pod to makeglossaries.

v2.02:
   * Renamed glossaries-dictionary-Brazil.dict to 
     glossaries-dictionary-Brazilian.dict

   * Replaced \@mkboth with \glossarymark in \glossarysection
     to make it easier for the user to override it

   * Fixed bug that generated no \printglossary warning when
     the glossary is placed in a group

   * translate=false option will now prevent automatic loading
     of translator package.

v2.01:
   * Documentation changes:
      - removed quick guide section from glossaries.pdf and replaced 
        it with a separate beginners guide (glossariesbegin.pdf)
      - added a section for front-end or script developers who
        want to access information from the aux file

   * Added new ragged right versions of long/super styles

   * Added 'nomain' package option to suppress the creation of the
     main glossary

   * Added 'nowarn' package option to suppress warnings

   * Removed unwanted full stops in transcript messages

   * Changed \linewidth to \hsize when setting lengths

   * Removed item_02 key from makeindex style file (no such key)

   * Moved \@do@wrglossary before term is displayed to prevent
     unwanted whatsit

v2.0 (1.20):
   * Fixed ngerman caption bug in glossaries-babel.sty

v1.19:

   * changed \acronymfont to use \textsmaller instead of \smaller
     (for "smaller" package option)

   * Added \glsdisp (similar to \glslink except that it uses
     \glsdisplay/glsdisplayfirst and unsets the first use flag)

   * Added experimental package glossaries-accsupp which 
     requires accsupp package.

v1.18:
   * fixed missing closing } in glossaries-babel.sty

   * added \glstarget so that glossary styles can be modified
     in the document without using internal commands.

   * glossary-super.sty isn't loaded if supertabular.sty isn't
     installed.

   * added nolong, nosuper, nolist, notree and nostyles package 
     options to prevent loading unnecessary packages.

   * added \oldacronym (emulates the old glossary package's 
     \newacronym command).

   * added sublistdotted style.

   * fixed bug caused by misspelt \glspagewidthlist (should be
     \glspagelistwidth).

   * fixed border in super4colheaderborder and 
     altsuper4colheaderborder styles.

   * fixed sort sanitization when package option sanitize={name=false}
     is used.

v1.17:
   * changed definition of \@glossary to prevent conflict with
     memoir

   * added check to determine if \printglossary is defined. (If
     it is, issue warning and redefine.)

   * provided means to suppress number list for specific entries

   * provided means to suppress description terminator for
     specific entries

   * added cross-referencing support

   * added hierarchical support

   * added xindy support

   * modified \glshypernumber to support \nohyperpage
     (code provided by Heiko Oberdiek)

   * added 2 and 3-page suffix support

   * added "order" package option to set word/letter ordering
     (only has an effect in combination with makeglossaries script)

   * added Brazilian dictionary (supplied by Thiago de Melo)

v1.16 :
   * fixed bug that causes footnote option to remove hyperlink
     for first use entries in glossaries other than the list
     of acronyms. (footnote option should only affect entries
     in \acronymtype glossary.)

   * Raised hypertarget so that links to glossary entries don't
     scroll off the top of the page.

   * Fixed expansion-related bug (thanks to fix provided by
     Ulrich Diez)

v1.15 :
   * added \glslabel

   * added altlong4col* and altsuper4col* styles

   * fixed PDF encoding problem caused when both translator
     and hyperref packages are being used

   * fixed bug when using smallcaps and smaller options that causes
     the long form in the list of acronyms to be the same for each 
     entry

   * Added warnings when rerun required when using glossary
     group hyper navigation

glossaries.perl v1.04:
   * add do_cmd_glslabel

   * changed links to the start of the relevant glossary entry
     rather than the entry's backlink

   * added implementation of starred forms of \gls etc

   * added frame related code if frames.pl has been loaded

v1.14 :
   * Fixed bug in \glsnavhyperlink that causes an error when used
     with hyperref and translator packages.

   * Added \glsautoprefix (specifies a prefix to the automatically
     generated label)

   * Added nonumberlist and numberedsection keys to \printglossary

   * Changed \glsnavigation so that it only lists the groups that
     are present. (This prevents unknown target warnings.)

   * Amended documentation.

mfirstuc v1.02 (18 June 2008):

   * Fixed bug that transfered grouping, (e.g 
     \makefirstuc{\emph{abc}xyz} moved the xyz into the \emph)

   * If group following initial command is empty, \MakeUppercase
     is applied to the command, e.g. \makefirstuc{\ae{}bc} now
     produces \MakeUppercase\ae{}bc.

v1.13 :
   * Fixed bug in long4colheaderborder that puts an extra row
     at the end of the glossary.

   * Fixed bug in \glstext etc that ignored 3rd argument (thanks
     to Franz Fischer for pointing this out).

   * Removed only preamble restriction on \newglossaryentry and
     \newacronym.

   * Added \glspluralsuffix.

   * Changed firstplural default so that it takes its value from
     the plural key if the first key is omitted.

   * Added \acrshortpl, \Acrshortpl, \ACRshortpl, \acrlongpl,
     \Acrlongpl, \ACRlongpl, \acrfullpl, \Acrfullpl, \ACRfullpl.

   * Fixed bugs in \Acrshort etc.

   * Add package options "smaller" and "shortcuts".

   * Acronym default plural forms now implemented for the additional
     acronym styles.

   * Fixed makeglossaries to allow filenames with spaces.

   * Fixed error in documentation describing \glsaddall
     - optional argument should be a key=value list.

   * Added Polish support (thanks to Piotr Formella for supplying
     the translations).

   * If babel is loaded and translator package is found on TeX's
     path, then the translator package will now be automatically 
     loaded.

mfirstuc v1.01 (13 May 2008):

   * Added \xmakefirstuc (expands argument before applying \makefirstuc)

v1.12 (8 March 2008):
   * Fixed bug that causes \glspl to print the plural short form
     on first use instead of the plural long form.

   * Added descriptionplural and symbolplural keys.

   * Added \glsshortkey, \glsshortpluralkey, \glslongkey and
     \glslongpluralkey.

   * Fixed bugs in \glsname, \glstext, \glsdesc etc.

   * Added a check for \hypertarget in addition to checking
     for \hyperlink (in the event that \hyperlink is defined
     but not \hypertarget).

   * Changed #! line in makeglossaries to use /usr/bin/env

   * Added package mfirstuc.sty which provides the command 
     \makefirstuc{<stuff>} which makes the first object of
     <stuff> uppercase unless <stuff> starts with a control
     sequence followed by a group, in which case the first
     object in the group is converted to uppercase. Examples:

     \makefirstuc{abc}        -> Abc
     \makefirstuc{\emph{abc}} -> \emph{Abc}
     \makefirstuc{{\'a}bc}    -> {\'A}bc
     \makefirstuc{\ae bc}     -> \AE bc
     \makefirstuc{{\ae}bc}    -> {\AE}bc

     (but don't do \makefirstuc{\ae{}bc} which produces \ae Bc.)

v1.11 (2 March 2008):
   * Fixed error in manual (glossary style is set using \glossarystyle
     not \setglossarystyle).

   * Changed the way the package is archived to make it compatible
     with TeX Live.

   * Improved error handling of makeglossaries and added --version
     and --help options.

v1.1 (22 Feb 2008):

   * New package options:

     - numberline: 
       inserts \numberline{} in \addcontentsline when used with
       the toc option.

     - numberedsection: 
       puts glossaries in numbered chapters/sections

     - translate:
       translate=false option prevents glossaries package from
       using pre-supplied translations.

     - description:
       changes definition of \newacronym to allow a description

     - footnote:
       changes definition of \newacronym to use a footnote on
       first use

     - smallcaps:
       changes definition of \newacronym to set acronyms in 
       small capitals

     - dua:
       changes definition of \newacronym to always expand
       acronyms

   * Added \setglossarysection
     - changes the section type used by the glossaries

   * Added listdotted glossary style.

   * No longer uses xspace package; uses amsgen instead.

   * Added \glsname, \glsdesc, \glssymbol, \glsfirst, \glstext, 
     \glsplural and \glsfirstplural.

   * Added support for translator package.

v1.08 (13 Oct 2007):
   * Added multilingual support
   * Fixed bug in listgroup and altlistgroup styles so that 
     \glsgroupheading uses \glsgetgrouptitle to get the group title 
     instead of displaying the label
   * Fixed typo in error message text when the description key
     is missing to \newglossaryentry.

v1.07 (13 Sep 2007):
   * Fixed bug causing incorrect page number for entries in the
     first paragraph of a page.

v1.06 (21 Aug 2007):
   * Changed the license text

v1.05 (10 Aug 2007):
   * Changed the default value of the sort key to just use the
     name key
   * Added \@mkboth to \glossarysection

v1.04 (3 Aug 2007):
   * Added \glstextformat

v1.03 (4 July 2007):
   * Added \glspostdescription

v1.02 (25 May 2007):
   * Added overview section in the documentation

v1.01 (17 May 2007):
   * Added number range facility (equivalent to makeindex's |( and |)
     formatting commands.)
   * Added a space after \delimN and \delimR in the ist file.

v1.0 (16 May 2007): Initial release