From brian.sorg at liberatinginsight.com Sun Mar 4 01:57:46 2007 From: brian.sorg at liberatinginsight.com (Brian Sorg) Date: Sat, 03 Mar 2007 20:57:46 -0500 Subject: [cl-pdf-devel] Documentation Effort Message-ID: <1172973466.13711.13.camel@melody.liberating> 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. 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 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. Take care, -- Brian Sorg Director & Founder Liberating Insight LLC brian.sorg at liberatinginsight.com Mobile: 260-602-1086 Office: 260-918-0490 From marc.battyani at fractalconcept.com Mon Mar 5 22:02:41 2007 From: marc.battyani at fractalconcept.com (Marc Battyani) Date: Mon, 5 Mar 2007 23:02:41 +0100 Subject: [cl-pdf-devel] Documentation Effort References: <1172973466.13711.13.camel@melody.liberating> Message-ID: <0c5101c75f71$fed8c230$1402a8c0@marcx2> "Brian Sorg" 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. Marc From marc.battyani at fractalconcept.com Fri Mar 30 20:32:21 2007 From: marc.battyani at fractalconcept.com (Marc Battyani) Date: Fri, 30 Mar 2007 22:32:21 +0200 Subject: [cl-pdf-devel] Documentation Effort References: <1172973466.13711.13.camel@melody.liberating> <0c5101c75f71$fed8c230$1402a8c0@marcx2> Message-ID: <100201c7730a$8495b760$1402a8c0@marcx2> "Marc Battyani" wrote: > "Brian Sorg" 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 From divanov at aha.ru Sat Mar 31 07:52:09 2007 From: divanov at aha.ru (Dmitriy Ivanov) Date: Sat, 31 Mar 2007 11:52:09 +0400 Subject: [cl-pdf-devel] Documentation Effort References: <1172973466.13711.13.camel@melody.liberating><0c5101c75f71$fed8c230$1402a8c0@marcx2> <100201c7730a$8495b760$1402a8c0@marcx2> Message-ID: <000001c77369$83168540$8100a8c0@digo> Hello Brian and Marc, | "Marc Battyani" wrote: | ...snip...| | 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... | ;-) Good effort! As the very fist note, I would suggest naming the libraries more "conventionally" and "uniformly": CL-PDF and CL-Typesetting instead of Cl-Pdf and Cl-Typesetting. Though tastes differ and I am by no means an expert in English :-) -- Sincerely, Dmitriy Ivanov