PHPDOC HowTo Summary

[email protected] (Salah Faya) Tue, 13 Nov 2007 13:50:17 +0300
Newsgroups php.doc.ar
Message-ID <[email protected]>
Dear all, and Abu Musaab,
 
 
There're a lot to be explained which has to be read directly from the howto website, but I will try to summarize the process in few points in order to give an overall idea about the process:
1- The PHP Manual documents are written in XML files, not the same order of the online php manual.
2- Translating these XML files must be according to the style which PHPDOC has.
3- Some of the english source files change regularly as phpdoc and php itself get updated (almost) on daily basis, we should also watch these changes to keep the translated files up-to-date. 
4- To change or translate any english XML file we have to get the latest version from the CVS repository and translate it as fast as possible because the file may be changed during translation to avoid conflicts.
5- After translation the translated file must be sent back to the CVS repository. 
6- The XML files of the PHP Manual is being rendered using docbook to generate readable manual formats (html and etc), therefore we have to consider docbook's abilities in regards to the charset so we are going to use Arabic ISO charset not UTF8 or Windows. 
7- The render is being done regularly by phpdoc team themself for all languages, the rendering may fail because of broken xml files or docbook limitations, so we will have to monitor and read the error reports to find out what to fix. 
8- If the rendering worked well, we will have our Arabic php manual online and we can ask add the Arabic version link on php.net
9- The phpdoc howto also explains how to download the phpdoc cvs repository, how to send it, and how to generate a readable version using docbook. These steps may not be needed by everyone of us. 10- The cvs can be accessed anonymously or via web.
11- There's an ongoing project of a livedoc generation (which shows the Manual online without the need of manual rendering) but I'm not sure what's the status of it at the moment. 
I hope I didn't forget any thing important, and if there're any questions please send through this mailing list.
 
 
Regards,Salah Faya