PHP is well known for having excellent documentation, documentation that is created by volunteers who collectively make changes every day. This HOWTO is designed for people who work on the official PHP documentation. See also » http://www.php.net/docs for viewable and downloadable versions of the PHP manual.
This HOWTO contains information about every aspect of the documentation process, which includes editing the DocBook XML sources, validating changes made to these sources, using the build system to generate documentation into other formats, and general tips like how to use SVN.
Related to this HOWTO is the simple README file that lives within the phpdoc SVN module. It's a quick guide for those already familiar with the basics of XML and SVN.
The latest copy of this HOWTO is available here: » http://doc.php.net/php/dochowto, and it may be downloaded from here: » http://php.net/get/dochowto.
No liability for the contents of this documents can be accepted. Use the concepts, examples and other content at your own risk. There may be errors and inaccuracies in this document, that may of course be damaging to your system. Proceed with caution, and although this is highly unlikely, the author(s) do not take any responsibility for that.
All copyrights are held by their respective owners, unless specifically noted otherwise. Use of a term in this document should not be regarded as affecting the validity of any trademark or service mark.
Naming of particular products or brands should not be seen as endorsements.
You are strongly recommended to take a backup of your system before major installation and backups at regular intervals.
This document is based on many files, previously hosted in the phpdoc module at cvs.php.net, containing information about several distinct subjects, ranging from generating the HTML files from XML sources to starting a new translation. This is a central place for all these things. We tried to include the original authors in the authors list of this file.
Feedback is most certainly welcome on this document. Without your submissions and input, this document wouldn't exist. Please send your additions, comments and criticisms to the following email address: <phpdoc@lists.php.net>.