summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2015-02-03 23:35:29 +0000
committerKarl Berry <karl@freefriends.org>2015-02-03 23:35:29 +0000
commitee0e64e16ff5d81050d780da9298fecd9eeae3b8 (patch)
tree11b7a5c347d869fb9e56cec384fa033bed295834 /Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
parent94b0072f70667d3cd7e762500a5417e5c70e5fb1 (diff)
glossaries (3feb15)
git-svn-id: svn://tug.org/texlive/trunk@36201 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex')
-rw-r--r--Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex169
1 files changed, 101 insertions, 68 deletions
diff --git a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
index 4855b1d9bd5..c1df666fc19 100644
--- a/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
+++ b/Master/texmf-dist/doc/latex/glossaries/glossaries-user.tex
@@ -367,11 +367,11 @@ and~\hyperlink{option#2}{#2}}
\MakeShortVerb{"}
\DeleteShortVerb{\|}
- \title{User Manual for glossaries.sty v4.12}
+ \title{User Manual for glossaries.sty v4.13}
\author{Nicola L.C. Talbot\\%
\url{http://www.dickimaw-books.com/}}
- \date{2014-11-22}
+ \date{2015-02-03}
\maketitle
\begin{abstract}
@@ -433,7 +433,7 @@ letter}{mfirstuc-manual}.
\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.12}.
+\qt{Documented Code for glossaries v4.13}.
This includes the documented code for the \sty{mfirstuc} package.
\item[INSTALL] Installation instructions.
@@ -1439,7 +1439,9 @@ has an unmaintained status, you can volunteer to take over the
maintenance by contacting me at
\url{http://www.dickimaw-books.com/contact.html}. The
\sty{translator} dictionary files for \styfmt{glossaries} are now
-provided by the appropriate language module.
+provided by the appropriate language module. For further details
+about information specific to a given language, please see the
+documentation for that language module.
Examples of use:
\begin{itemize}
@@ -1476,6 +1478,71 @@ Examples of use:
\end{itemize}
+Due to the varied nature of glossaries, it's likely that the
+predefined translations may not be appropriate. If you are using the
+\sty{babel} package and the \styfmt{glossaries} package option \pkgopt[babel]{translate}, you need to be familiar with the advice given in
+\urlref{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexwords}{changing
+the words babel uses}. If you are using the \sty{translator}
+package, then you can provide your own dictionary with the necessary
+modifications (using \cs{deftranslation}) and load it using
+\cs{usedictionary}.
+
+\begin{important}
+Note that the \sty{translator} dictionaries are loaded at the beginning of the
+document, so it won't have any effect if you put \cs{deftranslation}
+in the preamble. It should be put in your personal dictionary
+instead (as in the example below). See the \sty{translator}
+documentation for further details. (Now with \sty{beamer}
+documentation.)
+\end{important}
+
+Your custom dictionary doesn't have to be just a translation from
+English to another language. You may prefer to have a dictionary for
+a particular type of document. For example, suppose your
+institution's in-house reports have to have the glossary labelled as
+\qt{Nomenclature} and the page list should be labelled
+\qt{Location}, then you can create a file called, say,
+\begin{verbatim}
+myinstitute-glossaries-dictionary-English.dict
+\end{verbatim}
+that contains the following:
+\begin{verbatim}
+\ProvidesDictionary{myinstitute-glossaries-dictionary}{English}
+\deftranslation{Glossary}{Nomenclature}
+\deftranslation{Page List (glossaries)}{Location}
+\end{verbatim}
+You can now load it using:
+\begin{verbatim}
+\usedictionary{myinstitute-glossaries-dictionary}
+\end{verbatim}
+(Make sure that \texttt{myinstitute-glossaries-dictionary-English.dict}
+can be found by \TeX.) If you want to share your custom dictionary,
+you can upload it to \href{http://www.ctan.org/}{CTAN}.
+
+If you are using \sty{babel} and don't want to use the
+\sty{translator} interface, you can use the package
+option \pkgopt[babel]{translate}. For example:
+\begin{verbatim}
+\documentclass[british]{article}
+
+\usepackage{babel}
+\usepackage[translate=babel]{glossaries}
+
+\addto\captionsbritish{%
+ \renewcommand*{\glossaryname}{List of Terms}%
+ \renewcommand*{\acronymname}{List of Acronyms}%
+}
+\end{verbatim}
+
+Note that \gls{xindy} provides much better multi-lingual support
+than \gls{makeindex}, so I~recommend that you use \gls*{xindy}
+if you have glossary entries that contain
+\glspl{nonlatinchar}. See \sectionref{sec:xindy} for further
+details.
+
+\subsubsection{Creating a New Language Module}
+\label{sec:newlang}
+
The \styfmt{glossaries} package now uses the \sty{tracklang} package
to determine which language modules need to be loaded. If you want
to create a new language module, you should first read the
@@ -1663,8 +1730,9 @@ your root language label and \texttt{Irish} with the
\sty{translator} dictionary label.)
There are now two extra files: \texttt{glossaries-irish-noenc.ldf}
-and \texttt{glossaries-irish-utf8.ldf}. These both define
-\cs{glossariescaptionsirish} but the \texttt{*-noenc.ldf} uses
+and \texttt{glossaries-irish-utf8.ldf}.
+
+These both define \cs{glossariescaptionsirish} but the \texttt{*-noenc.ldf} uses
\LaTeX\ accent commands:
\begin{verbatim}
\@ifpackageloaded{polyglossia}%
@@ -1697,68 +1765,6 @@ whereas the \texttt{*-utf8.ldf} replaces the accent commands with
the appropriate UTF-8 characters.
-Due to the varied nature of glossaries, it's likely that the
-predefined translations may not be appropriate. If you are using the
-\sty{babel} package and the \styfmt{glossaries} package option \pkgopt[babel]{translate}, you need to be familiar with the advice given in
-\urlref{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=latexwords}{changing
-the words babel uses}. If you are using the \sty{translator}
-package, then you can provide your own dictionary with the necessary
-modifications (using \cs{deftranslation}) and load it using
-\cs{usedictionary}.
-
-\begin{important}
-Note that the \sty{translator} dictionaries are loaded at the beginning of the
-document, so it won't have any effect if you put \cs{deftranslation}
-in the preamble. It should be put in your personal dictionary
-instead (as in the example below). See the \sty{translator}
-documentation for further details. (Now with \sty{beamer}
-documentation.)
-\end{important}
-
-Your custom dictionary doesn't have to be just a translation from
-English to another language. You may prefer to have a dictionary for
-a particular type of document. For example, suppose your
-institution's in-house reports have to have the glossary labelled as
-\qt{Nomenclature} and the page list should be labelled
-\qt{Location}, then you can create a file called, say,
-\begin{verbatim}
-myinstitute-glossaries-dictionary-English.dict
-\end{verbatim}
-that contains the following:
-\begin{verbatim}
-\ProvidesDictionary{myinstitute-glossaries-dictionary}{English}
-\deftranslation{Glossary}{Nomenclature}
-\deftranslation{Page List (glossaries)}{Location}
-\end{verbatim}
-You can now load it using:
-\begin{verbatim}
-\usedictionary{myinstitute-glossaries-dictionary}
-\end{verbatim}
-(Make sure that \texttt{myinstitute-glossaries-dictionary-English.dict}
-can be found by \TeX.) If you want to share your custom dictionary,
-you can upload it to \href{http://www.ctan.org/}{CTAN}.
-
-If you are using \sty{babel} and don't want to use the
-\sty{translator} interface, you can use the package
-option \pkgopt[babel]{translate}. For example:
-\begin{verbatim}
-\documentclass[british]{article}
-
-\usepackage{babel}
-\usepackage[translate=babel]{glossaries}
-
-\addto\captionsbritish{%
- \renewcommand*{\glossaryname}{List of Terms}%
- \renewcommand*{\acronymname}{List of Acronyms}%
-}
-\end{verbatim}
-
-Note that \gls{xindy} provides much better multi-lingual support
-than \gls{makeindex}, so I~recommend that you use \gls*{xindy}
-if you have glossary entries that contain
-\glspl{nonlatinchar}. See \sectionref{sec:xindy} for further
-details.
-
\section{Generating the Associated Glossary Files}
\label{sec:makeglossaries}
@@ -4636,6 +4642,12 @@ files won't be created.
I strongly recommend that you don't use the commands
defined in this chapter in the arguments of sectioning or caption
commands or any other command that has a moving argument.
+
+Aside from problems with expansion issues, PDF bookmarks and
+possible nested hyperlinks in the table of contents (or list of
+whatever) any use of the commands described in \sectionref{sec:gls-like}
+will have their \firstuseflag\ unset when they appear in the table
+of contents (or list of whatever).
\end{important}
The above warning is particularly important if you are using the
@@ -5794,6 +5806,15 @@ The other commands depend on whether their corresponding keys were
assigned non-expandable values.
\end{important}
+If you want each word in a given entry field capitalised, you can
+use \ics{ecapitalisewords}\meta{text} defined by the \sty{mfirstuc}
+package, but make sure you use one of the expandable commands within
+\meta{text}. For example:
+\begin{verbatim}
+\ecaptialisewords{\glsentrytext{somelabel}}
+\end{verbatim}
+Note that \cs{ecapitalisewords} is not expandable.
+
\begin{definition}[\DescribeMacro{\glsentryname}]
\cs{glsentryname}\marg{label}
\end{definition}
@@ -6800,6 +6821,18 @@ change LaTeX’s \qt{fixed names}}.
\chapter{Acronyms}
\label{sec:acronyms}
+\begin{important}
+Note that although this chapter uses the term \qt{acronym}, you can also
+use the commands described here for abbreviations or contractions
+(as in the case of some of the examples given below).
+If the glossary title is no longer applicable (for example, it
+should be \qt{Abbreviations} rather than \qt{Acronyms}) then
+you can change the title either by redefining \ics{acronymname} (see
+\sectionref{sec:languages}) or by using the \gloskey[printglossary]{title}
+in the optional argument of \ics{printglossary} (or
+\ics{printacronym}).
+\end{important}
+
You may have noticed in \sectionref{sec:newglosentry} that when you
specify a new entry, you can specify alternate text to use when the
term is \glsd{firstuse} in the document. This provides a