Version 21 by Uli Wolf
on Jan 02, 2010 16:10.

compared with
Current by Uli Wolf
on Jan 02, 2010 18:09.

Key
This line was removed.
This word was removed. This word was added.
This line was added.

Changes (56)

View Page History
h1.Zend Framework Translator - Manual Compilation Instructions
<h1>Zend Framework Translator - Manual Compilation Instructions</h1>

h2.Introduction <h2>Introduction</h2>

<p>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.</p>

<p>On Windows, you can compile the docbook using Cygwin. See: [http://www.cygwin.com] <a href="http://www.cygwin.com">http://www.cygwin.com</a></p>

h2. Linting the Manual / Checking for Errors
<h2>Linting the Manual / Checking for Errors</h2>

<p>If you have an existing checkout of the ZF SVN, then update your Makefile:</p>
{code}
<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
$ svn update
$ autoconf
$ ./configure
{code}
]]></ac:plain-text-body></ac:macro>

<p>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}}". &quot;<code>_temp</code>&quot;.</p>

h3. Checking a single file you just edited
<h3>Checking a single file you just edited</h3>

{code}make XMLFILE=Zend_Acl.xml check1{code}
<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[make XMLFILE=Zend_Acl.xml check1]]></ac:plain-text-body></ac:macro>

h3. Checking the entire manual
<h3>Checking the entire manual</h3>

<p>Also, you can now manually xmllint the entire manual via:</p>
{code}
<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[
xmllint --xinclude --output _temp_manual.xml manual.xml
xmllint --valid --noout --postvalid _temp_manual.xml
{code}
]]></ac:plain-text-body></ac:macro>

.. or simply use:
<p>.. or simply use:</p>

{code}make check{code}
<ac:macro ac:name="code"><ac:plain-text-body><![CDATA[make check]]></ac:plain-text-body></ac:macro>

h2.Installation for Windows users
<h2>Installation for Windows users</h2>

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
<p>Installation steps for Cygwin:</p>
<ol>
<li>Choose &quot;Install from Internet&quot;, click [Next]</li>
<li>Choose the directory where you want to install Cygwin. Leave the other options on their &quot;RECOMMENDED&quot; selection. Click [Next]</li>
<li>Select a directory where you want downloaded files to be stored. Click [Next]</li>
<li>Select your way of connecting to the Internet. Click [Next]</li>
<li>Choose the most suitable mirror in the mirrorlist. Click [Next]</li>
<li>Select the following packages to install:</li>
</ol>
<ul>
<li>Devel &gt; automake1.9</li>
<li>Devel &gt; make</li>
<li>Libs &gt; libxslt<br />
All dependent packages will automatically be selected for you. Click \[Next\] [Next]</li>
</ul>
<ol>
# Sit <li>Sit back and relax while Cygwin and the selected packages are being downloaded and installed. This may take a while.</li>
# Check the option "Create icon on Desktop" and "Add icon to Start Menu" to your liking. Click \[Finish\].
<li>Check the option &quot;Create icon on Desktop&quot; and &quot;Add icon to Start Menu&quot; to your liking. Click [Finish].</li>
</ol>

h2. Building the manual (*nix AND Cygwin)

Below are instructions for building the documentation into HTML.
<h2>Building the manual (*nix AND Cygwin) </h2>

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.
<p>Below are instructions for building the documentation into HTML.</p>

