CTAN Comprehensive TeX Archive Network

Directory macros/latex/contrib/dtxdescribe

README.txt
The LaTeX dtxdescribe package
Describe additional object types in dtx source files.

v1.01 — 2019/03/22
Copyright 2016–2019 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.

Download the contents of this package in one zip archive (340.4k).

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, 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
Home pagehttp://bdtechconcepts.com
Version1.02
LicensesThe Project Public License 1.3
Copyright2016–2019 Brian Dunn
MaintainerBrian Dunn
Contained inTeX Live as dtxdescribe
MiKTeX as dtxdescribe
TopicsDocumentation support
See alsodoc
...
Guest Book Sitemap Contact Contact Author