doc:phd

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Last revisionBoth sides next revision
doc:phd [2009/07/29 18:54] – cvs -> svn chxdoc:phd [2009/12/30 18:05] – -f option changed from "html" -> "xhtml" at some point <= 0.9.1 danielc
Line 4: Line 4:
 If you have questions, add them 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) == 
 Replaces: Replaces:
   * configure.php   * configure.php
Line 12: Line 12:
 Replaces the `test`, `test_xml` `.manual.xml` make targets (i.e. builds the `.manual.xml` file and validates it). Replaces the `test`, `test_xml` `.manual.xml` make targets (i.e. builds the `.manual.xml` file and validates it).
  
-== PhD Renderer (Beta) ==+== PhD Renderer (Beta) == 
 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: 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:
   * The PHP.net theme (phpweb): ~6000 php files   * The PHP.net theme (phpweb): ~6000 php files
Line 38: Line 38:
 Optional: Optional:
   * Haru (or PDF)   * Haru (or PDF)
- 
 ==== Usage ==== ==== Usage ====
 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): 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):
Line 45: Line 44:
  
 <code bash> <code bash>
-$ svn co http://svn.php.net/repository/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.
Line 60: Line 59:
 ==== TODO / Planning ==== ==== TODO / Planning ====
   * See the [[doc/todo/phd]] page   * See the [[doc/todo/phd]] page
- 
doc/phd.txt · Last modified: 2017/09/22 13:28 by 127.0.0.1

Page Tools