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.
|The LaTeX Project Public License 1.3
|2016–2024 Brian Dunn
|TeX Live as dtxdescribe
MiKTeX as dtxdescribe
Download the contents of this package in one zip archive (475.6k).
- 2024-01-09 CTAN update: dtxdescribe
- 2023-01-04 CTAN update: dtxdescribe
- 2022-12-08 CTAN update: dtxdescribe
Maybe you are interested in the following packages as well.
- tkz-doc: Documentation macros for the TKZ series of packages
- colordoc: Coloured syntax highlights in documentation
- fcltxdoc: Macros for use in the author's documentation
- metainfo: Typeset document outline with metainfo