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.tex70
1 files changed, 64 insertions, 6 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 bb471d80816..674b7047221 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
@@ -225,13 +225,13 @@ styles (glossaries):>#1={\protect\ttfamily#1}|main}}
\DeleteShortVerb{\|}
\MakeShortVerb{"}
- \title{glossaries-extra.sty v1.40:
+ \title{glossaries-extra.sty v1.41:
an extension to the glossaries package}
\author{Nicola L.C. Talbot\\[10pt]
Dickimaw Books\\
\url{http://www.dickimaw-books.com/}}
- \date{2019-03-31}
+ \date{2019-04-09}
\maketitle
\begin{abstract}
@@ -4079,13 +4079,19 @@ If a widest name was set for the given level, this will
put \meta{text} inside a box of that width otherwise it just does
\meta{text}.
-This is followed by the symbol in parentheses if set, then
-the description and post-description hook, and finally the location
-list is displayed using:
+This is followed by the symbol in parentheses if set. Then, if the
+description is set, the description and post-description hook are
+displayed followed by:
+\begin{definition}[\DescribeMacro\glstopicSubPreLocSep]
+\cs{glstopicSubPreLocSep}
+\end{definition}
+(This command isn't used if the description isn't set.)
+
+Finally the location list is displayed using:
\begin{definition}[\DescribeMacro\glstopicSubLoc]
\cs{glstopicSubLoc}\marg{label}\marg{location}
\end{definition}
-which just does a space followed by \meta{location} by default.
+which just does \meta{location} by default.
\section{Glossary Style Modifications}
\label{sec:glosstylemods}
@@ -4398,6 +4404,15 @@ it's set at the start of the document (if it hasn't been changed in
the preamble). This should take into account situations where
\cs{hsize} isn't set until the start of the document.
+The separator between groups (if not \pkgopt{nogroupskip}) is now
+given by:
+\begin{definition}[\DescribeMacro\glslistgroupskip]
+\cs{glslistgroupskip}
+\end{definition}
+This defaults to \cs{indexspace} with penalties to deter page
+breaks.
+This command isn't used if \pkgopt{nogroupskip} is set.
+
The \sty{glossary-tree} package introduced two new commands in
\sty{glossaries} version 4.22, \ics{glstreegroupheaderfmt}
and \ics{glstreenavigationfmt}, which are used to format
@@ -4423,6 +4438,34 @@ all three to use a particular style you only need to redefine
\cs{glstreenamefmt} without affecting the other two commands, then
you now can.
+The separator between groups (if not \pkgopt{nogroupskip}) is now
+given by:
+\begin{definition}[\DescribeMacro\glstreegroupskip]
+\cs{glstreegroupskip}
+\end{definition}
+This defaults to \cs{indexspace} with penalties to deter page
+breaks.
+This command isn't used if \pkgopt{nogroupskip} is set (except for
+the styles that display the group titles).
+
+The styles that display the group titles now use:
+\begin{definition}[\DescribeMacro\glstreePreHeader]
+\cs{glstreePreHeader}\marg{label}\marg{title}
+\end{definition}
+where \meta{label} is the group label and \meta{title} is the group
+title. This does nothing by default
+and is inserted before the group title. You can redefine it to add
+the group title to the PDF bookmarks. For example, if the
+glossary title uses \cs{chapter} then:
+\begin{verbatim}
+\renewcommand{\glstreePreHeader}[2]{%
+ \pdfbookmark[1]{#2}{\currentglossary.#1}%
+}
+\end{verbatim}
+will insert section-level bookmarks. The use of \cs{currentglossary}
+helps to provide unique bookmark labels in the event of multiple
+glossaries.
+
The \glostyle{index}-like and \glostyle{tree}-like styles
insert the pre-\gls{numberlist} space with
\begin{definition}[\DescribeMacro\glstreeprelocation]
@@ -4472,6 +4515,21 @@ for the description and
\end{definition}
for the symbol.
+As from version 1.41, there are now wrapper commands for
+\cs{glstreedesc} and \cs{glstreechilddesc} that check for
+the description and symbol to determine whether or not to insert a
+space (\cs{glstreeprelocation} or \cs{glstreechildprelocation})
+before the page list. These are:
+\begin{definition}[\DescribeMacro\glstreeDescLoc]
+\cs{glstreeDescLoc}\marg{label}\marg{location}
+\end{definition}
+for top-level entries and
+\begin{definition}[\DescribeMacro\glstreeChildDescLoc]
+\cs{glstreeChildDescLoc}\marg{label}\marg{location}
+\end{definition}
+for sub-entries. This prevents a spurious space for terms that don't
+have a symbol or description but do have a location list (for
+example, aliases).
As from version 1.05, the \styfmt{glossaries-extra-stylemods}
package provides some additional commands for use with the