You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beehive.apache.org by ri...@apache.org on 2005/08/23 05:49:34 UTC
svn commit: r239321 -
/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/infra/beehive-ant-macros.xml
Author: rich
Date: Mon Aug 22 20:49:31 2005
New Revision: 239321
URL: http://svn.apache.org/viewcvs?rev=239321&view=rev
Log:
Added/edited examples to show project structure, plus a few other fixes.
Modified:
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/infra/beehive-ant-macros.xml
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/infra/beehive-ant-macros.xml
URL: http://svn.apache.org/viewcvs/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/infra/beehive-ant-macros.xml?rev=239321&r1=239320&r2=239321&view=diff
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/infra/beehive-ant-macros.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/infra/beehive-ant-macros.xml Mon Aug 22 20:49:31 2005
@@ -11,9 +11,7 @@
Page Flows, Controls and Web Services. These macros are located in the
<BeehiveHome>/ant/beehive-tools.xml file.</p>
<p>To use any of these macros import the beehive-tools file into your Ant script:</p>
- <source>
- <import file="${beehive.home}/ant/beehive-tools.xml"/>
- </source>
+ <source><import file="${beehive.home}/ant/beehive-tools.xml"/></source>
</section>
<section>
<title>The build-controls Ant Macro</title>
@@ -47,17 +45,31 @@
</table>
<p> </p>
<section>
- <title>Sample</title>
- <source>
-<build-controls srcdir="${src.dir}" destdir="${classes.dir}"
- tempdir="${gen.dir}" classpathref="build.classpath"/>
- </source>
+ <title>Sample</title>
+ <p>
+ The following project has a source directory, a destination directory, and a temporary directory for
+ generated files.
+ </p>
+ <source>
+project
+ build
+ classes
+ src
+ tempsrc </source>
+ <p>
+ For this project, the <code>build-controls</code> call would look like this:
+ </p>
+ <source>
+<build-controls srcdir="project/src"
+ destdir="project/build/classes"
+ tempdir="project/tempsrc"
+ classpathref="<em>build.classpath</em>"/></source>
</section>
</section>
<section>
<title>The build-pageflows Ant Macro</title>
- <p>This macro is intended for the compilation of the <strong>page flow</strong> portions of a web application.
+ <p>This macro is intended for the compilation of the <strong>Page Flow</strong> portions of a web application.
This macro will <strong>not</strong> compile controls inside of a web application. If the web application
contains controls, they must be compiled first using the <code>build-controls</code> macro (see above).
0nce the compilation of the controls is complete, the page flows within the web app can be compiled.</p>
@@ -107,41 +119,72 @@
</table>
<section>
- <title>Sample</title>
+ <title>Samples</title>
+ <p>
+ Consider a simple project with the following structure:
+ </p>
<source>
-<build-pageflows srcdir="${webapp.dir}" weboutputdir="${webapp.dir}"
- classoutputdir="${webapp.dir}/WEB-INF/classes"
- tempdir="${webapp.dir}/WEB-INF/${tmp.sourcegen.dir}"
- classpathref="webapp.build.classpath"/>
- </source>
+project
+ WEB-INF
+ classes
+ lib
+ src
+ web.xml </source>
+ <p>
+ For this project, the <code>build-pageflows</code> call would look like this:
+ </p>
+ <source>
+<build-pageflows srcdir="project" classpathref="<em>webapp.build.classpath</em>"/></source>
+ <p>
+ In a more complex project, web content, source, and the target (build) directory may be in different
+ places:
+ </p>
+ <source>
+project
+ src
+ web
+ WEB-INF
+ lib
+ web.xml
+build
+ webapp </source>
+ <p>
+ In this case, the <code>build-pageflows</code> call would be:
+ </p>
+ <source>
+<build-pageflows srcdir="project/src"
+ webcontentdir="project/web"
+ weboutputdir="project/build/webapp"
+ classpathref="<em>webapp.build.classpath</em>"/></source>
</section>
</section>
<section>
<title>The build-schemas Ant Macro</title>
- <p>This macro can be used to parse an XML Schema or Apache XMLBeans xsdconfig file into
- Apache XMLBeans. It is really just a wrapper for the XMLBean schema compiler which is part
- of the Apache XMLBeans distribution.</p>
- <p><code>build-schemas</code> accepts the following pararmeters:</p>
- <table>
+ <p>This macro can be used to parse an XML Schema or Apache XMLBeans xsdconfig file into
+ Apache XMLBeans. It is really just a wrapper for the XMLBean schema compiler which is part
+ of the Apache XMLBeans distribution.</p>
+ <p><code>build-schemas</code> accepts the following pararmeters:</p>
+ <table>
<tr><th>Parameter Name</th><th>Required</th><th>Description</th></tr>
- <tr>
- <td>srcdir</td>
- <td>Yes</td>
- <td>The directory containing XML Schemas or XMLBeans xsdconfig files to build.</td>
- </tr>
- <tr>
- <td>destdir</td>
- <td>Yes</td>
- <td>The directory to use for files generated during an XSD build.</td>
- </tr>
- </table>
+ <tr>
+ <td>srcdir</td>
+ <td>Yes</td>
+ <td>The directory containing XML Schemas or XMLBeans xsdconfig files to build.</td>
+ </tr>
+ <tr>
+ <td>destdir</td>
+ <td>Yes</td>
+ <td>The directory to use for files generated during an XSD build.</td>
+ </tr>
+ </table>
<section>
<title>Sample</title>
- <source>
-<build-schemas srcdir="${webapp.dir}/WEB-INF/schemas" destdir="${webapp.dir}/WEB-INF/classes"/>
- </source>
+ <p>
+ In this example, schemas are being built from a webapp's WEB-INF/schemas to WEB-INF/classes.
+ </p>
+ <source><build-schemas srcdir="WEB-INF/schemas" destdir="WEB-INF/classes"/></source>
</section>
</section>
<section>
@@ -153,35 +196,49 @@
<p><code>build-webservices</code> accepts the following pararmeters:</p>
<table>
- <tr><th>Parameter Name</th><th>Required</th><th>Description</th></tr>
- <tr>
- <td>srcdir</td>
- <td>Yes</td>
- <td>The directory containing web services to build.</td>
- </tr>
- <tr>
- <td>destdir</td>
- <td>Yes</td>
- <td>The destination directory for the compiled webservice files.</td>
- </tr>
- <tr>
- <td>tempdir</td>
+ <tr><th>Parameter Name</th><th>Required</th><th>Description</th></tr>
+ <tr>
+ <td>srcdir</td>
+ <td>Yes</td>
+ <td>The directory containing web services to build.</td>
+ </tr>
+ <tr>
+ <td>destdir</td>
+ <td>Yes</td>
+ <td>The destination directory for the compiled web service files.</td>
+ </tr>
+ <tr>
+ <td>tempdir</td>
+ <td>Yes</td>
+ <td>A temporary directory for any generated java files.</td>
+ </tr>
+ <tr>
+ <td>classpathref</td>
<td>Yes</td>
- <td>A temporary directory for any generated java files.</td>
- </tr>
- <tr>
- <td>classpathref</td>
- <td>Yes</td>
- <td>A classpath reference for building the controls. Required.</td>
- </tr>
- </table>
+ <td>A classpath reference for building the web service files. Required.</td>
+ </tr>
+ </table>
<section>
<title>Sample</title>
- <source>
-<build-webservices srcdir="${ws-src.dir}" destdir="${classes.dir}"
- tempdir="${gen.dir}" classpathref="build.classpath"/>
- </source>
+ <p>
+ The following project has a source directory, a destination directory, and a temporary directory for
+ generated files.
+ </p>
+ <source>
+project
+ build
+ classes
+ src
+ tempsrc </source>
+ <p>
+ For this project, the <code>build-webservices</code> call would look like this:
+ </p>
+ <source>
+<build-webservices srcdir="project/src"
+ destdir="project/build/classes"
+ tempdir="project/tempsrc"
+ classpathref="<em>build.classpath</em>"/></source>
</section>
</section>
</body>