summaryrefslogtreecommitdiff
path: root/info/dtxgallery/README
blob: fe78ab4c2e2197d05b4dfa4b5d825276e69934a4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
============
 DTXGALLERY 
============

This work is a collection of files that demonstrate 
simple things that are possible with the flexible 
and under-appreciated docstrip file format.

It is intended as a companion to Scott Pakin's
excellent and influential "dtxtut" example of producing
LaTeX packages in this way.

This work consists of the following files:

--------------
dtxgallery.dtx

A `meta-example' showing how multiple .dtx files can be
documented in a single file. Read the .pdf version of this
file first. 
--------------

-----------------
single-source.dtx

This is an example of both the .sty and .ins
files being extracted from the .dtx file. This
allows maintenance of a single source file
but still produces a "standard-behaviour" .dtx/.ins
pair for upload to CTAN.
-----------------

--------------------
conditional-code.dtx

This example shows how code can be extracted in different
contexts. For example, debug code in a package can be
included in the source .dtx file but be automatically
stripped out for the public release version of the package.
--------------------

-------------
rearrange.dtx

This example demonstrates how source code may
be written and documented in a different logical 
order than in which it is required to execute.

This can be useful, for example, when default 
values are provided at the very stage of the package 
loading, but you wish to describe them first in the 
main body of the (non-technical) documentation.
-------------


Maintained by Will Robertson, 2007.
Please send comments and suggestions (entire examples very
welcome!) to me at the typeset string of:
  \zap@space wspr \number`\Q \char64 gmail \char46 com {}

Distributed under the LaTeX Project Public License, version
1.3c or higher (your choice).