phpdoc / docbook / PEAR

From: Date: Fri, 16 Aug 2002 08:13:23 +0000
Subject: phpdoc / docbook / PEAR
Groups: php.pear.dev 
Request: Send a blank email to pear-dev+get-8459@lists.php.net to get a copy of this message
Hi! As I heard about some progress in the PEAR::PHPDoc development to add DocBook output filters, I needed to stop by and add my comments. First of all I really interested in all tools useable with PHPDoc (including PEAR::PHPDoc and PHPDocumentor). Sometime lately there were some discussions on merging these two projects into PEAR (something like the PEAR::DB and Metabase merger) or replacing the PEAR one completely with PHPDocumentor. I thought this would be a good move, but was never done... I think PHPDocumentor is superior in many aspects, and it's especially good to read English documentation about it ;)) Well, we may go into a discussion on merging the two, but the real point I write this letter is not that ;) I'll hold two sessions at the PHP Conference this november in Frankfurt. The titles are: Writing rich clients for your web application with PHP-GTK and XML-RPC Documenting your PHP code with PHPDoc and DocBook XML The second one connects me here ;)) What I would like to do actually is to document the application developed for the first session and thus present a "real life situation" example on how PHPDoc and DocBook can be used side-by-side to document API details and concepts. As my session description shows I would like to present a script which converts PHPDoc comments to DocBook, so you can have one central documentation for your concepts and your API in DocBook XML, and then you can generate HTML/PDF/RTF with the usual tools from it. This is where are roads meet ;) As I have heard the PEAR::PHPDoc tool is going to be extended to include such a converter, and I would not like to work separately, so I would like to ask about this progress, and what needs to be done. Actually I planned to write a new "output format" for PHPDocumentor, which I already experimented with, but if it turns out that PEAR::PHPDoc can meet the requirements in shorter time, then I'll probably join in here. Creating DocBook XML as an output format is in some aspects much easier then creating any other output, because for example there's no need to play with links, one just need to put in appropriate IDs, and DocBook rendering apps will do the rest (find the output file that the link points to, render the link correctly)... Unlike many of the php.net projects I am in, this has a deadline and I would not like to cause disillusion to my listeners with leaving this "selling point" out of the actual session... Goba

« previous php.pear.dev (#8459) next »