summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/dtxdescribe/README.txt
blob: af8731de747d029dacab97a628c4f8ea0a93efc5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
The LaTeX dtxdescribe package
Describe additional object types in dtx source files.

v1.05 — 2022/09/08
Copyright 2016–2022 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.