build.html

This the README for the Eclipse Plug-in distribution of the Jalopy Java Source Code Formatter.

Get and install the needed software as outlined in <a href="build.html#build-prerequisites" title="2.1.&nbsp;Prerequisites">Section&nbsp;2.1, &#8220;Prerequisites&#8221;</a>.
Make sure Ant is set up correctly.
</p></li><li><p>
Get the sources. Either download and unpack the
<a href="./download.html#source" target="_top">Jalopy source distribution</a> which
contains the complete Jalopy sources. Or grab the needed modules directly from the
<a href="http://sourceforge.net/cvs/?group_id=45216" target="_top">CVS</a> tree.</p></li><li><p>
Change to the directory where your Jalopy sources reside. You should find a
directory layout somewhat similar to the following (each directory represents a
module; the minimal needed modules are printed in <span class="emphasis"><em>bold</em></span>):
</p><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="screen">
 ..
   ant/                  The Ant Plug-in
   <span class="bold"><b>build/</b></span>                The Jalopy build system
   console/
   <span class="bold"><b>docu/</b></span>                 All documentation sources
   eclipse/              The Eclipse Plug-in
   jbuilder/             The JBuilder Plug-in
   jdeveloper/           The JDeveloper Plug-in
   jedit/                The jEdit Plug-in
   <span class="bold"><b>main/</b></span>                 The core Jalopy sources
   netbeans/             The NetBeans/Sun ONE Studio Plug-in
</pre></td></tr></table><p>
Change directory into <tt class="filename">/build</tt> where the master build script
lurks.
</p></li><li><p>
Adjust the global build properties to match your installation. The build
system uses quite a few properties to control the build process and
specify additional needed resources. You can find and adjust these properties in the file
<tt class="filename">build.properties</tt>.
</p><p>
Luckily you only have to change some common properties to get things running:
</p><div class="variablelist"><p class="title"><b>Common build properties</b></p><dl><dt><span class="term">DIR.DOCBOOK.XSL</span></dt><dd><p>
Specifies the installation directory of the DocBook XSL Stylesheets package.
Note that you have to specify a protocol, e.g. <tt class="filename">file:///G:/XML/docbook-xsl-1.62.4</tt>.
</p></dd><dt><span class="term">DIR.DOCBOOK.DTD</span></dt><dd><p>
Specifies the path where to find the DocBook XSL DTD.
You have to adjust the default path to match your installation.
</p></dd><dt><span class="term">LIB.PATH.<i class="replaceable"><tt>&lt;modulename&gt;</tt></i></span></dt><dd><p>
Specifies additional library path(s) needed to build a certain module.
You have to adjust the default path(s) to match your installation.
</p></dd><dt><span class="term">PACKAGE.PATH.<i class="replaceable"><tt>&lt;libraryname&gt;</tt></i></span></dt><dd><p>
Specifies the location to a directory containing the package-list file for a
given library. This is optional and only needed by Javadoc to resolve links to
documentation for externally referenced classes. Change the default path(s)
to match your installation.
</p></dd></dl></div></li><li><p>
Once everything is set up, you can start a build using <span><b class="command">ant</b></span> <i class="parameter"><tt>target</tt></i>
where <i class="parameter"><tt>target</tt></i> describes one of the main build targets (those with a
description, use <span><b class="command">ant</b></span> <i class="parameter"><tt>-projecthelp</tt></i> to display
the available targets). Just typing <span><b class="command">ant</b></span> will build the Jalopy
core runtime distribution.
</p></li><li><p>
When a build is done, you can find the created distribution(s) in the
<tt class="filename">tmp~/dist</tt> folder. The build system creates and stores all
intermediate files and subdirectories under the <tt class="filename">tmp~</tt>
directory.
</p></li><li><p>
If you make changes to the source code, just run Ant again; this will perform a
faster <i class="firstterm">incremental</i> rebuild of the target.
</p></li></ol></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="installation.html">Prev</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="part-core.html">Up</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="usage.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter&nbsp;1.&nbsp;Installation&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="manual.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;Chapter&nbsp;3.&nbsp;Usage</td></tr></table></div></td></tr></table></td></tr><tr><td bgcolor="#eeeecc" height="17" style="font-size:9px;padding-left:5px"><a href="#toppage">to top</a></td></tr><tr><td height="30"><br></td></tr><tr><td height="3"></td></tr><tr><td bgcolor="#336699" height="1"></td></tr><tr><td height="1"></td></tr><tr><td bgcolor="#336699" height="16"></td></tr><tr><td bgcolor="#ff9966" height="4"></td></tr><tr><td class="footer" align="center" height="15" valign="middle">
            Copyright &copy; 2001-2004, <a class="footer" href="./contact.html">Marco Hunsicker</a>. All rights reserved. Hosted by <a href="http://sourceforge.net">SourceForge.net</a></td></tr></tbody></table><img src="http://sourceforge.net/sflogo.php?group_id=45216&amp;type=1" width="1" height="1" border="0" hspace="0" vspace="0" alt=""></body></html>