summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/glossaries/glossaries.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/glossaries/glossaries.dtx')
-rw-r--r--Master/texmf-dist/source/latex/glossaries/glossaries.dtx105
1 files changed, 66 insertions, 39 deletions
diff --git a/Master/texmf-dist/source/latex/glossaries/glossaries.dtx b/Master/texmf-dist/source/latex/glossaries/glossaries.dtx
index 348cbe6819f..ac87b170a7d 100644
--- a/Master/texmf-dist/source/latex/glossaries/glossaries.dtx
+++ b/Master/texmf-dist/source/latex/glossaries/glossaries.dtx
@@ -1,14 +1,6 @@
%\iffalse
% glossaries.dtx generated using makedtx version 1.2 (c) Nicola Talbot
% Command line args:
-% -section "chapter"
-% -setambles ".*\.perl=>\nopreamble\nopostamble"
-% -setambles ".*\.tex=>\nopreamble\nopostamble"
-% -setambles ".*\.xdy=>\nopreamble\nopostamble"
-% -macrocode ".*\.perl"
-% -macrocode ".*\.tex"
-% -macrocode ".*\.xdy"
-% -author "Nicola Talbot"
% -src "glossaries\.sty\Z=>glossaries.sty"
% -src "glossaries-prefix.sty\Z=>glossaries-prefix.sty"
% -src "(glossary-.+)\.(sty)\Z=>\1.\2"
@@ -25,13 +17,21 @@
% -src "(samplexdy-mc.*\.xdy)\Z=>\1"
% -src "(database.*\.tex)\Z=>\1"
% -src "(.*\.perl)\Z=>\1"
+% -section "chapter"
+% -setambles ".*\.perl=>\nopreamble\nopostamble"
+% -setambles ".*\.tex=>\nopreamble\nopostamble"
+% -setambles ".*\.xdy=>\nopreamble\nopostamble"
% -codetitle "Main Package Code"
+% -author "Nicola Talbot"
+% -macrocode ".*\.perl"
+% -macrocode ".*\.tex"
+% -macrocode ".*\.xdy"
+% -doc "glossaries-manual.tex"
% -comment ".*\.perl"
% -comment ".*\.tex"
% -comment ".*\.xdy"
-% -doc "glossaries-manual.tex"
% glossaries
-% Created on 2017/11/14 19:44
+% Created on 2018/3/7 13:12
%\fi
%\iffalse
%<*package>
@@ -54,7 +54,7 @@
%\fi
% \iffalse
% Doc-Source file to use with LaTeX2e
-% Copyright (C) 2017 Nicola Talbot, all rights reserved.
+% Copyright (C) 2018 Nicola Talbot, all rights reserved.
% \fi
% \iffalse
%<*driver>
@@ -145,7 +145,7 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of
\setcounter{IndexColumns}{2}
-\CheckSum{19481}
+\CheckSum{19480}
\newcommand*{\ifirstuse}{\iterm{first use}}
\newcommand*{\firstuse}{\gls{firstuse}}
@@ -172,12 +172,12 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of
%\fi
%\MakeShortVerb{"}
%
-% \title{Documented Code For glossaries v4.35}
+% \title{Documented Code For glossaries v4.36}
% \author{Nicola L.C. Talbot\\[10pt]
%Dickimaw Books\\
%\url{http://www.dickimaw-books.com/}}
%
-% \date{2017-11-14}
+% \date{2018-03-07}
% \maketitle
%
%This is the documented code for the \styfmt{glossaries} package.
@@ -193,7 +193,7 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of
%glossaries package}.
%
%\item[\url{glossaries-user.pdf}]
-%For the main user guide, read \qt{glossaries.sty v4.35:
+%For the main user guide, read \qt{glossaries.sty v4.36:
%\LaTeX2e\ Package to Assist Generating Glossaries}.
%
%\item[\url{mfirstuc-manual.pdf}]
@@ -248,7 +248,7 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of
% This package requires \LaTeXe.
% \begin{macrocode}
\NeedsTeXFormat{LaTeX2e}
-\ProvidesPackage{glossaries}[2017/11/14 v4.35 (NLCT)]
+\ProvidesPackage{glossaries}[2018/03/07 v4.36 (NLCT)]
% \end{macrocode}
%\changes{4.18}{2015-09-09}{split mfirstuc into separate bundle}
% Required packages:
@@ -860,7 +860,8 @@ false,nolabel,autolabel,nameref}[nolabel]{%
%\changes{3.0}{2011-04-02}{new}
% Define the sort method: \pkgopt[standard]{sort} (default),
% \pkgopt[def]{sort} (order of definition) or
-% \pkgopt[use]{sort} (order of use).
+% \pkgopt[use]{sort} (order of use). If no indexing required, use
+% \pkgopt[none]{sort}.
% \begin{macrocode}
\define@choicekey{glossaries.sty}{sort}{standard,def,use,none}{%
\renewcommand*{\@glo@default@sorttype}{#1}%
@@ -7723,7 +7724,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% the commands like \cs{gls} have a final optional
% argument that can be used to insert additional text in the
% link (this will usually be appended, but can be redefined using
-% \ics{defentryfmt}).
+% \ics{defglsentryfmt}).
% It goes against the \LaTeX\ norm to have an optional
% argument after the mandatory arguments, but it makes more
% sense to write, say, \verb|\gls{label}['s]| rather than, say,
@@ -13206,23 +13207,49 @@ you
%\end{macro}
%
%\begin{macro}{\@gls@glossary}
+%\begin{definition}
+%\cs{@gls@glossary}\marg{type}\marg{indexing info}
+%\end{definition}
% (In v4.10, \cs{@glossary} was redefined to \cs{@gls@glossary} to
% avoid conflict with other packages.)
-% Define internal \cs{@gls@glossary} to ignore its argument.
-% This gets redefined in \cs{@makeglossary}. This is
-% defined to just \cs{index} as \cls{memoir} changes the definition of
+% Initially define internal \cs{@gls@glossary} to ignore its argument.
+% Indexing will be enabled when \cs{@gls@glossary} is redefined by
+% \cs{@makeglossary}.
+%
+% This command was originally
+% defined to do \cs{@index}\marg{indexing info} so that it behaved
+% much like \cs{index}. The definition was then changed to
+% use \cs{index} as \cls{memoir} changes the definition of
% \cs{@index}. (Thanks to Dan Luecking for pointing this out.)
%\changes{1.17}{2008-12-26}{changed definition to use
%\cs{index} instead of \cs{@index}}
%\changes{4.10}{2014-08-27}{Renamed \cs{@glossary} to \cs{@gls@glossary}}
-% The argument \verb|#1| is the glossary type.
%\changes{4.24}{2016-05-27}{added check for debug mode}
+%
+%However, if normal indexing is enabled (for example with \cs{makeindex}) but no
+%glossary lists are required (so \cs{@makeglossary} isn't used),
+%then \cs{index} will cause a problem here.
+%The \cs{@index} trick allows for special characters within
+%\meta{indexing info} (so you can do, for example, \verb|\index{%@\%}|),
+%and the original design of \cs{@glossary} here
+%was actually a legacy from the old \styfmt{glossary} package. With
+%the \styfmt{glossaries} package, the indexing information supplied in
+%the second argument is more constrained and just consists of the sort
+%value (given by the \gloskey{sort} key), the actual value
+%(given by \cs{glossentry}\marg{label} or
+%\cs{subglossentry}\marg{level}\marg{label}), and the format. This means that
+%there's no need to worry about special characters appearing in the
+%second argument as they can't be in the label or sort value. (If
+%they are in the sort value then the category code would've needed
+%to be changed when the entry was defined or \cs{glspercentchar}
+%would be needed with the sort sanitization switched off.)
+%This means that it's safe to simply ignore the second argument.
+%\changes{4.36}{2018-03-07}{removed \cs{index}}
% \begin{macrocode}
\newcommand*{\@gls@glossary}[2]{%
\if@gls@debug
\PackageInfo{glossaries}{wrglossary(#1)(#2)}%
\fi
- \index{#2}%
}
% \end{macrocode}
%\end{macro}
@@ -18856,7 +18883,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% \cs{gls}\marg{label}} on subsequent use.
% \begin{macrocode}
\NeedsTeXFormat{LaTeX2e}
-\ProvidesPackage{glossaries-prefix}[2017/11/14 v4.35 (NLCT)]
+\ProvidesPackage{glossaries-prefix}[2018/03/07 v4.36 (NLCT)]
% \end{macrocode}
% Pass all options to \sty{glossaries}:
% \begin{macrocode}
@@ -19271,7 +19298,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
%\label{sec:code:hypernav}
% Package Definition:
% \begin{macrocode}
-\ProvidesPackage{glossary-hypernav}[2017/11/14 v4.35 (NLCT)]
+\ProvidesPackage{glossary-hypernav}[2018/03/07 v4.36 (NLCT)]
% \end{macrocode}
%
% The commands defined in this package are provided to
@@ -19464,7 +19491,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% This defines an in-line style where the entries are
% comma-separated with just the name and description displayed.
% \begin{macrocode}
-\ProvidesPackage{glossary-inline}[2017/11/14 v4.35 (NLCT)]
+\ProvidesPackage{glossary-inline}[2018/03/07 v4.36 (NLCT)]
% \end{macrocode}
%
%\begin{style}{inline}
@@ -19655,7 +19682,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% \ics{item} command, it will appear in a bold font by
% default.
% \begin{macrocode}
-\ProvidesPackage{glossary-list}[2017/11/14 v4.35 (NLCT)]
+\ProvidesPackage{glossary-list}[2018/03/07 v4.36 (NLCT)]
% \end{macrocode}
%\begin{macro}{\indexspace}
%\changes{4.13}{2015-02-03}{new}
@@ -19937,7 +19964,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% The glossary styles defined in the \isty{glossary-long} package
% used the \env{longtable} environment in the glossary.
% \begin{macrocode}
-\ProvidesPackage{glossary-long}[2017/11/14 v4.35 (NLCT)]
+\ProvidesPackage{glossary-long}[2018/03/07 v4.36 (NLCT)]
% \end{macrocode}
% Requires the \isty{longtable} package:
% \begin{macrocode}
@@ -20434,7 +20461,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% \url{http://tex.stackexchange.com/a/56890}
%
% \begin{macrocode}
-\ProvidesPackage{glossary-longbooktabs}[2017/11/14 v4.35 (NLCT)]
+\ProvidesPackage{glossary-longbooktabs}[2018/03/07 v4.36 (NLCT)]
% \end{macrocode}
% Requires \sty{booktabs} package:
% \begin{macrocode}
@@ -20775,7 +20802,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% used the \env{longtable} environment in the glossary and use
% ragged right formatting for the multiline columns.
% \begin{macrocode}
-\ProvidesPackage{glossary-longragged}[2017/11/14 v4.35 (NLCT)]
+\ProvidesPackage{glossary-longragged}[2018/03/07 v4.36 (NLCT)]
% \end{macrocode}
% Requires the \isty{array} package:
% \begin{macrocode}
@@ -21208,7 +21235,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
%use the \sty{multicol} package. These use the tree-like glossary
%styles in a multicol environment.
% \begin{macrocode}
-\ProvidesPackage{glossary-mcols}[2017/11/14 v4.35 (NLCT)]
+\ProvidesPackage{glossary-mcols}[2018/03/07 v4.36 (NLCT)]
% \end{macrocode}
% Required packages:
% \begin{macrocode}
@@ -21645,7 +21672,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% The glossary styles defined in the \isty{glossary-super} package
% use the \env{supertabular} environment.
% \begin{macrocode}
-\ProvidesPackage{glossary-super}[2017/11/14 v4.35 (NLCT)]
+\ProvidesPackage{glossary-super}[2018/03/07 v4.36 (NLCT)]
% \end{macrocode}
% Requires the \isty{supertabular} package:
% \begin{macrocode}
@@ -22177,7 +22204,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% are like those provided by the \isty{glossary-super} package,
% except that the multiline columns have ragged right justification.
% \begin{macrocode}
-\ProvidesPackage{glossary-superragged}[2017/11/14 v4.35 (NLCT)]
+\ProvidesPackage{glossary-superragged}[2018/03/07 v4.36 (NLCT)]
% \end{macrocode}
% Requires the \isty{array} package:
% \begin{macrocode}
@@ -22617,7 +22644,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% that have a tree-like structure. These are designed for
% hierarchical glossaries.
% \begin{macrocode}
-\ProvidesPackage{glossary-tree}[2017/11/14 v4.35 (NLCT)]
+\ProvidesPackage{glossary-tree}[2018/03/07 v4.36 (NLCT)]
% \end{macrocode}
%
%\begin{macro}{\indexspace}
@@ -23338,7 +23365,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% hyperlinks may not work properly.
% \begin{macrocode}
\NeedsTeXFormat{LaTeX2e}
-\ProvidesPackage{glossaries-compatible-207}[2017/11/14 v4.35 (NLCT)]
+\ProvidesPackage{glossaries-compatible-207}[2018/03/07 v4.36 (NLCT)]
% \end{macrocode}
%\begin{macro}{\GlsAddXdyAttribute}
% Adds an attribute in old format.
@@ -23699,7 +23726,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
%\section{glossaries-compatible-307}
% \begin{macrocode}
\NeedsTeXFormat{LaTeX2e}
-\ProvidesPackage{glossaries-compatible-307}[2017/11/14 v4.35 (NLCT)]
+\ProvidesPackage{glossaries-compatible-307}[2018/03/07 v4.36 (NLCT)]
% \end{macrocode}
%
% Compatibility macros for predefined glossary styles:
@@ -24507,7 +24534,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% \end{macrocode}
% Package version number now in line with main glossaries package number.
% \begin{macrocode}
-\ProvidesPackage{glossaries-accsupp}[2017/11/14 v4.35 (NLCT)
+\ProvidesPackage{glossaries-accsupp}[2018/03/07 v4.36 (NLCT)
Experimental glossaries accessibility]
% \end{macrocode}
% Pass all options to \sty{glossaries}:
@@ -26946,7 +26973,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% modules.
% \begin{macrocode}
\NeedsTeXFormat{LaTeX2e}
-\ProvidesPackage{glossaries-babel}[2017/11/14 v4.35 (NLCT)]
+\ProvidesPackage{glossaries-babel}[2018/03/07 v4.36 (NLCT)]
% \end{macrocode}
% Load \sty{tracklang} to obtain language settings.
% \begin{macrocode}
@@ -26990,7 +27017,7 @@ false,nolabel,autolabel,nameref}[nolabel]{%
% modules.
% \begin{macrocode}
\NeedsTeXFormat{LaTeX2e}
-\ProvidesPackage{glossaries-polyglossia}[2017/11/14 v4.35 (NLCT)]
+\ProvidesPackage{glossaries-polyglossia}[2018/03/07 v4.36 (NLCT)]
% \end{macrocode}
% Load \sty{tracklang} to obtain language settings.
% \begin{macrocode}