summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.tex')
-rw-r--r--Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.tex66
1 files changed, 48 insertions, 18 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.tex b/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.tex
index 93908891dfa..27450659b73 100644
--- a/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.tex
+++ b/Master/texmf-dist/doc/latex/glossaries-extra/glossaries-extra-manual.tex
@@ -226,13 +226,13 @@ styles (glossaries):>#1={\protect\ttfamily#1}|main}}
\DeleteShortVerb{\|}
\MakeShortVerb{"}
- \title{glossaries-extra.sty v1.33:
+ \title{glossaries-extra.sty v1.34:
an extension to the glossaries package}
\author{Nicola L.C. Talbot\\[10pt]
Dickimaw Books\\
\url{http://www.dickimaw-books.com/}}
- \date{2018-07-26}
+ \date{2018-07-29}
\maketitle
\begin{abstract}
@@ -656,8 +656,11 @@ over a glossary list. This includes \ics{forglsentries} and
\ics{glsaddall}.
\end{important}
-Note that \ics{ifglsused} will just display ?? with
-\pkgopt[warn]{undefaction} if the entry hasn't been defined.
+Note that \ics{ifglsused} will display ?? in the document text with
+\pkgopt[warn]{undefaction} if the entry hasn't been defined, as the
+underlying boolean variable doesn't exist and so is neither true nor
+false. (There will also be a warning in the transcript.) See
+\sectionref{sec:glsunset} for further details.
\item[{\pkgoptdef{indexcrossrefs}}] This is a boolean option.
If \pkgoptfmt{true}, this will automatically index any
@@ -863,7 +866,7 @@ See the \gls{bib2gls} documentation for the
\item[{\pkgoptdef{docdef}}] This option governs the use of
\cs{newglossaryentry}. It was originally a boolean option,
-but as from version 1.06, it can now take one of three values (if
+but as from version 1.06, it can now take one of the following values (if
the value is omitted, \pkgoptfmt{true} is assumed):
\begin{itemize}
\item[{\pkgopt[false]{docdef}}] \ics{newglossaryentry} is not
@@ -912,6 +915,18 @@ document and either remove an entry or change its label, you may
need to delete the document's temporary files (such as the
\texttt{.aux} and \texttt{.gls} files).
+\item[{\pkgopt[atom]{docdef}}] (new to version 1.34)
+This option behaves like \pkgopt[restricted]{docdef} but creates the
+\texttt{.glsdefs} file for
+\href{https://atom.io/packages/autocomplete-glossaries}{atom's
+autocomplete support}. This file isn't input by
+\styfmt{glossaries-extra} and so associated problems with the use of
+this file are avoided, but it allows the autocomplete support to
+find the labels in the file. As with \pkgopt[restricted]{docdef},
+entries may be defined in the preamble or anywhere in the document,
+but they may only be referenced after they have been defined.
+Entries must be defined before the associated glossary is displayed.
+
\end{itemize}
The \styfmt{glossaries} package allows
@@ -937,7 +952,8 @@ the \qt{on-the-fly} commands described in \sectionref{sec:onthefly}.
\end{sloppypar}
\item[{\pkgoptdef{nomissingglstext}}] This is a boolean option.
-If true, this will suppress the warning text that will appear in the
+If true, this will suppress the warning written to the transcript
+and the warning text that will appear in the
document if the external glossary files haven't been generated due
to an incomplete document build. However, it's probably simpler
just to fix whatever has caused the failure to build the external
@@ -1831,7 +1847,7 @@ or, as from v1.31, you can use
\end{definition}
This is simply a shortcut for:
\begin{alltt}
-\cs{csdef}{glsxtrpostlink\meta{category}}\marg{definition}
+\cs{csdef}\{glsxtrpostlink\meta{category}\}\marg{definition}
\end{alltt}
Note that it doesn't check if the command has already been defined.
@@ -2088,15 +2104,29 @@ The \styfmt{glossaries} package provides
\ics{ifglsused}\marg{label}\marg{true}\marg{false}
\end{definition}
to determine whether or not an entry has been used. This requires
-the entry to have been defined. To allow for
-\pkgopt[warn]{undefaction} (which is automatically switched on with
-the \pkgopt{record} option), the \styfmt{glossaries-extra} package
-redefines this command to allow for this setting. In the event that
-this setting is on and \meta{label} is undefined, then neither
-\meta{true} nor \meta{false} is done and ?? is displayed in the text
-(with a warning in the transcript). This has the knock-on effect of
-providing a more understandable error message with the default setting
-if the entry is undefined.
+the entry to have been defined. If the entry is undefined, then the
+underlying boolean variable doesn't exist and so is neither true
+nor false. This command will produce an error with the default
+\pkgopt[error]{undefaction} mode and a warning with
+\pkgopt[warn]{undefaction} and, where appropriate, displays ?? in
+the document text to denote an undefined reference. With both modes,
+neither \meta{true} nor \meta{false} will be performed if
+\meta{label} doesn't exist.
+
+The \pkgopt{record} option automatically implements
+\pkgopt[warn]{undefaction} since no entries will be defined until
+they have been selected by \gls{bib2gls}. In this case, you
+may prefer to use:
+\begin{definition}[\DescribeMacro\GlsXtrIfUnusedOrUndefined]
+\cs{GlsXtrIfUnusedOrUndefined}\marg{label}\marg{true}\marg{false}
+\end{definition}
+(new to v1.34) which does \meta{true} if the entry given by
+\meta{label} is undefined or if the entry is marked as unused.
+Remember that neither \cs{ifglsused} nor
+\cs{GlsXtrIfUnusedOrUndefined} should be used in the post-link
+hook as the \gls{firstuseflag} will have already been unset
+before the hook is performed. (Instead, \ics{glsxtrifwasfirstuse}
+should be used, see \sectionref{sec:entryfmtmods}.)
There are two new commands provided with version 1.31+:
\begin{definition}[\DescribeMacro\glslocalreseteach]
@@ -3209,7 +3239,7 @@ For convenience, as from v1.31, you can use
\end{definition}
This is simply a shortcut for:
\begin{alltt}
-\cs{csdef}{glsxtrpostname\meta{category}}\marg{definition}
+\cs{csdef}\{glsxtrpostname\meta{category}\}\marg{definition}
\end{alltt}
Note that it doesn't check if the command has already been defined.
@@ -3242,7 +3272,7 @@ For convenience, as from v1.31, you can use
\end{definition}
This is simply a shortcut for:
\begin{alltt}
-\cs{csdef}{glsxtrpostdesc\meta{category}}\marg{definition}
+\cs{csdef}\{glsxtrpostdesc\meta{category}\}\marg{definition}
\end{alltt}
Note that it doesn't check if the command has already been defined.