http://git-wip-us.apache.org/repos/asf/ant/blob/5266b79b/manual/running.html ---------------------------------------------------------------------- diff --git a/manual/running.html b/manual/running.html index dac2ef3..56b03b2 100644 --- a/manual/running.html +++ b/manual/running.html @@ -25,7 +25,7 @@ <body> <h1>Running Apache Ant</h1> -<h2><a name="commandline">Command Line</a></h2> +<h2 id="commandline">Command Line</h2> <p> If you've installed Apache Ant as described in the <a href="install.html"> Installing Ant</a> section, running Ant from the command-line is simple: just type @@ -36,10 +36,10 @@ build file and runs the target specified in the <code>default</code> attribute of the <code><project></code> tag. To make Ant use a build file other than <code>build.xml</code>, use the command-line -option <nobr><code>-buildfile <i>file</i></code></nobr>, +option <code>-buildfile <i>file</i></code>, where <i>file</i> is the name of the build file you want to use (or a directory containing a <code>build.xml</code> file).</p> -If you use the <nobr><code>-find [<i>file</i>]</code></nobr> option, +If you use the <code>-find [<i>file</i>]</code> option, Ant will search for a build file first in the current directory, then in the parent directory, and so on, until either a build file is found or the root of the filesystem has been reached. By default, it will look for a build file @@ -47,13 +47,13 @@ called <code>build.xml</code>. To have it search for a build file other than <code>build.xml</code>, specify a file argument. <strong>Note:</strong> If you include any other flags or arguments on the command line after -the <nobr><code>-find</code></nobr> flag, you must include the file argument -for the <nobr><code>-find</code></nobr> flag, even if the name of the +the <code>-find</code> flag, you must include the file argument +for the <code>-find</code> flag, even if the name of the build file you want to find is <code>build.xml</code>. <p>You can also set <a href="using.html#properties">properties</a> on the command line. This can be done with -the <nobr><code>-D<i>property</i>=<i>value</i></code></nobr> option, +the <code>-D<i>property</i>=<i>value</i></code> option, where <i>property</i> is the name of the property, and <i>value</i> is the value for that property. If you specify a property that is also set in the build file @@ -63,8 +63,8 @@ command line will override the value specified in the build file. Defining properties on the command line can also be used to pass in the value of environment variables; just pass -<nobr><code>-DMYVAR=%MYVAR%</code></nobr> (Windows) or -<nobr><code>-DMYVAR=$MYVAR</code></nobr> (Unix) +<code>-DMYVAR=%MYVAR%</code> (Windows) or +<code>-DMYVAR=$MYVAR</code> (Unix) to Ant. You can then access these variables inside your build file as <code>${MYVAR}</code>. You can also access environment variables using the @@ -73,13 +73,13 @@ You can also access environment variables using the </p> <p>Options that affect the amount of logging output by Ant are: -<nobr><code>-quiet</code></nobr>, +<code>-quiet</code>, which instructs Ant to print less information to the console; -<nobr><code>-verbose</code></nobr>, which causes Ant to print -additional information to the console; <nobr><code>-debug</code></nobr>, +<code>-verbose</code>, which causes Ant to print +additional information to the console; <code>-debug</code>, which causes Ant to print considerably more additional information; and -<nobr><code>-silent</code></nobr> which makes Ant print nothing but task +<code>-silent</code> which makes Ant print nothing but task output and build failures (useful to capture Ant output by scripts). </p> @@ -89,7 +89,7 @@ When omitted, the target that is specified in the <a href="using.html#projects"><code>project</code></a> tag is used.</p> -<p>The <nobr><code>-projecthelp</code></nobr> option prints out a list +<p>The <code>-projecthelp</code> option prints out a list of the build file's targets. Targets that include a <code>description</code> attribute are listed as "Main targets", those without a <code>description</code> are listed as @@ -97,7 +97,7 @@ those without a <code>description</code> are listed as ("Other targets" are only displayed if there are no main targets, or if Ant is invoked in -verbose or -debug mode). -<h3><a name="options">Command-line Options Summary</a></h3> +<h3 id="options">Command-line Options Summary</h3> <pre>ant [options] [target [target2 [target3] ...]] Options: -help, -h print this message and exit @@ -139,20 +139,20 @@ Options: <a href="listeners.html">Loggers & Listeners</a>. <p>For more information about <code>-inputhandler</code> see <a href="inputhandler.html">InputHandler</a>. -<p>Easiest way of changing the exit-behaviour is subclassing the original main class: +<p>Easiest way of changing the exit-behaviour is subclassing the original main class:</p> <pre> public class CustomExitCode extends org.apache.tools.ant.Main { protected void exit(int exitCode) { // implement your own behaviour, e.g. NOT exiting the JVM } } -</pre> and starting Ant with access (<tt>-lib path-to-class</tt>) to this class. -</p> +</pre> +<p>and starting Ant with access (<tt>-lib path-to-class</tt>) to this class.</p> -<h3><a name="libs">Library Directories</a></h3> +<h3 id="libs">Library Directories</h3> <p> Prior to Ant 1.6, all jars in the ANT_HOME/lib would be added to the CLASSPATH -used to run Ant. This was done in the scripts that started Ant. From Ant 1.6, + used to run Ant. This was done in the scripts that started Ant. <em>Since Ant 1.6</em>, two directories are scanned by default and more can be added as required. The default directories scanned are ANT_HOME/lib and a user specific directory, ${user.home}/.ant/lib. This arrangement allows the Ant installation to be @@ -180,7 +180,6 @@ option. Ant itself is started with a very minimalistic classpath. Ant should work perfectly well with an empty CLASSPATH environment variable, something the the -noclasspath option actually enforces. We get many more support calls related to classpath problems (especially quoting problems) than we like. - </p> <p> @@ -229,9 +228,7 @@ to the value <code>build/classes</code>.</p> </blockquote> <p>adds two jars to Ants classpath.</p> - - -<h3><a name="files">Files</a></h3> +<h3 id="files">Files</h3> <p>The Ant wrapper script for Unix will source (read and evaluate) the file <code>~/.antrc</code> before it does anything. On Windows, the Ant @@ -240,7 +237,7 @@ wrapper batch-file invokes <code>%HOME%\antrc_pre.bat</code> at the start and files, for example, to set/unset environment variables that should only be visible during the execution of Ant. See the next section for examples.</p> -<h3><a name="envvars">Environment Variables</a></h3> +<h3 id="envvars">Environment Variables</h3> <p>The wrapper scripts use the following environment variables (if set):</p> @@ -255,24 +252,24 @@ set):</p> <li><code>ANT_ARGS</code> - Ant command-line arguments. For example, set <code>ANT_ARGS</code> to point to a different logger, include a - listener, and to include the <code>-find</code> flag.</li> + listener, and to include the <code>-find</code> flag.<br/> <strong>Note:</strong> If you include <code>-find</code> in <code>ANT_ARGS</code>, you should include the name of the build file - to find, even if the file is called <code>build.xml</code>. + to find, even if the file is called <code>build.xml</code>.</li> </ul> -<h3><a name="sysprops">Java System Properties</a></h3> +<h3 id="sysprops">Java System Properties</h3> <p>Some of Ant's core classes can be configured via system properties.</p> <p>Here is the result of a search through the codebase. Because system properties are -available via Project instance, I searched for them with a + available via Project instance, I searched for them with a</p> <pre> grep -r -n "getPropert" * > ..\grep.txt </pre> -command. After that I filtered out the often-used but not-so-important values (most of them +<p>command. After that I filtered out the often-used but not-so-important values (most of them read-only values): <i>path.separator, ant.home, basedir, user.dir, os.name, line.separator, java.home, java.version, java.version, user.home, java.class.path</i><br> And I filtered out the <i>getPropertyHelper</i> access.</p> -<table border="1"> +<table> <tr> <th>property name</th> <th>valid values /default value</th> @@ -291,12 +288,11 @@ And I filtered out the <i>getPropertyHelper</i> access.</p> <tr> <td><code>ant.executor.class</code></td> <td>classname; default is org. apache. tools. ant. helper. DefaultExecutor</td> - <td><b>Since Ant 1.6.3</b> Ant will delegate Target invocation to the + <td><em>Since Ant 1.6.3</em> Ant will delegate Target invocation to the org.apache.tools.ant.Executor implementation specified here. </td> </tr> - -<tr> + <tr> <td><code>ant.file</code></td> <td>read only: full filename of the build file</td> <td>This is set to the name of the build file. In @@ -304,8 +300,7 @@ org.apache.tools.ant.Executor implementation specified here. <import>-ed</a> files, this is set to the containing build file. </td> </tr> - -<tr> + <tr> <td><code>ant.file.*</code></td> <td>read only: full filename of the build file of Ant projects </td> @@ -314,8 +309,7 @@ org.apache.tools.ant.Executor implementation specified here. <import>-ed</a> files, </td> </tr> - -<tr> + <tr> <td><code>ant.input.properties</code></td> <td>filename (required)</td> <td>Name of the file holding the values for the @@ -509,7 +503,7 @@ the return code of the java program. So a successful build returns 0, failed builds return other values. </p> -<h2><a name="cygwin">Cygwin Users</a></h2> +<h2 id="cygwin">Cygwin Users</h2> <p>The Unix launch script that come with Ant works correctly with Cygwin. You should not have any problems launching Ant from the Cygwin shell. It is important to note, however, that once Ant is running it is part of the JDK @@ -521,7 +515,7 @@ shell from which Ant was launched. You can use an executable name such as "sh" and rely on that command being available in the Windows path. </p> -<h2><a name="os2">OS/2 Users</a></h2> +<h2 id="os2">OS/2 Users</h2> <p>The OS/2 launch script was developed to perform complex tasks. It has two parts: <code>ant.cmd</code> which calls Ant and <code>antenv.cmd</code> which sets the environment for Ant. Most often you will just call <code>ant.cmd</code> using the same command line options as described @@ -552,8 +546,8 @@ shell (of course unless called automatically from <code>ant.cmd</code>). It is t <p>Scripts <code>envset.cmd</code> and <code>runrc.cmd</code> perform auxiliary tasks. All scripts have some documentation inside.</p> -<h2><a name="background">Running Ant as a background process on - Unix(-like) systems</a></h2> +<h2 id="background">Running Ant as a background process on + Unix(-like) systems</h2> <p>If you start Ant as a background process (like in <code>ant &</code>) and the build process creates another process, Ant will @@ -568,7 +562,7 @@ have some documentation inside.</p> or <code><java></code> when the <code>fork</code> attribute is <code>true</code>.</p> -<h2><a name="viajava">Running Ant via Java</a></h2> +<h2 id="viajava">Running Ant via Java</h2> <p>If you have installed Ant in the do-it-yourself way, Ant can be started from one of two entry points:</p> <blockquote> @@ -599,11 +593,10 @@ The latter method supports the -lib, -nouserlib, -noclasspath options and will classpath possible, generally just the ant-launcher.jar. </p> -<a name="viaant"/> - -Ant can be started in Ant via the <code><java></code> command. -Here is an example: - +<p id="viaant"> + Ant can be started in Ant via the <code><java></code> command. + Here is an example: +</p> <pre> <java classname="org.apache.tools.ant.launch.Launcher" @@ -624,8 +617,6 @@ Here is an example: <arg value="${sub.target}"/> </java> </pre> -<br> - </body> </html>
http://git-wip-us.apache.org/repos/asf/ant/blob/5266b79b/manual/stylesheets/style.css ---------------------------------------------------------------------- diff --git a/manual/stylesheets/style.css b/manual/stylesheets/style.css index 3e1f10c..a77379e 100644 --- a/manual/stylesheets/style.css +++ b/manual/stylesheets/style.css @@ -78,6 +78,10 @@ table th { color: black; } +code { + white-space: nowrap; +} + pre { background-color: #efefef; } @@ -99,3 +103,56 @@ ul.inlinelist { padding: 0; } +div.float { + margin-top: 0.5rem; + width: 100%; + min-height: 1.5rem; + line-height: 1.5rem; + background-color: silver; +} + +div.float + table { + width: 100%; + table-layout: fixed; +} + +div.float + table th:first-child { + width: 20%; + white-space: nowrap; +} + +div.float + table tr:first-child { + width: 20%; + white-space: nowrap; +} + +span.left { + float: left; + font-family: Arial, Helvetica, sans-serif; + font-weight: bold; +} + +span.right { + float: right; +} + +span.left, span.right { + vertical-align: middle; + background-color: silver; +} + +ol.refs { + counter-reset: refs; +} + +ol.refs > li { + list-style: none; + position: relative; +} + +ol.refs > li:before { + content: "[" counter(refs, decimal) "] "; + counter-increment: refs; + position: absolute; + left: -2rem; +} http://git-wip-us.apache.org/repos/asf/ant/blob/5266b79b/manual/sysclasspath.html ---------------------------------------------------------------------- diff --git a/manual/sysclasspath.html b/manual/sysclasspath.html index 5efb208..3c50d26 100644 --- a/manual/sysclasspath.html +++ b/manual/sysclasspath.html @@ -24,7 +24,7 @@ <body> -<h2><a name="sysclasspath">build.sysclasspath</a></h2> +<h2 id="sysclasspath">build.sysclasspath</h2> <p>The value of the build.sysclasspath property controls how the system classpath, i.e. the classpath in effect when Apache Ant is run, affects the behavior of classpaths in Ant. @@ -32,7 +32,7 @@ The default behavior varies from task to task.</p> The values and their meanings are: -<table cellspacing="20"> +<table> <tr><th>value</th><th>meaning</th></tr> <tr> <td align="left" valign="top">only</td> http://git-wip-us.apache.org/repos/asf/ant/blob/5266b79b/manual/targets.html ---------------------------------------------------------------------- diff --git a/manual/targets.html b/manual/targets.html index a778c95..6501660 100644 --- a/manual/targets.html +++ b/manual/targets.html @@ -23,7 +23,7 @@ </head> <body> - <h1><a name="targets">Targets</a></h1> + <h1 id="targets">Targets</h1> <p>A target is a container of tasks that cooperate to reach a desired state during the build process.</p> @@ -52,7 +52,7 @@ C, then B and then A is executed. Wrong! C depends on B, and B depends on A, so first A is executed, then B, then C, and finally D.</p> - + <blockquote><pre><b>Call-Graph:</b> A --> B --> C --> D</pre></blockquote> <p>In a chain of dependencies stretching back from a given target @@ -116,7 +116,7 @@ <p>If no <code>if</code> and no <code>unless</code> attribute is present, the target will always be executed.</p> - <p><b>Important:</b> the <code>if</code> and <code>unless</code> + <p><b>Important</b>: the <code>if</code> and <code>unless</code> attributes only enable or disable the target to which they are attached. They do not control whether or not targets that a conditional target depends upon get executed. In fact, they do @@ -160,7 +160,7 @@ <p>A target has the following attributes:</p> - <table border="1" cellpadding="2" cellspacing="0"> + <table> <tr> <td valign="top"><b>Attribute</b></td> <td valign="top"><b>Description</b></td> @@ -213,7 +213,7 @@ "warn", "ignore"). <em>since Ant 1.8.2.</em></td> <td align="center" valign="top">No. Not allowed unless - <code>extensionOf</code> is present. Defaults to <code>fail</code>. + <code>extensionOf</code> is present. Defaults to <code>fail</code>. </td> </tr> </table> @@ -236,7 +236,7 @@ don't use Ants main class as entry point and calling them from the IDE is usually possible.</p> - <h1><a name="extension-points">Extension-Points</a></h1> + <h1 id="extension-points">Extension-Points</h1> <p><em>since Ant 1.8.0.</em></p> @@ -248,16 +248,16 @@ is to collect targets that contribute to the desired state in their depends list.</p> - <p>Targets can add themselves to an extension-points's depends list via + <p>Targets can add themselves to an extension-point's depends list via their extensionOf attribute. The targets that add themselves will be - added after the targets of the explicit depends-attribute of the + added after the targets of the explicit depends attribute of the extension-point, if multiple targets add themselves, their relative order is not defined.</p> <p>The main purpose of an extension-point is to act as an extension point for build files designed to be <a href="Tasks/import.html">imported</a>. In the imported - file an extension-point defines a state that must be reached and + file, an extension-point defines a state that must be reached and targets from other build files can join the depends list of said extension-point in order to contribute to that state.</p> @@ -276,7 +276,6 @@ <blockquote><pre><b>Call-Graph:</b> create-directory-layout --> 'empty slot' --> compile</pre></blockquote> - <p>And you need to generate some source before compilation, then in your main build file you may use something like</p> <blockquote><pre> @@ -288,7 +287,6 @@ <blockquote><pre><b>Call-Graph:</b> create-directory-layout --> generate-sources --> compile</pre></blockquote> - <p>This will ensure that the <em>generate-sources</em> target is executed before the <em>compile</em> target.</p> http://git-wip-us.apache.org/repos/asf/ant/blob/5266b79b/manual/tasksoverview.html ---------------------------------------------------------------------- diff --git a/manual/tasksoverview.html b/manual/tasksoverview.html index 776082c..da2de3d 100644 --- a/manual/tasksoverview.html +++ b/manual/tasksoverview.html @@ -23,8 +23,7 @@ </head> <body> -<a name="top"></a> -<h2>Overview of Apache Ant Tasks</h2> +<h2 id="top">Overview of Apache Ant Tasks</h2> <p>Given the large number of tasks available with Ant, it may be difficult to get an overall view of what each task can do. The following tables provide a short description of each task and a link to the complete @@ -38,7 +37,7 @@ documentation.</p> <a href="#ejb">EJB Tasks</a><br> <a href="#exec">Execution Tasks</a><br> <a href="#file">File Tasks</a><br> -<a href="#extensions">Java2 Extensions Tasks</a><br> +<a href="#extensions">Java Extensions Tasks</a><br> <a href="#log">Logging Tasks</a><br> <a href="#mail">Mail Tasks</a><br> <a href="#misc">Miscellaneous Tasks</a><br> @@ -48,38 +47,31 @@ documentation.</p> <a href="#scm">SCM Tasks</a><br> <a href="#testing">Testing Tasks</a><br> +<div class="float" id="archive"> + <span class="left">Archive Tasks</span> + <span class="right"><a href="#top" style="text-decoration:none;">🔝</a></span> +</div> -<p></p> -<table width="100%" border="0" cellpadding="4" cellspacing="0"> -<th align="left"> -<font size="+0" face="arial,helvetica,sanserif"> -<a name="archive">Archive Tasks</a> -</font> -</th> -<font size="-1" face="arial,helvetica,sanserif"> -<th align="right"><a href="#top">[Back to top]</a></th> -</font> -</table> -<table width="100%" border="1" cellpadding="4" cellspacing="0"> +<table> <tr valign="top"> - <th nowrap>Task Name</th> - <th nowrap>Description</th> + <th>Task Name</th> + <th>Description</th> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/unpack.html">GUnzip/BUnzip2/UnXZ</a></td> + <td><a href="Tasks/unpack.html">GUnzip/BUnzip2/UnXZ</a></td> <td><p>Expands a file packed using GZip, BZip2 or XZ.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/pack.html">GZip/BZip2/XZ</a></td> + <td><a href="Tasks/pack.html">GZip/BZip2/XZ</a></td> <td><p>Packs a file using the GZip, BZip2 or XZ algorithm. This task does not do any dependency checking; the output file is always generated</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/cab.html">Cab</a></td> + <td><a href="Tasks/cab.html">Cab</a></td> <td><p>Creates Microsoft CAB archive files. It is invoked similar to the <a href="Tasks/jar.html">Jar</a> or <a href="Tasks/zip.html">Zip</a> tasks. This task will work on @@ -88,29 +80,29 @@ documentation.</p> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/ear.html">Ear</a></td> + <td><a href="Tasks/ear.html">Ear</a></td> <td><p>An extension of the <a href="Tasks/jar.html">Jar</a> task with special treatment for files that should end up in an Enterprise Application archive.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/gunzip.html">GUnzip</a></td> + <td><a href="Tasks/gunzip.html">GUnzip</a></td> <td><p>Expands a GZip file.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/gzip.html">GZip</a></td> + <td><a href="Tasks/gzip.html">GZip</a></td> <td><p>GZips a set of files.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/jar.html">Jar</a></td> + <td><a href="Tasks/jar.html">Jar</a></td> <td><p>Jars a set of files.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/jlink.html">Jlink</a></td> + <td><a href="Tasks/jlink.html">Jlink</a></td> <td><p><i>Deprecated.</i> Use the <code>zipfileset</code> and <code>zipgroupfileset</code> attributes of the <a href="Tasks/jar.html">Jar</a> or @@ -118,50 +110,50 @@ documentation.</p> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/manifest.html">Manifest</a></td> + <td><a href="Tasks/manifest.html">Manifest</a></td> <td><p>Creates a manifest file.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/rpm.html">Rpm</a></td> + <td><a href="Tasks/rpm.html">Rpm</a></td> <td><p>Invokes the <i>rpm</i> executable to build a Linux installation file. This task currently only works on Linux or other Unix platforms with RPM support.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/signjar.html">SignJar</a></td> + <td><a href="Tasks/signjar.html">SignJar</a></td> <td><p>Signs a jar or zip file with the <i>javasign</i> command-line tool.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/tar.html">Tar</a></td> + <td><a href="Tasks/tar.html">Tar</a></td> <td><p>Creates a tar archive.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/unzip.html">Unjar</a></td> + <td><a href="Tasks/unzip.html">Unjar</a></td> <td><p>Unzips a jarfile.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/untar.html">Untar</a></td> + <td><a href="Tasks/untar.html">Untar</a></td> <td><p>Untars a tarfile.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/unzip.html">Unwar</a></td> + <td><a href="Tasks/unzip.html">Unwar</a></td> <td><p>Unzips a warfile.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/unzip.html">Unzip</a></td> + <td><a href="Tasks/unzip.html">Unzip</a></td> <td><p>Unzips a zipfile.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/war.html">War</a></td> + <td><a href="Tasks/war.html">War</a></td> <td><p>An extension of the <a href="Tasks/jar.html">Jar</a> task with special treatment for files that should end up in the <code>WEB-INF/lib</code>, <code>WEB-INF/classes</code>, or @@ -169,55 +161,44 @@ documentation.</p> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/zip.html">Zip</a></td> + <td><a href="Tasks/zip.html">Zip</a></td> <td><p>Creates a zipfile.</p></td> </tr> </table> -<p></p> -<table width="100%" border="0" cellpadding="4" cellspacing="0"> -<th align="left"> -<font size="+0" face="arial,helvetica,sanserif"> -<a name="audit">Audit/Coverage Tasks</a> -</font></th> -<font size="-1" face="arial,helvetica,sanserif"> -<th align="right"><a href="#top">[Back to top]</a></th> -</font> -</table> -<table width="100%" border="1" cellpadding="4" cellspacing="0"> +<div class="float" id="audit"> + <span class="left">Audit/Coverage Tasks</span> + <span class="right"><a href="#top" style="text-decoration:none;">🔝</a></span> +</div> + +<table> <tr valign="top"> - <th nowrap>Task Name</th> + <th>Task Name</th> <th>Description</th> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/jdepend.html">JDepend</a></td> + <td><a href="Tasks/jdepend.html">JDepend</a></td> <td><p>Invokes the <a href="http://www.clarkware.com/software/JDepend.html";> JDepend</a> parser. This parser "traverses a set of Java source-file directories and generates design-quality metrics for each Java package".</p></td> </tr> - </table> -<p></p> -<table width="100%" border="0" cellpadding="4" cellspacing="0"> -<th align="left"> -<font size="+0" face="arial,helvetica,sanserif"> -<a name="compile">Compile Tasks</a> -</font></th> -<font size="-1" face="arial,helvetica,sanserif"> -<th align="right"><a href="#top">[Back to top]</a></th> -</font> -</table> -<table width="100%" border="1" cellpadding="4" cellspacing="0"> +<div class="float" id="compile"> + <span class="left">Compile Tasks</span> + <span class="right"><a href="#top" style="text-decoration:none;">🔝</a></span> +</div> + +<table> <tr valign="top"> - <th nowrap>Task Name</th> + <th>Task Name</th> <th>Description</th> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/depend.html">Depend</a></td> + <td><a href="Tasks/depend.html">Depend</a></td> <td><p>Determines which classfiles are out-of-date with respect to their source, removing the classfiles of any other classes that depend on the out-of-date classes, forcing the re-compile of the removed classfiles. @@ -225,14 +206,14 @@ documentation.</p> <a href="Tasks/javac.html">Javac</a> task.</p></td> <tr valign="top"> - <td nowrap><a href="Tasks/javac.html">Javac</a></td> + <td><a href="Tasks/javac.html">Javac</a></td> <td><p>Compiles the specified source file(s) within the running (Ant) VM, or in another VM if the <code>fork</code> attribute is specified.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/jspc.html">JspC</a></td> + <td><a href="Tasks/jspc.html">JspC</a></td> <td><p>Runs the JSP compiler. It can be used to precompile JSP pages for fast initial invocation of JSP pages, deployment on a server without the full JDK installed, or simply to syntax-check the pages without @@ -243,161 +224,139 @@ documentation.</p> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/netrexxc.html">NetRexxC</a></td> + <td><a href="Tasks/netrexxc.html">NetRexxC</a></td> <td><p>Compiles a <a href="http://www2.hursley.ibm.com/netrexx"; target="_top">NetRexx</a> source tree within the running (Ant) VM.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/rmic.html">Rmic</a></td> + <td><a href="Tasks/rmic.html">Rmic</a></td> <td><p>Runs the <i>rmic</i> compiler on the specified file(s).</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/wljspc.html">Wljspc</a></td> + <td><a href="Tasks/wljspc.html">Wljspc</a></td> <td><p>Compiles JSP pages using Weblogic's JSP compiler, <i>weblogic.jspc</i>. (For non-Weblogic JSP compiles, see the <a href="Tasks/jspc.html">JspC</a> task.</p></td> </tr> - </table> -<p></p> -<table width="100%" border="0" cellpadding="4" cellspacing="0"> -<th align="left"> -<font size="+0" face="arial,helvetica,sanserif"> -<a name="deploy">Deployment Tasks</a> -</font></th> -<font size="-1" face="arial,helvetica,sanserif"> -<th align="right"><a href="#top">[Back to top]</a></th> -</font> -</table> -<table width="100%" border="1" cellpadding="4" cellspacing="0"> +<div class="float" id="deploy"> + <span class="left">Deployment Tasks</span> + <span class="right"><a href="#top" style="text-decoration:none;">🔝</a></span> +</div> + +<table> <tr valign="top"> - <th nowrap>Task Name</th> + <th>Task Name</th> <th>Description</th> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/serverdeploy.html">ServerDeploy</a></td> + <td><a href="Tasks/serverdeploy.html">ServerDeploy</a></td> <td><p>Task to run a "hot" deployment tool for vendor-specific J2EE server. </p></td> </tr> </table> -<p></p> -<table width="100%" border="0" cellpadding="4" cellspacing="0"> -<th align="left"> -<font size="+0" face="arial,helvetica,sanserif"> -<a name="doc">Documentation Tasks</a> -</font></th> -<font size="-1" face="arial,helvetica,sanserif"> -<th align="right"><a href="#top">[Back to top]</a></th> -</font> -</table> -<table width="100%" border="1" cellpadding="4" cellspacing="0"> +<div class="float" id="doc"> + <span class="left">Documentation Tasks</span> + <span class="right"><a href="#top" style="text-decoration:none;">🔝</a></span> +</div> + +<table> <tr valign="top"> - <th nowrap>Task Name</th> + <th>Task Name</th> <th>Description</th> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/javadoc.html">Javadoc/<i>Javadoc2</i></a></td> + <td><a href="Tasks/javadoc.html">Javadoc/<i>Javadoc2</i></a></td> <td><p>Generates code documentation using the <i>javadoc</i> tool. The Javadoc2 task is deprecated; use the Javadoc task instead.</p></td> </tr> - </table> -<p></p> -<table width="100%" border="0" cellpadding="4" cellspacing="0"> -<th align="left"> -<font size="+0" face="arial,helvetica,sanserif"> -<a name="ejb">EJB Tasks</a> -</font></th> -<font size="-1" face="arial,helvetica,sanserif"> -<th align="right"><a href="#top">[Back to top]</a></th> -</font> -</table> -<table width="100%" border="1" cellpadding="4" cellspacing="0"> +<div class="float" id="ejb"> + <span class="left">EJB Tasks</span> + <span class="right"><a href="#top" style="text-decoration:none;">🔝</a></span> +</div> + +<table> <tr valign="top"> - <th nowrap>Task Name</th> + <th>Task Name</th> <th>Description</th> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/ejb.html">EJB Tasks</a></td> + <td><a href="Tasks/ejb.html">EJB Tasks</a></td> <td><p>(See the documentation describing the EJB tasks.)</p></td> </tr> </table> -<p></p> -<table width="100%" border="0" cellpadding="4" cellspacing="0"> -<th align="left"> -<font size="+0" face="arial,helvetica,sanserif"> -<a name="exec">Execution Tasks</a> -</font></th> -<font size="-1" face="arial,helvetica,sanserif"> -<th align="right"><a href="#top">[Back to top]</a></th> -</font> -</table> -<table width="100%" border="1" cellpadding="4" cellspacing="0"> +<div class="float" id="exec"> + <span class="left">Execution Tasks</span> + <span class="right"><a href="#top" style="text-decoration:none;">🔝</a></span> +</div> + +<table> <tr valign="top"> - <th nowrap>Task Name</th> + <th>Task Name</th> <th>Description</th> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/ant.html">Ant</a></td> + <td><a href="Tasks/ant.html">Ant</a></td> <td><p>Runs Ant on a supplied buildfile, optionally passing properties (with possibly new values). This task can be used to build sub-projects.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/antcall.html">AntCall</a></td> + <td><a href="Tasks/antcall.html">AntCall</a></td> <td><p>Runs another target within the same buildfile, optionally passing properties (with possibly new values).</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/apply.html">Apply/<i>ExecOn</i></a></td> + <td><a href="Tasks/apply.html">Apply/<i>ExecOn</i></a></td> <td><p>Executes a system command. When the <code>os</code> attribute is specified, the command is only executed when Ant is run on one of the specified operating systems.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/dependset.html">Dependset</a></td> + <td><a href="Tasks/dependset.html">Dependset</a></td> <td><p>This task compares a set of source files with a set of target files. If any of the source files is newer than any of the target files, all the target files are removed. </p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/exec.html">Exec</a></td> + <td><a href="Tasks/exec.html">Exec</a></td> <td><p>Executes a system command. When the <code>os</code> attribute is specified, the command is only executed when Ant is run on one of the specified operating systems.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/java.html">Java</a></td> + <td><a href="Tasks/java.html">Java</a></td> <td><p>Executes a Java class within the running (Ant) VM, or in another VM if the <code>fork</code> attribute is specified.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/parallel.html">Parallel</a></td> + <td><a href="Tasks/parallel.html">Parallel</a></td> <td><p>A container task that can contain other Ant tasks. Each nested task specified within the <code><parallel></code> tag will be executed in its own thread.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/sequential.html">Sequential</a></td> + <td><a href="Tasks/sequential.html">Sequential</a></td> <td><p>A container task that can contain other Ant tasks. The nested tasks are simply executed in sequence. Its primary use is to support the sequential execution of a subset of tasks within @@ -405,19 +364,19 @@ documentation.</p> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/sleep.html">Sleep</a></td> + <td><a href="Tasks/sleep.html">Sleep</a></td> <td><p> A task for suspending execution for a specified period of time. Useful when a build or deployment process requires an interval between tasks.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/subant.html">Subant</a></td> + <td><a href="Tasks/subant.html">Subant</a></td> <td><p> Calls a given target for all defined sub-builds. This is an extension of ant for bulk project execution.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/waitfor.html">Waitfor</a></td> + <td><a href="Tasks/waitfor.html">Waitfor</a></td> <td><p>Blocks execution until a set of specified conditions become true. This task is intended to be used with the <a href="Tasks/parallel.html">Parallel</a> task to synchronize @@ -425,44 +384,39 @@ documentation.</p> </tr> </table> -<p></p> -<table width="100%" border="0" cellpadding="4" cellspacing="0"> -<th align="left"> -<font size="+0" face="arial,helvetica,sanserif"> -<a name="file">File Tasks</a> -</font></th> -<font size="-1" face="arial,helvetica,sanserif"> -<th align="right"><a href="#top">[Back to top]</a></th> -</font> -</table> -<table width="100%" border="1" cellpadding="4" cellspacing="0"> +<div class="float" id="file"> + <span class="left">File Tasks</span> + <span class="right"><a href="#top" style="text-decoration:none;">🔝</a></span> +</div> + +<table> <tr valign="top"> - <th nowrap>Task Name</th> + <th>Task Name</th> <th>Description</th> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/attrib.html">Attrib</a></td> + <td><a href="Tasks/attrib.html">Attrib</a></td> <td><p>Changes the permissions and/or attributes of a file or all files inside the specified directories. Currently, it has effect only under Windows.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/checksum.html">Checksum</a></td> + <td><a href="Tasks/checksum.html">Checksum</a></td> <td><p>Generates a checksum for a file or set of files. This task can also be used to perform checksum verifications.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/chgrp.html">Chgrp</a></td> + <td><a href="Tasks/chgrp.html">Chgrp</a></td> <td><p>Changes the group ownership of a file or all files inside the specified directories. Currently, it has effect only under Unix.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/chmod.html">Chmod</a></td> + <td><a href="Tasks/chmod.html">Chmod</a></td> <td><p>Changes the permissions of a file or all files inside the specified directories. Currently, it has effect only under Unix. The permissions are also UNIX style, like the arguments for the @@ -470,91 +424,91 @@ documentation.</p> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/chown.html">Chown</a></td> + <td><a href="Tasks/chown.html">Chown</a></td> <td><p>Changes the owner of a file or all files inside the specified directories. Currently, it has effect only under Unix.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/concat.html">Concat</a></td> + <td><a href="Tasks/concat.html">Concat</a></td> <td><p>Concatenates multiple files into a single one or to Ant's logging system.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/copy.html">Copy</a></td> + <td><a href="Tasks/copy.html">Copy</a></td> <td><p>Copies a file or Fileset to a new file or directory.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/copydir.html"><i>Copydir</i></a></td> + <td><a href="Tasks/copydir.html"><i>Copydir</i></a></td> <td><p><i>Deprecated.</i> Use the <a href="Tasks/copy.html">Copy</a> task instead.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/copyfile.html"><i>Copyfile</i></a></td> + <td><a href="Tasks/copyfile.html"><i>Copyfile</i></a></td> <td><p><i>Deprecated.</i> Use the <a href="Tasks/copy.html">Copy</a> task instead.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/delete.html">Delete</a></td> + <td><a href="Tasks/delete.html">Delete</a></td> <td><p>Deletes either a single file, all files and sub-directories in a specified directory, or a set of files specified by one or more <a href="Types/fileset.html">FileSet</a>s.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/deltree.html"><i>Deltree</i></a></td> + <td><a href="Tasks/deltree.html"><i>Deltree</i></a></td> <td><p><i>Deprecated.</i> Use the <a href="Tasks/delete.html">Delete</a> task instead.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/filter.html">Filter</a></td> + <td><a href="Tasks/filter.html">Filter</a></td> <td><p>Sets a token filter for this project, or reads multiple token filters from a specified file and sets these as filters. Token filters are used by all tasks that perform file-copying operations.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/fixcrlf.html">FixCRLF</a></td> + <td><a href="Tasks/fixcrlf.html">FixCRLF</a></td> <td><p>Modifies a file to add or remove tabs, carriage returns, linefeeds, and EOF characters.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/get.html">Get</a></td> + <td><a href="Tasks/get.html">Get</a></td> <td><p>Gets a file from a URL.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/mkdir.html">Mkdir</a></td> + <td><a href="Tasks/mkdir.html">Mkdir</a></td> <td><p>Creates a directory. Non-existent parent directories are created, when necessary.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/move.html">Move</a></td> + <td><a href="Tasks/move.html">Move</a></td> <td><p>Moves a file to a new file or directory, or a set(s) of file(s) to a new directory.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/patch.html">Patch</a></td> + <td><a href="Tasks/patch.html">Patch</a></td> <td><p>Applies a "diff" file to originals.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/rename.html"><i>Rename</i></a></td> + <td><a href="Tasks/rename.html"><i>Rename</i></a></td> <td><p><i>Deprecated.</i> Use the <a href="Tasks/move.html">Move</a> task instead.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/renameextensions.html"> + <td><a href="Tasks/renameextensions.html"> <i>RenameExtensions</i></a></td> <td><p><i>Deprecated</i>. Use the <a href="Tasks/move.html">Move</a> task with a <a href="Types/mapper.html#glob-mapper">glob mapper</a> @@ -562,13 +516,13 @@ documentation.</p> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/replace.html">Replace</a></td> + <td><a href="Tasks/replace.html">Replace</a></td> <td><p>Replace is a directory-based task for replacing the occurrence of a given string with another string in selected file.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/replaceregexp.html"> + <td><a href="Tasks/replaceregexp.html"> ReplaceRegExp</a></td> <td><p>Directory-based task for replacing the occurrence of a given regular expression with a substitution pattern in a file or set of @@ -576,46 +530,41 @@ documentation.</p> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/setpermissions.html">SetPermissions</a></td> + <td><a href="Tasks/setpermissions.html">SetPermissions</a></td> <td><p>Changes the permissions of a collection of resources.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/sync.html">Sync</a></td> + <td><a href="Tasks/sync.html">Sync</a></td> <td><p>Synchronize two directory trees.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/tempfile.html">Tempfile</a></td> + <td><a href="Tasks/tempfile.html">Tempfile</a></td> <td><p>Generates a name for a new temporary file and sets the specified property to that name.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/touch.html">Touch</a></td> + <td><a href="Tasks/touch.html">Touch</a></td> <td><p>Changes the modification time of a file and possibly creates it at the same time.</p></td> </tr> </table> -<p></p> -<table width="100%" border="0" cellpadding="4" cellspacing="0"> -<th align="left"> -<font size="+0" face="arial,helvetica,sanserif"> -<a name="extensions">Java2 Extensions Tasks</a> -</font></th> -<font size="-1" face="arial,helvetica,sanserif"> -<th align="right"><a href="#top">[Back to top]</a></th> -</font> -</table> -<table width="100%" border="1" cellpadding="4" cellspacing="0"> +<div class="float" id="extensions"> + <span class="left">Java Extensions Tasks</span> + <span class="right"><a href="#top" style="text-decoration:none;">🔝</a></span> +</div> + +<table> <tr valign="top"> - <th nowrap>Task Name</th> + <th>Task Name</th> <th>Description</th> </tr> <tr valign="top"> - <td nowrap> + <td> <a href="Tasks/jarlib-available.html">Jarlib-available</a></td> <td><p>Check whether an extension is present in a FileSet or an ExtensionSet. If the extension is present, the specified property is @@ -624,7 +573,7 @@ documentation.</p> </tr> <tr valign="top"> - <td nowrap> + <td> <a href="Tasks/jarlib-display.html">Jarlib-display</a></td> <td><p>Display the "Optional Package" and "Package Specification" information contained within the @@ -633,7 +582,7 @@ documentation.</p> </tr> <tr valign="top"> - <td nowrap> + <td> <a href="Tasks/jarlib-manifest.html">Jarlib-manifest</a></td> <td><p>Task to generate a manifest that declares all the dependencies in manifest. The dependencies are determined by looking in the @@ -643,7 +592,7 @@ documentation.</p> </tr> <tr valign="top"> - <td nowrap> + <td> <a href="Tasks/jarlib-resolve.html">Jarlib-resolve</a></td> <td><p>Try to locate a jar to satisfy an extension, and place the location of the jar into the specified property.</p> @@ -651,131 +600,113 @@ documentation.</p> </tr> </table> -<p></p> -<p></p> -<table width="100%" border="0" cellpadding="4" cellspacing="0"> -<th align="left"> -<font size="+0" face="arial,helvetica,sanserif"> -<a name="log">Logging Tasks</a> -</font></th> -<font size="-1" face="arial,helvetica,sanserif"> -<th align="right"><a href="#top">[Back to top]</a></th> -</font> -</table> -<table width="100%" border="1" cellpadding="4" cellspacing="0"> +<div class="float" id="log"> + <span class="left">Logging Tasks</span> + <span class="right"><a href="#top" style="text-decoration:none;">🔝</a></span> +</div> + +<table> <tr valign="top"> - <th nowrap>Task Name</th> + <th>Task Name</th> <th>Description</th> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/recorder.html">Record</a></td> + <td><a href="Tasks/recorder.html">Record</a></td> <td><p>Runs a listener that records the logging output of the build-process events to a file. Several recorders can exist at the same time. Each recorder is associated with a file.</p></td> </tr> </table> -<p></p> -<table width="100%" border="0" cellpadding="4" cellspacing="0"> -<th align="left"> -<font size="+0" face="arial,helvetica,sanserif"> -<a name="mail">Mail Tasks</a> -</font></th> -<font size="-1" face="arial,helvetica,sanserif"> -<th align="right"><a href="#top">[Back to top]</a></th> -</font> -</table> -<table width="100%" border="1" cellpadding="4" cellspacing="0"> +<div class="float" id="mail"> + <span class="left">Mail Tasks</span> + <span class="right"><a href="#top" style="text-decoration:none;">🔝</a></span> +</div> + +<table> <tr valign="top"> - <th nowrap>Task Name</th> + <th>Task Name</th> <th>Description</th> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/mail.html">Mail</a></td> + <td><a href="Tasks/mail.html">Mail</a></td> <td><p>A task to send SMTP email.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/mimemail.html">MimeMail</a></td> + <td><a href="Tasks/mimemail.html">MimeMail</a></td> <td><p><i>Deprecated</i>. Use the <a href="Tasks/mail.html">Mail</a> task instead.</p></td> </tr> - </table> -<p></p> -<table width="100%" border="0" cellpadding="4" cellspacing="0"> -<th align="left"> -<font size="+0" face="arial,helvetica,sanserif"> -<a name="misc">Miscellaneous Tasks</a> -</font></th> -<font size="-1" face="arial,helvetica,sanserif"> -<th align="right"><a href="#top">[Back to top]</a></th> -</font> -</table> -<table width="100%" border="1" cellpadding="4" cellspacing="0"> +<div class="float" id="misc"> + <span class="left">Miscellaneous Tasks</span> + <span class="right"><a href="#top" style="text-decoration:none;">🔝</a></span> +</div> + +<table> <tr valign="top"> - <th nowrap>Task Name</th> + <th>Task Name</th> <th>Description</th> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/defaultexcludes.html">Defaultexcludes</a></td> + <td><a href="Tasks/defaultexcludes.html">Defaultexcludes</a></td> <td><p>Modify the list of default exclude patterns from within your build file.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/echo.html">Echo</a></td> + <td><a href="Tasks/echo.html">Echo</a></td> <td><p>Echoes text to <code>System.out</code> or to a file.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/fail.html">Fail</a></td> + <td><a href="Tasks/fail.html">Fail</a></td> <td><p>Exits the current build by throwing a BuildException, optionally printing additional information.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/genkey.html">GenKey</a></td> + <td><a href="Tasks/genkey.html">GenKey</a></td> <td><p>Generates a key in keystore.</p></td> </tr> - - + <tr valign="top"> - <td nowrap><a href="Tasks/hostinfo.html">HostInfo</a></td> + <td><a href="Tasks/hostinfo.html">HostInfo</a></td> <td><p>Sets properties related to the provided host, or to the host the process is run on.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/input.html">Input</a></td> + <td><a href="Tasks/input.html">Input</a></td> <td><p>Allows user interaction during the build process by displaying a message and reading a line of input from the console.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/script.html">Script</a></td> + <td><a href="Tasks/script.html">Script</a></td> <td><p>Executes a script in a <a href="http://jakarta.apache.org/bsf/"; target="_top">Apache BSF</a>-supported language.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/sound.html">Sound</a></td> + <td><a href="Tasks/sound.html">Sound</a></td> <td><p>Plays a sound file at the end of the build, according to whether the build failed or succeeded.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/splash.html">Splash</a></td> + <td><a href="Tasks/splash.html">Splash</a></td> <td><p>Displays a splash screen.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/sql.html">Sql</a></td> + <td><a href="Tasks/sql.html">Sql</a></td> <td><p>Executes a series of SQL statements via JDBC to a database. Statements can either be read in from a text file using the <code>src</code> attribute, or from between the enclosing SQL @@ -783,85 +714,80 @@ documentation.</p> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/taskdef.html">Taskdef</a></td> + <td><a href="Tasks/taskdef.html">Taskdef</a></td> <td><p>Adds a task definition to the current project, such that this new task can be used in the current project.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/tstamp.html">TStamp</a></td> + <td><a href="Tasks/tstamp.html">TStamp</a></td> <td><p>Sets the <code>DSTAMP</code>, <code>TSTAMP</code>, and <code>TODAY</code> properties in the current project, based on the current date and time.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/typedef.html">Typedef</a></td> + <td><a href="Tasks/typedef.html">Typedef</a></td> <td><p>Adds a data-type definition to the current project, such that this new type can be used in the current project.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/xmlvalidate.html">XmlValidate</a></td> + <td><a href="Tasks/xmlvalidate.html">XmlValidate</a></td> <td><p>Checks that XML files are valid (or only well-formed). This task uses the XML parser that is currently used by Ant by default, but any SAX1/2 parser can be specified, if needed.</p></td> </tr> </table> -<p></p> -<table width="100%" border="0" cellpadding="4" cellspacing="0"> -<th align="left"> -<font size="+0" face="arial,helvetica,sanserif"> -<a name="preproc">Pre-process Tasks</a> -</font></th> -<font size="-1" face="arial,helvetica,sanserif"> -<th align="right"><a href="#top">[Back to top]</a></th> -</font> -</table> -<table width="100%" border="1" cellpadding="4" cellspacing="0"> +<div class="float" id="preproc"> + <span class="left">Pre-process Tasks</span> + <span class="right"><a href="#top" style="text-decoration:none;">🔝</a></span> +</div> + +<table> <tr valign="top"> - <th nowrap>Task Name</th> + <th>Task Name</th> <th>Description</th> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/antlr.html">ANTLR</a></td> + <td><a href="Tasks/antlr.html">ANTLR</a></td> <td><p>Invokes the <a HREF="http://www.antlr.org/"; target="_top">ANTLR</a> Translator generator on a grammar file.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/antstructure.html">AntStructure</a></td> + <td><a href="Tasks/antstructure.html">AntStructure</a></td> <td><p>Generates a DTD for Ant buildfiles that contains information about all tasks currently known to Ant.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/import.html">Import</a></td> + <td><a href="Tasks/import.html">Import</a></td> <td><p>Import another build file and potentially override targets in it with targets of your own.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/include.html">Include</a></td> + <td><a href="Tasks/include.html">Include</a></td> <td><p>Include another build file.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/javacc.html">JavaCC</a></td> + <td><a href="Tasks/javacc.html">JavaCC</a></td> <td><p>Invokes the <a HREF="http://javacc.dev.java.net/"; target="_top"> JavaCC</a> compiler-compiler on a grammar file.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/javah.html">Javah</a></td> + <td><a href="Tasks/javah.html">Javah</a></td> <td><p>Generates JNI headers from a Java class.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/jjdoc.html">JJDoc</a></td> + <td><a href="Tasks/jjdoc.html">JJDoc</a></td> <td><p>Invokes the <a href="http://javacc.dev.java.net/";> JJDoc</a> documentation generator for the JavaCC compiler-compiler. JJDoc takes a JavaCC parser specification and produces documentation @@ -871,7 +797,7 @@ documentation.</p> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/jjtree.html">JJTree</a></td> + <td><a href="Tasks/jjtree.html">JJTree</a></td> <td><p>Invokes the <a href="http://javacc.dev.java.net/";> JJTree</a> preprocessor for the JavaCC compiler-compiler. It inserts parse-tree building actions at various places in the JavaCC source that @@ -881,12 +807,12 @@ documentation.</p> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/macrodef.html">Macrodef</a></td> + <td><a href="Tasks/macrodef.html">Macrodef</a></td> <td><p>Define a new task as a macro built-up upon other tasks.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/native2ascii.html"> + <td><a href="Tasks/native2ascii.html"> Native2Ascii</a></td> <td><p>Converts files from native encodings to ASCII with escaped Unicode. A common usage is to convert source files maintained in a native @@ -894,84 +820,75 @@ documentation.</p> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/presetdef.html">Presetdef</a></td> + <td><a href="Tasks/presetdef.html">Presetdef</a></td> <td><p>Define a new task by instrumenting an existing task with default values for attributes or child elements.</p> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/translate.html">Translate</a></td> + <td><a href="Tasks/translate.html">Translate</a></td> <td><p>Identifies keys in files, delimited by special tokens, and translates them with values read from resource bundles.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/style.html">XSLT</a></td> + <td><a href="Tasks/style.html">XSLT</a></td> <td><p>Processes a set of documents via XSLT.</p></td> </tr> - </table> -<p></p> -<table width="100%" border="0" cellpadding="4" cellspacing="0"> -<th align="left"> -<font size="+0" face="arial,helvetica,sanserif"> -<a name="prop">Property Tasks</a> -</font></th> -<font size="-1" face="arial,helvetica,sanserif"> -<th align="right"><a href="#top">[Back to top]</a></th> -</font> -</table> -<table width="100%" border="1" cellpadding="4" cellspacing="0"> +<div class="float" id="prop"> + <span class="left">Property Tasks</span> + <span class="right"><a href="#top" style="text-decoration:none;">🔝</a></span> +</div> + +<table> <tr valign="top"> - <th nowrap>Task Name</th> + <th>Task Name</th> <th>Description</th> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/available.html">Available</a></td> + <td><a href="Tasks/available.html">Available</a></td> <td><p>Sets a property if a specified file, directory, class in the classpath, or JVM system resource is available at runtime.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/basename.html">Basename</a></td> + <td><a href="Tasks/basename.html">Basename</a></td> <td><p>Sets a property to the last element of a specified path. </tr> <tr valign="top"> - <td nowrap><a href="Tasks/buildnumber.html">BuildNumber</a></td> + <td><a href="Tasks/buildnumber.html">BuildNumber</a></td> <td><p>Task that can be used to track build numbers. </tr> <tr valign="top"> - <td nowrap><a href="Tasks/condition.html">Condition</a></td> + <td><a href="Tasks/condition.html">Condition</a></td> <td><p>Sets a property if a certain condition holds true; this is a generalization of <a href="Tasks/available.html">Available</a> and <a href="Tasks/uptodate.html">Uptodate</a>.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/dirname.html">Dirname</a></td> + <td><a href="Tasks/dirname.html">Dirname</a></td> <td><p>Sets a property to the value of the specified file up to, but not including, the last path element. </tr> <tr valign="top"> - <td nowrap> - <a href="Tasks/echoproperties.html">Echoproperties</a><br> - - </td> + <td><a href="Tasks/echoproperties.html">Echoproperties</a></td> <td><p>Lists the current properties.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/loadfile.html">LoadFile</a></td> + <td><a href="Tasks/loadfile.html">LoadFile</a></td> <td><p>Loads a file into a property.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/loadproperties.html">LoadProperties</a></td> + <td><a href="Tasks/loadproperties.html">LoadProperties</a></td> <td><p>Load a file's contents as Ant properties. This task is equivalent to using <code><property file="..."/></code> except that it supports nested <code><filterchain></code> elements, @@ -979,12 +896,12 @@ documentation.</p> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/makeurl.html">MakeURL</a></td> + <td><a href="Tasks/makeurl.html">MakeURL</a></td> <td><p>Creates a URL (list) from a file/fileset or path</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/pathconvert.html">PathConvert</a></td> + <td><a href="Tasks/pathconvert.html">PathConvert</a></td> <td><p>Converts a nested path, path reference, filelist reference, or fileset reference to the form usable on a specified platform and/or to a list of items separated by the specified separator and stores @@ -992,13 +909,13 @@ documentation.</p> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/property.html">Property</a></td> + <td><a href="Tasks/property.html">Property</a></td> <td><p>Sets a property (by name and value), or set of properties (from a file or resource) in the project.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/propertyfile.html"> + <td><a href="Tasks/propertyfile.html"> PropertyFile</a></td> <td><p>Creates or modifies property files. Useful when wanting to make unattended modifications to configuration files for application @@ -1008,132 +925,121 @@ documentation.</p> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/uptodate.html">Uptodate</a></td> + <td><a href="Tasks/uptodate.html">Uptodate</a></td> <td><p>Sets a property if a given target file is newer than a set of source files.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/whichresource.html">Whichresource</a></td> + <td><a href="Tasks/whichresource.html">Whichresource</a></td> <td><p>Find a class or resource.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/xmlproperty.html">XmlProperty</a></td> + <td><a href="Tasks/xmlproperty.html">XmlProperty</a></td> <td><p>Loads property values from a well-formed XML file.</p></td> </tr> </table> -<p></p> -<table width="100%" border="0" cellpadding="4" cellspacing="0"> -<th align="left"> -<font size="+0" face="arial,helvetica,sanserif"> -<a name="remote">Remote Tasks</a> -</font></th> -<font size="-1" face="arial,helvetica,sanserif"> -<th align="right"><a href="#top">[Back to top]</a></th> -</font> -</table> -<table width="100%" border="1" cellpadding="4" cellspacing="0"> +<div class="float" id="remote"> + <span class="left">Remote Tasks</span> + <span class="right"><a href="#top" style="text-decoration:none;">🔝</a></span> +</div> + +<table> <tr valign="top"> - <th nowrap>Task Name</th> + <th>Task Name</th> <th>Description</th> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/ftp.html">FTP</a></td> + <td><a href="Tasks/ftp.html">FTP</a></td> <td><p>Implements a basic FTP client that can send, receive, list, and delete files, and create directories.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/rexec.html">Rexec</a></td> + <td><a href="Tasks/rexec.html">Rexec</a></td> <td><p>Task to automate a remote rexec session.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/scp.html">Scp</a></td> + <td><a href="Tasks/scp.html">Scp</a></td> <td><p>Copy files to or from a remote server using SSH.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/setproxy.html">setproxy</a></td> + <td><a href="Tasks/setproxy.html">setproxy</a></td> <td><p>Sets Java's web proxy properties, so that tasks and code run in the same JVM can have through-the-firewall access to remote web sites.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/sshexec.html">Sshexec</a></td> + <td><a href="Tasks/sshexec.html">Sshexec</a></td> <td><p>Execute a command on a remote server using SSH.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/telnet.html">Telnet</a></td> + <td><a href="Tasks/telnet.html">Telnet</a></td> <td><p>Task to automate a remote <i>telnet</i> session. This task uses nested <code><read></code> and <code><write></code> tags to indicate strings to wait for and specify text to send.</p></td> </tr> - </table> -<p></p> -<table width="100%" border="0" cellpadding="4" cellspacing="0"> -<th align="left"> -<font size="+0" face="arial,helvetica,sanserif"> -<a name="scm">SCM Tasks</a> -</font></th> -<font size="-1" face="arial,helvetica,sanserif"> -<th align="right"><a href="#top">[Back to top]</a></th> -</font> -</table> -<table width="100%" border="1" cellpadding="4" cellspacing="0"> +<div class="float" id="scm"> + <span class="left">SCM Tasks</span> + <span class="right"><a href="#top" style="text-decoration:none;">🔝</a></span> +</div> + +<table> <tr valign="top"> - <th nowrap>Task Name</th> + <th>Task Name</th> <th>Description</th> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/cvs.html">Cvs</a></td> + <td><a href="Tasks/cvs.html">Cvs</a></td> <td><p>Handles packages/modules retrieved from a <a href="http://www.nongnu.org/cvs/"; target="_top">CVS</a> repository.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/changelog.html">CvsChangeLog</a></td> + <td><a href="Tasks/changelog.html">CvsChangeLog</a></td> <td><p>Generates an XML report of the changes recorded in a <a href="http://www.nongnu.org/cvs/"; target="_top">CVS</a> repository.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/cvspass.html">CVSPass</a></td> + <td><a href="Tasks/cvspass.html">CVSPass</a></td> <td><p>Adds entries to a .cvspass file. Adding entries to this file has the same affect as a <i>cvs login</i> command.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/cvstagdiff.html">CvsTagDiff</a></td> + <td><a href="Tasks/cvstagdiff.html">CvsTagDiff</a></td> <td><p>Generates an XML-formatted report file of the changes between two tags or dates recorded in a <a href="http://www.nongnu.org/cvs/"; target="_top">CVS</a> repository.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/clearcase.html">ClearCase</a></td> + <td><a href="Tasks/clearcase.html">ClearCase</a></td> <td><p>Tasks to perform the ClearCase cleartool <i>checkin</i>, <i>checkout</i>, <i>uncheckout</i>, <i>update</i>, <i>lock</i>, <i>unlock</i>, <i>mklbtype</i>, <i>rmtype</i>, <i>mklabel</i>, <i>mkattr</i>, <i>mkdir</i>, <i>mkelem</i>, and <i>mkbl</i> commands.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/ccm.html">Continuus/Synergy</a></td> + <td><a href="Tasks/ccm.html">Continuus/Synergy</a></td> <td><p>Tasks to perform the Continuus <i>ccmcheckin</i>, <i>ccmcheckout</i>, <i>ccmcheckintask</i>, <i>ccmreconfigure</i>, and <i>ccmcreateTask</i> commands.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/vss.html"> + <td><a href="Tasks/vss.html"> Microsoft Visual SourceSafe</a></td> <td><p>Tasks to perform the Visual SourceSafe <i>vssget</i>, <i>vsslabel</i>, <i>vsshistory</i>, <i>vsscheckin</i>, @@ -1141,57 +1047,45 @@ documentation.</p> commands.</p></td> </tr> - - <tr valign="top"> - <td nowrap><a href="Tasks/pvcstask.html">Pvcs</a></td> + <td><a href="Tasks/pvcstask.html">Pvcs</a></td> <td><p>Allows the user extract the latest edition of the source code from a PVCS repository.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/sos.html">SourceOffSite</a></td> + <td><a href="Tasks/sos.html">SourceOffSite</a></td> <td><p>Tasks to perform the SourceOffSite <i>sosget</i>, <i>soslabel</i>, <i>soscheckin</i>, and <i>soscheckout</i> commands.</p></td> </tr> - </table> -<p></p> -<table width="100%" border="0" cellpadding="4" cellspacing="0"> -<th align="left"> -<font size="+0" face="arial,helvetica,sanserif"> -<a name="testing">Testing Tasks</a> -</font></th> -<font size="-1" face="arial,helvetica,sanserif"> -<th align="right"><a href="#top">[Back to top]</a></th> -</font> -</table> -<table width="100%" border="1" cellpadding="4" cellspacing="0"> +<div class="float" id="testing"> + <span class="left">Testing Tasks</span> + <span class="right"><a href="#top" style="text-decoration:none;">🔝</a></span> +</div> + +<table> <tr valign="top"> - <th nowrap>Task Name</th> + <th>Task Name</th> <th>Description</th> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/junit.html">Junit</a></td> + <td><a href="Tasks/junit.html">Junit</a></td> <td><p>Runs tests from the <a href="http://www.junit.org";>Junit</a> testing framework. This task has been tested with JUnit 3.0 up to JUnit 3.7; it won't work with versions prior to JUnit 3.0.</p></td> </tr> <tr valign="top"> - <td nowrap><a href="Tasks/junitreport.html">JunitReport</a></td> + <td><a href="Tasks/junitreport.html">JunitReport</a></td> <td><p>Merges the individual XML files generated by the <a href="Tasks/junit.html">Junit</a> task and applies a stylesheet on the resulting merged document to provide a browsable report of the testcases results.</p></td> </tr> - </table> - - - </body> </html> http://git-wip-us.apache.org/repos/asf/ant/blob/5266b79b/manual/toc.html ---------------------------------------------------------------------- diff --git a/manual/toc.html b/manual/toc.html index 91d9824..cee6588 100644 --- a/manual/toc.html +++ b/manual/toc.html @@ -48,4 +48,3 @@ </body> </html> - http://git-wip-us.apache.org/repos/asf/ant/blob/5266b79b/manual/tutorial-HelloWorldWithAnt.html ---------------------------------------------------------------------- diff --git a/manual/tutorial-HelloWorldWithAnt.html b/manual/tutorial-HelloWorldWithAnt.html index babd9b4..9382045 100644 --- a/manual/tutorial-HelloWorldWithAnt.html +++ b/manual/tutorial-HelloWorldWithAnt.html @@ -22,29 +22,25 @@ <body> <h1>Tutorial: Hello World with Apache Ant</h1> -<p>This document provides a step by step tutorial for starting java programming with Apache Ant. +<p>This document provides a step by step tutorial for starting Java programming with Apache Ant. It does <b>not</b> contain deeper knowledge about Java or Ant. This tutorial has the goal to let you see, how to do the easiest steps in Ant.</p> - - <h2>Content</h2> -<p><ul> +<ul> <li><a href="#prepare">Preparing the project</a></li> <li><a href="#four-steps">Enhance the build file</a></li> <li><a href="#enhance">Enhance the build file</a></li> <li><a href="#ext-libs">Using external libraries</a></li> <li><a href="#resources">Resources</a></li> -</ul></p> - +</ul> -<a name="prepare"></a> -<h2>Preparing the project</h2> +<h2 id="prepare">Preparing the project</h2> <p>We want to separate the source from the generated files, so our java source files will be in <tt>src</tt> folder. All generated files should be under <tt>build</tt>, and there splitted into several subdirectories for the individual steps: <tt>classes</tt> for our compiled files and <tt>jar</tt> for our own JAR-file.</p> -<p>We have to create only the <tt>src</tt> directory. (Because I am working on Windows, here is +<p>We have to create only the <tt>src</tt> directory. (Because I am working on Windows, here is the win-syntax - translate to your shell):</p> <pre class="code"> @@ -64,7 +60,7 @@ public class HelloWorld { } </pre> -<p>Now just try to compile and run that: +<p>Now just try to compile and run that:</p> <pre class="code"> md build\classes javac -sourcepath src -d build\classes src\oata\HelloWorld.java @@ -74,7 +70,6 @@ which will result in <pre class="output"> Hello World </pre> -</p> <p>Creating a jar-file is not very difficult. But creating a <i>startable</i> jar-file needs more steps: create a manifest-file containing the start class, creating the target directory and archiving the files.</p> @@ -85,12 +80,10 @@ jar cfm build\jar\HelloWorld.jar myManifest -C build\classes . java -jar build\jar\HelloWorld.jar </pre> -<p><b>Note:</b> Do not have blanks around the >-sign in the <tt>echo Main-Class</tt> instruction because it would +<p><b>Note:</b> Do not have blanks around the >-sign in the <tt>echo Main-Class</tt> instruction because it would falsify it!</p> - -<a name="four-steps"></a> -<h2>Four steps to a running application</h2> +<h2 id="four-steps">Four steps to a running application</h2> <p>After finishing the java-only step we have to think about our build process. We <i>have</i> to compile our code, otherwise we couldn't start the program. Oh - "start" - yes, we could provide a target for that. We <i>should</i> package our application. Now it's only one class - but if you want to provide a download, no one would download several hundreds files ... @@ -138,7 +131,7 @@ ant run ant compile jar run </pre> -<p>While having a look at the buildfile, we will see some similar steps between Ant and the java-only commands: +<p>While having a look at the buildfile, we will see some similar steps between Ant and the Java-only commands:</p> <table> <tr> <th>java-only</th> @@ -182,19 +175,14 @@ java -jar build\jar\HelloWorld.jar <java jar="build/jar/HelloWorld.jar" fork="true"/> </pre></td> </tr></table> -</p> - - -<a name="enhance"></a> -<h2>Enhance the build file</h2> +<h2 id="enhance">Enhance the build file</h2> <p>Now we have a working buildfile we could do some enhancements: many time you are referencing the same directories, main-class and jar-name are hard coded, and while invocation you have to remember the right order of build steps.</p> <p>The first and second point would be addressed with <i>properties</i>, the third with a special property - an attribute of the <project>-tag and the fourth problem can be solved using dependencies.</p> - <pre class="code"> <project name="HelloWorld" basedir="." default="main"> @@ -237,7 +225,6 @@ of the <project>-tag and the fourth problem can be solved using dependenci </project> </pre> - <p>Now it's easier, just do a <tt class="code">ant</tt> and you will get</p> <pre class="output"> Buildfile: build.xml @@ -260,16 +247,15 @@ main: BUILD SUCCESSFUL </pre> - -<a name="ext-libs"></a> -<h2>Using external libraries</h2> +<h2 id="ext-libs">Using external libraries</h2> <p>Somehow told us not to use syso-statements. For log-Statements we should use a Logging-API - customizable on a high -degree (including switching off during usual life (= not development) execution). We use Log4J for that, because <ul> +degree (including switching off during usual life (= not development) execution). We use Log4J for that, because</p> +<ul> <li>it is not part of the JDK (1.4+) and we want to show how to use external libs</li> <li>it can run under JDK 1.2 (as Ant)</li> <li>it's highly configurable</li> <li>it's from Apache ;-)</li> -</ul></p> +</ul> <p>We store our external libraries in a new directory <tt>lib</tt>. Log4J can be <a href="http://www.apache.org/dist/logging/log4j/1.2.13/logging-log4j-1.2.13.zip";>downloaded [1]</a> from Logging's Homepage. Create the <tt>lib</tt> directory and extract the log4j-1.2.9.jar into that lib-directory. After that we have to modify @@ -340,25 +326,24 @@ a jarname <i>and</i> a classpath. So add our class in the red line to the alread [java] 0 [main] INFO oata.HelloWorld - Hello World </pre> -<p>What's that? <ul> +<p>What's that?</p> +<ul> <li><i>[java]</i> Ant task running at the moment</li> <li><i>0</i> <font size="-1">sorry don't know - some Log4J stuff</font></li> <li><i>[main]</i> the running thread from our application </li> -<li><i>INFO</i> log level of that statement</i> -<li><i>oata.HelloWorld</i> source of that statement</i> + <li><i>INFO</i> log level of that statement</li> + <li><i>oata.HelloWorld</i> source of that statement</li> <li><i>-</i> separator</li> <li><i>Hello World</i> the message</li> </ul> -For another layout ... have a look inside Log4J's documentation about using other PatternLayout's.</p> - +<p>For another layout ... have a look inside Log4J's documentation about using other PatternLayout's.</p> -<a name="config-files"> -<h2>Configuration files</h2> +<h2 id="config-files">Configuration files</h2> <p>Why we have used Log4J? "It's highly configurable"? No - all is hard coded! But that is not the debt of Log4J - it's ours. We had coded <tt>BasicConfigurator.configure();</tt> which implies a simple, but hard coded configuration. More comfortable would be using a property file. In the java source delete the BasicConfiguration-line from the main() method -(and the related import-statement). Log4J will search then for a configuration as described in it's manual. Then create -a new file <tt>src/log4j.properties</tt>. That's the default name for Log4J's configuration and using that name would make +(and the related import-statement). Log4J will search then for a configuration as described in it's manual. Then create +a new file <tt>src/log4j.properties</tt>. That's the default name for Log4J's configuration and using that name would make life easier - not only the framework knows what is inside, you too!</p> <pre class="code"> @@ -389,9 +374,7 @@ finished yet. We should deliver the configuration file, too. So we change the bu <p>This copies all resources (as long as they haven't the suffix ".java") to the build directory, so we could start the application from that directory and these files will included into the jar.</p> - -<a name="junit"> -<h2>Testing the class</h2> +<h2 id="junit">Testing the class</h2> <p>In this step we will introduce the usage of the JUnit [3] testframework in combination with Ant. Because Ant has a built-in JUnit 3.8.2 you could start directly using it. Write a test class in <tt>src\HelloWorldTest.java</tt>: </p> @@ -400,14 +383,14 @@ public class HelloWorldTest extends junit.framework.TestCase { public void testNothing() { } - + public void testWillAlwaysFail() { fail("An error message"); } - + }</pre> -<p>Because we dont have real business logic to test, this test class is very small: just show how to start. For +<p>Because we dont have real business logic to test, this test class is very small: just show how to start. For further information see the JUnit documentation [3] and the manual of <a href="Tasks/junit.html">junit</a> task. Now we add a junit instruction to our buildfile:</p> @@ -424,14 +407,14 @@ Now we add a junit instruction to our buildfile:</p> </classpath> </java> </target> - + <b><target name="junit" depends="jar"> <junit printsummary="yes"> <classpath> <path refid="classpath"/> <path refid="application"/> </classpath> - + <batchtest fork="yes"> <fileset dir="${src.dir}" includes="*Test.java"/> </batchtest> @@ -462,7 +445,7 @@ BUILD SUCCESSFUL ... </pre> -<p>We can also produce a report. Something that you (and other) could read after closing the shell .... +<p>We can also produce a report. Something that you (and other) could read after closing the shell .... There are two steps: 1. let <junit> log the information and 2. convert these to something readable (browsable).<p> <pre class="code"> @@ -476,15 +459,15 @@ There are two steps: 1. let <junit> log the information and 2. convert the <path refid="classpath"/> <path refid="application"/> </classpath> - + <b><formatter type="xml"/></b> - + <batchtest fork="yes" <b>todir="${report.dir}"</b>> <fileset dir="${src.dir}" includes="*Test.java"/> </batchtest> </junit> </target> - + <b><target name="junitreport"> <junitreport todir="${report.dir}"> <fileset dir="${report.dir}" includes="TEST-*.xml"/> @@ -495,26 +478,19 @@ There are two steps: 1. let <junit> log the information and 2. convert the <p>Because we would produce a lot of files and these files would be written to the current directory by default, we define a report directory, create it before running the <tt>junit</tt> and redirect the logging to it. The log format -is XML so <tt>junitreport</tt> could parse it. In a second target <tt>junitreport</tt> should create a browsable +is XML so <tt>junitreport</tt> could parse it. In a second target <tt>junitreport</tt> should create a browsable HTML-report for all generated xml-log files in the report directory. Now you can open the ${report.dir}\index.html and see the result (looks something like JavaDoc).<br> Personally I use two different targets for junit and junitreport. Generating the HTML report needs some time and you dont need the HTML report just for testing, e.g. if you are fixing an error or a integration server is doing a job. </p> - - - -<a name="resources"></a> -<h2>Resources</h2> +<h2 id="resources">Resources</h2> <pre> [1] <a href="http://www.apache.org/dist/logging/log4j/1.2.13/logging-log4j-1.2.13.zip";>http://www.apache.org/dist/logging/log4j/1.2.13/logging-log4j-1.2.13.zip</a> [2] <a href="http://logging.apache.org/log4j/docs/manual.html";>http://logging.apache.org/log4j/docs/manual.html</a> [3] <a href="http://www.junit.org/index.htm";>http://www.junit.org/index.htm</a> </pre> - - - </body> </html>
