--- Cody Koeninger <[EMAIL PROTECTED]> wrote: > On 1/9/06, Peter Seibel <[EMAIL PROTECTED]> wrote: > > In fact, an excellent gardener's project (one suggested to > > me when we were first starting by Edi Weitz) would be to > > write a user manual for cl-typesetting and cl-pdf. They are, > > I can attest, excellent libraries, but have almost no > > documentation.
I agree. cl-typesetting is of considerable interest to me, so I've downloaded it for a look, and I might have to document it out of self defense if I can figure it out :-). I've got a copy of TeX - the program on order so maybe that will help me orient myself. > Sounds interesting. Just for kicks, I just ran cl-pdf through > cl-doc. Not many docstrings for it to pull out, but here's > the results: > http://koeninger.org/projects/gardeners/cl-doc/cl-pdf/ > (no guarantee those links will stay up for long) Eeek. Peter, since you've used cl-typesetting to do something non-trivial, perhaps you could write a "cl-typesetting for clueless noobs" short tutorial? That would let us orient ourselves and perhaps start wading into the code adding docstrings. Part of the problem with creating documentation without knowing the program is it's an iterative process - you have to keep going back and correcting earlier documentation as you become progressively less clueless. > > And of course the documentation for those libraries, if no > > others, should be generated using the libraries themselves. Heh - chicken/egg problem. > Are you suggesting pdf-only documentation? brrr . . . cl-typesetting is potentially very powerful (as I understand it) in terms of what it can output, but you have to define what you want to do. What would be really nice is to implement TeX on top of it, and I gather it might even (or eventually) be capable of that, but it's not a simple proposition. Once I get my copies of the TeX documentation I will probably try to flesh out the math support, since that'll be my primary focus from a Math GUI standpoint. Maybe even make a "literate document" of of it since I'm hoping it can someday be part of the Axiom system... but that's a lotta work. Cheers, CY __________________________________________ Yahoo! DSL Something to write home about. Just $16.99/mo. or less. dsl.yahoo.com _______________________________________________ Gardeners mailing list [email protected] http://www.lispniks.com/mailman/listinfo/gardeners
