Re: PEAR Documentation

Bonjour, Arnaud Limbourg wrote:

Timothy Marsolais wrote:

Hi Everyone, I have been reading the list for a while, asking questions every once in awhile, and using PEAR in my sites for almost 2 years. Unfortunately, I am a self-taught programmer and sometimes struggle with the simplest of things. In fact, I doubt I will ever have the literacy to contribute or help maintain a package. My skill set, however, is in writing--my degrees are in English. So, I would like to contribute to the PEAR community by writing end-user documentation. My hope is that with a larger body of end-user documentation and tutorials (which seems to be everybody's LEAST favorite thing to produce) we can accelerate the rate at which programmers start utilizing PEAR in their projects. It might also help me learn more--which means less newbie questions on the lists. ;-) So, would anyone like a little help?

Hi tim, It is a great offer as documentation is so badly needed :) There is a dedicated mailing-list for documentation purposes (pear-doc@lists). There are several options to contribute documentation. You can write plain text and send it to the pear-doc list hoping that somebody will convert it to docbook; to be honest the doc team is small and it may take a long time for the document to be converted. Another solution is to write docbook (which is a set of xml files) directly. You can see the sources that generates the pear manual on cvs.php.net under the pear-doc directory. Arnaud. This project [1] was in stand-by for quite 2 monthes, but I still hope to provide soon some Docbook render by Text_Wiki.

The goal is to be able to translate docs existing in some wiki format (as e.g. Text_Wiki's doc itself or MDB2's wiki) into the Docbook format so they can be integrated in the official pear's doc. That will not do 100% of the job, some manual integration will certainly still be needed. I have some contacts with the Smarty guys who would also be interested by such a tool, so I hope to get some help this side as I'm in no case a Docbook guru. Any help would be appreciated, at least when I'm ready to make some integration tests. Regards -- toggg [1] http://cvs.php.net/viewcvs.cgi/pear/Text_Wiki/Text/Wiki/Render/Docbook/