1 files changed, 57 insertions, 14 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
index 98965518cad..2b3c87144ca 100644
--- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
+++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
@@ -216,7 +216,7 @@ package option \pkgopt{sanitize} described in \sectionref{sec:pkgopts-general}}
 }
 
 \ifpdf
-\externaldocument{glossaries}
+\externaldocument{glossaries-code}
 \fi
 
 \doxitem{Option}{option}{package options}
@@ -258,11 +258,11 @@ package option \pkgopt{sanitize} described in \sectionref{sec:pkgopts-general}}
 \MakeShortVerb{"}
 \DeleteShortVerb{\|}
 
- \title{User Manual for glossaries.sty v3.04}
+ \title{User Manual for glossaries.sty v3.05}
  \author{Nicola L.C. Talbot\\%
   \url{http://www.dickimaw-books.com/}}
 
- \date{2012-11-18}
+ \date{2013-04-21}
  \maketitle
 
 \noindent
@@ -287,10 +287,10 @@ The commands provided by the \sty{mfirstuc} package are briefly
 described in \htmldoc{mfirstuc.sty: uppercasing first
 letter}{mfirstuc-manual}.
 
-\item[\url{glossaries.pdf}]
+\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 v3.04}.
+\qt{Documented Code for glossaries v3.05}.
 This includes the documented code for the \sty{mfirstuc} package.
 
 \item[INSTALL] Installation instructions.
@@ -389,7 +389,7 @@ For example, in a
 texdoc -l glossaries
 \end{prompt}
 This should display the full pathname of the file 
-\texttt{glossaries.pdf}. View the contents of that directory and
+\texttt{glossaries-code.pdf}. View the contents of that directory and
 see if it contains the \texttt{samples} subdirectory.
 
 If you can't find the sample files, they are available in the
@@ -1167,7 +1167,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
-2.04.
+2.06.
 \end{important}
 
 \subsection{Using xindy explicitly}
@@ -1385,7 +1385,7 @@ You can use \pkgopt[none]{sanitize} as a shortcut for\newline
 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}}
+\usepackage[sanitize=none,sanitize={sort=false}]{glossaries}
 \end{verbatim}
 
 \begin{important}%
@@ -1466,6 +1466,8 @@ value in braces if it contains any commas. Example:
 \usepackage[acronym,nohypertypes={acronym,notation}]{glossaries}
 \newglossary[nlg]{notation}{not}{ntn}{Notation}
 \end{verbatim}
