Este tutorial explica como obter, compilar e escrever ou extender a documentação oficial do PHP-GTK 2- isto é, o manual que você esta lendo atualmente.

Se você simplesmente quer ler o manual, este provavelmente não é de nenhum interesse para você.

A fonte desta documentação, em conjunto com o fonte do PHP-GTK 2 e qualquer outra coisa que venha de baixo do guarda-chuva do PHP, reside no servidor CVS do projeto PHP em cvs.php.net. É baseado num dialeto do XML chamado DocBook, o qual foi criado para ser usado em livros e outras formas de documentação tecnica. A razão pela qual a documentação do PHP-GTK não pode aderir estritamente a sintaxe do DocBook é por causa de uma das suas maiores fraquesas: não há sintaxe do DocBook para suportar documentação de linguagens orientadas a objeto. Nós tivemos que desenvolver o nosso próprio. Isto, por sua vez, significa que o grupo da documentação do PHP-GTK também precisou adaptar outros mecanismos do php.net - como o livedocs e versões .chm - especificamente para funcionar com a sintaxe do php-gtk-doc, aonde nós poderiamos utilizar estas ferramentas sem modificações se nós pudessemos usar o XML puro do DocBook.

Apesar disso, existem vários beneficios em basear o manual em DocBook. O documento (todo o manual) pode ser disribuído em vários arquivos, assim os arquivos são peças manipuláveis e várias pessoas podem trabalhar ao mesmo tempo em várias partes dele. Além disso, os arquivos XML base podem ser convertidos em vários formatos: HTML puro para leitura offline, código PHP (como você pode ver no manual online), arquivos .chm do Windows, e arquivos .pdf, para nomear alguns poucos.

A grande disvantagem e que você precisa compilar o XML dos fontes no formato desejadp, o que pode levar algum tempo. Este manual consiste em mais de 300 arquivos únicos, e a versão compilda em HTML tem mais de 3000 arquivos gerados. A compilação eva 10 minutos em um sistema 1.6GHz; em um 400MHz é em torno de 40 a 45 minutos. Para combater este problema, tem uma versão do manual em uma única pagina HTML, bigmanual.html, a qual é construída em alguns poucos minutos e pode se usada para descobrir qualquer erro de sintaxe nos arquivos fonte.