After being certain the diff looks commit worthy, and the XML validates, it may be worthwhile to see how the change will look after the manual is built. We use » PhD to build the manual with several themes and formats available to create viewable documentation, including:
html, the plain html manual found at » http://www.php.net/manual/html/
bightml, one big HTML file, only available for download at » http://www.php.net/get/docs
php, the main PHP online manual found at » http://www.php.net/manual/. You'll need to setup a » phpweb mirror to view these locally.
By default, all of the above themes are built together. Use the --theme option to alter this behaviour.
Note: More information about PhD
The PHP Manual uses the » PhD build system which must be installed separately to build the manual.
Example usage for using PhD to build the manual:
Example #1 Example using PhD to build the PHP Manual
# See all the phd options $ phd -h # Working in the phpdoc is optional, as it may also be passed to phd $ cd /path/to/phpdoc/dir # First, run configure $ php configure.php # Using phd to build the entire manual $ phd -d .manual.xml # Or build just one part, with book.apc as an example id # And also we'll just create the bightml file here $ phd -d .manual.xml -p book.apc -t bightml
The built files are placed in the current working directory within php/, html/, and as bightml.html respectively.
If all goes well, you should have your own copy of the documentation, including any changes you've made.