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
|
Documentation README
====================
Warning
-------
Documentation is an important part of an application but this is one is in
its alpha stage and far from complete !
Requirements
------------
It uses the DocBook DTD and jade (together with cygnus stylesheets) to convert
it to HTML; I am not a docbook expert and the result is not optimal but I am
working on.
URLs:
Jade: ftp://ftp.jclark.com/pub/jade/
Cygnus stylesheets: ftp://ftp.cygnus.com/pub/home/rosalia/docware/
Layout:
-------
./ : man pages, Gaby tips, ...
C/ : English documentation
fr/: French documentation
[Note to translators: if you want to translate/write documentation in your
language, you simply have to create a 2-letter-locale directory]
Contributions
-------------
If you want to contribute (and since the user section is empty it shouldn't be
too difficult) just mail me and I'll agree :)
Misc notes
----------
I tried to use gnome-doc to produce the reference for plug-ins functions but it
was producting something too heavy for my LaTeX and I don't really have time to
search how to allow it to allocate more memory. So I hacked gnome-doc to
produce gaby-doc which output a lighter text and can be parsed without problems
by LaTeX.
Frederic Peters - Wed, 29 Sep 1999 19:34:27 +0200
|