Internals documentation part created!
| From: | Gabor Hojtsy | Date: | Sun, 21 Aug 2005 16:23:07 +0000 |
| Subject: | Internals documentation part created! | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969369673@lists.php.net to get a copy of this message | ||
Cheers guys,
Now this was a long todo item, we must admit :) I am going to commit my
changes in a few minutes, which finally integrate ZendAPI into the
manual, and move PHP 3 and PHP 4 related development information to one
part.
What is done?
--------------
- ZendAPI now resides in phpdoc/en/internals/zendapi with all the
figures, and all the content. I only made structural changes to the
files (ie. sect1 instead of chapter, sect2 instead of section), due to
the pushing down of the content one level in the manual TOC.
- Streams API docs now live in phpdoc/en/internals/streams. These files
also needed some small structural modifications, but since <refentry> is
allowed in <sect1>, there were only small changes.
- 'Extending PHP 3' now lives in phpdoc/en/internals/extendphp3.xml.
Since we are not going to maintain this file, I opted for staying in the
one file format, instead of splitting it up.
What does this mean?
--------------------
- Now we have all the development related docs in one concentrated place
in the phpdoc file system, as well as the manual TOC. This should help
readers and authors.
- By keeping Zend API docs in phpdoc (as agreed by Zend Technologies),
it is more visible, there is more chance that someone will eventually
update it, and polish it. It is also possible to translate now, but I
would not encourage anyone to translate the current outdated content.
Does it work?
-------------
I have "make test"-ed and "make html" tested my modifications, and it
seems that everything is fine. Zend figures still work fine. You need to
do an autoconf and a ./configure after updating your local phpdoc CVS
copy, since the configure file was also changed (now there is no need to
search for Zend stuff elsewhere).
Short term TODO
---------------
- Check the structure, find any initial problems, which should be fixed
before proceeding. Someone else is needed to look at this, since I am
somewhat attached to this structure :)
- Get rid of most of the Zend API figures. As far as I see, only two
figures are necessary from the current set (php structure, and phpinfo
output), since the others are only text output screen captured. These
screens can easily be marked up with text. I hope someone will pick this
up :)
- Test whether the other build options still work, fix them as needed. I
hope someone will pick this up :)
- Signal PHP 4, PHP 3 and PHP 5 specific sections in this part. Someone?
Long term TODO
--------------
Update the Zend API section for the latest Zend Engine 1. Either open a
new section for Zend Engine 2, describing the changes, or mix with Zend
Engine 1, providing reference changelog like notes. If the short term
TODO items are completed, we should send a notice to the internals list,
so maybe someone will pick up this long term TODO item :)
Have a nice weekend,
Gabor Hojtsy / Goba