Table of Contents

PhD -- Building the PHP manual with PHP

PhD takes the PHP Manual sources (DocBook) and outputs the various forms of the PHP Manual. It's generic enough to work on non-php.net projects, although that part is not perfect.

If you have questions, add them to the FAQ.

PhD Setup (N/A)

Replaces:

PhD Build (N/A)

Replaces the `test`, `test_xml` `.manual.xml` make targets (i.e. builds the `.manual.xml` file and validates it).

PhD Renderer (Beta)

Takes the .manual.xml (the file configure.php creates, which is the entire manual as one valid XML file) and generates several possible formats and themes for each translation including:

Where to get

Requirements

PHP exts

Required, but enabled by default as of PHP 5:

Optional:

Usage

Because the builder is incomplete, we still use the current system to build the huge .manual.xml file. An example use of PhD today (See `phd -h` for more options):

NOTE: You need to install PhD first.

$ svn co http://svn.php.net/repository/phpdoc/modules/doc-en phpdoc
$ cd phpdoc
$ php doc-base/configure.php
$ phd -d doc-base/.manual.xml -o output_dir -f php -P PHP

This will create

See the “Viewing the results” for various ways of viewing the rendered files.

TODO / Planning