CTAN Comprehensive TeX Archive Network

CTAN update: dtxdescribe

Date: February 2, 2022 4:18:22 PM CET
Brian Dunn submitted an update to the dtxdescribe package. Version: 1.03 2012-02-01 License: lppl1.3 Summary description: Describe additional object types in dtx source files Announcement text:
Now can describe hooks and a few other objects. Added a way to display macro nesting.
The package’s Catalogue entry can be viewed at https://ctan.org/pkg/dtxdescribe The package’s files themselves can be inspected at https://mirrors.ctan.org/macros/latex/contrib/dtxdescribe/
Thanks for the upload. For the CTAN Team Petra Rübe-Pugliese
CTAN is run entirely by volunteers and supported by TeX user groups. Please join a user group or donate to one, see https://ctan.org/lugs

dtxdescribe – Describe additional object types in dtx source files

The doc package includes tools for describing macros and environments in 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 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.

Packagedtxdescribe
Version1.09 2024-01-20
Copyright2016–2024 Brian Dunn
MaintainerBrian Dunn

Announcements

more

Guest Book Sitemap Contact Contact Author