chiark / gitweb /
.mdw-build.conf: Don't try `vpath' builds with this package.
[mdwtools] / README
1 The `mdwtools' collection
2
3
4 Licence
5
6         The `mdwtools' collection copyright (c) 2003 Mark Wooding.  It
7         is free software.  You are allowed (and encouraged) to share it
8         with your friends, or sell it to people.  You may modify and
9         redistribute it under the terms of the GNU General Public
10         License, either version 2 or (at your option) any later version.
11         See the file `COPYING' for details.  There's a pretty formatted
12         version in `gpl.tex'.
13
14         Clarification: I do /not/ consider that a document which uses
15         `mdwtools' is a `derived work'.  Hence, authors need not provide
16         source to their documents just because they use `mdwtools'.
17         However, I encourage authors to share their LaTeX sources, even
18         if they're as grim as mine.
19
20
21 Overview
22
23         For details about what the packages do, please read the individual
24         documentation.  This is just a quick overview.
25
26         at.sty          Define @-commands, just like you currently can
27                         with \-commands.  The advantage is that nobody's
28                         already taken all the short names.
29
30         centre.sty      Commands like \centre, for those of us who write
31                         English.
32
33         cmtt.sty        Typeset stuff in a typewriter face and use all
34                         the fancy characters, without messing with
35                         `verbatim' stuff.
36
37         colour.sty      Like `color.sty', only with English spellings.
38
39         crypto.sty      A grab-bag of stuff for writing crypto papers.
40                         There's some simple algorithm typesetting and
41                         some macros for typesetting some standard
42                         notations.
43
44         doafter.sty     A TeXnician's tool.  \doafter<token>{...}
45                         expands <token> after the {...} group is done,
46                         including any \aftergroup tokens attached to
47                         it.  This is largely useful to deal with colour
48                         hacking.
49
50         exercise.sty    Typeset exercises, and keep the answers to the
51                         end.  Handles numbering the answers properly,
52                         and inserting section titles in the answers
53                         section.
54
55         footnote.sty    A `footnote' environment for complex or long
56                         footnotes; saving footnotes in tables and
57                         parboxes.  Sadly incompatible with Robin
58                         Fairbairns's `footmisc'.
59
60         mathenv.sty     Some mathematical alignment environments.
61                         Replaces `eqnarray' with a good version; does
62                         very good matrix typesetting.  Documented in
63                         `mdwtab.dtx'.
64
65         mdwkey.sty      A TeXnician's tool.  Like `keyval.sty', but
66                         better -- more features, more correct behaviour
67                         with braces.
68
69         mdwlist.sty     Some simple list hacking.  A versatile
70                         `description' list; suspend and resume
71                         enumerations; compactify lists by removing
72                         vertical spacing between items.
73
74         mdwmath.sty     A grab-bag of mathematical things.  Square roots
75                         without the overlines; fix spacing for \pmod in
76                         running text; neato new generalized-fraction
77                         thing; fix \bigg... to adjust with text size; a
78                         bad \qed implementation.  (Also contains an
79                         earlier replacement for `eqnarray'.)
80
81         mdwtab.sty      The flagship: a replacement for LaTeX's
82                         `tabular' and `array' environments.  Too many
83                         improvements to list here.  Highlights: correct
84                         handling of lists in p{...} columns; good
85                         vertical spacing around rules; correct vertical
86                         alignment of ruled tables.  Now supports
87                         coloured tables (in `mtcolour.sty').
88
89         mdwthm.sty      Theorem typesetting.  Nothing earthshattering; I
90                         just use it in my documents.  Comes with a
91                         theorem style to hang the numbers in the
92                         margins.
93
94         mtcolor.sty     Like `mtcolour.sty' (below) for Americans.
95
96         mtcolour.sty    The colour support module for `mdwtab.sty'.
97                         Documented in `mdwtab.dtx'.
98
99         poetry.sty      Relatively straightforward typesetting for
100                         poems, centred in the page.  More a pile of
101                         infrastructure than something immediately
102                         usable.
103
104         slowbox.sty     Skipping over boxes which are slow to draw.
105
106         svcolor.sty     Like `svcolour.sty' (below) for Americans.
107
108         svcolour.sty    The colour support module for `sverb.sty'.
109                         Documented in `sverb.dtx'.
110
111         sverb.sty       Verbatim-like commands and environments.
112                         Supports `tab' characters; reads stuff from
113                         files; writes stuff to files.  Neato `demo'
114                         environment for showing off LaTeX packages.  Now
115                         has colour support.
116
117         svsplit.sty     Word-wrapping verbatim environment.  Documented
118                         in `sverb.dtx'.
119
120         syntax.sty      Former flagship.  Typesets grammars and syntax
121                         diagrams.
122
123 \f
124 Local variables:
125 mode: text
126 End: