[book cover]
Latest news 2019-10-04: Competition to win a copy of the children’s illustrated book “Quack, Quack, Quack. Give My Hat Back!”. Closing date: 1st Nov 2019 23:59 +00:00.

glossaries-extra package FAQ

FAQ Search Tips

This is the FAQ for the glossaries-extra package. See also the FAQ for the glossaries package, the glossaries-extra user manual, and glossaries-extra and bib2gls: An Introductory Guide.

\glsxtrshort, \glsxtrlong and \glsxtrfull (and their case variants) aren't indexing 🔗

This bug was fixed in version 1.30. For older versions you will need at least one instance of \gls.

Regardless of version, if you're not using any instances of \gls for that abbreviation then you should consider using one of the long-noshort or short-nolong or long-only-short-only styles for that entry's category. This is better from a coding point of view, as it will make it easier to change the style later if necessary, and, from a typing point of view, \gls is also shorter than \glsxtrshort etc (and \ac is shorter than \acl etc). If you need the full form for an instance other than first use but the short form elsewhere, then use the short-nolong style and use \glsxtrfull for the specific instance (unless it's in a caption or section title, in which case use \glsfmtfull)

Last modified: 2018-05-12 06:55:22.

Top

\glsaddall and \glsaddallunused don't work with bib2gls 🔗

If you need to include all entries provided in the .bib file(s), regardless of whether they've been indexed in the document, then you must use the selection=all resource option not \glsaddall or \glsaddallunused. These iterative commands can't work with bib2gls because they iterate over all defined entries but the entries can't be defined until they've been selected. The selection=all option works better than either of those commands as it doesn't cause an unwanted location.

Last modified: 2018-05-12 07:03:15.

Top

The abbreviation style isn't correct 🔗

Make sure you set the abbreviation style before the relevant \GlsXtrLoadResources. Also check the abbreviation definition in the .glstex file. Has the category field been set? Does the helper command provided to define the abbreviation (such as \bibglsnewabbreviation) set the category field? Check that the category matches the optional argument of \setabbreviationstyle. Remember that spaces are significant (including those created by the end of line character) and should be stripped from the category label.

Last modified: 2018-05-12 07:10:02.

Top

\printglossary doesn't work with bib2gls 🔗

\printglossary (and the iterative \printglossaries) is designed to work with makeindex and xindy. If you're using bib2gls you need to use \printunsrtglossary (or the iterative \printunsrtglossaries) instead.

In the rare event that you need to use bib2gls to select entries from the .bib files but need to use xindy to sort and collate (because of some custom xindy rule that can't be implemented by bib2gls) then you need to use the record=alsoindex package option which should allow \printglossary to work.

Last modified: 2018-05-12 07:17:42.

Top

The glossary listing order is incorrect 🔗

Open the .glstex file in a text editor and check the value of the sort field. This is the value used for the sort comparisons. (Special characters are marked up using commands like \glspercentchar. These were the actual character when bib2gls sorted the entries, but were replaced in order to write the sort value to the .glstex file without causing a syntax error when LaTeX parses it.)

If you have multiple .glstex files, these will form sorted sub-blocks.

Last modified: 2018-05-12 07:35:02.

Top

Glossary Styles

Error caused by \glslongextraNameFmt 🔗

This bug was in glossary-longextra.sty v1.37 and is fixed in v1.38. If you have v1.37, it can be patched with:

\renewcommand{\glslongextraNameFmt}[1]{%
 \glsentryitem{#1}\glstarget{#1}{\glossentryname{#1}}%
}

Last modified: 2018-12-01 08:00:58.

Top

© 2019 Dickimaw Books. "Dickimaw", "Dickimaw Books" and the Dickimaw parrot logo are trademarks. The Dickimaw parrot was painted by Magdalene Pritchett.

Terms of Use Privacy Policy Cookies Site Map FAQs