Re: Re: peardoc2 (was) DB_Result::tableInfo() docs misleading

From: Date: Wed, 28 Aug 2002 15:27:46 +0000
Subject: Re: Re: peardoc2 (was) DB_Result::tableInfo() docs misleading
References: 1 2 3  Groups: php.pear.dev 
Request: Send a blank email to pear-dev+get-8714@lists.php.net to get a copy of this message
Alexander Merz wrote:
Alan Knowles wrote:
- is there a plan to get this on to cvs.php.net, I could start looking at moving APD,bcompiler,Soap, DB_DataObject and HTML_Template_Flexy into it.
In my last Peardoc2 related mail a wrote a list, which docs need to be transformed. If this done we can go ahead on cvs.
yeah - back to the old addage = read the first and last lines of an email and ignore the body :) From what I've seen the key changes are (in terms of authoring): a) breaking the pacage sub pages into individual files b) a bit more of a standard structure to the package sections. The only though I had was it would be nice to see all the sub packages listed on the main contents page, (I know the list will probably get a bit long, but it does save an additional page load most of the time, and that index page would probably be cached anyway.) eg. Authenticaiton - Auth - The auth package... Date - Date - for date manipulation... - Data_Calc for doing date calculations. ... HTML - HTML_Template_IT .... ....
You can already write peardoc2-compatible docs for the mentioned classes. See http://www-user.tu-chemnitz.de/~meal/php/peardoc2/peardoc2.zip which contains the peardoc2 sources and in en/authoring an readme and a template for authors.
Ok, since the manual regeneration appears to be done on sundays - I guess putting this in CVS next week ? and cancelling the next weeks regen while we get the last bits transfered... ? sound like a reasonable schedule.? I think if we just pulled the plug on the current manual, without making sure all the latest bits are in there, it could be a little annoying for some people. Regards Alan


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