summaryrefslogtreecommitdiff
path: root/support/textoolspro/README.textoolspro
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /support/textoolspro/README.textoolspro
Initial commit
Diffstat (limited to 'support/textoolspro/README.textoolspro')
-rw-r--r--support/textoolspro/README.textoolspro40
1 files changed, 40 insertions, 0 deletions
diff --git a/support/textoolspro/README.textoolspro b/support/textoolspro/README.textoolspro
new file mode 100644
index 0000000000..43c326b2e0
--- /dev/null
+++ b/support/textoolspro/README.textoolspro
@@ -0,0 +1,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.
+