summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/dtxdescribe
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2024-01-21 03:01:05 +0000
committerNorbert Preining <norbert@preining.info>2024-01-21 03:01:05 +0000
commitb2fc73208c72c65ca8f9ce068898291b69322d32 (patch)
treec5027d520af6b383a642459af510e38224cf97d5 /macros/latex/contrib/dtxdescribe
parent2fd07558ccd8d3c8e354f8ea0b342ef7ac1e87a3 (diff)
CTAN sync 202401210301
Diffstat (limited to 'macros/latex/contrib/dtxdescribe')
-rw-r--r--macros/latex/contrib/dtxdescribe/README.txt2
-rw-r--r--macros/latex/contrib/dtxdescribe/dtxdescribe.dtx212
-rw-r--r--macros/latex/contrib/dtxdescribe/dtxdescribe.pdfbin470587 -> 470125 bytes
3 files changed, 110 insertions, 104 deletions
diff --git a/macros/latex/contrib/dtxdescribe/README.txt b/macros/latex/contrib/dtxdescribe/README.txt
index 7338088697..56c711de66 100644
--- a/macros/latex/contrib/dtxdescribe/README.txt
+++ b/macros/latex/contrib/dtxdescribe/README.txt
@@ -1,7 +1,7 @@
The LaTeX dtxdescribe package
Describe additional object types in dtx source files.
-v1.08 — 2024/01/08
+v1.09
Copyright 2016–2024 Brian Dunn — https://github.com/bdtc/dtxdescribe
LaTeX Project Public License, version 1.3
diff --git a/macros/latex/contrib/dtxdescribe/dtxdescribe.dtx b/macros/latex/contrib/dtxdescribe/dtxdescribe.dtx
index 3fb7205f40..387c465b6e 100644
--- a/macros/latex/contrib/dtxdescribe/dtxdescribe.dtx
+++ b/macros/latex/contrib/dtxdescribe/dtxdescribe.dtx
@@ -17,7 +17,7 @@
% \iffalse
%<package>\NeedsTeXFormat{LaTeX2e}
%<package>\ProvidesPackage{dtxdescribe}
-%<package> [2024/01/08 v1.08 Describe additional object types in source files.]
+%<package> [2024/01/20 v1.09 Describe additional object types in source files.]
%
%<*driver>
\documentclass{ltxdoc}
@@ -189,6 +189,8 @@ pageanchor=true,
% \changes{v1.07}{2023/01/03}{\ 2023/01/03}
% \changes{v1.08}{2024/01/08}{\ 2024/01/08}
% \changes{v1.08}{2024/01/08}{\ Updated contact info.}
+% \changes{v1.09}{2024/01/18}{Improved TOC change log and index entries.}
+% \changes{v1.09}{2024/01/20}{2024/01/20}
@@ -1423,7 +1425,12 @@ pageanchor=true,
% \clearpage
-% \StopEventually{\PrintChanges\PrintIndex}
+% \StopEventually{
+% \appendix
+% \GlossaryPrologue{\section{Change History}}
+% \PrintChanges
+% \IndexPrologue{\section{Index}}
+% \PrintIndex}
% ^^A *source
@@ -1657,29 +1664,29 @@ pageanchor=true,
% \changes{v1.06}{2022/12/06}{Fixed for updated \pkg{doc}.}
% \begin{macrocode}
\renewcommand*{\@wrsindex}[2][]{%
- \ifx\relax#1\relax
- \if@splitidx
+ \ifx\relax#1\relax%
+ \if@splitidx%
\@wrsindex[idx]{#2}%
- \else
+ \else%
\def\@tempa{#2}%
- \if@verbindex\@onelevel@sanitize\@tempa\fi
+ \if@verbindex\@onelevel@sanitize\@tempa\fi%
\@wrindex{\@tempa}%
- \fi
- \else
+ \fi%
+ \else%
%
% \def\@tempa{#2}%
\def\@tempa{#2\encapchar hdpindex{}}% dtxdescribe
%
- \csname index@#1@hook\endcsname
- \expandafter\ifx\csname @@wrsindex\endcsname\relax
+ \csname index@#1@hook\endcsname%
+ \expandafter\ifx\csname @@wrsindex\endcsname\relax%
\@@@wrsindex{#1}{{\@tempa}{\thepage}}%
- \else
+ \else%
\def\@tempb{\@@wrsindex{#1}}%
\expandafter\@tempb\@tempa||\\%
- \fi
- \endgroup
- \@esphack
- \fi
+ \fi%
+ \endgroup%
+ \@esphack%
+ \fi%
}
% \end{macrocode}
@@ -1728,16 +1735,16 @@ pageanchor=true,
\def\HD@@@bfseries\hfil#1\hfil{%
\ifx\\#1\\%
- \else
+ \else%
\raisebox{\baselineskip}[0pt]{%
- \kern-\HD@margin\relax
+ \kern-\HD@margin\relax%
% \pdfbookmark[\HD@toclevel@subindex]{#1}{HD.#1}}%
\pdfbookmark[\HD@toclevel@subindex]{#1}% dtxdescribe
{HD.#1.\arabic{DTXD@indexnumber}}% dtxdescribe
- \kern\HD@margin\relax
+ \kern\HD@margin\relax%
}%
- \fi
- \hfil#1\hfil
+ \fi%
+ \hfil#1\hfil%
}%
% \end{macrocode}
@@ -2161,27 +2168,28 @@ pageanchor=true,
% To avoid a floats lost error, do not print margin tags if inside a float.
% \changes{v1.06}{2022/12/06}{Fixed for updated \pkg{doc}.}
+% \changes{v1.09}{2024/01/20}{Removed extra spaces.}
% \begin{macrocode}
\IfPackageLoadedTF{doc}{
\def\@doc@describe#1#2{% dtxdescribe
- \ifdoc@noprint\else
+ \ifdoc@noprint\else%
\@ifundefined{@captype}{% not float? dtxdescribe
- \marginpar{\raggedleft
- \strut
- \doc@providetarget
+ \marginpar{\raggedleft%
+ \strut%
+ \doc@providetarget%
\@nameuse{PrintDescribe#1}{#2}%
\ifdefvoid{\DTXD@category}{}{% dtxdescribe
\space{\footnotesize[\mbox{\DTXD@category}]}%
}%
- }
+ }%
}{}%
- \fi
- \ifdoc@noindex\else
+ \fi%
+ \ifdoc@noindex\else%
\@nameuse{Special#1Index}{#2}%
- \fi
- \@esphack
- \endgroup
+ \fi%
+ \@esphack%
+ \endgroup%
\ignorespaces%
}
@@ -2202,48 +2210,48 @@ pageanchor=true,
\IfPackageLoadedTF{doc}{%
\def\@NewDocElement#1#2#3{%
- \doc@macrolikefalse
- \doc@topleveltrue
+ \doc@macrolikefalse%
+ \doc@topleveltrue%
\def\doc@idxtype{#3}%
\def\doc@idxgroup{#3s}%
- \let\doc@printtype\@empty
+ \let\doc@printtype\@empty%
\csname keys_set:nn\endcsname{doc}{#1}%
- \ifx\doc@printtype\@empty
+ \ifx\doc@printtype\@empty%
\@temptokena{}%
- \else
- \@temptokena\expandafter{\expandafter
- \textnormal\expandafter{\expandafter
- \space\expandafter
+ \else%
+ \@temptokena\expandafter{\expandafter%
+ \textnormal\expandafter{\expandafter%
+ \space\expandafter%
(\doc@printtype)}}%
- \fi
+ \fi%
\@nameedef{Print#2Name}##1{%
- {\noexpand\MacroFont
- \ifdoc@macrolike
+ {\noexpand\MacroFont%
+ \ifdoc@macrolike%
\noexpand\string##1% dtxdescribe
- \else
+ \else%
\noexpand\detokenize\expandafter{##1}% dtxdescribe
- \fi
- \the\@temptokena
+ \fi%
+ \the\@temptokena%
}}%
- \expandafter\let\csname PrintDescribe#2\expandafter\endcsname
- \csname Print#2Name\endcsname
+ \expandafter\let\csname PrintDescribe#2\expandafter\endcsname%
+ \csname Print#2Name\endcsname%
\edef\doc@expr{%
- \ifdoc@macrolike
- \noexpand\doc@createspecialmacrolikeindexes
- \else
- \noexpand\doc@createspecialindexes
- \fi
+ \ifdoc@macrolike%
+ \noexpand\doc@createspecialmacrolikeindexes%
+ \else%
+ \noexpand\doc@createspecialindexes%
+ \fi%
{#2}%
}%
- \expandafter\expandafter\expandafter
- \doc@expr
- \expandafter\expandafter\expandafter
- {\expandafter\doc@idxtype\expandafter}\expandafter
+ \expandafter\expandafter\expandafter%
+ \doc@expr%
+ \expandafter\expandafter\expandafter%
+ {\expandafter\doc@idxtype\expandafter}\expandafter%
{\doc@idxgroup}%
\doc@createdescribe{#2}%
- \ifdoc@macrolike
+ \ifdoc@macrolike%
\doc@createenv{TT}{#2}{#3}%
- \else
+ \else%
\doc@createenv{TF}{#2}{#3}%
\fi
}
@@ -2284,14 +2292,14 @@ pageanchor=true,
\newcommand*{\DTXD@maybecategory}{%
\ifdefvoid{\DTXD@category}%
{}%
- {
+ {%
% \end{macrocode}
%
% \cs{DTXDbreak} inserts a possible line break here,
% allowing a break if the following verbatim is too long.
% \changes{v1.07}{2022/12/24}{Improved line breaks.}
% \begin{macrocode}
- \string\DTXDbreak
+ \string\DTXDbreak%
% \end{macrocode}
% \begin{macrocode}
[%
@@ -2329,7 +2337,7 @@ pageanchor=true,
% \begin{macrocode}
\newcommand*{\DTXD@maybecategorylevel}[1]{%
\ifdefvoid{\DTXD@categorylevelname}%
- {}
+ {}%
{%
% \end{macrocode}
% Index: \\
@@ -2341,7 +2349,7 @@ pageanchor=true,
\string\verb% % to fool emacs highlighting
\noexpand\quotechar%
*%
- \noexpand\verbatimchar
+ \noexpand\verbatimchar%
[\DTXD@category]:%
\verbatimchar%
\noexpand\levelchar%
@@ -2353,7 +2361,7 @@ pageanchor=true,
% \changes{v1.07}{2022/12/19}{Fix occasional crash.}
%
% \begin{macrocode}
- \noexpand\doc@handleencap{usage}
+ \noexpand\doc@handleencap{usage}%
}% index
}%
}
@@ -2367,9 +2375,9 @@ pageanchor=true,
\newcommand*{\DTXD@findcategorylevelname}{%
\edef\DTXD@categorylevelname{\DTXD@category}%
\edef\DTXD@categorylevelname{\detokenize\expandafter{\DTXD@categorylevelname}}%
- \IfBeginWith{\DTXD@categorylevelname}{\DTXD@backslash}
- {\StrGobbleLeft{\DTXD@categorylevelname}{1}[\DTXD@categorylevelname]}
- {}
+ \IfBeginWith{\DTXD@categorylevelname}{\DTXD@backslash}%
+ {\StrGobbleLeft{\DTXD@categorylevelname}{1}[\DTXD@categorylevelname]}%
+ {}%
}
% \end{macrocode}
% \end{macro}
@@ -2421,11 +2429,11 @@ pageanchor=true,
% \end{description}
%
% \begin{macrocode}
- \noexpand\@bsphack
+ \noexpand\@bsphack%
\noexpand\DTXD@findcategorylevelname% dtxdescribe
% \end{macrocode}
% \begin{macrocode}
- \ifdoc@toplevel
+ \ifdoc@toplevel%
% \noexpand\special@index{##1\noexpand\actualchar
%
%
@@ -2438,7 +2446,7 @@ pageanchor=true,
\noexpand\DTXD@printobjectname% dtxdescribe
{\noexpand\DTXD@gtempa@nobackslash}%
{\noexpand\@gtempa}%
- \ifx\@nil#2\@nil\else \the\@temptokena \fi
+ \ifx\@nil#2\@nil\else \the\@temptokena \fi%
\noexpand\DTXD@maybecategory% dtxdescribe
\noexpand\encapchar main%
}%
@@ -2447,7 +2455,7 @@ pageanchor=true,
% Maybe add the category index entry:
% \begin{macrocode}
\noexpand\DTXD@maybecategorylevel{#2}% dtxdescribe
- \fi
+ \fi%
%
%
% \end{macrocode}
@@ -2456,7 +2464,7 @@ pageanchor=true,
% \verb?group:>name=\verb!*+name+ [category]|main?
%
% \begin{macrocode}
- \ifx\@nil#3\@nil\else
+ \ifx\@nil#3\@nil\else%
\noexpand\special@index{%
\the\@temptokenb\noexpand\levelchar%
% ##1\noexpand\actualchar{\string\ttfamily\space##1}%
@@ -2471,12 +2479,13 @@ pageanchor=true,
% Maybe add the category index entry:
% \begin{macrocode}
\noexpand\DTXD@maybecategorylevel{#2}% dtxdescribe
- \fi
+ \fi%
\noexpand\@esphack}%
% \end{macrocode}
%
% \textbf{Define \cs{Special<name>Index} \marg{1: name}}
%
+% \changes{v1.09}{2024/01/20}{Removed extra spaces.}
% \begin{macrocode}
\@nameedef{Special#1Index}##1{%
\noexpand\DTXD@findgtempa{##1}%
@@ -2490,15 +2499,15 @@ pageanchor=true,
% \end{description}
%
% \begin{macrocode}
- \noexpand\@bsphack
+ \noexpand\@bsphack%
\noexpand\DTXD@findcategorylevelname% dtxdescribe
% \end{macrocode}
%
% If is a top level object, index:\\
% \verb?name=\verb!*+name+ (type) [category]|usage?
% \begin{macrocode}
- \ifdoc@toplevel
- \noexpand\doc@providetarget
+ \ifdoc@toplevel%
+ \noexpand\doc@providetarget%
% \end{macrocode}
% \begin{macrocode}
% \noexpand\index{##1\noexpand\actualchar{\string\ttfamily\space##1}%
@@ -2506,7 +2515,7 @@ pageanchor=true,
\noexpand\DTXD@printobjectname% dtxdescribe
{\noexpand\DTXD@gtempa@nobackslash}%
{\noexpand\@gtempa}%
- \ifx\@nil#2\@nil\else \the\@temptokena \fi
+ \ifx\@nil#2\@nil\else \the\@temptokena \fi%
\noexpand\DTXD@maybecategory% dtxdescribe
\noexpand\doc@handleencap{usage}%
}%
@@ -2515,7 +2524,7 @@ pageanchor=true,
% Maybe add the category index entry:
% \begin{macrocode}
\noexpand\DTXD@maybecategorylevel{#2}% dtxdescribe
- \fi
+ \fi%
%
%
% \end{macrocode}
@@ -2523,7 +2532,7 @@ pageanchor=true,
% If group is not empty, index: \\
% \verb?group:>name=\verb!*+name+ [category]|usage?
% \begin{macrocode}
- \ifx\@nil#3\@nil\else
+ \ifx\@nil#3\@nil\else%
\noexpand\index{%
\the\@temptokenb\noexpand\levelchar%
% ##1\noexpand\actualchar{\string\ttfamily\space##1}
@@ -2538,7 +2547,7 @@ pageanchor=true,
% Maybe add the category index entry:
% \begin{macrocode}
\noexpand\DTXD@maybecategorylevel{#2}% dtxdescribe
- \fi
+ \fi%
%
%
\noexpand\@esphack}}
@@ -2570,22 +2579,22 @@ pageanchor=true,
% \end{description}
%
% \begin{macrocode}
- \noexpand\@bsphack
+ \noexpand\@bsphack%
\noexpand\DTXD@findcategorylevelname% dtxdescribe
% \end{macrocode}
% \begin{macrocode}
- \noexpand\ifdoc@noindex\noexpand\else
+ \noexpand\ifdoc@noindex\noexpand\else%
% \end{macrocode}
%
% If a top level object, index:\\
% \verb?name=\verb!*+\name+ (type) [category]|<main or usage>?
% \begin{macrocode}
- \ifdoc@toplevel
+ \ifdoc@toplevel%
\noexpand\special@index{%
\noexpand\DTXD@printobjectname% dtxdescribe
{\noexpand\DTXD@gtempa@nobackslash}%
{\noexpand\@gtempa}%
- \ifx\@nil#2\@nil\else \the\@temptokena \fi
+ \ifx\@nil#2\@nil\else \the\@temptokena \fi%
\noexpand\DTXD@maybecategory% dtxdescribe
\noexpand\encapchar ##1%
}%
@@ -2594,15 +2603,15 @@ pageanchor=true,
% Maybe add the category index entry:
% \begin{macrocode}
\noexpand\DTXD@maybecategorylevel{#2}% dtxdescribe
- \fi
+ \fi%
% \end{macrocode}
%
% If group is not empty, index: \\
% \verb?group:>name=\verb!*+\name+ [category]|<main or usage>?
% \begin{macrocode}
- \ifx\@nil#3\@nil\else
+ \ifx\@nil#3\@nil\else%
\noexpand\special@index{%
- \the\@temptokenb\noexpand\levelchar
+ \the\@temptokenb\noexpand\levelchar%
\noexpand\DTXD@printobjectname% dtxdescribe
{\noexpand\DTXD@gtempa@nobackslash}%
{\noexpand\@gtempa}%
@@ -2614,19 +2623,20 @@ pageanchor=true,
% Maybe add the category index entry:
% \begin{macrocode}
\noexpand\DTXD@maybecategorylevel{#2}% dtxdescribe
- \fi
- \noexpand\fi
+ \fi%
+ \noexpand\fi%
\noexpand\@esphack}%
% \end{macrocode}
%
% \textbf{Define \cs{SpecialMain<name>Index} \marg{1: name}}
% \begin{macrocode}
\@nameedef{SpecialMain#1Index}##1{%
- \expandafter\noexpand\csname Code#1Index\endcsname
+ \expandafter\noexpand\csname Code#1Index\endcsname%
{main}{##1}}%
% \end{macrocode}
%
% \textbf{Define \cs{Special<name>Index} \marg{1: name}}
+% \changes{v1.09}{2024/01/20}{Removed extra spaces.}
% \begin{macrocode}
\@nameedef{Special#1Index}##1{%
\noexpand\DTXD@findgtempa{##1}%
@@ -2640,23 +2650,23 @@ pageanchor=true,
% \end{description}
%
% \begin{macrocode}
- \noexpand\@bsphack
+ \noexpand\@bsphack%
\noexpand\DTXD@findcategorylevelname% dtxdescribe
% \end{macrocode}
% \begin{macrocode}
- \noexpand\ifdoc@noindex\noexpand\else
+ \noexpand\ifdoc@noindex\noexpand\else%
% \end{macrocode}
%
% If a top level object, index:\\
% \verb?name=\verb!*+\name+ (type) [category]|usage?
% \begin{macrocode}
- \ifdoc@toplevel
- \noexpand\doc@providetarget
+ \ifdoc@toplevel%
+ \noexpand\doc@providetarget%
\noexpand\index{%
\noexpand\DTXD@printobjectname% dtxdescribe
{\noexpand\DTXD@gtempa@nobackslash}%
{\noexpand\@gtempa}%
- \ifx\@nil#2\@nil\else \the\@temptokena \fi
+ \ifx\@nil#2\@nil\else \the\@temptokena \fi%
\noexpand\DTXD@maybecategory% dtxdescribe
\noexpand\doc@handleencap{usage}%
}%
@@ -2665,15 +2675,15 @@ pageanchor=true,
% Maybe add the category index entry:
% \begin{macrocode}
\noexpand\DTXD@maybecategorylevel{#2}% dtxdescribe
- \fi
+ \fi%
% \end{macrocode}
%
% If group is not empty, index: \\
% \verb?group:>name=\verb!*+\name+ [category]|usage?
% \begin{macrocode}
- \ifx\@nil#3\@nil\else
+ \ifx\@nil#3\@nil\else%
\noexpand\index{%
- \the\@temptokenb\noexpand\levelchar
+ \the\@temptokenb\noexpand\levelchar%
\noexpand\DTXD@printobjectname% dtxdescribe
{\noexpand\DTXD@gtempa@nobackslash}%
{\noexpand\@gtempa}%
@@ -2685,8 +2695,8 @@ pageanchor=true,
% Maybe add the category index entry:
% \begin{macrocode}
\noexpand\DTXD@maybecategorylevel{#2}% dtxdescribe
- \fi
- \noexpand\fi
+ \fi%
+ \noexpand\fi%
\noexpand\@esphack}}
}{}% doc loaded
@@ -3239,7 +3249,7 @@ pageanchor=true,
\hbadness=10000%
\hfuzz=5em%
\raggedleft%
- \ifblank{#1}{}{\raggedleft{\scriptsize[#1]} }
+ \ifblank{#1}{}{\raggedleft{\scriptsize[#1]} }%
\texttt{#2}%
}%
}{}% not float?
@@ -4515,10 +4525,6 @@ position=top,
% \clearpage
% \pagestyle{plain}
%
-% \renewcommand{\partname}{}
-% \renewcommand{\thepart}{}
-% \part{Change History and Index}
-%
%
% \Finale
%
diff --git a/macros/latex/contrib/dtxdescribe/dtxdescribe.pdf b/macros/latex/contrib/dtxdescribe/dtxdescribe.pdf
index 1712382523..15da06f8c0 100644
--- a/macros/latex/contrib/dtxdescribe/dtxdescribe.pdf
+++ b/macros/latex/contrib/dtxdescribe/dtxdescribe.pdf
Binary files differ