blob: 43c326b2e0d073c581b3b2680906e9b232b23c35 (
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
|
Readme of TeXtoolspro
What is it
----------
TeXtoolspro This is a small set of utility very useful for doing
documenation in LaTeX . It's intended mainly for programmers.
It's composed of :
boxerer.py: - It creates structured boxes, one inside another
so the structure of data and functions can be easily shown
-It creates black boxes ( diagrams who show the inputs,outputs
and functions of a module or a function).
sectioner.py : - This is a front-end filter of LaTeX-modified ( very
little ) code, so you can write sections in a relative way ( not
\section, but \+, \4- , \n , and so on ). This is in fact a really
new thing in LaTeX(AFAIK) and quite worthy.
miarticle.cls: This is a LaTeX class that allows up to 14 levels
of nesting, needed for doing documentations ( usually 7 levels
are not enough).
How to run it.
---------------
Take a look at the end of boxerer.py, there you'll see good examples.
For sectioner,
python sectioner.py mode_of_use inputfile outputfile
mode_of_use is article or report or manolo. See documentation
for further details.
How to make the documentation.
------------------------------
Run "latex textoolspro.tex" several times , because it needs to update
the crossreferences and such.
Or use a ghostscript visor to view textoolspro.ps.
|
