New on CTAN: dtxdescribe
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.
The package’s Catalogue entry can be viewed at http://www.ctan.org/pkg/dtxdescribe The package’s files themselves can be inspected at http://mirror.ctan.org/macros/latex/contrib/dtxdescribe/
Thanks for the upload. For the CTAN Team Petra Rübe-Pugliese
We are supported by the TeX users groups. Please join a users group; see http://www.tug.org/usergroups.html .
dtxdescribe – Describe additional object types in dtx source files
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, hooks, sockets, plug, keys, packages, classes, options, files, commands, arguments, and other objects, and also works with the standard document classes as well, for those who do not wish to use the .dtx format.
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.
The dtxexample environment is provided for typesetting example code and its results. Contents are displayed verbatim along with a caption and cross-referencing. They are then input and executed, and the result is shown.
Environments are also provided for displaying verbatim or formatted source code, user-interface displays, and sidebars with titles.
Macros are provided for formatting the names of inline LaTeX objects such as packages and booleans, as well as program and file names, file types, internet objects, the names of certain programs, a number of logos, and inline dashes and slashes.
| Package | dtxdescribe |
| Version | 1.09 2024-01-20 |
| Copyright | 2016–2024 Brian Dunn |
| Maintainer | Brian Dunn |