summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex')
-rw-r--r--Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex29
1 files changed, 20 insertions, 9 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
index 1a2cac34955..d2680063891 100644
--- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
+++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
@@ -398,11 +398,11 @@ and~\hyperlink{option#2}{#2}}
\MakeShortVerb{"}
\DeleteShortVerb{\|}
- \title{User Manual for glossaries.sty v4.31}
+ \title{User Manual for glossaries.sty v4.32}
\author{Nicola L.C. Talbot\\%
\url{http://www.dickimaw-books.com/}}
- \date{2017-08-10}
+ \date{2017-08-24}
\maketitle
\begin{abstract}
@@ -480,7 +480,7 @@ package.
\item[\url{glossaries-code.pdf}]
Advanced users wishing to know more about the inner workings of all the
packages provided in the \styfmt{glossaries} bundle should read
-\qt{Documented Code for glossaries v4.31}.
+\qt{Documented Code for glossaries v4.32}.
\item[INSTALL] Installation instructions.
@@ -839,7 +839,7 @@ An overview of these three options is given in
Can have non-standard locations in the location lists? &
\yes & \no & \yes\\
Maximum hierarchical depth &
- Unlimited & 3 & Unlimited\\
+ Unlimited but unreliable & 3 & Unlimited\\
\ics{glsdisplaynumberlist} reliable? &
\yes & \no & \no\\
\ics{newglossaryentry} restricted to preamble? &
@@ -2528,7 +2528,7 @@ package. Options that aren't \meta{key}=\meta{value} (such as
the \styfmt{glossaries} package. Don't use this option if you're new to using
\styfmt{glossaries} as the warnings are designed to help detect
common mistakes (such as forgetting to use \ics{makeglossaries}).
-Note that the \pkgopt[true]{debug} will override this option.
+Note that the \pkgopt[true]{debug} and \pkgopt[showtargets]{debug} will override this option.
\item[\pkgopt{noredefwarn}] If you load \styfmt{glossaries} with
a~class or another package that already defines glossary related
@@ -2539,10 +2539,21 @@ want to be warned about it, use this option to suppress those
warnings. Other warnings will still be issued unless you use the
\pkgopt{nowarn} option described above.
-\item[\pkgopt{debug}] Introduced in version 4.24, this boolean
-option switches on the debug mode. Note that the debug mode will automatically
-cancel the \pkgopt{nowarn} option. Consider the following example
-document:
+\item[\pkgopt{debug}] Introduced in version 4.24.
+This was a boolean option but as from v4.32 it's now a choice
+option. If no value is given, \pkgopt[true]{debug} is assumed.
+Both \pkgopt[true]{debug} and \pkgopt[showtargets]{debug}
+switch on the debug mode (and will automatically
+cancel the \pkgopt{nowarn} option). The \pkgopt[showtargets]{debug}
+option will additionally use
+\begin{definition}[\DescribeMacro\glsshowtarget]
+\cs{glsshowtarget}\marg{target name}
+\end{definition}
+to show the hypertarget\slash hyperlink name in the margin when
+\cs{glsdohypertarget} is used by commands like \cs{glstarget}
+and when \cs{glsdohyperlink} is used by commands like \cs{gls}.
+
+Consider the following example document:
\begin{verbatim}
\documentclass{article}
\usepackage{glossaries}