documentation/manual/pl/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 Also a CHM project file is prepared to create CHM help files on the fly.
  41 You need to install the MsHtmlHelpWorkshop.
  42
  43 To build the CHM file from within the commandshell go to the directory
  44 where your html files are build by using make as described before.
  45 Then call:
  46  "C:/path/to/workshop/hhc htmlhelp.hhp"
  47 where "C:/path/to/workshop/" is the path to you installation of MsHtmlHelpWorkshop
  48
  49 This will build a "Zend_Framework_LANGUAGE.chm" file.
  50 Within the file you will find a index and in future also a table of content.