
h1.Zend Framework Translator - Manual Compilation Instructions
h2.Introduction
The manual is written in Docbook XML and requires a Unix-like operating system with the standard GNU toolchain and xsltproc or a similar XSLT processor to build the source XML into the HTML that is shipped with the Zend Framework distributions.
On Windows, you can compile the docbook using Cygwin. See: [http://www.cygwin.com]
h2. Linting the Manual / Checking for Errors
If you have an existing checkout of the ZF SVN, then update your Makefile:
{code}
$ svn update
$ autoconf
$ ./configure
{code}
For all of the methods below, any errors reported are relative to a temporary file (not the original source file you edit). The temporary file name begins with "{{_temp}}".
h3. Checking a single file you just edited
{code}make XMLFILE=Zend_Acl.xml check1{code}
h3. Checking the entire manual
Also, you can now manually xmllint the entire manual via:
{code}
xmllint --xinclude --output _temp_manual.xml manual.xml
xmllint --valid --noout --postvalid _temp_manual.xml
{code}
.. or simply use:
{code}make check{code}
h2.Installation for Windows users
Installation steps for Cygwin:
# Choose "Install from Internet", click \[Next\]
# Choose the directory where you want to install Cygwin. Leave the other options on their "RECOMMENDED" selection. Click \[Next\]
# Select a directory where you want downloaded files to be stored. Click \[Next\]
# Select your way of connecting to the Internet. Click \[Next\]
# Choose the most suitable mirror in the mirrorlist. Click \[Next\]
# Select the following packages to install:
* Devel > automake1.9
* Devel > make
* Libs > libxslt
All dependent packages will automatically be selected for you. Click \[Next\]
# Sit back and relax while Cygwin and the selected packages are being downloaded and installed. This may take a while.
# Check the option "Create icon on Desktop" and "Add icon to Start Menu" to your liking. Click \[Finish\].
h2. Building the manual (*nix AND Cygwin)
Below are instructions for building the documentation into HTML.
NOTE: You don't necessarily need the whole distribution of source files for Zend Framework. All you need is the language directory you want to build, for example {{<ZF_HOME>/documentation/manual/ru/}} and you also need one sister directory {{<ZF_HOME>/documentation/manual/.build/}}. The latter directory contains a shell script that is needed during the manual build process. Note that you will have to create the .build directory yourself and also the mkentities.sh file.