+The values must be fully expanded, so \textbf{don't} try
+\verb|nohypertypes=\acronymtype|.
 See \sectionref{sec:glslink} for further details.
 
 \item[\pkgopt{savenumberlist}] This is a boolean option that
@@ -1895,6 +1897,9 @@ package must be placed before \cs{makeglossaries} as they are
 required when creating the customised style file. If you attempt
 to use those commands after \cs{makeglossaries} you will generate
 an error.
+
+Similarly, there are some commands that must be used after
+\cs{makeglossaries}.
 \end{important}
 
 You can suppress the creation of the customised \gls{xindy}
@@ -2109,6 +2114,11 @@ glossary entries using \gloskey{nonumberlist=false} (see above).
 Alternatively, you can use the \pkgopt{seeautonumberlist} package
 option.  For further details, see \sectionref{sec:crossref}.
 
+\begin{important}
+\ics{makeglossaries} must be used before any occurrence of
+\ics{newglossaryentry} that contains the \gloskey{see} key.
+\end{important}
+
 \end{description}
 
 The following keys are reserved for \ics{newacronym} (see
@@ -2583,6 +2593,25 @@ Note that no check is performed to see if the glossary types listed
 in \pkgopt{nohypertypes} or \cs{GlsDeclareNoHyperList} have been
 defined.
 
+\begin{important}\raggedright
+The values must be fully expanded, so \textbf{don't} try
+\verb|nohypertypes=\acronymtype| or
+\verb|\GlsDeclareNoHyperList{\acronymtype}|.
+Also, avoid unnecessary braces. For example,
+\verb|\GlsDeclareNoHyperList{{acronym},{common}}| won't work. You do
+however need an enclosing brace for the whole list when using the
+package option. So
+\begin{verbatim}
+\usepackage[nohypertypes={acronym,common}]{glossaries}
+\end{verbatim}
+is correct, but \verb|nohypertypes={{acronym},{common}}| won't work.
+\end{important}
+
+You can override the effect of \pkgopt{nohypertypes} or
+\cs{GlsDeclareNoHyperList} by explicitly setting the
+\gloskey[glslink]{hyper} option in commands such as \cs{glslink} or
+\cs{gls}.
+
 The way the \gls{linktext} is displayed depends on 
 \begin{definition}[\DescribeMacro{\glstextformat}]
 \cs{glstextformat}\marg{text}
@@ -2697,7 +2726,7 @@ sans-serif font, you can define a command called, say,
 and then use \texttt{hyperbsf} as the value for the \gloskey{format}
 key. (See also \ifpdf section~\ref*{sec:code:printglos} \fi
 \qt{Displaying the glossary} in the documented code,
-\texttt{glossaries.pdf}.) Remember that if you use \gls{xindy}, you
+\texttt{glossaries-code.pdf}.) Remember that if you use \gls{xindy}, you
 will need to add this to the list of location attributes:
 \begin{verbatim}
 \GlsAddXdyAttribute{hyperbsf}
@@ -3273,6 +3302,13 @@ reference the entry in the main glossary with \verb|\gls{main-svm}|.
 \chapter{Cross-Referencing Entries}
 \label{sec:crossref}
 
+\begin{important}
+You must use \ics{makeglossaries} \emph{before} defining any
+cross-referenced entries. If any of the terms that you have
+cross-referenced don't appear in the glossary, check that you have
+put \cs{makeglossaries} before all entry definitions.
+\end{important}
+
 There are several ways of cross-referencing entries in the 
 glossary: 
 
@@ -3358,6 +3394,13 @@ just use the \gloskey{see} key instead of \ics{glssee}, you can
 automatically activate the \gls*{numberlist} using the
 \pkgopt{seeautonumberlist} package option.
 
+\begin{important}
+You must use \ics{makeglossaries} \emph{before} the entry
+definitions containing the \gloskey{see} key and before any
+instances of \ics{glssee} or the entry won't be automatically added
+to the glossary.
+\end{important}
+
 \section{Customising Cross-reference Text}
 \label{sec:customxr}
 
@@ -3600,7 +3643,7 @@ it with that package, \cs{glsentrynumberlist} will be used instead.
 
 For further information see \ifpdf section~\ref*{sec:code:glsnolink}
 \fi \qt{Displaying entry details without adding information to the
-glossary} in the documented code (\texttt{glossaries.pdf}).
+glossary} in the documented code (\texttt{glossaries-code.pdf}).
 
 \chapter{Displaying a glossary}
 \label{sec:printglossary}
@@ -5740,7 +5783,7 @@ A navigation hypertarget can be created using
 \end{definition}
 For further details about \cs{glsnavhypertarget}, see
 \ifpdf section~\ref*{sec:code:hypernav} in \fi the documented code 
-(\texttt{glossaries.pdf}).
+(\texttt{glossaries-code.pdf}).
 
 Most of the predefined glossary styles redefine \cs{glsgroupheading}
 to simply ignore its argument.  The \glostyle{listhypergroup} style
@@ -5861,7 +5904,7 @@ style that varies according to the glossary type.
 
 For further details of these commands, see \ifpdf
 section~\ref*{sec:code:printglos} \fi \qt{Displaying the glossary}
-in the documented code (\texttt{glossaries.pdf}).
+in the documented code (\texttt{glossaries-code.pdf}).
 
 \section{Example: creating a completely new style}
 \label{sec:exnewstyle}
@@ -5986,7 +6029,7 @@ that displays each entry in a \env{longtable} as follows:
 \label{sec:utilities}
 
 This section describes some utility commands. Additional commands
-can be found in the documented code (glossaries.pdf).
+can be found in the documented code (glossaries-code.pdf).
 
 \begin{definition}[\DescribeMacro{\forallglossaries}]
 \cs{forallglossaries}\oarg{glossary list}\marg{cs}\marg{body}
@@ -6114,7 +6157,7 @@ The sample file \samplefile{accsupp} illustrates the
 \sty{glossaries-accsupp} package.
 
 See \ifpdf section~\ref*{sec:code:accsupp} in \fi the documented code
-(\texttt{glossaries.pdf}) for further details. It is recommended
+(\texttt{glossaries-code.pdf}) for further details. It is recommended
 that you also read the \sty{accsupp} documentation. 
 
 \chapter{Troubleshooting}