このチュートリアルでは、PHP-GTK 2 の公式ドキュメント、 つまりあなたが今読んでいるこのマニュアルを取得し、コンパイルする方法や 変更したり拡張したりする方法を説明します。

単にマニュアルを読みたいだけの人にとっては、この内容は不要です。

このドキュメントのソースや PHP-GTK 2 自体のソースなど、 PHP プロジェクトの管理下にあるものはすべて PHP プロジェクトの CVS サーバ cvs.php.net にあります。 このマニュアルは XML の方言のひとつである DocBook に緩やかにもとづいて作成されています。これは書籍や技術文書のために設計されたものです。 PHP-GTK ドキュメントプロジェクトが DocBook の文法に厳密に従っていない理由は、 DocBook には大きな弱点があるからです。 DocBook にはオブジェクト指向言語のドキュメントをサポートする構文がないのです。 そこで自分たちで独自のものを作成することになりました。 こんなことをしたために、PHP-GTK Documentation Group は、他の php.net のシステム (livedocs や .chm 形式のビルドなど) に php-gtk-doc の構文を対応させるための作業も必要となりました。 もし DocBook XML をそのまま使えたら、これらの php.net のシステムももう少しうまく使用できたんですけどね。

このような問題があるにもかかわらず、DocBook を使用してマニュアルを作ることには利点もあります。 ドキュメント (このマニュアル全体) を多くのファイルに分けて配布できるので、 個々のファイルは小さなものになります。それにより、 多くの人が同時にいろいろな箇所をいじれるようになります。 さらに、もととなる XML ファイルからさまざまな形式に変換することができます。 たとえばオフラインで読むための HTML、PHP のコード (オンラインマニュアルの形式)、 Windows の .chm ファイルや .pdf ファイルが作成できます。これらはほんの一部に過ぎません。

逆に大きな問題となるのが、XML ソースをお好みの形式にするためにはコンパイルが必要だということです。 これには少々時間がかかります。このマニュアルは 300 以上のファイルからできており HTML 形式にコンパイルすると 3000 以上のファイル数になりますが、 1.6GHz のシステムではコンパイルに約 10 分かかります。 400MHz のシステムでは 40 分から 45 分程度かかります。 これが気になる場合は、マニュアル全体をひとつの HTML ファイル bigmanual.html にまとめることができます。 これは数分でビルドできるので、ソースファイルの構文エラーをチェックするのに便利です。