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
[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... 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. Aidan
Re: [PHP-DOC] RE: Zend API documentation.
My personal opinion: I think it's great to have these zend docs available at phpdoc. Since the manual is at first glance a manual for users, and already very large (and will grow in future) I hope this will _NOT_ become a part of the manual. Providing it as seperate developer manual would be a better idea IMHO. But I am also no old pro and nothing to decide. having the manual as it is now as the user-manual and the zend api docs as a start for a developer-manual that reference each other is a good thing [tm] imho. the user-manual may have an appendix extending PHP which contains a pointer to the developer-manual +1 for having a users manual, and a developers manual separately :) +1 for having a complete user manual, and a shortened user manual downloadable :) As for translation, the users manual is the most important part. Developers often know english much better than users, so they would be happy with an up to date english developers manual IMHO. So the separation not just helps users but also translators to ditinquish what is the most important to translate. Extending PHP 3 can also be moved to the developers manual. Goba
[PHP-DOC] RE: Zend API documentation.
I spoke to Zeev in IRC shortly, and he has given me permission to move the Zend API documentation into the phpdoc tree. I checked it out a short while ago, and am going through cleaning it up to phpdoc style. I am not going to commit this just yet -- i wanted to get any comments first, since i'm not an old pro at phpdoc yet - so i want to check everything out first. Thanks, James -- James Cox :: [EMAIL PROTECTED] Please CC me when replying to my messages
Re: [PHP-DOC] RE: Zend API documentation.
Hi, On Wed, 2 Jan 2002 22:14:30 - James Cox [EMAIL PROTECTED] wrote: I am not going to commit this just yet -- i wanted to get any comments first, since i'm not an old pro at phpdoc yet - so i want to check everything out first. I am no old pro either, but I think is is great to have the API docs accessable for phpdoc people. visionperhaps they will get updated ;)/vision Jan -- Q: Thank Jan? A: http://geschenke.an.dasmoped.net/
Re: [PHP-DOC] RE: Zend API documentation.
James Cox wrote: I spoke to Zeev in IRC shortly, and he has given me permission to move the Zend API documentation into the phpdoc tree. I checked it out a short while ago, and am going through cleaning it up to phpdoc style. I am not going to commit this just yet -- i wanted to get any comments first, since i'm not an old pro at phpdoc yet - so i want to check everything out first. great deal! let's do it :-) I had checked out the zapidoc @ zendcvs some time ago and it seemed that some things are outdated and from the book by till/tobias. is that right or am I wrong? -moh
Re: [PHP-DOC] RE: Zend API documentation.
Hi I am not going to commit this just yet -- i wanted to get any comments first, since i'm not an old pro at phpdoc yet - so i want to check everything out first. I am no old pro either, but I think is is great to have the API docs accessable for phpdoc people. visionperhaps they will get updated ;)/vision Jan My personal opinion: I think it's great to have these zend docs available at phpdoc. Since the manual is at first glance a manual for users, and already very large (and will grow in future) I hope this will _NOT_ become a part of the manual. Providing it as seperate developer manual would be a better idea IMHO. But I am also no old pro and nothing to decide. Friedhelm
Re: [PHP-DOC] RE: Zend API documentation.
Hi, On Wed, 2 Jan 2002 23:39:37 +0100 Friedhelm Betz [EMAIL PROTECTED] wrote: My personal opinion: I think it's great to have these zend docs available at phpdoc. Since the manual is at first glance a manual for users, and already very large (and will grow in future) I hope this will _NOT_ become a part of the manual. Providing it as seperate developer manual would be a better idea IMHO. But I am also no old pro and nothing to decide. having the manual as it is now as the user-manual and the zend api docs as a start for a developer-manual that reference each other is a good thing [tm] imho. the user-manual may have an appendix extending PHP which contains a pointer to the developer-manual Jan -- Q: Thank Jan? A: http://geschenke.an.dasmoped.net/
RE: [PHP-DOC] RE: Zend API documentation.
I'm guessing that much could be out of date, however that would be one of the core things of getting it into the hands of the phpdoc team. :) James -Original Message- From: Richard Samar [mailto:[EMAIL PROTECTED]] Sent: Wednesday, January 02, 2002 10:21 PM To: James Cox Cc: phpdoc Subject: Re: [PHP-DOC] RE: Zend API documentation. James Cox wrote: I spoke to Zeev in IRC shortly, and he has given me permission to move the Zend API documentation into the phpdoc tree. I checked it out a short while ago, and am going through cleaning it up to phpdoc style. I am not going to commit this just yet -- i wanted to get any comments first, since i'm not an old pro at phpdoc yet - so i want to check everything out first. great deal! let's do it :-) I had checked out the zapidoc @ zendcvs some time ago and it seemed that some things are outdated and from the book by till/tobias. is that right or am I wrong? -moh
Re: [PHP-DOC] RE: Zend API documentation.
James Cox wrote: I'm guessing that much could be out of date, however that would be one of the core things of getting it into the hands of the phpdoc team. :) James I just talked to Hartmut at the phpconf in Frankfurt and there were ideas of moving it to phpdoc and also to make it up2date :-) ...I though don't want talk for anyone. So I'll wait and see what he has to say this progress now :-) -moh
Re: [PHP-DOC] RE: Zend API documentation.
Philip Olson wrote: I just talked to Hartmut at the phpconf in Frankfurt and there were ideas of moving it to phpdoc and also to make it up2date :-) ...I though don't want talk for anyone. So I'll wait and see what he has to say this progress now :-) Sounds good. Here are a couple initial options that come to mind: a) Add a Warning entity on outdated zend api pages until the given page is up-to-date. OR b) Don't include any zend api docs until all is up-to-date. In order not to omit 90% of the apiddoc (this is just a tiny little exaggerated estimation!) I think a) will make the majority of us more happy :-) ehh, what was c) again? :-) -moh
