path: root/Master/texmf-dist/doc/latex/glossaries-extra/CHANGES

1.24 (2017-11-14):

 * glossaries-extra-manual.tex:

   - corrected syntax of \glsxtrifhasfield and \GlsXtrIfFieldEqStr
     (first argument is field, second is entry label)

 * glossaries-extra.sty:

   - added \glsxtrforcsvfield

   - added \glsxtrlocalsetgrouptitle

   - bug fix (\glsadd breaks with sort=use)

1.23 (2017-11-12):

 * glossaries-extra.sty:

   - added \glsxtrrestorepostpunc

   - added \GlsXtrIfFieldUndef

   - added \glsxtrifcustomdiscardperiod

   - added starred form of \glsxtrfmt

   - bug fix: added missing label in \@glsxtrentryfmt

   - fixed shortcuts=all / true option
     (\newabbr now defined with \providecommand)

 * glossaries-extra-stylemods.sty:

   - added \glsupdatewidest, \gglsupdatewidest, \eglsupdatewidest
     and \xglsupdatewidest

1.22 (2017-11-08):

 * glossaries-extra.sty:

   - \glsseeitemformat: added check for short field 

   - added \glossentrynameother and \glsxtrglossentryother

   - added \glsxtrnopostpunc and \glsxtractivatenopost

 * glossary-bookindex.sty:

   - removed \ifglsnopostdot check from \glsxtrbookindexprelocation
     (inappropriate as bookindex style doesn't display the
      description)

1.21 (2017-11-03):

 * glossaries-extra.sty:

  - fixed shortcuts=ac and shortcuts=none settings

  - new package option postpunc

  - added extra debug settings (debug=showwrgloss and debug=all)

  - modified \glsseeitemformat

  - new commands: \glsuseabbrvfont and \glsuselongfont

  - new command \glsxtrglossentry

  - new commands: \ifglsxtr@hyperoutside and
    \glsxtrinithyperoutside and associated key hyperoutside
    and category attribute hyperoutside.

  - new attribute textformat

  - patched \glsnavhyperlink

  - \glsenablehyper and \glsdisablehyper now use \def rather
    than \let to allow for redefinitions of \glsdohyperlink etc

  - added \@glsxtr@checkgroup (letter group check is now
    in \@print@unsrt@glossary during the construction of
    \@glsxtr@doglossary to avoid complications caused
    by the tabular-like styles)

  - added \glshex, \glsxtrresourceinit

  - added \GlsXtrTotalRecordCount, \GlsXtrRecordCount,
    \GlsXtrLocationRecordCount, \glsxtrdetoklocation,
    \glsxtrenablerecordcount, \glsxtrrecordtriggervalue,
    \GlsXtrSetRecordCountAttribute, \glsxtrifrecordtrigger

  - added \rgls, \rglspl, \rGls, \rGlspl, \rGLS, \rGLSpl,
    \rglsformat, \rglsplformat, \rGlsformat, \rGlsplformat,
    \rGLSformat, \rGLSplformat

  - added \glsxtrnewgls, \glsxtrnewglslike, \glsxtrnewrgls,
    \glsxtrnewrglslike

  - added \printunsrtglossaryentryprocesshook,
    \printunsrtglossaryskipentry,
    \printunsrtglossarypredoglossary,
    \glsxtriflabelinlist

  - added \GlsXtrIfFieldEqStr

  - new abbreviation styles: nolong-short, nolong-short-noreg,
    nolong-short-sm, nolong-short-sc

 * glossary-bookindex.sty: new

 * glossaries-extra-stylemods.sty:

  - added package option "all"

  - added \glsxtrprelocation

  - added \glstreeprelocation and \glstreechildprelocation

  - added \glslistprelocation, \glslistchildprelocation,
    and \glslistchildpostlocation

  - patched indexgroup, indexhypergroup, treegroup,
    treehypergroup, treenonamegroup, treenonamehypergroup,
    alttreegroup, alttreehypergroup, mcolindexgroup,
    mcolindexhypergroup, mcolindexspannav, mcoltreegroup,
    mcoltreehypergroup, mcoltreespannav, mcoltreenonamegroup,
    mcoltreenonamehypergroup, mcoltreenonamespannav,
    mcolalttreegroup, mcolalttreehypergroup, mcolalttreespannav,
    listgroup, listhypergroup, altlistgroup, altlisthypergroup
    styles to discourage page breaks after
    letter group headings.

  - added \gglssetwidest

  - ensured that all tabular-like styles have the 
    \ifglsnogroupskip moved outside of the definition
    of \glsgroupskip

