[cl-pdf-devel] Documentation Effort

[Marc Battyani]

"Marc Battyani" <marc.battyani at fractalconcept.com> wrote:
> "Brian Sorg" <brian.sorg at liberatinginsight.com> wrote:
>
>> As some of you know I started working on some cl-pdf documentation a few
>> years ago, but that effort ran out of steam fairly quickly.
>
> Hehe, I told you: writing documentation is boring ;-)
>
>> Well I am back into using cl-pdf more these days and have starting
>> working on documenting it again. This time however my goal is as
>> follows:
>>
>> 1. Produce the documentation entirely in Cl-pdf and Cl-typesetting 2. 
>> Ensure that the source to the documentation provides a clear working
>> example. 3. Make it modular enough that anyone could contribute a chapter
>
> Very good idea!
> Maybe a small markup/macro language for the doc will be a good idea.
>
>> I have a basic start to the documentation online right now on my
>> website. You can download the pdf and documentation from 
>> http://www.liberatinginsight.com/cl-pdf/cl-pdf-doc.tar.gz I would welcome 
>> any comments and/or suggestions on what the content
>> should look like, how it should be structured etc.  Also if anyone sees
>> better ways to organize and format the cl-pdf-doc code itself please let
>> me know. Of course if anyone is interesting in helping put it together I
>> would appreciate the help. Once the basic structure is in place I will 
>> include this in the cl-pdf
>> repository, but I want to hold off a little while until I can be fairly
>> confident that major organizational changes don't need to happen.
>
> Seems a good idea for me.

Brian sent me what he has started for the documentation of cl-typesetting 
and cl-pdf. I've put it into a new "documentation" directory in 
cl-typesetting.

Feel free to add content and/or improve it when you have some time... ;-)

Marc