doc:phd
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
doc:phd [2009/01/30 10:05] – todos cweiske | doc:phd [2009/07/29 19:32] – cvs->svn philip | ||
---|---|---|---|
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 | + | PhD takes the PHP Manual sources (DocBook) and outputs |
- | If you have questions, add it to the [[phd/faq|FAQ]]. | + | If you have questions, add them to the [[doc:phd:faq|FAQ]]. |
== PhD Setup (N/A) == | == PhD Setup (N/A) == | ||
Replaces: | Replaces: | ||
- | | + | * configure.php |
- | | + | |
* bunch of scripts in the scripts/ directory | * bunch of scripts in the scripts/ directory | ||
Line 14: | 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 |
- | In the future it will also generate CHM and PDF files. | + | * The PHP.net theme (phpweb): |
+ | * HTML: ~6000 html files | ||
+ | * HTML: One bightml.html file | ||
+ | * PDF: PDF versions, either as one or several | ||
+ | * CHM: The CHM files | ||
+ | * MAN: Man pages | ||
==== Where to get ==== | ==== Where to get ==== | ||
- | * Source: [[http://cvs.php.net/ | + | |
+ | | ||
* [[doc: | * [[doc: | ||
- | * Demo: [[http://docs.php.net/ | + | * Demo: [[http:// |
- | * Bugs: [[http:// | + | * Bugs and feature requests: [[http:// |
==== Requirements ==== | ==== Requirements ==== | ||
- | * PHP 5 | + | * PHP 5 (5.3 preferred) |
- | * Translators require ngsmls currently | + | |
=== PHP exts === | === PHP exts === | ||
- | These are all enabled by default | + | Required, but enabled by default |
* 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: | NOTE: You need to [[doc: | ||
<code bash> | <code bash> | ||
- | $ cvs -d:pserver: | + | $ svn co http://svn.php.net/ |
$ cd phpdoc | $ cd phpdoc | ||
- | $ php configure.php | + | $ php doc-base/configure.php |
$ phd -d .manual.xml | $ phd -d .manual.xml | ||
</ | </ | ||
Line 53: | Line 59: | ||
==== TODO / Planning ==== | ==== TODO / Planning ==== | ||
- | * Use PEAR style class naming and class locations | + | * See the [[doc/todo/phd]] page |
- | * Split up into different 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.txt · Last modified: 2017/09/22 13:28 by 127.0.0.1