1.20 (2017-09-11):

 * New 'printgloss' key targetnameprefix

 * Corrected .ins to remove default preamble and postamble
   from .bib files

1.19 (2017-09-08):

 * New command: \GlsXtrSetDefaultNumberFormat

 * New command: \glsxtrhyperlink

 * New command: \glsxtrifhasfield

 * Added thevalue and theHvalue keys to \glslink etc

 * Bug fixes for record=only and record=alsoindex options

 * Added example .bib files for use with bib2gls

1.18 (2017-08-10):

 * Fixed bug caused by missing argument of 'stylemods'.

1.17 (2017-08-09):

 * Added \glsxtrword, \glsxtrwordsep and check for 'markwords'
   and 'markshortwords' category attributes.

 * New abbreviation styles:

    - short-nolong-noreg
    - short-nolong-desc-noreg
    - long-noshort-desc-noreg
    - long-noshort-noreg
    - long-em-noshort-em-noreg
    - long-em-noshort-em-desc-noreg
    - long-only-short-only
    - long-only-short-only-desc

   designed to work with 'markwords' attribute:
    - long-hyphen-short-hyphen
    - long-hyphen-short-hyphen-desc
    - long-hyphen-noshort-desc-noreg
    - long-hyphen-postshort-hyphen
    - long-hyphen-postshort-hyphen-desc
    - short-hyphen-long-hyphen
    - short-hyphen-long-hyphen-desc
    - short-hyphen-postlong-hyphen
    - short-hyphen-postlong-hyphen-desc

 * New sample document sample-abbr-styles.tex that illustrates all 
   available abbreviation styles.

 * Fixed some inconsistencies in the predefined abbreviation styles.

 * Added extra value 'ac' to package option 'shortcuts'

 * Added \ifglsxtrinsertinside check for subsequent use.

 * Added \glsxtrparen, \glsxtrsubsequentfmt and sundry other helper 
   commands related to abbreviation styles.

1.16 (2017-06-15):

 * New key: seealso

 * New commands: \glsxtrseealsolabels, \glsxtrseelist,
   \glsxtrindexseealso, \glsxtruseseealso, 
   \glsxtrautoindexentry, \glsxtrautoindexassignsort,
   \glsxtrautoindex

 * New package option: autoseeindex 
   (autoseeindex=false requires at least glossaries v4.30)

 * Added xindy "seealso" cross-reference class to work with
   \glsxtrindexseealso (requires at least glossaries v4.30,
   otherwise behaves like \glssee).

 * Added example-glossaries-xr.tex which contains dummy entries
   with cross-references for use in test documents.

 * Fixed bug in \@gls@noidx@getgrouptitle

 * Fixed bug in \@print@unsrt@glossary

1.15 (2017-05-10):

 * Fixed typo in command name (\glsabbvfont -> \glsabbrvfont)

 * Deferred location expansion in \@glsxtr@dorecord

