Re: future of PEAR

However, It is able to take tutorials that you write in docbook format and do linking between the tutorials and API documentation as desired. Regards, Greg Alexey Borzov wrote:

Hi! Stefan Neufeind wrote:

While we're at it: Afaik some while ago someone raised a short discussion on how to actually write docs. Greg said there are howtos for phpDocumentor - but haven taken a short look at them myself a while ago I must say that I was only able to get a simple doc from the inline commands with phpDocumentor. Maybe could someone who is familiar with writing docs please post a link to a small howto (2 pages at most)? This howto should then include all the steps from generating the docs from inline comments, improving them by writing extensive additional documentation around that and submitting it to the doc- system used at pear.php.net. Would really much appreciate that!

Here is a short howto for adding docs (not API docs that are handled by phpDocumentor): 0) Checkout peardoc dir from CVS repository, 1) Write docs in plain text format with your favourite editor, 2) Add DocBook markup using the online DocBook manual and using existing docs as a reference, 3) Use 'configure', 'make test', 'make html' commands to check whether the docs actually build and look OK, 4) Use 'cvs add' and 'cvs commit' commands to add the docs to peardoc. They will appear online on Sunday. That's it. phpDocumentor is a wonderful package, but it is currently unable to write tutorials, you should do this yourself. ;]