diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/glossaries/glossaries.dtx')
| -rw-r--r-- | Master/texmf-dist/source/latex/glossaries/glossaries.dtx | 155 |
1 files changed, 113 insertions, 42 deletions
diff --git a/Master/texmf-dist/source/latex/glossaries/glossaries.dtx b/Master/texmf-dist/source/latex/glossaries/glossaries.dtx index 95b968bf56c..14a2905bd9e 100644 --- a/Master/texmf-dist/source/latex/glossaries/glossaries.dtx +++ b/Master/texmf-dist/source/latex/glossaries/glossaries.dtx @@ -1,14 +1,19 @@ %\iffalse % glossaries.dtx generated using makedtx version 1.1 (c) Nicola Talbot % Command line args: -% -doc "glossaries-manual.tex" -% -setambles ".*\.perl=>\nopreamble\nopostamble" -% -setambles ".*\.tex=>\nopreamble\nopostamble" -% -setambles ".*\.xdy=>\nopreamble\nopostamble" +% -codetitle "Main Package Code" % -comment ".*\.perl" % -comment ".*\.tex" % -comment ".*\.xdy" +% -macrocode ".*\.perl" +% -macrocode ".*\.tex" +% -macrocode ".*\.xdy" +% -doc "glossaries-manual.tex" % -author "Nicola Talbot" +% -setambles ".*\.perl=>\nopreamble\nopostamble" +% -setambles ".*\.tex=>\nopreamble\nopostamble" +% -setambles ".*\.xdy=>\nopreamble\nopostamble" +% -section "chapter" % -src "glossaries\.sty\Z=>glossaries.sty" % -src "glossaries-prefix.sty\Z=>glossaries-prefix.sty" % -src "(glossary-.+)\.(sty)\Z=>\1.\2" @@ -25,13 +30,8 @@ % -src "(samplexdy-mc.*\.xdy)\Z=>\1" % -src "(database.*\.tex)\Z=>\1" % -src "(.*\.perl)\Z=>\1" -% -macrocode ".*\.perl" -% -macrocode ".*\.tex" -% -macrocode ".*\.xdy" -% -section "chapter" -% -codetitle "Main Package Code" % glossaries -% Created on 2016/6/9 19:36 +% Created on 2016/10/12 15:51 %\fi %\iffalse %<*package> @@ -60,6 +60,8 @@ %<*driver> \documentclass[report]{nlctdoc} +\DeleteShortVerb{|} + \iffalse glossaries-manual.tex is a stub file used by makedtx to create glossaries.dtx @@ -143,7 +145,7 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of \setcounter{IndexColumns}{2} -\CheckSum{19165} +\CheckSum{19216} \newcommand*{\ifirstuse}{\iterm{first use}} \newcommand*{\firstuse}{\gls{firstuse}} @@ -169,14 +171,13 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of %</driver> %\fi %\MakeShortVerb{"} -%\DeleteShortVerb{\|} % -% \title{Documented Code For glossaries v4.25} +% \title{Documented Code For glossaries v4.26} % \author{Nicola L.C. Talbot\\[10pt] %Dickimaw Books\\ %\url{http://www.dickimaw-books.com/}} % -% \date{2016-06-09} +% \date{2016-10-12} % \maketitle % %This is the documented code for the \styfmt{glossaries} package. @@ -192,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.25: +%For the main user guide, read \qt{glossaries.sty v4.26: %\LaTeX2e\ Package to Assist Generating Glossaries}. % %\item[\url{mfirstuc-manual.pdf}] @@ -247,7 +248,7 @@ governed by the \gloskey{first} and \gloskey{firstplural} keys of % This package requires \LaTeXe. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries}[2016/06/09 v4.25 (NLCT)] +\ProvidesPackage{glossaries}[2016/10/12 v4.26 (NLCT)] % \end{macrocode} %\changes{4.18}{2015-09-09}{split mfirstuc into separate bundle} % Required packages: @@ -495,10 +496,16 @@ false,nolabel,autolabel,nameref}[nolabel]{% % \cs{@glossary@default@style}. This is initialised to % \texttt{list}. (The \glostyle{list} style is % defined in the accompanying \isty{glossary-list} package -% described in \autoref{sec:code:styles}.) +% described in \autoref{sec:code:styles}.) Note that the +% \glostyle{list} style is incompatible with \sty{classicthesis} +% so change the default to \glostyle{index} if that package has been +% loaded. %\begin{macro}{\@glossary@default@style} +%\changes{4.26}{2016-10-12}{added check for classicthesis} % \begin{macrocode} -\newcommand*{\@glossary@default@style}{list} +\@ifpackageloaded{classicthesis} +{\newcommand*{\@glossary@default@style}{index}} +{\newcommand*{\@glossary@default@style}{list}} % \end{macrocode} %\end{macro} % @@ -18348,7 +18355,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % \cs{gls}\marg{label}} on subsequent use. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-prefix}[2016/06/09 v4.25 (NLCT)] +\ProvidesPackage{glossaries-prefix}[2016/10/12 v4.26 (NLCT)] % \end{macrocode} % Pass all options to \sty{glossaries}: % \begin{macrocode} @@ -18763,7 +18770,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\label{sec:code:hypernav} % Package Definition: % \begin{macrocode} -\ProvidesPackage{glossary-hypernav}[2016/06/09 v4.25 (NLCT)] +\ProvidesPackage{glossary-hypernav}[2016/10/12 v4.26 (NLCT)] % \end{macrocode} % % The commands defined in this package are provided to @@ -18935,7 +18942,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}[2016/06/09 v4.25 (NLCT)] +\ProvidesPackage{glossary-inline}[2016/10/12 v4.26 (NLCT)] % \end{macrocode} % %\begin{style}{inline} @@ -19126,7 +19133,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % \ics{item} command, it will appear in a bold font by % default. % \begin{macrocode} -\ProvidesPackage{glossary-list}[2016/06/09 v4.25 (NLCT)] +\ProvidesPackage{glossary-list}[2016/10/12 v4.26 (NLCT)] % \end{macrocode} %\begin{macro}{\indexspace} %\changes{4.13}{2015-02-03}{new} @@ -19408,7 +19415,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}[2016/06/09 v4.25 (NLCT)] +\ProvidesPackage{glossary-long}[2016/10/12 v4.26 (NLCT)] % \end{macrocode} % Requires the \isty{longtable} package: % \begin{macrocode} @@ -19905,7 +19912,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % \url{http://tex.stackexchange.com/a/56890} % % \begin{macrocode} -\ProvidesPackage{glossary-longbooktabs}[2016/06/09 v4.25 (NLCT)] +\ProvidesPackage{glossary-longbooktabs}[2016/10/12 v4.26 (NLCT)] % \end{macrocode} % Requires \sty{booktabs} package: % \begin{macrocode} @@ -20246,7 +20253,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}[2016/06/09 v4.25 (NLCT)] +\ProvidesPackage{glossary-longragged}[2016/10/12 v4.26 (NLCT)] % \end{macrocode} % Requires the \isty{array} package: % \begin{macrocode} @@ -20679,7 +20686,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}[2016/06/09 v4.25 (NLCT)] +\ProvidesPackage{glossary-mcols}[2016/10/12 v4.26 (NLCT)] % \end{macrocode} % Required packages: % \begin{macrocode} @@ -20722,7 +20729,14 @@ false,nolabel,autolabel,nameref}[nolabel]{% \begin{multicols}{\glsmcols} \setlength{\parindent}{0pt}% \setlength{\parskip}{0pt plus 0.3pt}% - \let\item\@idxitem}% +% \end{macrocode} +%\changes{4.26}{2016-10-12}{replaced \cs{@idxitem} with +%\cs{glstreeitem}} +% \begin{macrocode} + \let\item\glstreeitem + \let\subitem\glstreesubitem + \let\subsubitem\glstreesubsubitem + }% {\end{multicols}}% } % \end{macrocode} @@ -20781,7 +20795,11 @@ false,nolabel,autolabel,nameref}[nolabel]{% \begin{multicols}{\glsmcols}[\noindent\glstreenavigationfmt{\glsnavigation}] \setlength{\parindent}{0pt}% \setlength{\parskip}{0pt plus 0.3pt}% - \let\item\@idxitem}% +% \end{macrocode} +%\changes{4.26}{2016-10-12}{replaced \cs{@idxitem} with +%\cs{glstreeitem}} +% \begin{macrocode} + \let\item\glstreeitem}% {\end{multicols}}% % \end{macrocode} % Add a heading for each group (with a target). The group's title is @@ -21104,7 +21122,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}[2016/06/09 v4.25 (NLCT)] +\ProvidesPackage{glossary-super}[2016/10/12 v4.26 (NLCT)] % \end{macrocode} % Requires the \isty{supertabular} package: % \begin{macrocode} @@ -21636,7 +21654,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}[2016/06/09 v4.25 (NLCT)] +\ProvidesPackage{glossary-superragged}[2016/10/12 v4.26 (NLCT)] % \end{macrocode} % Requires the \isty{array} package: % \begin{macrocode} @@ -22076,7 +22094,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % that have a tree-like structure. These are designed for % hierarchical glossaries. % \begin{macrocode} -\ProvidesPackage{glossary-tree}[2016/06/09 v4.25 (NLCT)] +\ProvidesPackage{glossary-tree}[2016/10/12 v4.26 (NLCT)] % \end{macrocode} % %\begin{macro}{\indexspace} @@ -22119,6 +22137,56 @@ false,nolabel,autolabel,nameref}[nolabel]{% % \end{macrocode} %\end{macro} % +%Allow the user to adjust the \glostyle{index} style without disturbing the index. +%\begin{macro}{\glstreeitem} +%Top level item used in \glostyle{index} style. +%\changes{4.26}{2016-10-12}{new} +% \begin{macrocode} +\ifdef\@idxitem +{\newcommand{\glstreeitem}{\@idxitem}} +{\newcommand{\glstreeitem}{\par\hangindent40\p@}} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glstreesubitem} +%\changes{4.26}{2016-10-12}{new} +%Level~1 item used in \glostyle{index} style. +% \begin{macrocode} +\ifdef\subitem +{\let\glstreesubitem\subitem} +{\newcommand\glstreesubitem{\glstreeitem\hspace*{20\p@}}} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glstreesubsubitem} +%\changes{4.26}{2016-10-12}{new} +%Level~1 item used in \glostyle{index} style. +% \begin{macrocode} +\ifdef\subsubitem +{\let\glstreesubsubitem\subsubitem} +{\newcommand\glstreesubsubitem{\glstreeitem\hspace*{30\p@}}} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glstreepredesc} +%Allow the user to adjust the space before the description (except +%for the \glostyle{alttree} style). +%\changes{4.26}{2016-10-12}{new} +% \begin{macrocode} +\newcommand{\glstreepredesc}{\space} +% \end{macrocode} +%\end{macro} +% +%\begin{macro}{\glstreechildpredesc} +%Allow the user to adjust the space before the description for +%sub-entries (except for the \glostyle{treenoname} and +%\glostyle{alttree} style). +%\changes{4.26}{2016-10-12}{new} +% \begin{macrocode} +\newcommand{\glstreechildpredesc}{\space} +% \end{macrocode} +%\end{macro} +% %\begin{style}{index} % The \glostyle{index} glossary style % is similar in style to the way indices are usually typeset @@ -22137,7 +22205,10 @@ false,nolabel,autolabel,nameref}[nolabel]{% \renewenvironment{theglossary}% {\setlength{\parindent}{0pt}% \setlength{\parskip}{0pt plus 0.3pt}% - \let\item\@idxitem}% + \let\item\glstreeitem + \let\subitem\glstreesubitem + \let\subsubitem\glstreesubsubitem + }% % \end{macrocode} %\changes{3.08a}{2013-09-28}{added paragraph break at end of environment} % \begin{macrocode} @@ -22160,7 +22231,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% \renewcommand*{\glossentry}[2]{% \item\glsentryitem{##1}\glstreenamefmt{\glstarget{##1}{\glossentryname{##1}}}% \ifglshassymbol{##1}{\space(\glossentrysymbol{##1})}{}% - \space \glossentrydesc{##1}\glspostdescription\space ##2% + \glstreepredesc \glossentrydesc{##1}\glspostdescription\space ##2% }% % \end{macrocode} % Sub entries: level 1 entries use \ics{subitem}, levels greater @@ -22184,7 +22255,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% \fi \glstreenamefmt{\glstarget{##2}{\glossentryname{##2}}}% \ifglshassymbol{##2}{\space(\glossentrysymbol{##2})}{}% - \space\glossentrydesc{##2}\glspostdescription\space ##3% + \glstreechildpredesc\glossentrydesc{##2}\glspostdescription\space ##3% }% % \end{macrocode} % Vertical gap between groups is the same as that used by indices: @@ -22273,7 +22344,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% \parindent0pt\relax \glsentryitem{##1}\glstreenamefmt{\glstarget{##1}{\glossentryname{##1}}}% \ifglshassymbol{##1}{\space(\glossentrysymbol{##1})}{}% - \space\glossentrydesc{##1}\glspostdescription\space##2\par + \glstreepredesc\glossentrydesc{##1}\glspostdescription\space##2\par }% % \end{macrocode} % Sub entries: level \meta{n} is indented by \meta{n} times @@ -22289,7 +22360,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% \fi \glstreenamefmt{\glstarget{##2}{\glossentryname{##2}}}% \ifglshassymbol{##2}{\space(\glossentrysymbol{##2})}{}% - \space\glossentrydesc{##2}\glspostdescription\space ##3\par + \glstreechildpredesc\glossentrydesc{##2}\glspostdescription\space ##3\par }% % \end{macrocode} % Vertical gap between groups is the same as that used by @@ -22388,7 +22459,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% \parindent0pt\relax \glsentryitem{##1}\glstreenamefmt{\glstarget{##1}{\glossentryname{##1}}}% \ifglshassymbol{##1}{\space(\glossentrysymbol{##1})}{}% - \space\glossentrydesc{##1}\glspostdescription\space##2\par + \glstreepredesc\glossentrydesc{##1}\glspostdescription\space##2\par }% % \end{macrocode} % Sub entries: level \meta{n} is indented by \meta{n} times @@ -22744,7 +22815,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % hyperlinks may not work properly. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-compatible-207}[2016/06/09 v4.25 (NLCT)] +\ProvidesPackage{glossaries-compatible-207}[2016/10/12 v4.26 (NLCT)] % \end{macrocode} %\begin{macro}{\GlsAddXdyAttribute} % Adds an attribute in old format. @@ -23105,7 +23176,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% %\section{glossaries-compatible-307} % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-compatible-307}[2016/06/09 v4.25 (NLCT)] +\ProvidesPackage{glossaries-compatible-307}[2016/10/12 v4.26 (NLCT)] % \end{macrocode} % % Compatibility macros for predefined glossary styles: @@ -23913,7 +23984,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % \end{macrocode} % Package version number now in line with main glossaries package number. % \begin{macrocode} -\ProvidesPackage{glossaries-accsupp}[2016/06/09 v4.25 (NLCT) +\ProvidesPackage{glossaries-accsupp}[2016/10/12 v4.26 (NLCT) Experimental glossaries accessibility] % \end{macrocode} % Pass all options to \sty{glossaries}: @@ -26344,7 +26415,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % modules. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-babel}[2016/06/09 v4.25 (NLCT)] +\ProvidesPackage{glossaries-babel}[2016/10/12 v4.26 (NLCT)] % \end{macrocode} % Load \sty{tracklang} to obtain language settings. % \begin{macrocode} @@ -26388,7 +26459,7 @@ false,nolabel,autolabel,nameref}[nolabel]{% % modules. % \begin{macrocode} \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{glossaries-polyglossia}[2016/06/09 v4.25 (NLCT)] +\ProvidesPackage{glossaries-polyglossia}[2016/10/12 v4.26 (NLCT)] % \end{macrocode} % Load \sty{tracklang} to obtain language settings. % \begin{macrocode} |