Re: [PHP-DOC] Re: Zend API documentation to be moved to the phpdoc repository
I propose moving the Zend API docs to phpdoc/en/zendapi, but we need to make up a good folder structure. We need the XML files, but not simpler then Extending_Zend_xml, and we also need the figures and source examples in some sensible folder structure. I also don't know whether it would be better to move on the CVS server (retaining history), or just copy-add-commit-remove_on_old_file... Why don't we stick it in phpdoc/en/chapters/zendapi and move the streams stuff into phpdoc/en/chapters/streams? As for the structure relative to this directory, can't we keep the current directory structure on the zend site? I'd like to see the CVS files copied across, retaining the history. The chapters folder is silly. There is no such thing in the manual we call chapters. We can have an en/developers/ folder for example, where we put the developers docs (zend and streams for now). Goba
Re: [PHP-DOC] Re: Zend API documentation to be moved to the phpdoc repository
The chapters folder is silly. There is no such thing in the manual we call chapters. We can have an en/developers/ folder for example, where we put the developers docs (zend and streams for now). Goba We have at the moment: PHP API: Interfaces for extension writers (http://livedocs.homelinux.com/en/api.html) That chapter contains the steams chapter. http://livedocs.homelinux.com/en/streams.html I'm not sure what the proper words are, section / chapter, whatever. I agree we should create a section of the manual for things which don't apply to general users. developers sounds good to me. phpdoc/en/developers/zend phpdoc/en/developers/streams Is that the only thing we have to decide? If yes, then we need to: a) move the zend docs to proposed folder, disregarding history b) move the stream docs to proposed folder c) add a preface for the developer section Anything else?
Re: [PHP-DOC] Re: Zend API documentation to be moved to the phpdoc repository
The chapters folder is silly. There is no such thing in the manual we call chapters. We can have an en/developers/ folder for example, where we put the developers docs (zend and streams for now). Goba We have at the moment: PHP API: Interfaces for extension writers (http://livedocs.homelinux.com/en/api.html) That chapter contains the steams chapter. http://livedocs.homelinux.com/en/streams.html I'm not sure what the proper words are, section / chapter, whatever. I agree we should create a section of the manual for things which don't apply to general users. developers sounds good to me. phpdoc/en/developers/zend phpdoc/en/developers/streams Is that the only thing we have to decide? If yes, then we need to: a) move the zend docs to proposed folder, disregarding history b) move the stream docs to proposed folder c) add a preface for the developer section Anything else? Oh, yes! A lot!! Update the Zend API stuff... :) +1 for en/developers Nuno
Re: [PHP-DOC] Re: Zend API documentation to be moved to the phpdoc repository
What about having sub-chapters for the API docs for each PHP version. For example there are still PHP 3 developer docs in the manual, the Zend API Docs are for PHP 4, and we lack PHP 5 information. This is all different so this is something to think about. We first need to know if there are many API changes between Zend 1 and 2. For example, the Streams API is identical, so there is no need to replicate it. Nuno
Re: [PHP-DOC] Re: Zend API documentation to be moved to the phpdoc repository
On Wed, 13 Oct 2004, Nuno Lopes wrote: What about having sub-chapters for the API docs for each PHP version. For example there are still PHP 3 developer docs in the manual, the Zend API Docs are for PHP 4, and we lack PHP 5 information. This is all different so this is something to think about. We first need to know if there are many API changes between Zend 1 and 2. For example, the Streams API is identical, so there is no need to replicate it. Most ofphp 4 applies to php 5, except for new stuff, and oo stuff. Derick -- Derick Rethans http://derickrethans.nl | http://ez.no | http://xdebug.org
Re: [PHP-DOC] Re: Zend API documentation to be moved to the phpdoc repository
Putting streams stuff into the chapters folder was a mistake in the first place, since 'chapters' is depreciated, it is not supposed to have new files, and stuff is moved out of it to more sensible places (eg. install)... Is that the only thing we have to decide? If yes, then we need to: a) move the zend docs to proposed folder, disregarding history b) move the stream docs to proposed folder c) add a preface for the developer section We might need to restructure some of the Zend docs (ie. change container tags) to enable smooth integration into the part structure we use additionaly. Anything else? Oh, yes! A lot!! Update the Zend API stuff... :) Of course :) What about having sub-chapters for the API docs for each PHP version. For example there are still PHP 3 developer docs in the manual, the Zend API Docs are for PHP 4, and we lack PHP 5 information. This is all different so this is something to think about. Interesting question. How do we cope versioning of the development docs... Now the Zend API docs are even not actual for PHP 4 AFAIK. Since the Zend API have not changed much between Zend Engine 1 and 2, we might do best with a bit of separation on the OO part only. Goba
Re: [PHP-DOC] Re: Zend API documentation to be moved to the phpdoc repository
On Tue, 12 Oct 2004, Aidan Lister wrote: I propose moving the Zend API docs to phpdoc/en/zendapi, but we need to make up a good folder structure. We need the XML files, but not simpler then Extending_Zend_xml, and we also need the figures and source examples in some sensible folder structure. I also don't know whether it would be better to move on the CVS server (retaining history), or just copy-add-commit-remove_on_old_file... Goba Why don't we stick it in phpdoc/en/chapters/zendapi and move the streams stuff into phpdoc/en/chapters/streams? As for the structure relative to this directory, can't we keep the current directory structure on the zend site? I'd like to see the CVS files copied across, retaining the history. The history is pretty much empty, so there is no good reason for doing that. Derick -- Derick Rethans http://derickrethans.nl | http://ez.no | http://xdebug.org
