Author: ben
Date: 2007-12-29 16:10:26 -0800 (Sat, 29 Dec 2007)
New Revision: 7684
Added:
openlaszlo/trunk/docs/src/developers/images/doc-ant-build-developers.png
Modified:
openlaszlo/trunk/docs/src/developers/doc-toolchain.dbk
openlaszlo/trunk/docs/src/developers/images/doc-ant-build.graffle
Log:
Change 20071229-ben-r by [EMAIL PROTECTED] on 2007-12-29 16:08:09 PST
in /Users/ben/src/svn/openlaszlo/trunk
for http://svn.openlaszlo.org/openlaszlo/trunk
Summary: Added an image and some explanation about how the
developer's guide is built by ant.
Documentation:
A new image at the bottom of the chapter shows the flow
through ant tasks in the process of building the
developer's guide.
Modified: openlaszlo/trunk/docs/src/developers/doc-toolchain.dbk
===================================================================
--- openlaszlo/trunk/docs/src/developers/doc-toolchain.dbk 2007-12-30
00:09:37 UTC (rev 7683)
+++ openlaszlo/trunk/docs/src/developers/doc-toolchain.dbk 2007-12-30
00:10:26 UTC (rev 7684)
@@ -655,7 +655,7 @@
<section id="how-ant-drives">
<title>How Ant Drives the Transformations</title>
- <para>The build file in <literal>docs/src/build.xml</literal> is
arguably the most complicated build file in the entire OpenLaszlo platform. It
has several layers of abstraction, which, when combined with the doc
toolchain's complexities we've already explored, make following the ant file
nearly impossible. The way to make sense of the build file is to think of what
we already have learned the process is, as described in the rest of this
chapter. In this discussion, we'll favor concepts over details, lest we drown
in details. You may also wish to try <ulink
url="http://www.yworks.com/en/products_antexplorer_about.htm";>yWorks Ant
Explorer</ulink> which provides a visualization of the build file.</para>
+ <para>The build file in <literal>docs/src/build.xml</literal> is
arguably the most complicated build file in the entire OpenLaszlo platform. It
has several layers of abstraction, which, when combined with the doc
toolchain's complexities we've already explored, make following the ant file
nearly impossible. The way to make sense of the build file is to think of what
we already have learned the process is, as described in the rest of this
chapter. In this discussion, we'll favor concepts over details, lest we drown
in details. You may also wish to try <ulink
url="http://www.yworks.com/en/products_antexplorer_about.htm";>yWorks Ant
Explorer</ulink> which provides a visualization of the build file.</para>
<para>The build file is composed of both specific targets and
parameterized targets. The parameterized targets do most of the work, and the
specific targets set up the right parameters with which to call the
parameterized targets. In <xref linkend="directory-structure"/>, the ant
properties corresponding to particular directories in the LPS tree are listed;
understanding those mappings is crucial to being able to read and follow the
build.</para>
<para>In this diagram of the major targets in the reference build,
parameterized targets are highlighted:
<informalfigure><mediaobject><imageobject>
@@ -667,7 +667,15 @@
<para><literal>dbk.topic.generate</literal> drives the js2doc2dbk
transformation. It says, "find all the elements in the input file (
<literal>LaszloLibrary-verbose.js2doc</literal> for the reference) that match
the topic specified in the <literal>filter.topic</literal> parameter. Apply the
transformations in <literal>js2doc2dbk.xsl</literal> to those elements, and
output the results to the file specified in the
<literal>local.output.file</literal>." </para>
<para><literal>book.html.generate</literal> drives the docbook to HTML
transformation.</para>
<para><literal>dbk.examples.preprocess</literal> prepares the examples
in the specified docbook for rendering and final output, by running the docbook
through <literal>xsl/dbkpreprocessexamples.xsl</literal>.</para>
+ <para>This diagram shows the major targets in the developer's guide
build. As before, parameterized targets are highlighted:
+ <informalfigure><mediaobject><imageobject>
+ <imagedata fileref="images/doc-ant-build-developers.png"/>
+ </imageobject>
+ </mediaobject></informalfigure>
+ </para>
</section>
+
+
</section>
Added: openlaszlo/trunk/docs/src/developers/images/doc-ant-build-developers.png
Property changes on:
openlaszlo/trunk/docs/src/developers/images/doc-ant-build-developers.png
___________________________________________________________________
Name: svn:mime-type
+ image/png
Modified: openlaszlo/trunk/docs/src/developers/images/doc-ant-build.graffle
===================================================================
(Binary files differ)
_______________________________________________
Laszlo-checkins mailing list
[email protected]
http://www.openlaszlo.org/mailman/listinfo/laszlo-checkins
