README 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. Required software:
  2. - autoconf
  3. - make
  4. - xsltproc
  5. - xmllint
  6. On Windows, you should use Cygwin software or another port of GNU
  7. development tools.
  8. How to build the DocBook documentation:
  9. - run "autoconf" in this dir
  10. - run "./configure" in this dir
  11. - run "make"
  12. The HTML files are rendered in the "html" dir.
  13. When developing content, you can verify your changes by running:
  14. "make check"
  15. This verifies the XML for the whole manual is valid.
  16. You can verify your changes in a single file by running:
  17. "make XMLFILE=filename.xml check1"
  18. The filename.xml is relative to the "module_specs" directory.
  19. DocBook resources:
  20. http://www.ibiblio.org/godoy/sgml/docbook/howto/index.html
  21. http://opensource.bureau-cornavin.com/crash-course/index.html
  22. http://ds9a.nl/docbook/
  23. http://www.sagehill.net/docbookxsl/index.html
  24. http://docbook.org/tdg/en/html/part2.html DocBook tag reference
  25. Also a CHM project file is prepared to create CHM help files on the fly.
  26. You need to install the MsHtmlHelpWorkshop.
  27. To build the CHM file from within the commandshell go to the directory
  28. where your html files are build by using make as described before.
  29. Then call:
  30. "C:/path/to/workshop/hhc htmlhelp.hhp"
  31. where "C:/path/to/workshop/" is the path to you installation of MsHtmlHelpWorkshop
  32. This will build a "Zend_Framework_LANGUAGE.chm" file.
  33. Within the file you will find a index and in future also a table of content.