<!--
* Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
- * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle
+ * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
*
* This file is part of Jalview.
*
*
* You should have received a copy of the GNU General Public License along with Jalview. If not, see <http://www.gnu.org/licenses/>.
-->
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+ <html><head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+ <title>Chapter 5. Ant Plug-in task</title><link rel="stylesheet" href="site.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.65.1"><link rel="home" href="manual.html" title="Jalopy User Manual"><link rel="up" href="part-plugins.html" title="Part II. Plug-ins"><link rel="previous" href="part-plugins.html" title="Part II. Plug-ins"><link rel="next" href="plugin-ant-config.html" title="5.2. Configuration"><link rel="preface" href="dedication.html" title="Dedication"><link rel="preface" href="acknowledge.html" title="Acknowledgements"><link rel="preface" href="introduction.html" title="Introduction"><link rel="part" href="part-core.html" title="Part I. Jalopy core"><link rel="chapter" href="installation.html" title="Chapter 1. Installation"><link rel="chapter" href="build.html" title="Chapter 2. Building"><link rel="chapter" href="usage.html" title="Chapter 3. Usage"><link rel="chapter" href="settings.html" title="Chapter 4. Settings"><link rel="part" href="part-plugins.html" title="Part II. Plug-ins"><link rel="chapter" href="plugin-ant.html" title="Chapter 5. Ant Plug-in task"><link rel="chapter" href="plugin-console.html" title="Chapter 6. Console Application"><link rel="chapter" href="plugin-eclipse.html" title="Chapter 7. Eclipse Plug-in"><link rel="chapter" href="plugin-jbuilder.html" title="Chapter 8. JBuilder OpenTool"><link rel="chapter" href="plugin-jdev.html" title="Chapter 9. JDeveloper Extension"><link rel="chapter" href="plugin-jedit.html" title="Chapter 10. jEdit Plug-in"><link rel="chapter" href="plugin-netbeans.html" title="Chapter 11. NetBeans/Sun ONE Studio module"><link rel="appendix" href="dependencies.html" title="Appendix A. Library Dependencies"><link rel="appendix" href="license-bsd.html" title="Appendix B. The Jalopy BSD License"><link rel="appendix" href="license-antlr.html" title="Appendix C. ANTLR SOFTWARE RIGHTS"><link rel="appendix" href="license-apache.html" title="Appendix D. The Apache Software License, Version 1.1"><link rel="appendix" href="license-gnu.html" title="Appendix E. GNU GENERAL PUBLIC LICENSE Version 2, June 1991"><link rel="appendix" href="license-gnu-doc.html" title="Appendix F. GNU Free Documentation License Version 1.1, March 2000"><link rel="appendix" href="license-common-public.html" title="Appendix G. Common Public License Version 1.0"><link rel="appendix" href="license-sun-public.html" title="Appendix H. SUN PUBLIC LICENSE Version 1.0"><link rel="index" href="ix01.html" title="Index"><link rel="section" href="plugin-ant.html#plugin-ant-installation" title="5.1. Installation"><link rel="section" href="plugin-ant-config.html" title="5.2. Configuration"><link rel="section" href="plugin-ant-usage.html" title="5.3. Usage"><link rel="section" href="plugin-ant-license.html" title="5.4. License">
+ <meta name="description" content="Jalopy Java Source Code Formatter Beautifier Pretty Printer">
+ <meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" l gen true for "http://jalopy.sf.net" r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://jalopy.sf.net" r (n 0 s 0 v 0 l 0))'>
+ </head><body id="toppage" bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table width="700" border="0" cellpadding="0" cellspacing="0" align="left"><tbody><tr><td><table cellpadding="0" cellspacing="0" width="100%" style="border:1px solid #336699"><tbody><tr><td height="16"></td></tr><tr><td bgcolor="#3399cc" height="1"></td></tr><tr style="border:none"><td style="border:none"><table border="0" cellspacing="0" cellpadding="0"><tbody><tr><td class="logo">JALOPY</td><td class="sublogo" valign="bottom">Java Source Code Formatter Beautifier Pretty Printer</td></tr></tbody></table></td></tr><tr><td bgcolor="#3399cc" height="1"></td></tr><tr><td height="10"></td></tr><tr><td bgcolor="#ff8000" height="4"></td></tr><tr><td height="20" bgcolor="#336699" style="color:#ffffff;padding-left:10px"><a href="./index.html" class="navlink">Overview</a> •
+ <a href="./download.html" class="navlink">Download</a> •
+ <a href="./docs.html" class="navlink">Documentation</a> •
+ <a href="./plugins.html" class="navlink">Plug-ins</a> •
+ <a href="./links.html" class="navlink">Links</a> •
+ <a href="./contact.html" class="navlink">Contact</a></td></tr><tr><td height="1" bgcolor="#ffffff"></td></tr></tbody></table></td></tr><tr valign="top"><td valign="top" bgcolor="#ffffff"><table border="0" cellpadding="0" cellspacing="0" width="100%"><tbody><tr><td height="20" bgcolor="#faebd7" style="padding-left:15px"><a href="./features.html" class="navlink2">Features</a> |
+ <a href="./history.html" class="navlink2">History</a> |
+ <a href="./manual.html" class="navlink2">Manual</a> |
+ <a href="./faq.html" class="navlink2">FAQ</a> |
+ <a href="./api/index.html" class="navlink2">Javadoc</a></td></tr><tr><td height="20" bgcolor="#ffffff"></td></tr><tr><td bgcolor="#eeeecc" height="17" align="right" style="font-size:10px;padding-right:3px">
+ This page generated: <strong>June 8 2004</strong></td></tr></tbody></table><table border="0" width="100%" cellspacing="0" cellpadding="5"><tr><td><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 5. Ant Plug-in task</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="part-plugins.html">Prev</a> </td><th width="60%" align="center">Part II. Plug-ins</th><td width="20%" align="right"> <a accesskey="n" href="plugin-ant-config.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="plugin-ant"></a>Chapter 5. Ant Plug-in task</h2></div></div><div></div></div><a class="indexterm" name="d0e5516"></a><a class="indexterm" name="d0e5521"></a><p>
+Describes the installation and usage of the Jalopy Ant Plug-in task.
+</p><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="plugin-ant-installation"></a>5.1. Installation</h2></div></div><div></div></div><p>
+Explains the steps involved in getting the Ant task up and running.
+</p><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="plugin-ant-installation-requirements"></a>5.1.1. System requirements</h3></div></div><div></div></div><p>
+The Plug-in requires Ant 1.3 or higher. It has been tested with 1.3 and 1.5 versions of Ant.
+Please feel free to notify of other success stories.
+See <a href="installation.html#installation-requirements" title="1.1. System requirements">Section 1.1, “System requirements”</a> for the basic requirements to
+run Jalopy.
+</p><p>
+To obtain more information about this wonderful build tool, visit the official
+Ant home page at the Apache Jakarta site:
+<a href="http://jakarta.apache.org/ant/" target="_top">http://jakarta.apache.org/ant/</a>
+</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="plugin-ant-installation-installation"></a>5.1.2. Installation</h3></div></div><div></div></div><a class="indexterm" name="d0e5546"></a><p>
+The Plug-in comes either as a single <tt class="filename">.zip</tt> or compressed
+<tt class="filename">.tar</tt> archive. Unzipping either one of these files into a directory
+of your choice (referred to as <i class="replaceable"><tt><INST_DIR></tt></i>)
+will produce three subdirectories <tt class="filename">/bin</tt>, <tt class="filename">/docs</tt>
+and <tt class="filename">/lib</tt>.
+</p><p>
+</p><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="screen">
+..
+ bin/ contains wrapper scripts for different platforms
+ docs/ contains the documentation
+ lib/ contains all necessary libraries
+</pre></td></tr></table><p>
+</p><a class="indexterm" name="d0e5576"></a><a class="indexterm" name="d0e5579"></a><p>
+Before you can use the Jalopy Ant task in your build scripts, you have to add
+it to your system. Maybe the simplest way is to utilize the
+<span><b class="command"><taskdef></b></span> element in your build script as follows:
+</p><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="programlisting">
+<taskdef name="jalopy"
+ classname="de.hunsicker.jalopy.plugin.ant.AntPlugin">
+ <classpath>
+ <fileset dir="<i class="replaceable"><tt><INST_DIR></tt></i>/lib">
+ <include name="*.jar" />
+ </fileset>
+ </classpath>
+</taskdef>
+</pre></td></tr></table><p>
+If you rather want to add the provided libraries to your classpath (either by
+copying the libraries into the <tt class="filename">/lib</tt> folder of your Ant
+installation or setting up the classpath as usual), please be aware that the
+provided parser (<tt class="filename">aelfred-<i class="replaceable"><tt>xxx</tt></i>.jar</tt>)
+is incompatible with Ant 1.4.1 or prior releases. If you happen to use one of
+these outdated versions, the parser library must not be copied into the
+<tt class="filename">/lib</tt> folder (or added to the classpath) otherwise Ant will fail to work!
+</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="part-plugins.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="part-plugins.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="plugin-ant-config.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Part II. Plug-ins </td><td width="20%" align="center"><a accesskey="h" href="manual.html">Home</a></td><td width="40%" align="right" valign="top"> 5.2. Configuration</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 © 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&type=1" width="1" height="1" border="0" hspace="0" vspace="0" alt=""></body></html>
git://source.jalview.org / jalview.git / blobdiff