1.14 (2017-04-18):

 * New keys for \glsadd: thevalue and theHvalue

 * New key 'wrgloss' for \gls, \glstext etc and associated
   commands:
   \glsxtrinitwrgloss
   \ifglsxtrinitwrglossbefore
   \glsxtrinitwrglossbeforetrue
   \glsxtrinitwrglossbeforefalse

 * New command: \glsxtrlocationhyperlink

 * New attribute checks: externallocation, wrgloss

 * Bug fix: "incorrect alias target name when using \glshyperlink
   (and therefore also \glsseeformat)"
   http://www.dickimaw-books.com/cgi-bin/bugtracker.cgi?action=view&key=120

 * Bug fix: corrected assignment of \cGls in \glsenableentrycount
   and \glsenableentryunitcount

1.13 (2017-02-07):

 * Fixed bug in \glsdisp that caused an infinite loop.

 * Switched to \providecommand for \glsxtrsetaliasnoindex

1.12 (2017-02-03):

 * \longnewglossaryentry now has a starred version that
   doesn't suppress the post-description hook. The unstarred
   version now inserts \glsxtrpostlongdescription at the end
   of the description instead of the hard-coded
   \leavevmode\unskip\nopostdesc

 * Added option 'postdot' (shortcut for 'nopostdot=false')

 * Added 'alias' key to \newglossaryentry and associated command
   \glsxtralias

 * \printunsrtglossary now has a starred version.

 * New commands:

     \apptoglossarypreamble
     \pretoglossarypreamble
     \glsxtrprovidestoragekey
     \glsxtrfielduse
     \glsxtrifkeydefined
     \glsxtrfieldlistadd
     \glsxtrfieldlistgadd
     \glsxtrfieldlisteadd
     \glsxtrfieldlistxadd
     \glsxtrfielddolistloop
     \glsxtrfieldforlistloop
     \glsxtrfieldifinlist
     \glsxtrfieldxifinlist
     \glsxtrdisplaysingleloc
     \glsxtrdisplaystartloc
     \glsxtrdisplayendloc
     \glsxtrdisplayendlochook
     \glsxtrlocrangefmt
     \GlsXtrSetField
     \gGlsXtrSetField
     \eGlsXtrSetField
     \xGlsXtrSetField
     \GlsXtrLetField
     \csGlsXtrLetField
     \GlsXtrLetFieldToField
     \glsxtrdeffield
     \glsxtredeffield
     \glsxtrsetfieldifexists
     \GlsXtrRecordCounter
     \printunsrtglossaryunit
     \printunsrtglossaryunitsetup
     \glsxtrcopytoglossary
     \provideignoredglossary
     \glsxtrabbrvpluralsuffix
     \glsxtrfmt
     \glsxtrentryfmt
     \GlsXtrFmtField
     \GlsXtrFmtDefaultOptions

 * Added existence checks to \newignoredglossary

 * Modified \glsnoidxdisplayloc to check for range formations.

 * The record=only package option automatically implements
   indexcrossref=false

 * \glsxtrresourcefile sets the category code of @ to letter
   to allow internal commands within the location field.

 * \GlsXtrLoadResources can now be used multiple times. After
   the first instance "\jobname-<n>" is used as the argument
   to \glsxtrresourcefile.

 * New abbreviation styles: 

    long-postshort-user
    long-postshort-user-desc
    short-postlong-user
    short-postlong-user-desc

1.11 (2017-01-19):

 * \glsxtrresourcefile now enforces the file extension .glstex
   (This change is a security feature so there's no backward
    compatibility. If you have used this command from v1.08 
    you'll have to change the file name extension to continue 
    using it. Alternatively use \input or \loadglsentries instead.)

 * Extra information written to aux file by \glsxtrresourcefile

 * Added \GlsXtrLoadResources

 * New command: \glsxtrpageref (like glossary.sty's \glsrefentry
   but uses \pageref instead of \ref).

 * Added starred version of \newignoredglossary

 * Added support for attributes: targeturl, targetcategory
   and targetname.

1.10 (2016-12-17):

 * Fixed bug causing \GLS to behave like \GLSpl
   http://www.dickimaw-books.com/cgi-bin/bugtracker.cgi?action=view;key=117

1.09 (2016-12-16):

 * Fixed bug when using the optional argument of \makeglossaries

