| 1 |
pgfopts - LaTeX package options with pgfkeys |
| 2 |
============================================ |
| 3 |
|
| 4 |
Using key-value options for packages and macros is a good way of |
| 5 |
handling large numbers of options with a clean interface. The |
| 6 |
`pgfkeys` package provides a very well designed system for |
| 7 |
defining and using keys, but does not make this available for |
| 8 |
handling LaTeX class and package options. The `pgfopts` package |
| 9 |
adds this ability to `pgfkeys`, in the same way that `kvoptions` |
| 10 |
extends the `keyval` package. |
| 11 |
|
| 12 |
Installation |
| 13 |
------------ |
| 14 |
|
| 15 |
The package is supplied in `.dtx` format and as a pre-extracted |
| 16 |
zip file, `pgfopts.tds.zip`. The later is most convenient for |
| 17 |
most users: simply unzip this in your local `texmf` directory. |
| 18 |
If you want to unpack the `.dtx` yourself, running `tex |
| 19 |
pgfopts.dtx` will extract the package whereas 'latex pgfopts.dtx |
| 20 |
will extract it and also typeset the documentation. |
| 21 |
|
| 22 |
Typesetting the documentation requires a number of packages in |
| 23 |
addition to those needed to use the package. This is mainly |
| 24 |
because of the number of demonstration items included in the |
| 25 |
text. To compile the documentation without error, you will |
| 26 |
need the packages: |
| 27 |
- `csquotes` |
| 28 |
- `helvet` |
| 29 |
- `hypdoc` |
| 30 |
- `listings` |
| 31 |
- `lmodern` |
| 32 |
- `mathpazo` |
| 33 |
- `microtype` |