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.tex67
1 files changed, 47 insertions, 20 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
index ca79ac9bd84..a1288c3db33 100644
--- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
+++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
@@ -179,8 +179,8 @@ the backslash character may appear as a dash when used in the
main document text, so \cs{foo} will appear as: ---foo.
\glspar
When \TeX\ writes information to a file, fragile
-commands must be protected. The \gloskey{name}, \gloskey{description}
-and \gloskey{symbol} keys all have their values written to a file,
+commands must be protected. The \gloskey{name}, \gloskey{description},
+\gloskey{symbol} and \gloskey{sort} keys all have their values written to a file,
which means that care must be taken if those values contain fragile
commands. There are two approaches: 1) the fragile commands must be
protected using \ics{protect}; 2) the values are sanitized.
@@ -233,15 +233,11 @@ package option \pkgopt{sanitize} described in \sectionref{sec:pkgopts-general}}
\MakeShortVerb{"}
\DeleteShortVerb{\|}
- \title{User Manual for glossaries.sty v3.02}
- \author{Nicola L.C. Talbot\\[10pt]
-School of Computing Sciences\\
-University of East Anglia\\
-Norwich. Norfolk\\
-NR4 7TJ. United Kingdom.\\
-\url{http://theoval.cmp.uea.ac.uk/~nlct/}}
+ \title{User Manual for glossaries.sty v3.03}
+ \author{Nicola L.C. Talbot\\%
+ \url{http://www.dickimaw-books.com/}}
- \date{2012-05-21}
+ \date{2012-09-21}
\maketitle
\noindent
@@ -269,7 +265,7 @@ letter}{mfirstuc-manual}.
\item[\url{glossaries.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 v3.02}.
+\qt{Documented Code for glossaries v3.03}.
This includes the documented code for the \sty{mfirstuc} package.
\item[INSTALL] Installation instructions.
@@ -431,11 +427,8 @@ latex sample4col
As before, if you don't have Perl installed, you will need to use
\gls{makeindex} directly instead of using
\gls{makeglossaries}. The vertical gap between entries is the
-gap created at the start of each group. This can be suppressed by
-redefining \ics{glsgroupskip} after the glossary style has been set:
-\begin{verbatim}
-\renewcommand*{\glsgroupskip}{}
-\end{verbatim}
+gap created at the start of each group. This can be suppressed
+using the \pkgopt{nogroupskip} package option.
\item[sampleAcr.tex]\label{ex:sampleAcr} This document has some
sample acronyms. It also adds the glossary to the table of contents,
@@ -1332,7 +1325,7 @@ in \sectionref{sec:newglossary}).
\meta{key}=\meta{value} option whose value is also a
\meta{key}=\meta{value} list. By default, the \styfmt{glossaries}
package \glspl{sanitize} the values of the \gloskey{name},
-\gloskey{description} and \gloskey{symbol} keys used when defining a
+\gloskey{description}, \gloskey{symbol} and \gloskey{sort} keys used when defining a
new glossary entry. This means that you can use fragile commands in
those keys, but it may lead to unexpected results if you try to
display these values within the document text. This sanitization can
@@ -1346,12 +1339,16 @@ symbol=true}]{glossaries}
\end{verbatim}
You can use \pkgopt[none]{sanitize} as a shortcut for\newline
\pkgoptfmt{sanitize=\{name=false,description=false,symbol=false\}}.
+Note that this shortcut doesn't change the \gloskey{sort}
+sanitization. That one needs to be switched off explicitly:
+\begin{verbatim}
+\usepackage{sanitize=none,sanitize={sort=false}}
+\end{verbatim}
\begin{important}%
\textbf{Note}: this sanitization only applies to the \gloskey{name},
-\gloskey{description} and \gloskey{symbol} keys. It doesn't apply
-to any of the other keys (except the \gloskey{sort} key which is
-always \glsd{sanitize} if \pkgopt[standard]{sort} is in effect) so fragile commands contained in the value of
+\gloskey{description}, \gloskey{symbol} and \gloskey{sort} keys. It doesn't apply
+to any of the other keys so fragile commands contained in the value of
the other keys must always be protected using \cs{protect}.
Since the value of the \gloskey{text} key is obtained from the
\gloskey{name} key, you will still need to protect fragile commands
@@ -1679,6 +1676,18 @@ automatically implement \gloskey{nonumberlist=false} for that entry.
the default counter to use in the \glspl{numberlist}
(see \sectionref{sec:numberlists}).
+\item[\pkgopt{nopostdot}] This is a boolean option. If no value is
+specified, \texttt{true} is assumed. When set to \texttt{true}, this
+option suppresses the default post description dot used by some of
+the predefined styles. The default setting is
+\pkgopt[false]{nopostdot}.
+
+\item[\pkgopt{nogroupskip}] This is a boolean option. If no value is
+specified, \texttt{true} is assumed. When set to \texttt{true}, this
+option suppresses the default vertical gap between groups used by
+some of the predefined styles. The default setting is
+\pkgopt[false]{nogroupskip}.
+
\end{description}
\section{Sorting Options}
@@ -4031,6 +4040,9 @@ it as a list of acronyms using the package option
\begin{important}
All glossaries must be defined before \ics{makeglossaries} to
ensure that the relevant output files are opened.
+
+See \sectionref{sec:fixednames} if you want to redefine \cs{glossaryname},
+especially if you are using \sty{babel} or \sty{translator}.
\end{important}
@@ -4906,6 +4918,9 @@ in the next section) or make the modifications after
\glossarystyle{long}
\renewcommand*{\glsgroupskip}{}
\end{verbatim}
+As from version 3.03, you can now use the package option
+\pkgopt{nogroupskip} to suppress the gap between groups for the
+default styles.
All the styles except for the three- and four-column styles and the
\glostyle{listdotted} style use the command
@@ -4918,6 +4933,9 @@ a comma) you will need to redefine \cs{glspostdescription} before
the glossary is displayed. Alternatively, you can suppress it for a
given entry by placing \ics{nopostdesc} in the entry's description.
+As from version 3.03 you can now use the package option
+\pkgopt{nopostdot} to suppress this full stop.
+
\section{List Styles}
\label{sec:liststyles}
@@ -5638,6 +5656,9 @@ style simply redefines \cs{glsgroupskip} to be \ics{indexspace},
whereas the tabular-like styles redefine \cs{glsgroupskip} to
produce a blank row.
+As from version 3.03, the package option \pkgopt{nogroupskip} can be
+used to suppress this default gap for the predefined styles.
+
\begin{definition}[\DescribeMacro{\glossaryentryfield}]
\cs{glossaryentryfield}\marg{label}\marg{formatted name}\marg{description}
\marg{symbol}\marg{number list}
@@ -6007,6 +6028,12 @@ Further information on debugging \LaTeX\ code is available at
Below is a list of the most frequently asked questions. For
other queries, consult the \styfmt{glossaries} FAQ at
\url{http://theoval.cmp.uea.ac.uk/~nlct/latex/packages/faq/glossariesfaq.html}.
+Bug reports can be submitted at
+\url{http://www.dickimaw-books.com/bug-report.html}. For general
+queries, you are more likely to get a faster response if you post
+them to somewhere like the comp.text.tex newsgroup, the \LaTeX\
+Community Forum (\url{http://www.latex-community.org/}) or
+Stack Exchange (\url{http://tex.stackexchange.com/}).
\begin{enumerate}
\item \textbf{Q.} I get the error message: