documentation/manual/en/README

   1 Required software:
   2
   3 - autoconf
   4 - make
   5 - xsltproc
   6 - xmllint
   7
   8 On Windows, you should use Cygwin software or another port of GNU
   9 development tools.
  10
  11 How to build the DocBook documentation:
  12
  13 - run "autoconf" in this dir
  14 - run "./configure" in this dir
  15 - run "make"
  16
  17 The HTML files are rendered in the "html" dir.
  18
  19 When developing content, you can verify your changes by running:
  20
  21   "make check"
  22
  23 This verifies the XML for the whole manual is valid.
  24
  25 You can verify your changes in a single file by running:
  26
  27   "make XMLFILE=filename.xml check1"
  28
  29 The filename.xml is relative to the "module_specs" directory.
  30
  31 DocBook resources:
  32
  33 http://www.ibiblio.org/godoy/sgml/docbook/howto/index.html
  34 http://opensource.bureau-cornavin.com/crash-course/index.html
  35 http://ds9a.nl/docbook/
  36 http://www.sagehill.net/docbookxsl/index.html
  37 http://docbook.org/tdg/en/html/part2.html DocBook tag reference
  38
  39
  40 To generat a CHM project file, you must install MsHtmlHelpWorkshop.
  41
  42 To build the CHM file on the command line navigate to the directory
  43 in which the manual html files are built as described above
  44
  45 Then call:
  46
  47  "C:/path/to/workshop/hhc htmlhelp.hhp"
  48
  49 where "C:/path/to/workshop/" is the path to MsHtmlHelpWorkshop.
  50
  51 This will build a "Zend_Framework_LANGUAGE.chm" file.
  52
  53  You should now have an index in the file..