PHPのマニュアルのビルド方法(2012年4月時点

PHPのマニュアルは、DocBookと呼ばれるフォーマットで記述されており、PhDというPHPのマニュアルのためのツールによってそのDocBookからHTMLやCHM、PDFなどの複数の形式にビルドできる。

そのマニュアルのビルド方法は、他のブログで紹介されていたやり方とは今ではすこし変わっている。この記事では、2012年4月時点で実際にPHPのマニュアルをリポジトリから取ってきてビルドする方法を紹介する。

必要なツールのインストール

MaxOSXで作業していることを前提とする。
subversionとpearを予めインストールしておいて、PhDをpear経由でインストールする。

$ pear install http://doc.php.net/get/PhD-1.1.4.tgz
$ phd --version
PhD Version: 1.1.4
PHP Version: 5.3.8
Copyright(c) 2007-2012 The PHP Documentation Group

リポジトリからの取得

次にマニュアルのソースをリポジトリから取ってくる。作業用のディレクトリを作って、その中に以下のような3つのリポジトリをsvnからチェックアウトする。

$ mkdir phpdoc-ja
$ cd phpdoc-ja
$ svn co https://svn.php.net/repository/phpdoc/doc-base/trunk/ doc-base
$ svn co https://svn.php.net/repository/phpdoc/en/trunk en
$ svn co https://svn.php.net/repository/phpdoc/ja/trunk ja

ビルド

実際にビルドする。

$ php doc-base/configure.php --with-lang=ja
$ phd -d doc-base/.manual.xml

成功すれば、outputディレクトリ以下に、マニュアルがビルドされる。

出力フォーマットを変更する

デフォルトだと、一つのHTMLに全てのページが含まれている形でビルドされる。PhDで、どのような形式が選択できるのかは、以下のようにわかる。

$ phd --list
Supported packages:
       Generic
              xhtml
              bigxhtml

このサポートされているパッケージは、PhDに関連するpearパッケージをインストールすることで増やすことが出来る。例えば、PDFやCHM形式でビルドしたい場合は、PhD_PHPパッケージをインストールすることで対応するパッケージを追加できる。

$ pear install http://doc.php.net/get/PhD_PHP-1.1.4.tgz
$ phd --list
Supported packages:
	Generic
		xhtml
		bigxhtml
		manpage
	PHP
		xhtml
		bigxhtml
		php
		howto
		manpage
		pdf
		bigpdf
		kdevelop
		chm
		tocfeed
		epub
		enhancedchm

例えば、CHMでビルドする場合はPhDのオプションで以下のようにPHPパッケージのchmフォーマットと指定する。

$ phd -f chm -P PHP -d doc-base/.manual.xml

PhDの他のパッケージは、PhD_IDEとPhD_PEARとかがありPhDのページに一覧があるのでそれを参照する。

終わり

PHPのマニュアルのビルド方法を紹介した。