doc:phd

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
doc:phd [2009/02/20 23:05]
philip misc fixes
doc:phd [2017/09/22 13:28] (current)
Line 1: Line 1:
-==== PhD -- Building the PHP manuals of the future ​==== +==== PhD -- Building the PHP manual with PHP ==== 
-PhD takes PHP Manual sources (DocBook) and outputs ​a beautiful manual for all to see. It's generic enough to work on non-php.net projects ​too.+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 it to the [[doc:​phd:​faq|FAQ]].+If you have questions, add them to the [[doc:​phd:​faq|FAQ]].
  
 == PhD Setup (N/A) ==  == PhD Setup (N/A) == 
Line 13: Line 13:
  
 == PhD Renderer (Beta) ==  == PhD Renderer (Beta) == 
-Takes the .manual.xml and generates ~6000 php files~6000 html files and one bightml.html file. +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:​ 
-This also generates CHM and PDF files.+  * The PHP.net theme (phpweb): ​~6000 php files 
 +  * HTML: ~6000 html files 
 +  * HTML: One bightml.html file 
 +  * PDF: PDF versions, either as one or several ​PDF files 
 +  * CHM: The CHM files 
 +  * MAN: Man pages
  
 ==== Where to get ==== ==== Where to get ====
-  * Source: [[http://cvs.php.net/​viewvc.cgi/phd/]]+  ​* Definitive Guide: [[http://​doc.php.net/​phd/​docs/​]] 
 +  ​* Source: [[http://svn.php.net/​viewvc/​phd/​]]
   * [[doc:​phd:​install|Installation docs]]   * [[doc:​phd:​install|Installation docs]]
-  * Demo: [[http://docs.php.net/​manual/​]] +  * Demo: [[http://​php.net/​manual/​]] 
-  * Bugs: [[http://​bugs.php.net/​search.php?​cmd=display&​status=Open&​bug_type%5B%5D=Doc+Build+problem|PhD Bugs at bugs.php.net]]+  * Bugs and feature requests: [[http://​bugs.php.net/​search.php?​cmd=display&​status=Open&​bug_type%5B%5D=Doc+Build+problem|PhD Bugs at bugs.php.net]]
  
 ==== Requirements ==== ==== Requirements ====
Line 26: Line 32:
  
 === PHP exts === === PHP exts ===
-These are all enabled by default ​in PHP 5.+Required, but enabled by default ​as of PHP 5:
   * libxml2   * libxml2
   * xmlreader   * xmlreader
   * dom   * dom
 +Optional: 
 +  * Haru (or PDF)
 ==== Usage ==== ==== Usage ====
-Because the builder is not done, we still use the current system to build the .manual.xml file. An example use of PhD today (See `phd -h` for more options):+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 [[doc:​phd:​install|install PhD]] first. NOTE: You need to [[doc:​phd:​install|install PhD]] first.
  
 <code bash> <code bash>
-cvs -d:pserver:​cvsread@cvs.php.net/​repository ​co phpdoc+svn co http://svn.php.net/​repository/​phpdoc/​modules/​doc-en ​phpdoc
 $ cd phpdoc $ cd phpdoc
-$ php configure.php +$ php doc-base/configure.php 
-$ phd -d .manual.xml+$ phd -d doc-base/.manual.xml ​-o output_dir -f php -P PHP
 </​code>​ </​code>​
  
 This will create ​ This will create ​
   * "​php"​ directory containing the "​phpweb"​ files   * "​php"​ directory containing the "​phpweb"​ files
-  * "html" direcotry containing the "​downloadable chunked html" files +  * "xhtml" direcotry containing the "​downloadable chunked html" files 
-  * "bightml.html" file, which is the "​downloadable bightml"​ file+  * "bigxhtml" file, which is the "​downloadable bightml"​ file
  
 See the "​[[doc/​phd/​view|Viewing the results]]"​ for various ways of viewing the rendered files. See the "​[[doc/​phd/​view|Viewing the results]]"​ for various ways of viewing the rendered files.
  
 ==== TODO / Planning ==== ==== TODO / Planning ====
-  * Use PEAR style class naming and class locations +  * See the [[doc/todo/phd]] page
-  * Split up into different packages: ​phd core, phd xhtml, phd pdf, and theme packages +
-  * Remove dependency on version.xml as it's possible with pear themes +
-   * "so I could do pear install phd && pear install phd-xhtml && pear install phd-peardoc or pear install phd-all to install everything"​ +
doc/phd.1235171112.txt.gz · Last modified: 2017/09/22 13:28 (external edit)