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.tex86
1 files changed, 82 insertions, 4 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 291cd280f70..f48bac27bc9 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
@@ -1,7 +1,5 @@
\documentclass[report,inlinetitle,widecs]{nlctdoc}
-\usepackage[utf8]{inputenc}
-\usepackage[T1]{fontenc}
\usepackage{alltt}
\usepackage{hologo}
\usepackage[colorlinks,
@@ -143,13 +141,13 @@ styles (glossaries):>#1={\protect\ttfamily#1}|main}}
\DeleteShortVerb{\|}
\MakeShortVerb{"}
- \title{glossaries-extra.sty v1.07:
+ \title{glossaries-extra.sty v1.08:
an extension to the glossaries package}
\author{Nicola L.C. Talbot\\[10pt]
Dickimaw Books\\
\url{http://www.dickimaw-books.com/}}
- \date{2016-08-15}
+ \date{2016-12-13}
\maketitle
\begin{abstract}
@@ -457,6 +455,73 @@ default for \styfmt{glossaries}). You can switch this to a warning
message (and ?? appearing in the text) with
\pkgopt[warn]{undefaction}.
+\item[{\pkgopt{record}}] (New to v1.08.) This is a \meta{key}=\meta{value}
+option, which has three allowed values: \pkgoptfmt{off} (default),
+\pkgoptfmt{only} and \pkgoptfmt{alsoindex}. If the value is omitted
+\pkgoptfmt{only} is assumed. The option is provided for the benefit
+of any post-processing applications that need to know information
+about the entries used in the document. The option may only be set
+in the preamble.
+
+The \pkgopt[off]{record} option switches off the recording, as per
+the default behaviour. It implements \pkgopt[error]{undefaction}
+
+The other values switch on the recording and also
+\pkgopt[warn]{undefaction}, but \pkgopt[only]{record}
+will also switch off the indexing mechanism (even if \cs{makeglossaries}
+or \cs{makenoidxglossaries} has been used) whereas
+\pkgopt[alsoindex]{record} will both record and index.
+
+With the recording on, any of the commands that would typically
+index the entry (such as \cs{gls}, \cs{glstext} or \cs{glsadd})
+will add a \cs{glsxtr@record} entry to the \texttt{.aux} file.
+The post-processing application can then read these lines to find
+out which entries have been used. (Remember that commands like
+\cs{glsentryname} don't index, so any use of these commands won't
+add a corresponding \cs{glsxtr@record} entry to the \texttt{.aux}
+file.)
+
+There are two new commands that are intended for use with the
+recording function:
+\begin{definition}[\DescribeMacro\glsxtrresourcefile]
+\cs{glsxtrresourcefile}\oarg{options}\marg{filename}
+\end{definition}
+This writes the line
+\begin{alltt}
+\cs{glsxtr@resource}\marg{options}\marg{filename}
+\end{alltt}
+to the \texttt{.aux} file and, if \meta{filename} exists, will then
+input \meta{filename}. The post-processor may use this information
+to create the required file. The options aren't processed by
+\styfmt{glossaries-extra} (other than simply writing \meta{options}
+to the \texttt{.aux} file). The post-processor determines the
+allowed options.
+
+\begin{definition}[\DescribeMacro\printunsrtglossary]
+\cs{printunsrtglossary}\oarg{options}
+\end{definition}
+This behaves like \cs{printnoidxglossary} but never sorts the
+entries and always lists all the defined entries for the given
+glossary (and doesn't require \cs{makenoidxglossaries}).
+The optional argument is as for \cs{printnoidxglossary}.
+The \gls{numberlist} will need setting by the post-processor
+by adding the \gloskey{loclist} field to the entry definitions,
+otherwise the \gls*{numberlist} will be empty. The \gloskey{loclist}
+field should be a comma-separated list where each location in the
+list is in the format
+\begin{definition}
+\cs{glsnoidxdisplayloc}\marg{prefix}\marg{counter}\marg{format}\marg{location}
+\end{definition}
+(see the \styfmt{glossaries} manual for information about that
+command).
+
+All glossaries may be displayed in the order of their definition
+using:
+\begin{definition}[\DescribeMacro\printunsrtglossaries]
+\cs{printunsrtglossaries}
+\end{definition}
+which is analogous to \cs{printnoidxglossaries}.
+
\item[{\pkgopt{docdef}}] This option governs the use of
\cs{newglossaryentry}. It was originally a boolean option,
but as from version 1.06, it can now take one of three values (if
@@ -673,6 +738,19 @@ The \ics{newacronym} command is modified to use the new abbreviation
interface provided by \styfmt{glossaries-extra}.
(See \sectionref{sec:abbreviations}.)
+The \cs{makeglossaries} command now has an optional argument.
+\begin{definition}[\DescribeMacro\makeglossaries]
+\cs{makeglossaries}\oarg{list}
+\end{definition}
+If \meta{list} is empty, \cs{makeglossaries} behaves as per
+its original definition in the \styfmt{glossaries} package,
+otherwise \meta{list} can be a comma-separated list of glossaries
+that need processing with an external indexing application.
+
+It should then be possible to use \cs{printglossary} for those
+glossaries listed in \meta{list} and \cs{printnoidxglossary}
+for the other glossaries.
+
\section{Entry Indexing}
\label{sec:wrglossary}