README 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  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. To generat a CHM project file, you must install MsHtmlHelpWorkshop.
  26. To build the CHM file on the command line navigate to the directory
  27. in which the manual html files are built as described above
  28. Then call:
  29. "C:/path/to/workshop/hhc htmlhelp.hhp"
  30. where "C:/path/to/workshop/" is the path to MsHtmlHelpWorkshop.
  31. This will build a "Zend_Framework_LANGUAGE.chm" file.
  32. You should now have an index in the file..