From 231f84a3fd38e7b05d38ddd4401a3b324884d88e Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Fri, 30 Mar 2018 21:15:38 +0000 Subject: dtxdescribe (30mar18) git-svn-id: svn://tug.org/texlive/trunk@47191 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/dtxdescribe/README | 20 ------- Master/texmf-dist/doc/latex/dtxdescribe/README.txt | 20 +++++++ .../doc/latex/dtxdescribe/dtxdescribe.pdf | Bin 620831 -> 621148 bytes .../source/latex/dtxdescribe/dtxdescribe.dtx | 64 ++++++--------------- .../tex/latex/dtxdescribe/dtxdescribe.sty | 9 ++- 5 files changed, 42 insertions(+), 71 deletions(-) delete mode 100644 Master/texmf-dist/doc/latex/dtxdescribe/README create mode 100644 Master/texmf-dist/doc/latex/dtxdescribe/README.txt (limited to 'Master') diff --git a/Master/texmf-dist/doc/latex/dtxdescribe/README b/Master/texmf-dist/doc/latex/dtxdescribe/README deleted file mode 100644 index fa8adaa2991..00000000000 --- a/Master/texmf-dist/doc/latex/dtxdescribe/README +++ /dev/null @@ -1,20 +0,0 @@ -The LaTeX dtxdescribe package -Describe additional object types in dtx source files. - -v0.10 — 2016/12/08 -Copyright 2016 Brian Dunn — www.BDTechConcepts.com -LaTeX Project Public License, version 1.3 - -The doc package includes tools for describing macros and environments in -LATEX source dtx format. The dtxdescribe package adds additional tools for -describing booleans, lengths, counters, keys, packages, classes, options, files, -commands, arguments, and other objects. - -Each item is given a margin tag similar to \DescribeEnv, and is listed in -the index by itself and also by category. Each item may be sorted further by -an optional class. All index entries except code lines are hyperlinked. - -Descriptions are best accompanied by examples, so the environment -dtxexample is provided. Contents are displayed verbatim along with a -caption and cross-referencing. They are then \input and executed, and the -result is shown. diff --git a/Master/texmf-dist/doc/latex/dtxdescribe/README.txt b/Master/texmf-dist/doc/latex/dtxdescribe/README.txt new file mode 100644 index 00000000000..e158ac3bfdc --- /dev/null +++ b/Master/texmf-dist/doc/latex/dtxdescribe/README.txt @@ -0,0 +1,20 @@ +The LaTeX dtxdescribe package +Describe additional object types in dtx source files. + +v0.11 — 2018/03/30 +Copyright 2016–2018 Brian Dunn — www.BDTechConcepts.com +LaTeX Project Public License, version 1.3 + +The doc package includes tools for describing macros and environments in +LATEX source dtx format. The dtxdescribe package adds additional tools for +describing booleans, lengths, counters, keys, packages, classes, options, files, +commands, arguments, and other objects. + +Each item is given a margin tag similar to \DescribeEnv, and is listed in +the index by itself and also by category. Each item may be sorted further by +an optional class. All index entries except code lines are hyperlinked. + +Descriptions are best accompanied by examples, so the environment +dtxexample is provided. Contents are displayed verbatim along with a +caption and cross-referencing. They are then \input and executed, and the +result is shown. diff --git a/Master/texmf-dist/doc/latex/dtxdescribe/dtxdescribe.pdf b/Master/texmf-dist/doc/latex/dtxdescribe/dtxdescribe.pdf index 17ab09790b1..e7cadb2a6f7 100644 Binary files a/Master/texmf-dist/doc/latex/dtxdescribe/dtxdescribe.pdf and b/Master/texmf-dist/doc/latex/dtxdescribe/dtxdescribe.pdf differ diff --git a/Master/texmf-dist/source/latex/dtxdescribe/dtxdescribe.dtx b/Master/texmf-dist/source/latex/dtxdescribe/dtxdescribe.dtx index 95790045699..d72f69c6f1d 100644 --- a/Master/texmf-dist/source/latex/dtxdescribe/dtxdescribe.dtx +++ b/Master/texmf-dist/source/latex/dtxdescribe/dtxdescribe.dtx @@ -17,7 +17,7 @@ % \iffalse %\NeedsTeXFormat{LaTeX2e} %\ProvidesPackage{dtxdescribe} -% [2016/12/08 v0.10 Describe additional object types in dtx source files.] +% [2018/03/30 v0.11 Describe additional object types in dtx source files.] % %<*driver> \documentclass{ltxdoc} @@ -171,13 +171,6 @@ % \usepackage{morefloats} % \usepackage{marginfix} -\usepackage{tocloft} -\setlength{\cftsubsecnumwidth}{3em} -\setlength{\cftsubsubsecindent}{2.8em} -\setlength{\cftsubsubsecnumwidth}{4em} -\setlength{\cftbeforesubsecskip}{1ex} - -% \usepackage{titletoc} @@ -195,26 +188,14 @@ - -\newcommand*{\lmacro}[1]{\textbackslash#1} -\newcommand*{\cmds}[1]{\texttt{#1}} -\newcommand*{\env}[1]{\texttt{#1}} -\newcommand*{\pkg}[1]{\textsf{#1}} -\newcommand*{\acro}[1]{\textsc{\lowercase{#1}}} - - - - - - +\providerobustcmd*{\lmacro}[1]{\textbackslash#1} +\providerobustcmd*{\cmds}[1]{\texttt{#1}} +\providerobustcmd*{\env}[1]{\texttt{#1}} +\providerobustcmd*{\ctr}[1]{\texttt{#1}} +\providerobustcmd*{\pkg}[1]{\textsf{#1}} +\providerobustcmd*{\prog}[1]{\texttt{#1}} -% % \newcommand*{\tikz}{Ti\textit{k}z} -% \newcommand*{\htmlfive}{\acro{HTML}\oldstylenums{5}} -% \newcommand*{\cssthree}{\acro{CSS}\oldstylenums{3}} -% -% \newcommand*{\goesto}{$\Rightarrow$} - % \newenvironment{docsidebar}[1][] % {\par\addvspace{1.5ex}% % \hfill\minipage{.9\linewidth}\raggedright#1\smallskip\hrule\medskip} @@ -271,7 +252,7 @@ Keywords={LaTeX, dtx, source, DescribeMacro}% %<*package> % \fi % -% \CheckSum{369} +% \CheckSum{368} % % \CharacterTable % {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z @@ -290,6 +271,7 @@ Keywords={LaTeX, dtx, source, DescribeMacro}% % Right brace \} Tilde \~} % \changes{v0.10}{2016/12/08}{\ 2016/12/08 Initial ver} +% \changes{v0.11}{2018/03/30}{\ 2018/03/30} @@ -314,23 +296,12 @@ Keywords={LaTeX, dtx, source, DescribeMacro}% % % \bigskip % -% {\small\copyright{} 2016} Brian Dunn\\ \small \texttt{bd@BDTechConcepts.com} +% {\small\copyright{} 2016--2018} Brian Dunn\\ \small \texttt{bd@BDTechConcepts.com} % % \vspace{.5in} % % {\Large \textup{\quicksummary}} % -% -% -% ^^A % \title{The \pkg{keyfloat} package\thanks{This document -% ^^A % corresponds to \pkg{keyfloat}~\fileversion, -% ^^A % dated \filedate.}} -% ^^A % \author{{\small\copyright{} 2016} Brian Dunn\\ \small \texttt{bd@BDTechConcepts.com}} -% ^^A % \published{} -% ^^A % \subtitle{\textup{Subtitle}} -% ^^A % -% ^^A % \maketitle -% % \vfill % % @@ -381,7 +352,7 @@ Keywords={LaTeX, dtx, source, DescribeMacro}% % % \pkg{dtxdescribe} extends this concept to include a number of % additional objects, such as booleans and keys. -% To help identify what is being described in the margin, small tags +% To help identify what is being described in the margin, small tags are % added to the name, such as ``Env'', ``Bool'', or ``Key''. % These new objects are also listed in the index with the same tag % shown after their names, and also by group. @@ -397,7 +368,6 @@ Keywords={LaTeX, dtx, source, DescribeMacro}% % This documentation and its index show examples of these macros in use. % % While the index may appear to be overkill for a small package, -% \margintag{Too much!} % keep in mind that it includes a number of fictional entries from the examples. % Extensive cross-referencing can be useful for larger works. % And, of course, you need not cross-reference everything! @@ -1140,10 +1110,11 @@ Keywords={LaTeX, dtx, source, DescribeMacro}% % Index by tag and class: % % Write the tag and class as a group, under which is the name and the formatted name. +% \changes{v0.11}{2018/02/05}{Index tag no longer plural.} % \begin{macrocode} \begingroup% \DTXD@origwrindex{% -#4s:\levelchar% index tag +#4:\levelchar% index tag \ifblank{#1}{}{[#1]:\levelchar}% class #2\actualchar{\protect\ttfamily#2}% name \encapchar #5}% @@ -1254,17 +1225,17 @@ Keywords={LaTeX, dtx, source, DescribeMacro}% % then printed and sorted by the macro name with the backslash, and the tag. % % Write indextag:>(class):>csname\verb+|usage+ +% \changes{v0.11}{2018/02/05}{Index tag no longer plural.} % \begin{macrocode} \begingroup% \DTXD@origwrindex{% -#4s:\levelchar% index tag +#4:\levelchar% index tag \ifblank{#1}{}{[#1]:\levelchar}% class \DTXD@verbatimcmd{#2}% name \encapchar #5}% \@esphack% \ignorespaces% } - % \end{macrocode} % \end{macro} % @@ -1604,11 +1575,13 @@ Keywords={LaTeX, dtx, source, DescribeMacro}% % \begin{macro}{\watchout} \oarg{text} % % Prints a warning sign and optional text. +% +% \changes{v0.11}{2018/03/30}{Changed to \cs{raggedleft}.} % \begin{macrocode} \newcommand{\watchout}[1][]{% \@ifundefined{@captype}{% not float? % \@bsphack% -\marginpar{\hspace*{\fill}% +\marginpar{\raggedleft% \textcolor{red!50!black}{\warningsign\normalsize\quad#1}}% % \@esphack% \ignorespaces% @@ -1616,7 +1589,6 @@ Keywords={LaTeX, dtx, source, DescribeMacro}% } % \end{macrocode} % \end{macro} -% % \subsection{The \env{dtxexample} Environment} diff --git a/Master/texmf-dist/tex/latex/dtxdescribe/dtxdescribe.sty b/Master/texmf-dist/tex/latex/dtxdescribe/dtxdescribe.sty index e6d503be509..359c83d3342 100644 --- a/Master/texmf-dist/tex/latex/dtxdescribe/dtxdescribe.sty +++ b/Master/texmf-dist/tex/latex/dtxdescribe/dtxdescribe.sty @@ -19,7 +19,7 @@ \NeedsTeXFormat{LaTeX2e} \ProvidesPackage{dtxdescribe} - [2016/12/08 v0.10 Describe additional object types in dtx source files.] + [2018/03/30 v0.11 Describe additional object types in dtx source files.] @@ -124,7 +124,7 @@ \encapchar #5}% \begingroup% \DTXD@origwrindex{% -#4s:\levelchar% index tag +#4:\levelchar% index tag \ifblank{#1}{}{[#1]:\levelchar}% class #2\actualchar{\protect\ttfamily#2}% name \encapchar #5}% @@ -172,7 +172,7 @@ \encapchar #5}% \begingroup% \DTXD@origwrindex{% -#4s:\levelchar% index tag +#4:\levelchar% index tag \ifblank{#1}{}{[#1]:\levelchar}% class \DTXD@verbatimcmd{#2}% name \encapchar #5}% @@ -181,7 +181,6 @@ } - \renewcommand*{\DescribeMacro}[2][]{% \@bsphack% \@ifundefined{@captype}{% not float? @@ -316,7 +315,7 @@ \newcommand{\watchout}[1][]{% \@ifundefined{@captype}{% not float? -\marginpar{\hspace*{\fill}% +\marginpar{\raggedleft% \textcolor{red!50!black}{\warningsign\normalsize\quad#1}}% \ignorespaces% }{}% not float? -- cgit v1.2.3