1.08 (2016-12-13):

 * Added record option

 * New commands: 

   - \glsxtrresourcefile
   - \printunsrtglossary
   - \printunsrtglossaries

 * Fixed bug that occurs with undefaction=warn and an
   undefined \glslabel in the post-link hook

1.07 (2016-08-15):

 * New commands \glsxtrp etc.

 * New command \glsxtrabbrvfootnote used by the footnote
   abbreviation styles (instead of hard-coding \footnote
   into the style).

 * Fixed bug in footnote styles that used \glsfirstlongfont
   instead of \glsfirstlongfootnotefont.

 * Fixed "first" and "firstplural" keys in the postfootnote
   style (was causing repeated footnotes).

 * Fixed "text" key in the long-short-desc and short-long-desc
   abbreviation styles, and fixed misspelling of \glsabbrvfont 
   in the "plural" key.

 * Fixed \glsfirst, \Glsfirst and \GLSfirst to ensure they
   honour the nohyperfirst attribute.

 * Fixed bug in \RestoreAcronyms
   www.dickimaw-books.com/cgi-bin/bugtracker.cgi?action=view&key=113

1.06 (2016-06-18):

 * Added docdefs=restricted (don't use .glsdefs file, document 
   definitions allowed provided they come before the glossary 
   in which they belong is displayed)

 * New command \glsxtrusesee

