The
The
Since
The
makeglossariesgui
[options] [filename]
The filename must be supplied when run in batch mode
(the
Available options:
-b
)-n
)-v
)-h
)
When run in batch mode,
A file can be loaded from the command line invocation
(see ) or in the
Suppose you have the following document (called, say,
\documentclass{article} \usepackage{glossaries} \makeglossaries \newglossaryentry{sample}{name={sample}, description={an example}} \begin{document} A \gls{sample} document. \printglossaries \end{document}
First run
Once
In this example, only one entry has been indexed in the
Since only one entry has been used, there's only one row. The first column lists the entry's label, the second column lists the entry's sort field and the third column shows the number of times that entry was indexed in the document. If you have a long list of entries, you can use the search box to find an entry according to its label. (The sort column isn't searched.) Regular expressions are permitted.
The tab
() provides information, warnings
and suggestions. In this example, there are no errors detected, so it
just provides suggestions and some links on how to incorporate
If you have defined an entry in your document, but it's not listed in
the details window for the relevant glossary, then it hasn't been indexed
in your document. Remember that the commands described in section
If you're using the
Now let's consider the following document (called, say,
\documentclass{article} \usepackage[utf8]{inputenc} \usepackage[xindy]{glossaries} \makeglossaries \newglossaryentry{S}{name={\S}, description={section symbol}} \newglossaryentry{alpha}{name={\ensuremath{\alpha}}, description={alpha}} \newglossaryentry{beta}{name={$\beta$},text={\beta}, description={beta}} \begin{document} Test: \gls{S}, $\gls{alpha}$, $\gls{beta}$. \printglossaries \end{document}
As before, run
Would replace complete index key with empty string, ignoring
and the
index 0 should be less than the length of the string
Again the entries are ignored, but the message is fairly cryptic.
If we load the auxiliary file (
Xindy has ignored one or more entries with empty sort strings. Xindy failed with exit code 1.
Once this error message has been dismissed, the
tab
should automatically be selected (see ).
This identifies the problem entries and recommends a solution, in this case,
add the
In the panel, the
Spot what's wrong with the following document:
\documentclass{article} \usepackage{glossaries} \makeglossaries \newglossaryentry{sample}{name={sample}, description={an example}} \begin{document} A \gls{sample} document. \printglossary[type=acronym] \end{document}
If you use the normal method of
\usepackage{glossaries}
to
\usepackage{glossaries-extra}
then we do finally get an error:
! Package glossaries-extra Error: Glossary typeacronym doesn't exist.
The
No glossaryacronym .
and the diagnostics panel will show the message:
It looks as though you might have done something like, but there's no
[type= acronym ]acronym glossary.
If you switch to the panel,
the labels for the glossaries defined in the document are
listed next to
Remember that you not only have to define your entries, but you also
have to index them if you want them to appear in the glossary. The
In the sample document below, I've defined an entry but it hasn't been indexed anywhere in the document.
\documentclass{article} \usepackage{glossaries} \makeglossaries \newglossaryentry{sample}{name={sample}, description={an example}} \begin{document} A sample document. \printglossaries \end{document}
My first step, as usual, is to run
No entries were found for glossarymain .
The diagnostics panel shows the following message:
There were no entries listed for themain glossary. Remember that you must index entries for them to appear in the glossary using the commands provided by the glossaries package. Entries that have been defined but not indexed won't be listed. If you don't want to use this glossary, add thenomain package option to your document. Check the following:
- Have you used commands like
or in the document? (If you haven't, you need to add them.) - If you have used commands like
or in the preamble, have you remembered to put them after - If you have at least version 4.24 of the glossaries package, have you used the debug option? (That might provide some more information for me to analyse.)
(The sentence referencing
Remember that if you use
Consider the following document:
\documentclass{article} \usepackage{glossaries} \makenoidxglossaries \newglossaryentry{sample}{name={sample}, description={an example}} \begin{document} A \gls{sample} document. \printnoidxglossaries \end{document}
If I load the
It seems you've used, which means you don't need xindy or makeindex, you just need a second LaTeX run to get the glossary up to date.
Note that
\documentclass{article} \usepackage{glossaries} \makenoidxglossaries \newglossaryentry{sample}{name={sample}, description={an example}} \begin{document} A \gls{sample} document. \printnoidxglossary[type=acronym] \end{document}
This provides some additional information in the diagnostics panel:
Package glossaries Warning: Empty glossary for
Rerun may be required (or you may have forgotten to use commands like
[type= acronym ]) on input line 13. It looks as though you might have done something like
, but there's no
[type= acronym ]acronym glossary.
So
Note that
In this example I've omitted
\documentclass{article} \usepackage{glossaries} \makeglossaries \newglossaryentry{sample}{name={sample}, description={an example}} \begin{document} A \gls{sample} document. \end{document}
This doesn't cause any problems for
Package glossaries Warning: Noor found. (Remove if you don't want any glossaries.) This document will not have a glossary.
If you suppress these warnings then
Sometimes things can go so badly wrong that
Consider the following document:
\batchmode \documentclass{beamer} \usepackage{glossaries} \makeglossaries \newglossaryentry{sample}{name=sample,first={\textit{sample}}, description={an example}} \begin{document} \begin{frame} \gls{sample} \end{frame} \begin{frame} \printglossary \end{frame} \end{document}
This document goes badly wrong. The first error message is:
! Undefined control sequence. \in@ #1#2->\begingroup \def \in@@
If I load the log file into
Since the aux file doesn't exist, there's not much I can do to help, but I'll parse the log file in case there are any clues there.
It's possible that there's an expansion issue involving a fragile command. Things to check for:
- Have you used a class like
beamer that doesn't make common formatting commands likerobust? - Have you tried using
in front of fragile commands contained within your entry definitions? - Have you tried switching off the expansion using commands like
? (See section 4.6 Expansion in the glossaries user manual.)
The problem here is that a fragile command has been used in the entry
definition. The problematic command in this example is
\documentclass{beamer} \usepackage{glossaries} \makeglossaries \glsnoexpandfields \newglossaryentry{sample}{name=sample,first={\textit{sample}}, description={an example}} \begin{document} \begin{frame} \gls{sample} \end{frame} \begin{frame} \printglossary \end{frame} \end{document}
The main panel shows the character encoding that
Consider the following example:
\documentclass{article} \usepackage[T1]{fontenc} \usepackage[utf8]{inputenc} \usepackage[style=indexgroup]{glossaries} \makeglossaries \newglossaryentry{elite}{name={élite},description={select group}} \begin{document} \gls{elite} \printglossary \end{document}
This document is saved as UTF-8 and has a term where the sort
value starts with an extended character. This doesn't work as
The first message in the diagnostics panel (see
) is only picked up after you
rerun
There seems to be a problem with the letter group label Ã. The label is used to construct a command name, so it can't contain any special characters. (This includes extended characters if you're using inputenc.sty.)
l.3 \glsgroupheading{Ã}You may want to consider using xindy with a LaTeX engine that has native Unicode support (XeLaTeX or LuaLaTeX) or use bib2gls instead.
This message doesn't show up when you first attempt to create
the glossary files with
The indexer encodingISO-8859-1 doesn't seem to match the document encoding (utf8). This may not be a problem if you aren't using extended characters in the sort values.
In this case it is a problem. The two different encodings are also shown in . The indexer encoding is listed as ISO-8859-1, and the document encoding is listed as utf8.
The problem shows up more clearly in the
The application settings can be adjusted through the
menu. This has menu items for increasing or decreasing the font size ( or ), setting the dry run mode () or open the dialog window (). Note that the dry run mode is the only setting that isn't remembered the next time you runThe dialog has four tabs: , , and .
The () tab allows you to select the directory to use on start up. This is the directory the file chooser will be set to initially.
There's also a check to see if the
The tab lists the paths to
The font used in the and panels can be set in the tab. In addition to adjusting the font size through the
or menu items, you can also set the required font size in this tab.
The