# Go to a shell prompt, or Windows users will run Cygwin (you can double-click the icon on the Desktop or in the Start menu if you've chosen any of these options at install-time)
# Navigate to the directory where the documentation files are stored using the traditional Unix commands. For Cygwin users, drives are stored under "{{/cygdrive}}". So if your documentation files are stored under "{{c:\ZF\documentation}}", you'll need to run the command "{{cd /cygdrive/c/ZF/documentation/}}".
You're under a Unix environment, so don't forget all paths are case sensitive!
# To compile the doc, go to the directory in which manual.xml is located (e.g. documentation/manual/en), and run:
{{$ autoconf}}
{{$ ./configure}}
{{$ cd ../}}
{{$ mkdir .build}}
{{$ cd .build}}
{{$ touch mkentities.sh}}
{{$ cd ../../}}
{{$ chmod +x ../.build/mkentities.sh}}
{{$ nice make}}
# Now run the command below to see a list of errors (if any) in the XML:
{{xmllint --valid --noout manual.xml}}
<p>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 <code>&lt;ZF_HOME&gt;/documentation/manual/ru/</code> and you also need one sister directory <code>&lt;ZF_HOME&gt;/documentation/manual/.build/</code>. 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.</p>

h2. Rebuilding the manual
<ol>
<li>Go to a shell prompt, or Windows users will run Cygwin (you can double-click the icon on the Desktop or in the Start menu if you've chosen any of these options at install-time)</li>
<li>Navigate to the directory where the documentation files are stored using the traditional Unix commands. For Cygwin users, drives are stored under &quot;<code>/cygdrive</code>&quot;. So if your documentation files are stored under &quot;<code>c:\ZF\documentation</code>&quot;, you'll need to run the command &quot;<code>cd /cygdrive/c/ZF/documentation/</code>&quot;.<br />
You're under a Unix environment, so don't forget all paths are case sensitive!</li>
<li>To compile the doc, go to the directory in which manual.xml is located (e.g. documentation/manual/en), and run:<br />
<code>$ autoconf</code><br />
<code>$ ./configure</code><br />
<code>$ mkdir ../.build</code><br />
<code>$ touch ../.build/mkentities.sh</code><br />
<code>$ chmod +x ../.build/mkentities.sh</code><br />
<code>$ make</code></li>
<li>Now run the command below to see a list of errors (if any) in the XML:<br />
<code>xmllint --valid --noout manual.xml</code></li>
</ol>

If you have made changes to the documentation and need to rebuild the HTML pages, navigate a shell to the documentation tree that you wish to rebuild, and type the following commands:

{{$ make clean}}
{{$ make}}
<h2>Rebuilding the manual</h2>

h2.Troubleshooting

If you're encountering errors while trying the build instructions above...
# Remove all files from the html/ subdir except dbstyle.css

# Remove all files from the root dir except {{manual.xml}}, {{configure.in}}, {{Makefile.in}} and {{README}}. The important one here is {{entities.ent}}.

# You can optionally remove the "{{/autom4te.cache}}" and the "{{/build/docbook-xsl}}" directory

# Try to build again following the instructions given above. If it still throws errors, post a message to the [mailto:fw-docs@lists.zend.com] list.
<p>If you have made changes to the documentation and need to rebuild the HTML pages, navigate a shell to the documentation tree that you wish to rebuild, and type the following commands:</p>

h2. References
<p> <code>$ make clean</code><br />
<code>$ make</code></p>

<h2>Troubleshooting </h2>
http://www.sagehill.net/docbookxsl/ToolsSetup.html
<p>If you're encountering errors while trying the build instructions above...</p>
<ol>
<li>Remove all files from the html/ subdir except dbstyle.css</li>
</ol>


<ol>
<li>Remove all files from the root dir except <code>manual.xml</code>, <code>configure.in</code>, <code>Makefile.in</code> and <code>README</code>. The important one here is <code>entities.ent</code>.</li>
</ol>


<ol>
<li>You can optionally remove the &quot;<code>/autom4te.cache</code>&quot; and the &quot;<code>/build/docbook-xsl</code>&quot; directory</li>
</ol>


<ol>
<li>Try to build again following the instructions given above. If it still throws errors, post a message to the <a href="mailto:fw-docs@lists.zend.com">fw-docs@lists.zend.com</a> list.</li>
</ol>


<h2>References</h2>

<p><a class="external-link" href="http://www.sagehill.net/docbookxsl/ToolsSetup.html">http://www.sagehill.net/docbookxsl/ToolsSetup.html</a></p>