summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/glossaries/glossaries-user.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/glossaries/glossaries-user.tex')
-rw-r--r--macros/latex/contrib/glossaries/glossaries-user.tex67
1 files changed, 58 insertions, 9 deletions
diff --git a/macros/latex/contrib/glossaries/glossaries-user.tex b/macros/latex/contrib/glossaries/glossaries-user.tex
index 58ec44fb6e..8b39cc03f2 100644
--- a/macros/latex/contrib/glossaries/glossaries-user.tex
+++ b/macros/latex/contrib/glossaries/glossaries-user.tex
@@ -407,6 +407,9 @@ Predefined Styles}}
% example-glossaries-brief.tex
\gfile{example\dhyphen glossaries\dhyphen brief.tex}%
{\providedby{\sty{glossaries} v4.33+}}%
+ % example-glossaries-utf8.tex
+ \gfile{example\dhyphen glossaries\dhyphen utf8.tex}%
+ {\providedby{\sty{glossaries} v4.53+}}%
% example-glossaries-parent.tex
\gfile{example\dhyphen glossaries\dhyphen parent.tex}%
{\providedby{\sty{glossaries} v4.33+}}%
@@ -5450,7 +5453,25 @@ cs}\margm{\gls{glspl}-like cs}\margm{\gls{Gls}-like cs}\margm{\gls{Glspl}-like c
\syntax{\oargm{glossary-label}\margm{group-label}\margm{group-title}}
\desc{used to create a hyper target for a \idx{group} in order
to support styles that have navigation links to glossary
- \idxpl{group}}
+ \idxpl{group}. Note that if you only want to change the way that
+ the target is created, redefine \gls{glsnavhypergroupdotarget}
+ instead}
+ }
+ % \glsnavhypergroupdotarget
+ \gcmd{gls\-nav\-hyper\-group\-do\-target}
+ {
+ \providedby{\sty{glossary-hypernav} v4.53+}
+ \syntax{\margm{glossary-label}\margm{group-label}\margm{group-title}}
+ \desc{used by \gls{glsnavhypertarget} to create the hypertarget
+for the given group}
+ }
+ % \glsnavigationitem
+ \gcmd{gls\-navigation\-item}
+ {
+ \providedby{\sty{glossary-hypernav} v4.53+}
+ \syntax{\margm{group-label}}
+ \desc{used by \gls{glsnavigation} to create the hyperlink
+for the given group (with the title corresponding to the group label)}
}
% \glsnavigation
\gcmd{gls\-navigation}
@@ -11481,11 +11502,11 @@ formats}
{\begin{information}[title={\app{bib2gls}}]}
{\end{information}}
-\title{User Manual for glossaries.sty v4.52}
+\title{User Manual for glossaries.sty v4.53}
\author{Nicola L.C. Talbot\\%
\href{http://www.dickimaw-books.com/contact}{\nolinkurl{dickimaw-books.com/contact}}}
-\date{2022-11-03}
+\date{2023-09-29}
\begin{document}
\maketitle
@@ -11569,7 +11590,7 @@ package.
\begin{itemdesc}
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.52}.
+\qt{Documented Code for glossaries v4.53}.
\end{itemdesc}
\itemtitle{\url{CHANGES}}
@@ -11960,6 +11981,14 @@ documents that illustrate the various functions. These are listed in
The following rollback releases are available:
\begin{itemize}
+\item Version 4.52 (2022-11-03):
+\begin{codebox}
+\cmd{usepackage}\marg{glossaries}\oarg{=v4.52}
+\end{codebox}
+This is the last version that uses an internal comma-separated list
+for the hyper group information in \sty{glossary-hypernav}. Version
+4.53 has switched to using a sequence.
+
\item Version 4.49 (2021-11-01):
\begin{codebox}
\cmd{usepackage}\marg{glossaries}\oarg{=v4.49}
@@ -13542,6 +13571,11 @@ These entries all have brief descriptions. For example:
\gls{newglossaryentry}\marg{lorem}\marg{\gloskeyval{name}{lorem},\gloskeyval{description}{ipsum}}
\end{codebox}
+\filedef{example-glossaries-utf8.tex}
+This file is based on \file{example-glossaries-brief.tex} but random
+characters have been converted to accented characters to test
+\idx{utf8} support.
+
\filedef{example-glossaries-long.tex}
These entries all have long descriptions. For example:
\begin{codebox}
@@ -14606,7 +14640,7 @@ Perl. There's more information about this at
\begin{important}
When upgrading the \sty{glossaries} package, make sure you also
upgrade your version of \app{makeglossaries}. The current version is
-4.51.
+4.53.
\end{important}
Some of the options are only applicable to \app{makeindex} and some
@@ -21133,16 +21167,15 @@ The predefined styles adjust \gls+{acrfull} and
reflect the style.
\end{important}
-When \idxpl{acronym} are defined, \gls{newacronym} will set the \gloskey{sort} key to:
-\cmddef{acronymsort}
+When \idxpl{acronym} are defined, \gls{newacronym} will set the
+\gloskey{sort} key to \gls{acronymsort}.
The \idxpl{acronymstyle} redefine this to suit the style. This
command must fully expand in order for the \idx{indexingapp} to pick
up the correct sort value.
If the \gloskey{sort} key is set in the optional argument of
\gls{newacronym}, it will override this.
-The \gloskey{name} key is set to:
-\cmddef{acronymentry}
+The \gloskey{name} key is set to \gls{acronymentry}.
Again, the \idxpl{acronymstyle} redefine this to suit the style.
If the \gloskey{name} key is set in the optional argument of
\gls{newacronym}, it will override this.
@@ -26931,6 +26964,11 @@ target in the header:
}
\end{compactcodebox}
+\cmddef{glsnavhypergroupdotarget}
+This is used by \gls{glsnavhypertarget} to create the actual \idx{hyperlink}
+target. So if you need to change the way that the target is created,
+redefine this command rather than \gls{glsnavhypertarget}.
+
\cmddef{glsnavhyperlink}
Creates a \idx{hyperlink} to the given \idx{group}, where the
target name is obtained from:
@@ -26940,10 +26978,21 @@ The \meta{glossary-label} argument is the label that identifies the
Typically, styles don't need to explicitly use this command as they
can use the following command instead.
+\begin{information}
+Version 4.53 has switched from using an internal comma-separated
+list to a sequence command. If you have hacked the internal commands
+you will need to either rollback to v4.52 or switch to the newer
+commands.
+\end{information}
+
\cmddef{glsnavigation}
Displays a simple navigation list, where each item in the list has a
\idx{hyperlink} created with \gls{glsnavhyperlink} to a \idx{group},
where the \idx{group} title is obtained with \gls{glsgetgrouptitle}.
+Each item in the list has the title and hyperlink set with:
+\cmddef{glsnavigationitem}
+This fetches the corresponding group title and creates a hyperlink
+with \gls{glsnavhyperlink}.
The items are separated with:
\cmddef{glshypernavsep}
The default definition is \code{\gls{space}\gls{textbar}\gls{space}}