Latest news 2019-11-04: The giveaway of two signed copies of “Quack, quack, quack. Give my hat back!” has closed and the winning entrants have been selected. Thank you to everyone who took part.

bib2gls application FAQ

FAQ Search Tips

An indexing application designed for use with the glossaries-extra package. Related resources: gallery, home page and GitHub repository.

General Queries

What version of Java is required? 🔗

At least Java 8. Earlier versions don't have the required sort method.

Last modified: 2019-03-31 13:45:25.

Top

Sorting

How do I sort by group? 🔗

You don't (usually). The group field is an internal field that's designed to be set by bib2gls. When you invoke bib2gls with the --group switch, most of the sort methods will assign the group field as a by-product of sorting.

It is possible to assign a custom value to the group field, but if you do this you must ensure that the entries are ordered in such a way that the groups aren't broken up. This is typically done by separating the glossary into logical blocks through the use of multiple instances of \GlsXtrLoadResources with the group option set.

Technically it is possible to change the field used for sorting to group but the value of the group field must always be a label. The corresponding title is set in the document where it's not visible to bib2gls. This means that at most you can only sort by the label not by the title.

If you find yourself wanting to order by group then that's a strong indication that you have a hierarchical glossary and you should be using the parent field instead. You just need to find an appropriate glossary style.

Compare, for example, sample-textsymbols.tex and sample-textsymbols2.tex, both of which use miscsymbols.bib. The first case sorts by the group label and sets the sort suffix to the description field. The second case uses a hierarchical approach that sorts the topic (top-level @index and @indexplural entries) by name and sorts the symbols by their description. The second method is the simpler and better approach that will work with non-English languages.

See also Logical Glossary Divisions (type vs group vs parent).

Last modified: 2019-04-09 16:18:25.

Top

Why doesn't symbol-sort-fallback work? 🔗

The symbol-sort-fallback option identifies the fallback field to use if the sort field is missing. If the sort field is set then the fallback value isn't needed. Similarly, if the sort field is never needed (for example, the field used for sorting is changed with sort-field) then the fallback value will never be needed. So if the symbol-sort-fallback option doesn't seem to be working check that you haven't set the sort field in the .bib file and check that you haven't switched to a different field for sorting.

Last modified: 2019-04-01 07:22:11.

Top

Warnings

What does the warning "Found internal non bib-field" mean? 🔗

The full warning is:

Warning: Found internal non bib-field 'field' in '.bib' file for entry 'label'. Unexpected results may occur.

There are some keys, such as group and location, that are defined by the glossaries-extra package for use when manually creating your glossaries (with \printunsrtglossaries and without any external tool). However, bib2gls considers these fields as internal fields where the values are assigned according to the resource options or command line switches. If you set them manually, you will override bib2gls's normal behaviour, which can cause unexpected results. Since this takes some users by surprise, as from version 1.9, bib2gls warns if these fields are found in the .bib file.

If you get this warning, check the field in the tables in section 4.3 ("Fields") of the bib2gls manual. If you are absolutely sure you know what you are doing then you can disable this warning.

If you're trying to use the 'group' field, see Logical Divisions (type vs group vs parent).

Last modified: 2019-04-09 16:23:52.

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