1.05 (2016-06-10):

 * Added \glsfirstlongfootnotefont and \glslongfootnotefont
   (Bug fix http://www.dickimaw-books.com/cgi-bin/bugtracker.cgi?action=view&key=110)

 * Bug fix in short-em-long style (corrected long form font command)

 * glossaries-extra-stylemods.sty: provided supplementary
   alttree commands.

1.04 (2016-05-02):

 * Added \GlsXtrEnablePreLocationTag

 * Added check for category \glsxtrpostname... in 
   \glxstrpostnamehook

 * Added new abbreviation styles:
    - long-short-user
    - long-short-user-desc
    - short-long-user
    - short-long-user-desc
   and their accompanying commands \glsxtruserfield, 
   \glsxtruserparen, \glsabbrvuserfont and \glsxtrusersuffix.

 * Added new abbreviation styles:
    - long-em-short-em
    - long-em-short-em-desc
    - short-em-long-em
    - short-em-long-em-desc
   and their accompanying commands \glsabbrvemfont and
   \glsfirstlongemfont

 * Fixed sort in long-short-desc abbreviation style.

 * Reorganised naming scheme of abbreviation styles.
   (Backward-compatible synonyms provided.)

 * Added \glsxtrregularfont

 * Added \glslongfont and \glslongdefaultfont

 * Added glossdescfont and glossnamefont attribute checks in
   \glossentryname, \Glossentryname and \glossentrydesc

 * Tidied up accessibility support

 * Modified \glstext, \glsfirst, \glsplural, \glsfirstplural
   (and case-changing variants) to set the abbreviation style
   if required.

1.03 (2016-04-27):

 * Fixed bug in \glsxtrtitleshortpl
   (www.dickimaw-books.com/cgi-bin/bugtracker.cgi?action=view&key=107)

 * Fixed bugs in \glsplural, \Glsplural, \GLSplural,
   \Glsfirstplural, \GLSfirstplural, \glsxtrtitlelongpl

1.02 (2016-04-25):

 * Added \ifglsxtrinsertinside

 * Added \glsfmtlong, \glsfmtlongpl, \Glsfmtlong, \Glsfmtlongpl,
   \glsfmtfull, \glsfmtfullpl, \Glsfmtfull, \Glsfmtfullpl

 * Added package glossaries-extra-stylemods.sty

1.01 (2016-02-02):

 * Added retainfirstuseperiod attribute

 * bug fix for "short-desc" style:
    fixed typo in \glsxtrinlinefullformat
    and added missing second argument

1.0 (2016-01-24 First stable release):

 * indexcrossrefs is now initially set to false but will 
   be automatically switched on if the "see" key is used.

0.5.4 (2015-12-15):

 * Modified \glsdohyperlink and \glsdonohyperlink to ameliorate
   the problems resulted from nested link-text.

 * Added per unit entry counting.

 * Modified \cglsformat etc to check for the regular attribute.

 * Added \GlsXtrEnableOnTheFly

 * Added \GlsXtrSetAltModifier and \GlsXtrSetDefaultGlsOpts

 * Added \glsxtrprotectlinks to deal with nested \gls etc.

 * Added \glsxtrpostunset, \glsxtrpostlocalunset,
   \glsxtrpostreset and \gslxtrpostlocalreset

 * Added checks for entry's existence in shortcut tests
   \glshasattribute and \glsifattribute and in 
   \glspostlinkhook

 * Added \glsxtrdowrglossaryhook

 * Added package option indexcrossrefs

 * Fixed \@newglossaryentryposthook so that it will add an empty
   see value if not set. Added "see" element to field map 
   \@gls@keymap.

 * Added redefinition of \@gls@setdefault@glslink@opts to
   set the default index value.

 * \MakeAcronymsAbbreviations now disables \setacronymstyle

0.5.3 (2015-12-08):

 * Fixed bug in "abbreviations" package option.

 * Added support for "indexname" and "dualindex" attributes
   with associated new commands.

 * Added provision for language modules (but none provided).

 * Removed \GlsXtrNoGlsWarningNoAutoMakeMain
   (identical to \GlsXtrNoGlsWarningEmptyMain)

 * Added check for \glsdescwidth and \glspagelistwidth and
   fixed adjustment for \glslistdottedwidth.

0.5.2 (2015-12-08):

 * Modified the "nonumberlist" key (\printglossary) so that
   it saves the number list.

 * Added \GlsXtrFormatLocationList

 * New command \GlsXtrEnableInitialTagging

 * Added \glsxtrfieldtitlecase

 * Modified \glossentrydesc to check for "glossdesc" attribute.

 * Modified \glossentryname to check for "glossname" attribute.

 * Fixed misspelt glossaries-accsupp (final letter was missing)
   in \@ifpackageloaded

 * Modified commands like \@glstext@ to use \glsaccess...
   instead of \glsentry... if glossaries-accsupp loaded.

 * Added:

   \GLSaccessname
   \GLSaccesstext
   \GLSaccessplural
   \GLSaccessfirst
   \GLSaccessfirstplural
   \GLSaccesssymbol
   \GLSaccesssymbolplural
   \GLSaccessdesc
   \GLSaccessdescplural
   \GLSaccessshort
   \GLSaccessshortpl
   \GLSaccesslong
   \glsaccesslongpl
   \Glsaccesslongpl
   \GLSaccesslongpl

 * Removed \glsxtrabbrvfmt and moved
   \glssetabbrvfmt{\glscategory{\glslabel}} to \glsentryfmt

 * Added check for post-definition style switch.

 * Added \glsxtrnewabbrevpresetkeyhook

0.5.1 (2015-12-07):

 * Removed \ifglsxtruseuchead
   Now implemented through the "headuc" attribute.
   Commands like \glsxtrheadshort modified to accommodate this.

 * Added:
   \Glsaccessname
   \Glsaccesstext
   \Glsaccessplural
   \Glsaccessfirst
   \Glsaccessfirstplural
   \Glsaccesssymbol
   \Glsaccesssymbolplural
   \Glsaccessdesc
   \Glsaccessdescplural

 * Abbreviation styles (non-regular) now switch off regular
   attribute if it has been set. (In case the style is
   switched for a given category, e.g the "acronym" category.)

0.5 (2015-12-07):

 * Renamed \glsentryfmtshort -> \glsfmtshort etc
   These now use new commands \glsxtrtitleshort and
   \glsxtrheadmarkshort etc to work better in page headers
   that convert to upper case.

 * Added new commands for use in section headings:
   \glsfmttext, \Glsfmttext, \glsfmtplural, \Glsfmtplural,
   \glsfmtfirst, \Glsfmtfirst, \glsfmtfirstpl,
   \Glsfmtfirstpl

 * New commands \glshascategoryattribute and \glshasattribute

 * Added \glsfirstabbrvdefaultfont and \glsfirstlongdefaultfont
   Styles now set \glsfirstabbrvfont and \glsfirstlongfont

 * \markright and \markboth redefined so that they use
   \glsxtrmarkhook (use \glsxtrRevertMarks to restore
   original definitions).

 * Redefined \glsenableentrycount and added 
   \glsxtrifcounttrigger (support for "entrycount" 
   attribute). Added \GlsXtrEnableEntryCounting

 * Changed default behaviour of commands like \cgls
   so they don't produce a warning if used without
   \glsenableentrycount. Instead a warning is triggered
   if \glsenableentrycount is used without setting
   the "entrycount" attribute.

 * Added \cGLS, \cGLSpl

 * \acronymfont and \firstacronymfont redefined to 
   use \glsabbrvfont and \glsfirstabbrvfont (switched back
   with \RestoreAcronyms).

 * New abbreviation styles: footnote-sc, postfootnote-sc,
   long-short-sm, long-short-sm-desc, short-sm-long,
   short-sm-long-desc, short-sm, short-sm-desc, short-desc,
   long-sm, long-desc-sm, footnote-sm, postfootnote-sm,
   long-short-em, long-short-em-desc, short-em-long,
   short-em-long-desc, short-em, short-em-desc, short-desc,
   long-em, long-desc-em, footnote-em, postfootnote-em.

 * New command \glsxtrsmfont for use in *-sm abbreviation
   styles and \glsxtrsmsuffix for the default short plural
   suffix.

 * New command \glsxtrscfont for use in *-sc abbreviation
   styles and \glsxtrscsuffix for the default short plural
   suffix.

0.4 (2015-12-03):

 * The "abbreviations" option redefines \acronymtype if
   the "acronym" option hasn't been used.

 * Redefinition of \newacronym sets the default type to
   \acronymtype

 * Added \glsxtrifemptyglossary

 * \glsxtrnewsymbol and \glsxtrnewnumber adjusted so that the
   name and label need to be supplied.

 * Fixed bug in \newterm

 * Changed \glsentryfmtshort etc to use \glsxtrshort etc

0.3 (2015-12-03):

 * Added \glsxtrNoGlossaryWarning and "nomissingglstext" option.

 * Added \glsshortpltok and \glslongpltok. Abbreviation styles
   now additionally set the first, firstplural and plural
   keys even if the regular attribute isn't set to true.
   (Allows the use of commands like \glsfirst, although 
    limitations apply.)

 * Added \glsxtrpostlinkAddDescOnFirstUse and
   \glsxtrpostlinkAddSymbolOnFirstUse

 * \glsentryfmt also checks for the presence of the short key.

 * Added support for insertdots attribute.

 * Added \glsxtrpostlinkendsentence

 * Added \glsxtrshortpl etc.

 * Renamed \abbrvdefaultfont -> \glsabbrvdefaultfont

 * Added abbreviation plural shortcuts.

 * Added glossaries-accsupp support.

 * Bug fix in long-short-desc and short-long-desc abbreviation
   styles
   - argument of \glsxtrfullformat should be \the\glslabeltok
     not \the\glsshorttok

 * Bug fix in *-sc abbreviation styles

0.2 (2015-11-30):

 * Name changes:

    \glsxtrlongfont -> \glsfirstlongfont
    \abbrvfont -> \glsabbrvfont
    \firstabbrvfont -> \glsfirstabbrvfont

 * "short" abbreviation style uses "short (long)"
   for the inline full style.

0.1 (2015-11-22): Initial experimental release.