Zend Framework Docbook End-User Documentation
=============================================

To build the documentation, you have two options: using the standard
xsltproc toolchain, or using PhD (http://docs.php.net/phd/), PHP's
Documentation renderer (preferred).

Using PhD
---------

To generate using PhD, you need the following tools:

- xsltproc
- The ZF build tools:
  You can check these out locally within this directory by running the
  following command:
  "svn co http://framework.zend.com/svn/framework/build-tools/trunk/build-tools/docs phd"

From here, you need to collate the docbook sources to a single file, and
then run PhD:

- run "xsltproc --xinclude ./phd/db4-upgrade.xsl manual.xml.in > manual.full.xml | tee -a err.txt"
- run "./phd/pear/phd -g 'phpdotnet\phd\Highlighter_GeSHi' --xinclude -f zfpackage -d manual.full.xml -o ./output"

The manual will now be in "output/zf-package-chunked-xhtml/manual.html"


Using the xsltproc toolchain
----------------------------

Using the xsltproc toolchain requires the following tools:

- autoconf
- make
- xsltproc
- xmllint

You can setup this environment variables to set a different DTD or stylesheet:

- DOCBOOK_DTD=http://www.docbook.org/xml/5.0/dtd/docbook.dtd
- DOCBOOK_XSL=http://docbook.sourceforge.net/release/xsl/1.76.1/html/chunk.xsl
- DOCBOOK_FO_XSL=http://docbook.sourceforge.net/release/xsl/1.76.1/fo/docbook.xsl

On Windows, you should use Cygwin software or another port of GNU 
development tools.


- run "autoconf" in this dir
- run "./configure" in this dir
- run "make"

The HTML files are rendered in the "html" dir.

When developing content, you can verify your changes by running:

  "make check"

This verifies the XML for the whole manual is valid.

You can verify your changes in a single file by running:

  "make XMLFILE=filename.xml check1"

The filename.xml is relative to the "module_specs" directory.

DocBook resources:

http://www.ibiblio.org/godoy/sgml/docbook/howto/index.html
http://opensource.bureau-cornavin.com/crash-course/index.html
http://ds9a.nl/docbook/
http://www.sagehill.net/docbookxsl/index.html
http://docbook.org/tdg/en/html/part2.html DocBook tag reference


To generate a CHM project file, you must install MsHtmlHelpWorkshop.

To build the CHM file on the command line navigate to the directory
in which the manual html files are built as described above

Then call:
 
 "C:/path/to/workshop/hhc htmlhelp.hhp"
 
where "C:/path/to/workshop/" is the path to MsHtmlHelpWorkshop.

This will build a "Zend_Framework_LANGUAGE.chm" file.

 You should now have an index in the file.