documentation/manual/README.txt

   1 INTRODUCTION
   2
   3 The manual is written in Docbook XML and requires a Unix-like
   4 operating system with the standard GNU toolchain and xsltproc
   5 or a similar XSLT processor to build the source XML into the
   6 HTML that is shipped with the Zend Framework distributions.
   7
   8 On Windows, you can compile the docbook using Cygwin.  See:
   9 http://www.cygwin.com
  10
  11
  12
  13 INSTALLATION FOR WINDOWS USERS
  14
  15 Installation steps for Cygwin:
  16   1. Choose "Install from Internet", click [Next]
  17   2. Choose the directory where you want to install Cygwin. Leave the other
  18      options on their "RECOMMENDED" selection. Click [Next]
  19   3. Select a directory where you want downloaded files to be stored. Click
  20      [Next]
  21   4. Select your way of connecting to the Internet. Click [Next]
  22   5. Choose the most suitable mirror in the mirrorlist. Click [Next]
  23   6. Select the following packages from Devel or Libs to install:
  24      * automake1.9
  25      * libxslt
  26      * make
  27      All dependent packages will automatically be selected for you.
  28      Click [Next]
  29   7. Sit back and relax while Cygwin and the selected packages are being
  30      downloaded and installed. This may take a while.
  31   8. Check the option "Create icon on Desktop" and "Add icon to Start Menu" to
  32      your liking. Click [Finish].
  33
  34
  35
  36 BUILDING THE DOCUMENTATION (*NIX AND CYGWIN)
  37
  38 To build the documentation into HTML:
  39   1. Go to a shell prompt, or Windows users will run Cygwin (you can double-click
  40      the icon on the Desktop or in the Start menu if you've chosen any of these
  41      options at install-time)
  42   2. Navigate to the directory where the documentation files are stored using
  43      the traditional Unix commands.  For Cygwin users, drives are stored under
  44      "/cygdrive".  So if your documentation files are stored under
  45      "c:\ZF\documentation", you'll need to run the command "cd c:/ZF/documentation/".
  46      You're under a Unix environment, so don't forget all paths are case sensitive!
  47   3. To compile the doc, go to the directory in which manual.xml is located and run:
  48      $ autoconf
  49      $ ./configure
  50      $ make
  51
  52
  53
  54 TROUBLESHOOTING
  55
  56 If you're encountering errors while trying the build instructions above...
  57   1. Remove all files from the html/ subdir except dbstyle.css
  58
  59   2. Remove all files from the root dir except manual.xml, configure.in,
  60      Makefile.in and README.  The important one here is entities.ent.
  61
  62   3. You can optionally remove the "/autom4te.cache" directory and the
  63      "/build/docbook-xsl" directory
  64
  65   4. Try to build again following the instructions given above. If it still
  66      throws errors, post a message to the fw-docs@lists.zend.com list.
  67