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.tex51
1 files changed, 34 insertions, 17 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
index 33663add251..d2018e1cf28 100644
--- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
+++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
@@ -447,11 +447,11 @@ and~\hyperlink{option#2}{#2}}
\MakeShortVerb{"}
\DeleteShortVerb{\|}
- \title{User Manual for glossaries.sty v4.33}
+ \title{User Manual for glossaries.sty v4.34}
\author{Nicola L.C. Talbot\\%
\url{http://www.dickimaw-books.com/}}
- \date{2017-09-20}
+ \date{2017-11-03}
\maketitle
\begin{abstract}
@@ -461,7 +461,7 @@ Sorted lists with collated \glslink{entrylocation}{locations} can be
generated either using \TeX\ or using a supplementary \gls{indexingapp}.
Additional features not provided here may be available through
-the supplemental package \gls{glossaries-extra} which, if required,
+the extension package \gls{glossaries-extra} which, if required,
needs to be installed separately. New features will be added to
\gls*{glossaries-extra}. Versions of the \styfmt{glossaries}
package after v4.21 will mostly be just bug fixes. Note that
@@ -536,7 +536,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.33}.
+\qt{Documented Code for glossaries v4.34}.
\item[INSTALL] Installation instructions.
@@ -580,7 +580,11 @@ rather than \app{latex} (DVI format) as \appfmt{pdflatex} deals with
hyperlinks much better. If you use the DVI format, you will
encounter problems where you have long hyperlinks or hyperlinks in
subscripts or superscripts. This is an issue with the DVI format not
-with \styfmt{glossaries}.
+with \styfmt{glossaries}. If you really need to use the DVI format
+and have a problem with hyperlinks in maths mode, I recommend you use
+\gls{glossaries-extra} with the \texttt{hyperouter} and
+\texttt{textformat} attributes set to appropriate values
+for problematic entries.
\end{important}
\clearpage
@@ -767,7 +771,6 @@ format. \cs{newglossaryentry} should not be used explicitly.\par
\par
\end{table}
-
\optionsec[\TeX]{TeX}
This option doesn't require an external \gls{indexingapp} but, with
@@ -2776,7 +2779,7 @@ resulting file onto the man path. Alternatively do
\begin{important}
When upgrading the \styfmt{glossaries} package, make sure you also
upgrade your version of \gls{makeglossaries}. The current version is
-4.33.
+4.34.
\end{important}
\subsection{Using the makeglossaries-lite Lua Script}
@@ -3059,12 +3062,12 @@ option will additionally use
to show the hypertarget or 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}.
-This puts the information in the margin using \ics{marginpar}.
-If this causes a problem, you'll need to redefine
-\cs{glsshowtarget}. For example:
-\begin{verbatim}
-\renewcommand*{\glsshowtarget}[1]{\texttt{\small [#1]}}
-\end{verbatim}
+This puts the information in the margin using \ics{marginpar} unless
+math mode or inner mode are detected, in which case it puts the
+information in line enclosed by square brackets. The
+\gls{glossaries-extra} package provides an additional setting that
+may be used to show where the indexing is occurring. See the
+\gls{glossaries-extra} manual for further details.
The purpose of the debug mode can be demonstrated with
the following example document:
@@ -8024,6 +8027,7 @@ glossary} in the documented code (\texttt{glossaries-code.pdf}).
\chapter{Displaying a glossary}
\label{sec:printglossary}
+All defined glossaries may be displayed using:
\begin{description}
\itempar{\opt1:}
\begin{definition}[\DescribeMacro{\printnoidxglossaries}]
@@ -8048,7 +8052,9 @@ missing, these commands will just do \cs{null} for each missing
glossary to assist dictionary style documents that just use
\cs{glsaddall} without inserting any text. If you use
\gls{glossaries-extra}, it will insert a heading and boilerplate text when the
-external files are missing.)
+external files are missing. The extension package also provides
+\cs{printunsrtglossaries} as an alternative. See the
+\gls{glossaries-extra} manual for further details.)
If the glossary still does not appear after you re-\LaTeX\ your
document, check the \gls*{makeindex}\slash\gls*{xindy} log files to
@@ -8084,8 +8090,9 @@ glossary is assumed. For example, to print the list of acronyms:
\end{verbatim}
Note that you can't display an ignored glossary, so don't try
setting \gloskey[printglossary]{type} to the name of a glossary that
-was defined using \ics{newignoredglossary}. (See
-\sectionref{sec:newglossary}.)
+was defined using \ics{newignoredglossary}, described in
+\sectionref{sec:newglossary}. (You can display an ignored glossary
+with \cs{printunsrtglossary} provided by \gls{glossaries-extra}.)
\item[{\gloskey[printglossary]{title}}] This is the glossary's
title (overriding the title specified when the glossary was
@@ -8138,6 +8145,11 @@ order), \texttt{letter} (letter order), \texttt{standard} (word or
letter ordering taken from the \pkgopt{order} package option),
\texttt{use} (order of use), \texttt{def} (order of definition)
\texttt{nocase} (case-insensitive) or \texttt{case} (case-sensitive).
+Note that the word and letter comparisons (that is, everything other
+than \texttt{sort=use} and \texttt{sort=def}) just use a simple
+character code comparison. For a locale-sensitive sort, you must use
+either \gls{xindy} (\opt3) or \gls{bib2gls} (\opt4). Note that \gls{bib2gls}
+provides many other sort options.
\begin{important}
If you use the \texttt{use} or \texttt{def} values make sure
@@ -10682,6 +10694,11 @@ package options \pkgopt{entrycounter}, \pkgopt{counterwithin} and
of available styles in \tableref{tab:styles}.
You can view samples of all the predefined styles at
\url{http://www.dickimaw-books.com/gallery/glossaries-styles/}.
+Note that \gls{glossaries-extra} provides an additional style
+\glostyle{bookindex} in the supplementary package
+\sty{glossary-bookindex}, which is designed for indexes (rather than
+glossaries). See the \gls{glossaries-extra} manual for further
+details.
\begin{important}
Note that the group styles (such as \glostyle{listgroup}) will
@@ -10727,8 +10744,8 @@ be displayed.}
\ttfamily super* & 1 & \tick & \\
\ttfamily *index* & 2 & & \tick\\
\ttfamily treenoname* & --- & \tick & \tick\\
-\ttfamily *tree* & --- & & \tick\\
\ttfamily *alttree* & --- & & \tick\\
+\ttfamily *tree* & --- & & \tick\\
\ttfamily inline & 1 & \tick &
\end{tabular}
\par