On Wed, Sep 23, 2009 at 18:20, Israel Ekpo <israele...@gmail.com> wrote: > I am looking to create something in this format (http://us2.php.net/json) > but I want to be able to view it locally only and make sure the appearance > and contents are correct before making commits to phpdoc
See `phd -h` PhD has "partial rendering" option, which renders only the chapters you want to render. $ phd -d --docbook /path/to/your/.manual.xml -p the-id-you-want-to-render Also, you can pick which package/format/theme you want to render. Depending on your installed PhD version you can do: $ phd --docbook /path/to/your/.manual.xml --package PHP --format xhtml # Using PhD 0.9 or newer or $ phd -d /path/to/your/.manual.xml -f xhtml -t chunkedhtml # Using PhD 0.4 or older The ".manual.xml" file is generated by 'phpdoc/doc-base/trunk/configure.php'. configure.php does support 'partial building' too, but thats not something we usually do as it destroys all crosslinks. Besides, the entire process of building and rendering the entire documentatons takes less then 5 minutes >> http://wiki.php.net/doc/howto/editing >> >> The above page talks about running a configure.php file. $ svn co http://svn.php.net/repository/phpdoc/modules/doc-en $ php doc-base/configure.php # Make sure clean build works $ phd -d doc-base/.manual.xml # Just to try it out, feel free to browse through the generated files $ php doc-base/scripts/docgen/docgen.php -e the_extension -o doc-en/reference/the_extension # Generate the new docs $ vim doc-base/manual.xml.in # Find a fitting section and add &reference.the_extension.book; $ php doc-base/configure.php # Validate your changes, fix any issues that show up $ phd -d doc-base/.manual.xml # Render the changes $ vim doc-en/reference/the_extension/*.xml # Add content ..And redo the last 3 steps until everything is good to go Feel free to update the wiki with your experience, and comment on what is missing. Its hard to figure out what is missing from the beginner steps out for those who do this every day :] -Hannes
