Re: PEAR Documentation?

At 10:21 AM 11/24/2000 +0100, Ulf Wendel wrote:

Sterling Hughes schrieb: That is a project I have here at Pentap (modifying PHPDoc to output Docbook XML), however, all I can really say is that I'm working on it, I don't have That's not really a hard job for someone who know XSL in detail. Take the generated XML files and transform them into DocBook. Make sure to use Version 4.12. Prior version don't have any notation for OO language elements as far as I know. And PEAR is OO no matter wheter Pentab Sources are OO or not...

Sure thang...

Please do not change the XML document generation itself. A change might lead us to different PHPDoc distributions. As long as lots of people use PHP 3, I will keep PHP 3 compatiblity. This means the template renderer will survive for a long time. Reading DocBook XML is much harder than reading the internal XML format. DocBook as an internal format would make it unneccessarily complicated and I do not appreceate DocBook as the internal format.

I'm not going to, I was planning on adding an XML rendering layer. Sort of like the html rendering layer. PHPDoc has support for multiple rendering layers (or with a little modification it would be possible), correct?

I think perhaps we should be a little reluctant to document the PEAR classes in the online manual itself. Perhaps build another repository for PEAR documentation (with a note that PEAR code is distributed with PHP at the moment). Then link to this repository in the online manual... That's the way we have to go on the long run. But only very few PEAR elements are already worth to get documented. The primary focus should be a big clean-up and coordination of all the PEAR stuff. The bad thing is that knowbody has the time to do so.

I'm already working on it. All I really need to get is the module browsing interface put together and convince our resident design expert to whip something nice together and I'll have something in early december. -Sterling