incubator-easyant-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From hi...@apache.org
Subject svn commit: r1081393 [5/11] - in /incubator/easyant/site/staging: ./ history/ history/trunk/ history/trunk/changelog/ history/trunk/howto/ history/trunk/ref/ history/trunk/ref/anttasks/ history/trunk/ref/anttasks/findclasspath/ history/trunk/ref/buildt...
Date Mon, 14 Mar 2011 14:29:02 GMT
Added: incubator/easyant/site/staging/history/trunk/ref/Directorystructure.html
URL: http://svn.apache.org/viewvc/incubator/easyant/site/staging/history/trunk/ref/Directorystructure.html?rev=1081393&view=auto
==============================================================================
--- incubator/easyant/site/staging/history/trunk/ref/Directorystructure.html (added)
+++ incubator/easyant/site/staging/history/trunk/ref/Directorystructure.html Mon Mar 14 14:29:00 2011
@@ -0,0 +1,135 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<!--
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+-->
+<html>
+<head>
+    <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
+    <script type="text/javascript">var xookiConfig = {level: 1};</script>   
+    
+
+  <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+  <title>Directory structure</title>
+  <meta name="keywords" content="" />
+  <meta name="description" content="" />
+  <link rel="stylesheet" type="text/css" href="../../../style/style.css" media="screen"/>
+  <!-- for tree, see if it would better go in xooki.js -->
+  <link rel="stylesheet" type="text/css" href="../../../style/tree.css" />
+  <script src="../../../js/jquery.pack.js" type="text/javascript"></script>
+  <script src="../../../js/jquery.treeview.js" type="text/javascript"></script>
+  <script type="text/javascript">
+  $(document).ready(function(){$("#treemenu").Treeview({speed: "fast",store: true});});
+  </script>
+
+<script language="javascript" type="text/javascript">xooki = {u: function(url) {return "../../../xooki/"+url;}};</script>
+</head>
+<body>
+<div id="header">
+    <div id="incubatorlogo">
+	<img src="../../../images/apache-incubator-logo.png"/>
+    </div>    
+    <div id="topmenu">
+        <ul>
+            <li><a href="../../../index.html" id="topmenu1" accesskey="1" title="">Home</a></li>
+            <li><a href="../../../contact.html" id="topmenu2" accesskey="2" title="">Get involved</a></li>
+        </ul>
+    </div>
+</div>
+<!-- end #header -->
+<div id="menu">
+    <ul>
+        <li class="first"><a href="../../../index.html" accesskey="1" title="">Home</a></li>
+        <li><a href="../../../download.html" accesskey="1" title="">Download</a></li>
+        <li><a href="http://www.apache.org/licenses/" title="">License</a></li>
+        <li><a href="../../../history/trunk/tutorials.html" title="">Tutorials</a></li>
+        <li><a href="../../../history/trunk/reference.html" title="">References</a></li>
+    </ul>
+</div>
+<!-- end #menu -->
+<div id="content">
+    <div id="sidebar" class="boxed">
+        <h2 class="title">Apache EasyAnt&#153;</h2>
+        <div id="links">
+                <ul id="treemenu" class="treeview"><li id="xooki-index" class="submenu"><a href="../../../index.html" >Home</a><ul class="closed"><li id="xooki-features"><a href="../../../features.html" >Features</a></li><li id="xooki-license"><a href="http://www.apache.org/licenses/" >License</a></li><li id="xooki-faq"><a href="../../../faq.html" >FAQ</a></li></ul></li><li id="xooki-download"><a href="../../../download.html" >Download</a></li><li id="xooki-history" class="submenu">History<ul class="open"><li id="xooki-history/trunk/index" class="submenu"><a href="../../../history/trunk/index.html" >Trunk</a><ul class="open"><li id="xooki-history/trunk/tutorials" class="submenu"><a href="../../../history/trunk/tutorials.html" >Tutorials</a><ul class="closed"><li id="xooki-history/trunk/howto/GettingStarted"><a href="../../../history/trunk/howto/GettingStarted.html" >Getting Started</a></li><li id="xooki-history/trunk/howto/SettingupasimpleEasyAntproject"><a href="../../../hi
 story/trunk/howto/SettingupasimpleEasyAntproject.html" >Setting up a simple EasyAnt Project</a></li><li id="xooki-history/trunk/howto/writePlugins"><a href="../../../history/trunk/howto/writePlugins.html" >Writing plugins</a></li><li id="xooki-history/trunk/howto/skeleton"><a href="../../../history/trunk/howto/skeleton.html" >Working with skeletons of project</a></li><li id="xooki-history/trunk/howto/multimodules"><a href="../../../history/trunk/howto/multimodules.html" >Working with multi-modules</a></li><li id="xooki-history/trunk/howto/BuildConfigurations"><a href="../../../history/trunk/howto/BuildConfigurations.html" >Build configurations</a></li></ul></li><li id="xooki-history/trunk/reference" class="submenu"><a href="../../../history/trunk/reference.html" >Reference</a><ul class="open"><li id="xooki-history/trunk/ref/features"><a href="../../../history/trunk/ref/features.html" >Features</a></li><li id="xooki-history/trunk/ref/Defaultlifecycle"><a href="../../../histor
 y/trunk/ref/Defaultlifecycle.html" >Default lifecycle</a></li><li id="xooki-history/trunk/ref/Directorystructure"><a href="../../../history/trunk/ref/Directorystructure.html" class="current">Directory structure</a></li><li id="xooki-history/trunk/ref/Modulefiles"><a href="../../../history/trunk/ref/Modulefiles.html" >Module files</a></li><li id="xooki-history/trunk/ref/ProjectMancommand"><a href="../../../history/trunk/ref/ProjectMancommand.html" >ProjectMan commands</a></li><li id="xooki-history/trunk/ref/phases"><a href="../../../history/trunk/ref/phases.html" >Understanding phases</a></li><li id="xooki-history/trunk/ref/anttasks" class="submenu"><a href="../../../history/trunk/ref/anttasks.html" >Ant Tasks</a><ul class="closed"><li id="xooki-history/trunk/ref/anttasks/BindTarget"><a href="../../../history/trunk/ref/anttasks/BindTarget.html" >bindtarget</a></li><li id="xooki-history/trunk/ref/anttasks/checkresolver"><a href="../../../history/trunk/ref/anttasks/checkresolve
 r.html" >checkresolver</a></li><li id="xooki-history/trunk/ref/anttasks/CoreVersiontask"><a href="../../../history/trunk/ref/anttasks/CoreVersiontask.html" >core-version</a></li><li id="xooki-history/trunk/ref/anttasks/easyant"><a href="../../../history/trunk/ref/anttasks/easyant.html" >easyant</a></li><li id="xooki-history/trunk/ref/anttasks/findclasspath" class="submenu"><a href="../../../history/trunk/ref/anttasks/findclasspath.html" >findclasspath</a><ul class="closed"><li id="xooki-history/trunk/ref/anttasks/findclasspath/basic-configuration-strategy"><a href="../../../history/trunk/ref/anttasks/findclasspath/basic-configuration-strategy.html" >basic-configuration-strategy</a></li><li id="xooki-history/trunk/ref/anttasks/findclasspath/environment-strategy"><a href="../../../history/trunk/ref/anttasks/findclasspath/environment-strategy.html" >environment-strategy</a></li><li id="xooki-history/trunk/ref/anttasks/findclasspath/project-dependency-strategy"><a href="../../..
 /history/trunk/ref/anttasks/findclasspath/project-dependency-strategy.html" >project-dependency-strategy</a></li></ul></li><li id="xooki-history/trunk/ref/anttasks/Importtask" class="submenu"><a href="../../../history/trunk/ref/anttasks/Importtask.html" >import</a><ul class="closed"><li id="xooki-history/trunk/ref/anttasks/plugintask"><a href="../../../history/trunk/ref/anttasks/plugintask.html" >plugin task</a></li><li id="xooki-history/trunk/ref/anttasks/buildtypetask"><a href="../../../history/trunk/ref/anttasks/buildtypetask.html" >buildtype task</a></li></ul></li><li id="xooki-history/trunk/ref/anttasks/menugenerator"><a href="../../../history/trunk/ref/anttasks/menugenerator.html" >menugenerator</a></li><li id="xooki-history/trunk/ref/anttasks/LoadModuletask"><a href="../../../history/trunk/ref/anttasks/LoadModuletask.html" >loadmodule</a></li><li id="xooki-history/trunk/ref/anttasks/Parametertask"><a href="../../../history/trunk/ref/anttasks/Parametertask.html" >param
 eter</a></li><li id="xooki-history/trunk/ref/anttasks/Pathtask"><a href="../../../history/trunk/ref/anttasks/Pathtask.html" >path</a></li><li id="xooki-history/trunk/ref/anttasks/Property"><a href="../../../history/trunk/ref/anttasks/Property.html" >property</a></li><li id="xooki-history/trunk/ref/anttasks/registerartifact"><a href="../../../history/trunk/ref/anttasks/registerartifact.html" >registerartifact</a></li><li id="xooki-history/trunk/ref/anttasks/SubModuletask"><a href="../../../history/trunk/ref/anttasks/SubModuletask.html" >submodule</a></li></ul></li><li id="xooki-history/trunk/ref/buildtypes/buildtypes"><a href="../../../history/trunk/ref/buildtypes/buildtypes.html" >Build Types</a></li><li id="xooki-history/trunk/ref/plugins/plugins"><a href="../../../history/trunk/ref/plugins/plugins.html" >Plugins</a></li><li id="xooki-history/trunk/ref/EasyAntconfigurationfile"><a href="../../../history/trunk/ref/EasyAntconfigurationfile.html" >EasyAnt configuration file</a
 ></li><li id="xooki-history/trunk/ref/ProjectIvyInstance"><a href="../../../history/trunk/ref/ProjectIvyInstance.html" >Project Ivy Instance</a></li></ul></li><li id="xooki-history/trunk/changelog" class="submenu"><a href="../../../history/trunk/changelog.html" >Changelog</a><ul class="closed"><li id="xooki-history/trunk/changelog/0.7"><a href="../../../history/trunk/changelog/0.7.html" >0.7</a></li></ul></li><li id="xooki-history/trunk/faq"><a href="../../../history/trunk/faq.html" >FAQ</a></li><li id="xooki-history/trunk/contact"><a href="../../../history/trunk/contact.html" >Contact</a></li></ul></li></ul></li><li id="xooki-contact" class="submenu"><a href="../../../contact.html" >Get Involved</a><ul class="closed"><li id="xooki-Mailinglist"><a href="../../../Mailinglist.html" >Mailing list</a></li><li id="xooki-Issuetracking"><a href="../../../Issuetracking.html" >Issue tracking</a></li><li id="xooki-Sourcerepository"><a href="../../../Sourcerepository.html" >Source repo
 sitory</a></li><li id="xooki-irc"><a href="../../../irc.html" >IRC</a></li></ul></li><li id="xooki-Team"><a href="../../../Team.html" >Team</a></li><li id="xooki-foundation" class="submenu"><a href="../../../foundation.html" >Foundation</a><ul class="closed"><li id="xooki-undefined"><a href="http://www.apache.org" >ASF</a></li><li id="xooki-undefined"><a href="http://www.apache.org/foundation/sponsorship.html" >Sponsorship</a></li><li id="xooki-undefined"><a href="http://www.apache.org/foundation/thanks.html" >Thanks</a></li></ul></li></ul>
+        </div>
+    </div>
+
+    <div id="posts">
+        <br class="xooki-br"/><h1>Directory structure</h1>
+EasyAnt cames with a lot of convention, most of them are inspired by maven conventions. <br class="xooki-br"/><br class="xooki-br"/>Those conventions can be configured through properties such as :
+<ul> 
+  <li>src.main.java</li>
+  <li>src.main.resources</li>
+  <li>src.test.java</li>
+  <li>src.test.resources</li>
+  <li>src.main.webapp</li>
+  <li>src.documentation.dir</li>
+</ul>
+
+In this document will try to explain you the directory structure of standard EasyAnt project.<br class="xooki-br"/><br class="xooki-br"/><h2>Standard directory structure</h2>
+<h3>Separating project main code and test code</h3>
+In a ideal world application may have some tests (functionnal / unit test / integration test, etc...).<br class="xooki-br"/>This tests doesn't make sense at all to be shipped during the packaging phase of your application.<br class="xooki-br"/>To avoid this, by default EasyAnt makes a separation between  
+<ul>
+  <li>project code</li>
+  <li>test code</li>
+</ul>
+
+By convention, project code is stored in <i>src/main</i> directory</i>, whereas your test code is in <i>src/test</i> directory.<br class="xooki-br"/><br class="xooki-br"/><h3>Separating source code and resources</h3>
+To clarify the directory structure source files and resources are separated in two directory.<br class="xooki-br"/><br class="xooki-br"/>The directory structure of project source code looks like :
+<ul>
+  <li><i>src/main/java</i> for main source code (note that this can be configured through the property <i>src.main.java</i>)</li>
+  <li><i>src/main/resources</i> for resource files (note that this can be configured through the property <i>src.main.resources</i>)</li>
+</ul>
+
+
+The directory structure of test source code:
+<ul>
+  <li><i>src/test/java</i> for test source code (note that this can be configured through the property <i>src.test.java</i>)</li>
+  <li><i>src/test/resources</i> for test resource files (note that this can be configured through the property <i>src.test.resources</i>)</li>
+</ul>
+
+<div id="note><br class="xooki-br"/>Note: this also apply with non-java project (like groovy / scala project). <br class="xooki-br"/>Groovy project : 
+<ul>
+  <li><i>src/main/groovy</i> for main source code (note that this can be configured through the property <i>src.main.groovy</i>)</li>
+  <li><i>src/test/groovy</i> for test source code (note that this can be configured through the property <i>src.test.groovy</i>)</li>
+</ul>
+
+Scala project : 
+<ul>
+  <li><i>src/main/scala</i> for main source code (note that this can be configured through the property <i>src.main.scala</i>)</li>
+  <li><i>src/test/scala</i> for test source code (note that this can be configured through the property <i>src.test.scala</i>)</li>
+</ul>
+</note>
+
+<h2>WebApp ressources</h2>
+By convention, WebApp ressources are stored in <i>src/main/webapp</i>.<br class="xooki-br"/>This can be adapted through the property <i>src.main.webapp</i> <br class="xooki-br"/><br class="xooki-br"/><h2>Documentation files</h2>
+By convention, documentation files are stored in <i>src/documentation</i>.<br class="xooki-br"/>You can configure it through the property named <i>src.documentation.dir</i>.
+    </div>
+    <!-- end #posts -->
+    <!-- end #links -->
+    <div style="clear: both;">&nbsp;</div>
+</div>
+<!-- end #content -->
+<div id="footer">
+    <p id="legal">
+        <i>Copyright &#169; 2011 The Apache Software Foundation, Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0.txt">Apache License, Version 2.0</a>.</i><br>
+        <i>Apache EasyAnt, Apache Ivy, Apache Ant, Ivy, Ant, Apache, the Apache Ivy logo, the Apache Ant logo and the Apache feather logo are trademarks of The Apache Software Foundation.</i><br>
+        <i>All other marks mentioned may be trademarks or registered trademarks of their respective owners. </i>
+    </p>
+</div>
+<!-- end #footer -->
+</body>
+</html>

Propchange: incubator/easyant/site/staging/history/trunk/ref/Directorystructure.html
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: incubator/easyant/site/staging/history/trunk/ref/Directorystructure.html
------------------------------------------------------------------------------
    svn:keywords = Date Revision Author HeadURL Id

Propchange: incubator/easyant/site/staging/history/trunk/ref/Directorystructure.html
------------------------------------------------------------------------------
    svn:mime-type = text/html

Added: incubator/easyant/site/staging/history/trunk/ref/EasyAntconfigurationfile.html
URL: http://svn.apache.org/viewvc/incubator/easyant/site/staging/history/trunk/ref/EasyAntconfigurationfile.html?rev=1081393&view=auto
==============================================================================
--- incubator/easyant/site/staging/history/trunk/ref/EasyAntconfigurationfile.html (added)
+++ incubator/easyant/site/staging/history/trunk/ref/EasyAntconfigurationfile.html Mon Mar 14 14:29:00 2011
@@ -0,0 +1,242 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<!--
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+-->
+<html>
+<head>
+    <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
+    <script type="text/javascript">var xookiConfig = {level: 1};</script>   
+    
+
+  <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+  <title>EasyAnt configuration file</title>
+  <meta name="keywords" content="" />
+  <meta name="description" content="" />
+  <link rel="stylesheet" type="text/css" href="../../../style/style.css" media="screen"/>
+  <!-- for tree, see if it would better go in xooki.js -->
+  <link rel="stylesheet" type="text/css" href="../../../style/tree.css" />
+  <script src="../../../js/jquery.pack.js" type="text/javascript"></script>
+  <script src="../../../js/jquery.treeview.js" type="text/javascript"></script>
+  <script type="text/javascript">
+  $(document).ready(function(){$("#treemenu").Treeview({speed: "fast",store: true});});
+  </script>
+
+<script language="javascript" type="text/javascript">xooki = {u: function(url) {return "../../../xooki/"+url;}};</script>
+</head>
+<body>
+<div id="header">
+    <div id="incubatorlogo">
+	<img src="../../../images/apache-incubator-logo.png"/>
+    </div>    
+    <div id="topmenu">
+        <ul>
+            <li><a href="../../../index.html" id="topmenu1" accesskey="1" title="">Home</a></li>
+            <li><a href="../../../contact.html" id="topmenu2" accesskey="2" title="">Get involved</a></li>
+        </ul>
+    </div>
+</div>
+<!-- end #header -->
+<div id="menu">
+    <ul>
+        <li class="first"><a href="../../../index.html" accesskey="1" title="">Home</a></li>
+        <li><a href="../../../download.html" accesskey="1" title="">Download</a></li>
+        <li><a href="http://www.apache.org/licenses/" title="">License</a></li>
+        <li><a href="../../../history/trunk/tutorials.html" title="">Tutorials</a></li>
+        <li><a href="../../../history/trunk/reference.html" title="">References</a></li>
+    </ul>
+</div>
+<!-- end #menu -->
+<div id="content">
+    <div id="sidebar" class="boxed">
+        <h2 class="title">Apache EasyAnt&#153;</h2>
+        <div id="links">
+                <ul id="treemenu" class="treeview"><li id="xooki-index" class="submenu"><a href="../../../index.html" >Home</a><ul class="closed"><li id="xooki-features"><a href="../../../features.html" >Features</a></li><li id="xooki-license"><a href="http://www.apache.org/licenses/" >License</a></li><li id="xooki-faq"><a href="../../../faq.html" >FAQ</a></li></ul></li><li id="xooki-download"><a href="../../../download.html" >Download</a></li><li id="xooki-history" class="submenu">History<ul class="open"><li id="xooki-history/trunk/index" class="submenu"><a href="../../../history/trunk/index.html" >Trunk</a><ul class="open"><li id="xooki-history/trunk/tutorials" class="submenu"><a href="../../../history/trunk/tutorials.html" >Tutorials</a><ul class="closed"><li id="xooki-history/trunk/howto/GettingStarted"><a href="../../../history/trunk/howto/GettingStarted.html" >Getting Started</a></li><li id="xooki-history/trunk/howto/SettingupasimpleEasyAntproject"><a href="../../../hi
 story/trunk/howto/SettingupasimpleEasyAntproject.html" >Setting up a simple EasyAnt Project</a></li><li id="xooki-history/trunk/howto/writePlugins"><a href="../../../history/trunk/howto/writePlugins.html" >Writing plugins</a></li><li id="xooki-history/trunk/howto/skeleton"><a href="../../../history/trunk/howto/skeleton.html" >Working with skeletons of project</a></li><li id="xooki-history/trunk/howto/multimodules"><a href="../../../history/trunk/howto/multimodules.html" >Working with multi-modules</a></li><li id="xooki-history/trunk/howto/BuildConfigurations"><a href="../../../history/trunk/howto/BuildConfigurations.html" >Build configurations</a></li></ul></li><li id="xooki-history/trunk/reference" class="submenu"><a href="../../../history/trunk/reference.html" >Reference</a><ul class="open"><li id="xooki-history/trunk/ref/features"><a href="../../../history/trunk/ref/features.html" >Features</a></li><li id="xooki-history/trunk/ref/Defaultlifecycle"><a href="../../../histor
 y/trunk/ref/Defaultlifecycle.html" >Default lifecycle</a></li><li id="xooki-history/trunk/ref/Directorystructure"><a href="../../../history/trunk/ref/Directorystructure.html" >Directory structure</a></li><li id="xooki-history/trunk/ref/Modulefiles"><a href="../../../history/trunk/ref/Modulefiles.html" >Module files</a></li><li id="xooki-history/trunk/ref/ProjectMancommand"><a href="../../../history/trunk/ref/ProjectMancommand.html" >ProjectMan commands</a></li><li id="xooki-history/trunk/ref/phases"><a href="../../../history/trunk/ref/phases.html" >Understanding phases</a></li><li id="xooki-history/trunk/ref/anttasks" class="submenu"><a href="../../../history/trunk/ref/anttasks.html" >Ant Tasks</a><ul class="closed"><li id="xooki-history/trunk/ref/anttasks/BindTarget"><a href="../../../history/trunk/ref/anttasks/BindTarget.html" >bindtarget</a></li><li id="xooki-history/trunk/ref/anttasks/checkresolver"><a href="../../../history/trunk/ref/anttasks/checkresolver.html" >checkr
 esolver</a></li><li id="xooki-history/trunk/ref/anttasks/CoreVersiontask"><a href="../../../history/trunk/ref/anttasks/CoreVersiontask.html" >core-version</a></li><li id="xooki-history/trunk/ref/anttasks/easyant"><a href="../../../history/trunk/ref/anttasks/easyant.html" >easyant</a></li><li id="xooki-history/trunk/ref/anttasks/findclasspath" class="submenu"><a href="../../../history/trunk/ref/anttasks/findclasspath.html" >findclasspath</a><ul class="closed"><li id="xooki-history/trunk/ref/anttasks/findclasspath/basic-configuration-strategy"><a href="../../../history/trunk/ref/anttasks/findclasspath/basic-configuration-strategy.html" >basic-configuration-strategy</a></li><li id="xooki-history/trunk/ref/anttasks/findclasspath/environment-strategy"><a href="../../../history/trunk/ref/anttasks/findclasspath/environment-strategy.html" >environment-strategy</a></li><li id="xooki-history/trunk/ref/anttasks/findclasspath/project-dependency-strategy"><a href="../../../history/trunk/
 ref/anttasks/findclasspath/project-dependency-strategy.html" >project-dependency-strategy</a></li></ul></li><li id="xooki-history/trunk/ref/anttasks/Importtask" class="submenu"><a href="../../../history/trunk/ref/anttasks/Importtask.html" >import</a><ul class="closed"><li id="xooki-history/trunk/ref/anttasks/plugintask"><a href="../../../history/trunk/ref/anttasks/plugintask.html" >plugin task</a></li><li id="xooki-history/trunk/ref/anttasks/buildtypetask"><a href="../../../history/trunk/ref/anttasks/buildtypetask.html" >buildtype task</a></li></ul></li><li id="xooki-history/trunk/ref/anttasks/menugenerator"><a href="../../../history/trunk/ref/anttasks/menugenerator.html" >menugenerator</a></li><li id="xooki-history/trunk/ref/anttasks/LoadModuletask"><a href="../../../history/trunk/ref/anttasks/LoadModuletask.html" >loadmodule</a></li><li id="xooki-history/trunk/ref/anttasks/Parametertask"><a href="../../../history/trunk/ref/anttasks/Parametertask.html" >parameter</a></li><l
 i id="xooki-history/trunk/ref/anttasks/Pathtask"><a href="../../../history/trunk/ref/anttasks/Pathtask.html" >path</a></li><li id="xooki-history/trunk/ref/anttasks/Property"><a href="../../../history/trunk/ref/anttasks/Property.html" >property</a></li><li id="xooki-history/trunk/ref/anttasks/registerartifact"><a href="../../../history/trunk/ref/anttasks/registerartifact.html" >registerartifact</a></li><li id="xooki-history/trunk/ref/anttasks/SubModuletask"><a href="../../../history/trunk/ref/anttasks/SubModuletask.html" >submodule</a></li></ul></li><li id="xooki-history/trunk/ref/buildtypes/buildtypes"><a href="../../../history/trunk/ref/buildtypes/buildtypes.html" >Build Types</a></li><li id="xooki-history/trunk/ref/plugins/plugins"><a href="../../../history/trunk/ref/plugins/plugins.html" >Plugins</a></li><li id="xooki-history/trunk/ref/EasyAntconfigurationfile"><a href="../../../history/trunk/ref/EasyAntconfigurationfile.html" class="current">EasyAnt configuration file</a
 ></li><li id="xooki-history/trunk/ref/ProjectIvyInstance"><a href="../../../history/trunk/ref/ProjectIvyInstance.html" >Project Ivy Instance</a></li></ul></li><li id="xooki-history/trunk/changelog" class="submenu"><a href="../../../history/trunk/changelog.html" >Changelog</a><ul class="closed"><li id="xooki-history/trunk/changelog/0.7"><a href="../../../history/trunk/changelog/0.7.html" >0.7</a></li></ul></li><li id="xooki-history/trunk/faq"><a href="../../../history/trunk/faq.html" >FAQ</a></li><li id="xooki-history/trunk/contact"><a href="../../../history/trunk/contact.html" >Contact</a></li></ul></li></ul></li><li id="xooki-contact" class="submenu"><a href="../../../contact.html" >Get Involved</a><ul class="closed"><li id="xooki-Mailinglist"><a href="../../../Mailinglist.html" >Mailing list</a></li><li id="xooki-Issuetracking"><a href="../../../Issuetracking.html" >Issue tracking</a></li><li id="xooki-Sourcerepository"><a href="../../../Sourcerepository.html" >Source repo
 sitory</a></li><li id="xooki-irc"><a href="../../../irc.html" >IRC</a></li></ul></li><li id="xooki-Team"><a href="../../../Team.html" >Team</a></li><li id="xooki-foundation" class="submenu"><a href="../../../foundation.html" >Foundation</a><ul class="closed"><li id="xooki-undefined"><a href="http://www.apache.org" >ASF</a></li><li id="xooki-undefined"><a href="http://www.apache.org/foundation/sponsorship.html" >Sponsorship</a></li><li id="xooki-undefined"><a href="http://www.apache.org/foundation/thanks.html" >Thanks</a></li></ul></li></ul>
+        </div>
+    </div>
+
+    <div id="posts">
+        <br class="xooki-br"/><h1>EasyAnt configuration file</h1>
+The configuration file named easyant-conf.xml allow you to tune :
+<ul>
+  <li>easyant ivy instance (used to retrieve build types / plugins)</li>
+  <li>system plugins</li>
+  <li>properties</li>
+</ul>
+<pre>
+&lt;easyant-config&gt;<br class="xooki-br"/>        &lt;!-- Configure the easyant ivy instance --&gt;<br class="xooki-br"/>    &lt;ivysettings file="${easyant.home}/ivysettings.xml"/&gt;<br class="xooki-br"/>        &lt;!-- Configure system plugins --&gt;<br class="xooki-br"/>    &lt;system-plugins&gt;<br class="xooki-br"/>        &lt;plugin organisation="org.apache.easyant.plugins" module="skeleton" revision="0.1" as="skeleton"/&gt;<br class="xooki-br"/>        &lt;plugin organisation="org.apache.easyant.plugins" module="ivy-repo-management" revision="0.1" as="repo-management"/&gt;<br class="xooki-br"/>    &lt;/system-plugins&gt;<br class="xooki-br"/>        &lt;!-- Configuring user properties --&gt;<br class="xooki-br"/>        &lt;properties&gt;<br class="xooki-br"/>            &lt;property name="my.property" value="foobar"/&gt;<br class="xooki-br"/>        &lt;/properties&gt;<br class="xooki-br"/>&lt;/easyant-config&gt;
+</pre>
+
+<h2>Configuring easyant ivy instance</h2>
+By default, easyant ivy instance is configured to use a set of repositories based on your file system that are deployed with the easyant distribution. These repositories are supposed to be available online in a future release of easyant, and contain the build modules available to the user.<br class="xooki-br"/><br class="xooki-br"/>Easyant ivy instance is not used to retrieve project dependencies.<br class="xooki-br"/>If you want to configure the project ivy instance you should look at <a href="ref/ProjectIvyInstance.html">this page</a>.<br class="xooki-br"/><br class="xooki-br"/>You can configure / override the easyant ivy instance through the following tag
+<pre>
+&lt;ivysettings file="/path/to/ivysettings.xml"/&gt;
+</pre>
+or
+<pre>
+&lt;ivysettings url="/path/to/ivysettings.xml"/&gt;
+</pre>
+
+
+<table class="sortable" id="anyid">
+  <thead>
+  <tr>
+    <td>attribute name</td>
+    <td class="unsortable">description</td>
+  </tr>
+  </thead>
+  <tbody>
+  <tr>
+    <td>file</td>
+    <td>a file referecing a ivysettings file for easyant ivy instance</td>
+  </tr>
+
+  <tr>
+    <td>url</td>
+    <td>an url referencing a ivysettings file for easyant ivy instance</td>
+  </tr>
+  </tbody>
+</table>
+
+By default easyant ivy instance is configured to use the default ivysettings provided by easyant-core.jar.<br class="xooki-br"/><br class="xooki-br"/><h3>default ivy settings provided by easyant-core.jar</h3>
+You can reference this default ivysettings file through the property <i>easyant.default.ivysettings.url</i>.<br class="xooki-br"/>This file preconfigure :
+<ul>
+  <li>easyant cache in $USER_HOME/.easyant/easyant-cache</li>
+  <li>default repositories:<br class="xooki-br"/>     <ul>
+       <li><i>easyant-core-modules</i> shipped in easyant-core.jar</li>
+       <li><i>easyant-shared-modules</i> pointing to "${user.home}/.easyant/repository/easyant-shared-modules" used to store users plugins/buildtypes</li>
+       <li><i>public-maven</i> used to retrieved plugins/buildtypes dependencies</li>
+       <li><i>easyant-default-chain</i> the default chain containing the 3 previous repositories</li>
+     </ul>
+  </li>
+</ul>
+
+<h3>Using easyant-extra-modules</h3>
+If you want to use easyant-extra-modules.jar (containing additional plugins/buildtypes) you can use the property <i>easyant.extra.ivysettings.url</i>.<br class="xooki-br"/><br class="xooki-br"/><h3>Extending the default configuration</h3>
+In an enterprise context it can make sense to configure a enteprise repository to store easyant plugins/ easyant skeletons etc...<br class="xooki-br"/><br class="xooki-br"/>This can be done writting your own ivysettings including if necessary the default configuration :  
+<pre>
+&lt;ivysettings&gt;<br class="xooki-br"/>        &lt;!-- import the default ivy settings --&gt;<br class="xooki-br"/>    &lt;include url="${easyant.default.ivysettings.url}"/&gt;<br class="xooki-br"/>    &lt;!-- define your own default resolver, here a chain that include a new repo + the default chain provided by easyant --&gt;<br class="xooki-br"/>    &lt;settings defaultResolver="my-chain"/&gt;<br class="xooki-br"/>    &lt;resolvers&gt;<br class="xooki-br"/>        &lt;filesystem name="my-custom-repo"&gt;<br class="xooki-br"/>                &lt;ivy pattern="/path/to/your/repo/[organisation]/[module]/ivy-[revision].xml"/&gt;<br class="xooki-br"/>                &lt;artifact pattern="/path/to/your/repo/[organisation]/[module]/[type]s/[artifact]-[revision].[ext]"/&gt;<br class="xooki-br"/>            &lt;/filesystem&gt;<br class="xooki-br"/><br class="xooki-br"/>        &lt;chain name="my-chain"&gt;<br class="xooki-br"/>            &lt;resolver ref="my-custom-repo" /&gt;<br 
 class="xooki-br"/>            &lt;resolver ref="easyant-default-chain" /&gt;<br class="xooki-br"/>        &lt;/chain&gt;<br class="xooki-br"/>    &lt;/resolvers&gt;<br class="xooki-br"/>&lt;/ivysettings&gt;
+</pre>
+
+<h2>Configuring system plugins</h2>
+A system plugin can provide some additionnal functionnalities that can be used from everywhere.<br class="xooki-br"/>To reference a set of plugins you can use the following syntax :
+<pre>
+&lt;plugin organisation="org.apache.easyant.plugins" module="skeleton" revision="0.1" as="skeleton"/&gt;
+</pre>
+<h3>Plugin attributes</h3>
+<table class="sortable" id="pluginattribute">
+  <thead>
+  <tr>
+    <td>attribute name</td>
+    <td class="unsortable">description</td>
+  </tr>
+  </thead>
+  <tbody>
+  <tr>
+    <td>organisation</td>
+    <td>plugin organisation name</td>
+  </tr>
+  <tr>
+    <td>org</td>
+    <td>shorter form to set plugin organisation name</td>
+  </tr>
+  <tr>
+    <td>module</td>
+    <td>plugin module name</td>
+  </tr>
+
+  <tr>
+    <td>module</td>
+    <td>plugin module name</td>
+  </tr>
+  <tr>
+    <td>revision</td>
+    <td>plugin revision number</td>
+  </tr>
+  <tr>
+    <td>rev</td>
+    <td>shorter form to define plugin revision number</td>
+  </tr>
+  <tr>
+    <td>mrid</td>
+    <td>a module revision id.<br/>This argument can be used to define a plugin using a module revision id (Syntax: [organisation]#[module];[revision])</td>
+  </tr>
+  <tr>
+    <td>as</td>
+    <td>an alias to prefix plugin's targets</td>
+  </tr>
+  <tr>
+    <td>mandatory</td>
+    <td>plugin module name</td>
+  </tr>
+
+  <tr>
+    <td>mode</td>
+    <td>define if we should <i>import</i> or <i>include</i> the plugin</td>
+  </tr>
+  </tbody>
+</table>
+<pre>
+&lt;!-- Using exploded style --&gt;<br class="xooki-br"/>&lt;plugin organisation="org.apache.easyant.plugins" module="skeleton" revision="0.1" as="skeleton"/&gt;<br class="xooki-br"/>&lt;!-- shorter form --&gt;<br class="xooki-br"/>&lt;plugin org="org.apache.easyant.plugins" module="skeleton" rev="0.1" as="skeleton"/&gt;<br class="xooki-br"/>&lt;!-- Using a mrid style --&gt;<br class="xooki-br"/>&lt;plugin mrid="org.apache.easyant.plugins#skeleton;0.1" as="skeleton"/&gt;
+</pre>
+
+<h2>Defining user properties</h2>
+You can also define user properties. Those properties will be available from everywhere when invoking easyant.
+<pre>
+&lt;property name="my.property" value="foobar"/&gt;<br class="xooki-br"/>&lt;property file="/path/to/mycompany.properties"/&gt;<br class="xooki-br"/>&lt;property url="/path/to/mycompany.properties"/&gt;
+</pre>
+<h3>Properties attribute</h3>
+<table class="sortable" id="propertiesAttribute">
+  <thead>
+  <tr>
+    <td>attribute name</td>
+    <td class="unsortable">description</td>
+  </tr>
+  </thead>
+  <tbody>
+  <tr>
+    <td>name</td>
+    <td>a property name</td>
+  </tr>
+  <tr>
+    <td>value</td>
+    <td>a property value</td>
+  </tr>
+  <tr>
+    <td>url</td>
+    <td>an url referencing a property file</td>
+  </tr>
+  <tr>
+    <td>file</td>
+    <td>a property file</td>
+  </tr>
+  </tbody>
+</table>
+    </div>
+    <!-- end #posts -->
+    <!-- end #links -->
+    <div style="clear: both;">&nbsp;</div>
+</div>
+<!-- end #content -->
+<div id="footer">
+    <p id="legal">
+        <i>Copyright &#169; 2011 The Apache Software Foundation, Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0.txt">Apache License, Version 2.0</a>.</i><br>
+        <i>Apache EasyAnt, Apache Ivy, Apache Ant, Ivy, Ant, Apache, the Apache Ivy logo, the Apache Ant logo and the Apache feather logo are trademarks of The Apache Software Foundation.</i><br>
+        <i>All other marks mentioned may be trademarks or registered trademarks of their respective owners. </i>
+    </p>
+</div>
+<!-- end #footer -->
+</body>
+</html>

Propchange: incubator/easyant/site/staging/history/trunk/ref/EasyAntconfigurationfile.html
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: incubator/easyant/site/staging/history/trunk/ref/EasyAntconfigurationfile.html
------------------------------------------------------------------------------
    svn:keywords = Date Revision Author HeadURL Id

Propchange: incubator/easyant/site/staging/history/trunk/ref/EasyAntconfigurationfile.html
------------------------------------------------------------------------------
    svn:mime-type = text/html

Added: incubator/easyant/site/staging/history/trunk/ref/Modulefiles.html
URL: http://svn.apache.org/viewvc/incubator/easyant/site/staging/history/trunk/ref/Modulefiles.html?rev=1081393&view=auto
==============================================================================
--- incubator/easyant/site/staging/history/trunk/ref/Modulefiles.html (added)
+++ incubator/easyant/site/staging/history/trunk/ref/Modulefiles.html Mon Mar 14 14:29:00 2011
@@ -0,0 +1,172 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<!--
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+-->
+<html>
+<head>
+    <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
+    <script type="text/javascript">var xookiConfig = {level: 1};</script>   
+    
+
+  <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+  <title>Module files</title>
+  <meta name="keywords" content="" />
+  <meta name="description" content="" />
+  <link rel="stylesheet" type="text/css" href="../../../style/style.css" media="screen"/>
+  <!-- for tree, see if it would better go in xooki.js -->
+  <link rel="stylesheet" type="text/css" href="../../../style/tree.css" />
+  <script src="../../../js/jquery.pack.js" type="text/javascript"></script>
+  <script src="../../../js/jquery.treeview.js" type="text/javascript"></script>
+  <script type="text/javascript">
+  $(document).ready(function(){$("#treemenu").Treeview({speed: "fast",store: true});});
+  </script>
+
+<script language="javascript" type="text/javascript">xooki = {u: function(url) {return "../../../xooki/"+url;}};</script>
+</head>
+<body>
+<div id="header">
+    <div id="incubatorlogo">
+	<img src="../../../images/apache-incubator-logo.png"/>
+    </div>    
+    <div id="topmenu">
+        <ul>
+            <li><a href="../../../index.html" id="topmenu1" accesskey="1" title="">Home</a></li>
+            <li><a href="../../../contact.html" id="topmenu2" accesskey="2" title="">Get involved</a></li>
+        </ul>
+    </div>
+</div>
+<!-- end #header -->
+<div id="menu">
+    <ul>
+        <li class="first"><a href="../../../index.html" accesskey="1" title="">Home</a></li>
+        <li><a href="../../../download.html" accesskey="1" title="">Download</a></li>
+        <li><a href="http://www.apache.org/licenses/" title="">License</a></li>
+        <li><a href="../../../history/trunk/tutorials.html" title="">Tutorials</a></li>
+        <li><a href="../../../history/trunk/reference.html" title="">References</a></li>
+    </ul>
+</div>
+<!-- end #menu -->
+<div id="content">
+    <div id="sidebar" class="boxed">
+        <h2 class="title">Apache EasyAnt&#153;</h2>
+        <div id="links">
+                <ul id="treemenu" class="treeview"><li id="xooki-index" class="submenu"><a href="../../../index.html" >Home</a><ul class="closed"><li id="xooki-features"><a href="../../../features.html" >Features</a></li><li id="xooki-license"><a href="http://www.apache.org/licenses/" >License</a></li><li id="xooki-faq"><a href="../../../faq.html" >FAQ</a></li></ul></li><li id="xooki-download"><a href="../../../download.html" >Download</a></li><li id="xooki-history" class="submenu">History<ul class="open"><li id="xooki-history/trunk/index" class="submenu"><a href="../../../history/trunk/index.html" >Trunk</a><ul class="open"><li id="xooki-history/trunk/tutorials" class="submenu"><a href="../../../history/trunk/tutorials.html" >Tutorials</a><ul class="closed"><li id="xooki-history/trunk/howto/GettingStarted"><a href="../../../history/trunk/howto/GettingStarted.html" >Getting Started</a></li><li id="xooki-history/trunk/howto/SettingupasimpleEasyAntproject"><a href="../../../hi
 story/trunk/howto/SettingupasimpleEasyAntproject.html" >Setting up a simple EasyAnt Project</a></li><li id="xooki-history/trunk/howto/writePlugins"><a href="../../../history/trunk/howto/writePlugins.html" >Writing plugins</a></li><li id="xooki-history/trunk/howto/skeleton"><a href="../../../history/trunk/howto/skeleton.html" >Working with skeletons of project</a></li><li id="xooki-history/trunk/howto/multimodules"><a href="../../../history/trunk/howto/multimodules.html" >Working with multi-modules</a></li><li id="xooki-history/trunk/howto/BuildConfigurations"><a href="../../../history/trunk/howto/BuildConfigurations.html" >Build configurations</a></li></ul></li><li id="xooki-history/trunk/reference" class="submenu"><a href="../../../history/trunk/reference.html" >Reference</a><ul class="open"><li id="xooki-history/trunk/ref/features"><a href="../../../history/trunk/ref/features.html" >Features</a></li><li id="xooki-history/trunk/ref/Defaultlifecycle"><a href="../../../histor
 y/trunk/ref/Defaultlifecycle.html" >Default lifecycle</a></li><li id="xooki-history/trunk/ref/Directorystructure"><a href="../../../history/trunk/ref/Directorystructure.html" >Directory structure</a></li><li id="xooki-history/trunk/ref/Modulefiles"><a href="../../../history/trunk/ref/Modulefiles.html" class="current">Module files</a></li><li id="xooki-history/trunk/ref/ProjectMancommand"><a href="../../../history/trunk/ref/ProjectMancommand.html" >ProjectMan commands</a></li><li id="xooki-history/trunk/ref/phases"><a href="../../../history/trunk/ref/phases.html" >Understanding phases</a></li><li id="xooki-history/trunk/ref/anttasks" class="submenu"><a href="../../../history/trunk/ref/anttasks.html" >Ant Tasks</a><ul class="closed"><li id="xooki-history/trunk/ref/anttasks/BindTarget"><a href="../../../history/trunk/ref/anttasks/BindTarget.html" >bindtarget</a></li><li id="xooki-history/trunk/ref/anttasks/checkresolver"><a href="../../../history/trunk/ref/anttasks/checkresolve
 r.html" >checkresolver</a></li><li id="xooki-history/trunk/ref/anttasks/CoreVersiontask"><a href="../../../history/trunk/ref/anttasks/CoreVersiontask.html" >core-version</a></li><li id="xooki-history/trunk/ref/anttasks/easyant"><a href="../../../history/trunk/ref/anttasks/easyant.html" >easyant</a></li><li id="xooki-history/trunk/ref/anttasks/findclasspath" class="submenu"><a href="../../../history/trunk/ref/anttasks/findclasspath.html" >findclasspath</a><ul class="closed"><li id="xooki-history/trunk/ref/anttasks/findclasspath/basic-configuration-strategy"><a href="../../../history/trunk/ref/anttasks/findclasspath/basic-configuration-strategy.html" >basic-configuration-strategy</a></li><li id="xooki-history/trunk/ref/anttasks/findclasspath/environment-strategy"><a href="../../../history/trunk/ref/anttasks/findclasspath/environment-strategy.html" >environment-strategy</a></li><li id="xooki-history/trunk/ref/anttasks/findclasspath/project-dependency-strategy"><a href="../../..
 /history/trunk/ref/anttasks/findclasspath/project-dependency-strategy.html" >project-dependency-strategy</a></li></ul></li><li id="xooki-history/trunk/ref/anttasks/Importtask" class="submenu"><a href="../../../history/trunk/ref/anttasks/Importtask.html" >import</a><ul class="closed"><li id="xooki-history/trunk/ref/anttasks/plugintask"><a href="../../../history/trunk/ref/anttasks/plugintask.html" >plugin task</a></li><li id="xooki-history/trunk/ref/anttasks/buildtypetask"><a href="../../../history/trunk/ref/anttasks/buildtypetask.html" >buildtype task</a></li></ul></li><li id="xooki-history/trunk/ref/anttasks/menugenerator"><a href="../../../history/trunk/ref/anttasks/menugenerator.html" >menugenerator</a></li><li id="xooki-history/trunk/ref/anttasks/LoadModuletask"><a href="../../../history/trunk/ref/anttasks/LoadModuletask.html" >loadmodule</a></li><li id="xooki-history/trunk/ref/anttasks/Parametertask"><a href="../../../history/trunk/ref/anttasks/Parametertask.html" >param
 eter</a></li><li id="xooki-history/trunk/ref/anttasks/Pathtask"><a href="../../../history/trunk/ref/anttasks/Pathtask.html" >path</a></li><li id="xooki-history/trunk/ref/anttasks/Property"><a href="../../../history/trunk/ref/anttasks/Property.html" >property</a></li><li id="xooki-history/trunk/ref/anttasks/registerartifact"><a href="../../../history/trunk/ref/anttasks/registerartifact.html" >registerartifact</a></li><li id="xooki-history/trunk/ref/anttasks/SubModuletask"><a href="../../../history/trunk/ref/anttasks/SubModuletask.html" >submodule</a></li></ul></li><li id="xooki-history/trunk/ref/buildtypes/buildtypes"><a href="../../../history/trunk/ref/buildtypes/buildtypes.html" >Build Types</a></li><li id="xooki-history/trunk/ref/plugins/plugins"><a href="../../../history/trunk/ref/plugins/plugins.html" >Plugins</a></li><li id="xooki-history/trunk/ref/EasyAntconfigurationfile"><a href="../../../history/trunk/ref/EasyAntconfigurationfile.html" >EasyAnt configuration file</a
 ></li><li id="xooki-history/trunk/ref/ProjectIvyInstance"><a href="../../../history/trunk/ref/ProjectIvyInstance.html" >Project Ivy Instance</a></li></ul></li><li id="xooki-history/trunk/changelog" class="submenu"><a href="../../../history/trunk/changelog.html" >Changelog</a><ul class="closed"><li id="xooki-history/trunk/changelog/0.7"><a href="../../../history/trunk/changelog/0.7.html" >0.7</a></li></ul></li><li id="xooki-history/trunk/faq"><a href="../../../history/trunk/faq.html" >FAQ</a></li><li id="xooki-history/trunk/contact"><a href="../../../history/trunk/contact.html" >Contact</a></li></ul></li></ul></li><li id="xooki-contact" class="submenu"><a href="../../../contact.html" >Get Involved</a><ul class="closed"><li id="xooki-Mailinglist"><a href="../../../Mailinglist.html" >Mailing list</a></li><li id="xooki-Issuetracking"><a href="../../../Issuetracking.html" >Issue tracking</a></li><li id="xooki-Sourcerepository"><a href="../../../Sourcerepository.html" >Source repo
 sitory</a></li><li id="xooki-irc"><a href="../../../irc.html" >IRC</a></li></ul></li><li id="xooki-Team"><a href="../../../Team.html" >Team</a></li><li id="xooki-foundation" class="submenu"><a href="../../../foundation.html" >Foundation</a><ul class="closed"><li id="xooki-undefined"><a href="http://www.apache.org" >ASF</a></li><li id="xooki-undefined"><a href="http://www.apache.org/foundation/sponsorship.html" >Sponsorship</a></li><li id="xooki-undefined"><a href="http://www.apache.org/foundation/thanks.html" >Thanks</a></li></ul></li></ul>
+        </div>
+    </div>
+
+    <div id="posts">
+        <br class="xooki-br"/><h1>Module files</h1>
+A project using EasyAnt <b>MUST</b> contain a file named module.ivy and an optional file named module.ant.<br class="xooki-br"/><br class="xooki-br"/><h2>The module.ivy file</h2>
+<p />
+This file is the module descriptor of your project. <br class="xooki-br"/>It contains several informations like your company name, the module name, dependencies, and Easyant build information.<br class="xooki-br"/><br class="xooki-br"/><h3>A short example</h3>
+<pre>
+&lt;ivy-module version="2.0" xmlns:ea="<a href="http://www.easyant.org">http://www.easyant.org</a>"&gt; <br class="xooki-br"/>  &lt;info organisation="org.mycompany" module="myJavaApp" status="integration" &gt;<br class="xooki-br"/>    &lt;ea:build organisation="org.apache.easyant.buildtypes" module="build-std-java" revision="0.2"/&gt;<br class="xooki-br"/>  &lt;/info&gt;<br class="xooki-br"/>  &lt;configurations&gt;<br class="xooki-br"/>    &lt;conf name="default" visibility="public" description="runtime dependencies and master artifact can be used with this conf"/&gt;<br class="xooki-br"/>    &lt;conf name="test" visibility="private" description="this scope indicates<br class="xooki-br"/> that the dependency is not required for normal use of the application, and is <br class="xooki-br"/>only available for the test compilation and execution phases."/&gt;<br class="xooki-br"/>  &lt;/configurations&gt;<br class="xooki-br"/>&lt;/ivy-module&gt;
+</pre>
+In this module descriptor, we have an application named myJavaApp created by org.mycompany.<br class="xooki-br"/>To use easyant you must declare the easyant namespace 
+<pre>
+xmlns:ea="<a href="http://www.easyant.org">http://www.easyant.org</a>"
+</pre>
+Pay attention to the <b>ea:build</b> tag.<br class="xooki-br"/>This tags define which build-type is used for your project. In this example we use <b>build-std-java</b> which provides all the targets necessary to compile / package a standard java application.
+<div id="note">Note: The organisation argument in <b>ea:build</b> tag is optionnal. If not specified easyant will use the default one (org.apache.easyant.buildtypes).</div>
+
+Running easyant with this example will run the default target (package).<br class="xooki-br"/>A few seconds later, you will have the generated jar in your_project/target/artifacts/myJavaApp.jar.<br class="xooki-br"/><br class="xooki-br"/><h3>Changing build-system properties</h3>
+So now we want to change several things on this build system.<br class="xooki-br"/>For example, we want to have the generated jar in "dist" directory instead of "targets/artifacts".<br class="xooki-br"/>We will add additional informations inside <easyant> tag.
+<pre>
+&lt;ea:build organisation="org.apache.easyant.buildtypes" module="build-std-java" revision="0.2"/&gt;<br class="xooki-br"/> &lt;ea:property name="target.artifacts" value="dist"/&gt;<br class="xooki-br"/>&lt;/ea:build&gt;
+</pre>
+Running "easyant" will generate the output jar in "dist" directory.<br class="xooki-br"/><br class="xooki-br"/><h3>Adding dependencies</h3>
+Dependencies are defined in the module.ivy files.<br class="xooki-br"/>There is a section dedicated to <b>dependencies</b><br class="xooki-br"/>Let's consider that our project needs an artifact named foo provided by acme in revision 2.0<br class="xooki-br"/>The dependencies section will look like this :
+<pre>
+&lt;dependencies&gt;<br class="xooki-br"/>&lt;dependency org="acme" name="foo" rev="2.0" conf="default"/&gt;<br class="xooki-br"/>&lt;/dependencies&gt;
+</pre>
+If you want to have more informations on dependencies please refer to the <a href="http://ant.apache.org/ivy/history/latest-milestone/ivyfile/dependency.html">official ivy documentation</a><br class="xooki-br"/><br class="xooki-br"/><h3>Using additional plugins</h3>
+In some cases, we want to use several features that are not included in the default build-type provided by easyant.<br class="xooki-br"/>If your project needs to use a specific plugin, you can use the <b>ea:plugin</b> tag inside <b>ea:build</b> tag.<br class="xooki-br"/>Example: <br class="xooki-br"/>Suppose we want to use code coverage feature.
+<pre>
+&lt;ea:build organisation="org.apache.easyant.buildtypes" module="build-std-java" revision="0.2"/&gt;<br class="xooki-br"/> &lt;ea:property name="target.artifacts" value="dist"/&gt;<br class="xooki-br"/> &lt;ea:plugin org="org.apache.easyant.plugins" module="emma" revision="0.1"/&gt;<br class="xooki-br"/>&lt;/ea:build&gt;
+</pre>
+Calling to "easyant -p" we should see the emma public target :
+<pre>
+org.apache.easyant.plugins#emma.:emma     generate emma covera report
+</pre>
+As you can see the target is prefixed by the project name.<br class="xooki-br"/>Most of the time the project name is quite long so easyant allows you to define an alias for the project names. This alias can be used in place of the complete project name. You can define an alias for a plugin using <b>as</b> argument as below.
+<pre>
+&lt;ea:build organisation="org.apache.easyant.buildtypes" module="build-std-java" revision="0.2"/&gt;<br class="xooki-br"/> &lt;ea:property name="target.artifacts" value="dist"/&gt;<br class="xooki-br"/> &lt;ea:plugin org="org.apache.easyant.plugins" module="emma" revision="0.1" as="emma"/&gt;<br class="xooki-br"/>&lt;/ea:build&gt;
+</pre>
+Calling to "easyant -p" we should see the emma public target :
+<pre>
+emma.:emma generate emma covera report
+</pre>
+<div id="note">Note: The organisation argument in <b>ea:plugin</b> tag is optionnal. If not specified easyant will use the default one (org.apache.easyant.plugins).</div>
+
+<h2>The Optional module.ant file</h2>
+<p />
+Easyant also provides you a hook for injecting custom build logic into your build process. This could include any kind of custom manipulation for using easyant locally.<br class="xooki-br"/><p />
+The module.ant file is a conventional ant script. You can retain any convenient build logic from your legacy scripts in module.ant. All targets defined in this file are available for invocation using easyant through command terminal.<br class="xooki-br"/><p />
+<u>Example:</u>
+Consider the following module.ivy file:<br class="xooki-br"/><p />
+<pre>
+&lt;ivy-module version="2.0"&gt; <br class="xooki-br"/>    &lt;info organisation="org.apache.easyant" module="standard-java-app" status="integration" &gt;<br class="xooki-br"/>                &lt;ea:build organisation="org.apache.easyant.buildtypes" module="build-std-java" revision="0.2"&gt;<br class="xooki-br"/>                        &lt;ea:plugin organisation="org.apache.easyant.plugins" module="checkstyle" revision="0.1"/&gt;<br class="xooki-br"/>                &lt;/ea:build&gt; <br class="xooki-br"/>        &lt;/info&gt;<br class="xooki-br"/>    &lt;configurations&gt;<br class="xooki-br"/>        &lt;conf name="default" visibility="public" description="runtime dependencies and master artifact"/&gt;<br class="xooki-br"/>        &lt;conf name="test" visibility="private" description="this scope indicates this is only available for the test compilation and execution phases."/&gt;<br class="xooki-br"/>    &lt;/configurations&gt;<br class="xooki-br"/>    &lt;dependencies&gt;
 <br class="xooki-br"/>        &lt;dependency org="hsqldb" name="hsqldb" rev="1.8.0.7" conf="default-&gt;default"/&gt;<br class="xooki-br"/>        &lt;dependency org="junit" name="junit" rev="4.4" conf="test-&gt;default" /&gt;<br class="xooki-br"/>    &lt;/dependencies&gt;<br class="xooki-br"/>&lt;/ivy-module&gt;<br class="xooki-br"/>
+</pre>
+The above code snippet is a declaration of a easyant project that uses the standard-java-app build type. The same functionality can be achieved by the following module.ant file in your project root directory:<br class="xooki-br"/>
+<pre>
+&lt;project name="org.apache.easyant.buildtypes#standard-java-app"<br class="xooki-br"/>    xmlns:ea="antlib:org.apache.easyant"&gt;<br class="xooki-br"/>    &lt;ea:build organisation="org.apache.easyant.buildtypes" module="build-std-java" revision="0.2"/&gt;<br class="xooki-br"/>        &lt;ea:plugin organisation="org.apache.easyant.plugins" module="checkstyle" revision="0.1"/&gt;<br class="xooki-br"/>&lt;/project&gt;              
+</pre>
+<div id="note">Note: organisation are optionnal in <b>ea:build</b> / <b>ea:plugin</b>. If no organisation is set easyant will use the default one.
+<ul>
+  <li><i>org.apache.easyant.buildtypes</i> for buildtypes</li>
+  <li><i>org.apache.easyant.plugins</i> for plugins</li>
+</ul>
+</div>
+
+Similarly, you can provide additional functionalities using the module.ant incase, you dont find smaller things missing in your build types or plugins. For larger customizations, you may consider writing new plugins.<br class="xooki-br"/><br class="xooki-br"/><h2>Mixing module.ivy and module.ant</h2>
+EasyAnt offer the possibility to mix both files.<br class="xooki-br"/>This make sense if we need to use buildtypes/plugins and additional targets specific to your project.<br class="xooki-br"/><br class="xooki-br"/>Let's try to add a target name hello world in the project.<br class="xooki-br"/>The module ivy looks like this : 
+<pre>
+&lt;ivy-module version="2.0"&gt; <br class="xooki-br"/>    &lt;info organisation="org.apache.easyant" module="standard-java-app" status="integration" &gt;<br class="xooki-br"/>                &lt;ea:build organisation="org.apache.easyant.buildtypes" module="build-std-java" revision="0.2"/&gt;<br class="xooki-br"/>        &lt;/info&gt;<br class="xooki-br"/>    &lt;configurations&gt;<br class="xooki-br"/>        &lt;conf name="default" visibility="public" description="runtime dependencies and master artifact"/&gt;<br class="xooki-br"/>        &lt;conf name="test" visibility="private" description="this scope indicates this is only available for the test compilation and execution phases."/&gt;<br class="xooki-br"/>    &lt;/configurations&gt;<br class="xooki-br"/>    &lt;dependencies/&gt;<br class="xooki-br"/>&lt;/ivy-module&gt;
+</pre>
+
+Here we're able to run any phase/target provided by the <b>build-std-java</b> build type.<br class="xooki-br"/><br class="xooki-br"/>Now we will add our helloWorld target in module.ant
+<pre>
+&lt;project name="org.apache.easyant.buildtypes#standard-java-app"<br class="xooki-br"/>    xmlns:ea="antlib:org.apache.easyant"&gt;<br class="xooki-br"/>    &lt;target name="helloWorld" description="display a helloWorld message"&gt;<br class="xooki-br"/>        &lt;echo message="Hello World!"/&gt;<br class="xooki-br"/>    &lt;/target&gt;<br class="xooki-br"/>&lt;/project&gt;
+</pre>
+
+Running a easyant -p should display our new target helloWorld. This target should be available if we launch easyant helloWorld.<br class="xooki-br"/><br class="xooki-br"/>Considering that all the phases provided <b>build-std-java</b> are loaded before the module.ant, you can attach your custom target to any phase.<br class="xooki-br"/>This complete the basic needs.<br class="xooki-br"/><br class="xooki-br"/><h2>Going further : overriding target / phases</h2>
+Let's consider the use case were you want to adapt a specific target or phase to your need.<br class="xooki-br"/>We need to keep in mind that ant-based system works with a useFirst mechanism.<br class="xooki-br"/>Which means :
+<ul>
+  <li>properties are set only first time we use it</li>
+  <li>target / phase are set first time we use it</li>
+</ul>
+
+But the choregraphy is to load :<br class="xooki-br"/>  * the module.ivy<br class="xooki-br"/>  * the module.ant<br class="xooki-br"/><br class="xooki-br"/>This means that you're not able to override target/phases in the module.ant.<br class="xooki-br"/>Fortunately EasyAnt provides a way to do it.<br class="xooki-br"/>The real choregraphy is to load :<br class="xooki-br"/>  * the override.module.ant<br class="xooki-br"/>  * the module.ivy<br class="xooki-br"/>  * the module.ant<br class="xooki-br"/><br class="xooki-br"/>The <b>override.module.ant</b> is a true ant script loaded before the module.ivy. It's the right place if you want to override target/phases provided by things defined later in module.ivy.<br class="xooki-br"/><br class="xooki-br"/>For example suppose we want to introduce a new phase named my-phase run before the default package phase. 
+<pre>
+&lt;project name="org.apache.easyant.buildtypes#standard-java-app"<br class="xooki-br"/>    xmlns:ea="antlib:org.apache.easyant"&gt;<br class="xooki-br"/>        &lt;!-- Define a new phase --&gt;<br class="xooki-br"/>        &lt;phase name="my-phase" description="foobar"/&gt;<br class="xooki-br"/>        &lt;!-- Override the package phase that depends on my-phase and the default package phase --&gt;<br class="xooki-br"/>        &lt;phase name="package" depends="my-phase, org.apache.easyant.plugins#phases-std.package" description="package the application"/&gt;<br class="xooki-br"/>&lt;/project&gt;
+</pre>
+
+    </div>
+    <!-- end #posts -->
+    <!-- end #links -->
+    <div style="clear: both;">&nbsp;</div>
+</div>
+<!-- end #content -->
+<div id="footer">
+    <p id="legal">
+        <i>Copyright &#169; 2011 The Apache Software Foundation, Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0.txt">Apache License, Version 2.0</a>.</i><br>
+        <i>Apache EasyAnt, Apache Ivy, Apache Ant, Ivy, Ant, Apache, the Apache Ivy logo, the Apache Ant logo and the Apache feather logo are trademarks of The Apache Software Foundation.</i><br>
+        <i>All other marks mentioned may be trademarks or registered trademarks of their respective owners. </i>
+    </p>
+</div>
+<!-- end #footer -->
+</body>
+</html>

Propchange: incubator/easyant/site/staging/history/trunk/ref/Modulefiles.html
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: incubator/easyant/site/staging/history/trunk/ref/Modulefiles.html
------------------------------------------------------------------------------
    svn:keywords = Date Revision Author HeadURL Id

Propchange: incubator/easyant/site/staging/history/trunk/ref/Modulefiles.html
------------------------------------------------------------------------------
    svn:mime-type = text/html

Added: incubator/easyant/site/staging/history/trunk/ref/ProjectIvyInstance.html
URL: http://svn.apache.org/viewvc/incubator/easyant/site/staging/history/trunk/ref/ProjectIvyInstance.html?rev=1081393&view=auto
==============================================================================
--- incubator/easyant/site/staging/history/trunk/ref/ProjectIvyInstance.html (added)
+++ incubator/easyant/site/staging/history/trunk/ref/ProjectIvyInstance.html Mon Mar 14 14:29:00 2011
@@ -0,0 +1,114 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<!--
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+-->
+<html>
+<head>
+    <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
+    <script type="text/javascript">var xookiConfig = {level: 1};</script>   
+    
+
+  <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+  <title>Project Ivy Instance</title>
+  <meta name="keywords" content="" />
+  <meta name="description" content="" />
+  <link rel="stylesheet" type="text/css" href="../../../style/style.css" media="screen"/>
+  <!-- for tree, see if it would better go in xooki.js -->
+  <link rel="stylesheet" type="text/css" href="../../../style/tree.css" />
+  <script src="../../../js/jquery.pack.js" type="text/javascript"></script>
+  <script src="../../../js/jquery.treeview.js" type="text/javascript"></script>
+  <script type="text/javascript">
+  $(document).ready(function(){$("#treemenu").Treeview({speed: "fast",store: true});});
+  </script>
+
+<script language="javascript" type="text/javascript">xooki = {u: function(url) {return "../../../xooki/"+url;}};</script>
+</head>
+<body>
+<div id="header">
+    <div id="incubatorlogo">
+	<img src="../../../images/apache-incubator-logo.png"/>
+    </div>    
+    <div id="topmenu">
+        <ul>
+            <li><a href="../../../index.html" id="topmenu1" accesskey="1" title="">Home</a></li>
+            <li><a href="../../../contact.html" id="topmenu2" accesskey="2" title="">Get involved</a></li>
+        </ul>
+    </div>
+</div>
+<!-- end #header -->
+<div id="menu">
+    <ul>
+        <li class="first"><a href="../../../index.html" accesskey="1" title="">Home</a></li>
+        <li><a href="../../../download.html" accesskey="1" title="">Download</a></li>
+        <li><a href="http://www.apache.org/licenses/" title="">License</a></li>
+        <li><a href="../../../history/trunk/tutorials.html" title="">Tutorials</a></li>
+        <li><a href="../../../history/trunk/reference.html" title="">References</a></li>
+    </ul>
+</div>
+<!-- end #menu -->
+<div id="content">
+    <div id="sidebar" class="boxed">
+        <h2 class="title">Apache EasyAnt&#153;</h2>
+        <div id="links">
+                <ul id="treemenu" class="treeview"><li id="xooki-index" class="submenu"><a href="../../../index.html" >Home</a><ul class="closed"><li id="xooki-features"><a href="../../../features.html" >Features</a></li><li id="xooki-license"><a href="http://www.apache.org/licenses/" >License</a></li><li id="xooki-faq"><a href="../../../faq.html" >FAQ</a></li></ul></li><li id="xooki-download"><a href="../../../download.html" >Download</a></li><li id="xooki-history" class="submenu">History<ul class="open"><li id="xooki-history/trunk/index" class="submenu"><a href="../../../history/trunk/index.html" >Trunk</a><ul class="open"><li id="xooki-history/trunk/tutorials" class="submenu"><a href="../../../history/trunk/tutorials.html" >Tutorials</a><ul class="closed"><li id="xooki-history/trunk/howto/GettingStarted"><a href="../../../history/trunk/howto/GettingStarted.html" >Getting Started</a></li><li id="xooki-history/trunk/howto/SettingupasimpleEasyAntproject"><a href="../../../hi
 story/trunk/howto/SettingupasimpleEasyAntproject.html" >Setting up a simple EasyAnt Project</a></li><li id="xooki-history/trunk/howto/writePlugins"><a href="../../../history/trunk/howto/writePlugins.html" >Writing plugins</a></li><li id="xooki-history/trunk/howto/skeleton"><a href="../../../history/trunk/howto/skeleton.html" >Working with skeletons of project</a></li><li id="xooki-history/trunk/howto/multimodules"><a href="../../../history/trunk/howto/multimodules.html" >Working with multi-modules</a></li><li id="xooki-history/trunk/howto/BuildConfigurations"><a href="../../../history/trunk/howto/BuildConfigurations.html" >Build configurations</a></li></ul></li><li id="xooki-history/trunk/reference" class="submenu"><a href="../../../history/trunk/reference.html" >Reference</a><ul class="open"><li id="xooki-history/trunk/ref/features"><a href="../../../history/trunk/ref/features.html" >Features</a></li><li id="xooki-history/trunk/ref/Defaultlifecycle"><a href="../../../histor
 y/trunk/ref/Defaultlifecycle.html" >Default lifecycle</a></li><li id="xooki-history/trunk/ref/Directorystructure"><a href="../../../history/trunk/ref/Directorystructure.html" >Directory structure</a></li><li id="xooki-history/trunk/ref/Modulefiles"><a href="../../../history/trunk/ref/Modulefiles.html" >Module files</a></li><li id="xooki-history/trunk/ref/ProjectMancommand"><a href="../../../history/trunk/ref/ProjectMancommand.html" >ProjectMan commands</a></li><li id="xooki-history/trunk/ref/phases"><a href="../../../history/trunk/ref/phases.html" >Understanding phases</a></li><li id="xooki-history/trunk/ref/anttasks" class="submenu"><a href="../../../history/trunk/ref/anttasks.html" >Ant Tasks</a><ul class="closed"><li id="xooki-history/trunk/ref/anttasks/BindTarget"><a href="../../../history/trunk/ref/anttasks/BindTarget.html" >bindtarget</a></li><li id="xooki-history/trunk/ref/anttasks/checkresolver"><a href="../../../history/trunk/ref/anttasks/checkresolver.html" >checkr
 esolver</a></li><li id="xooki-history/trunk/ref/anttasks/CoreVersiontask"><a href="../../../history/trunk/ref/anttasks/CoreVersiontask.html" >core-version</a></li><li id="xooki-history/trunk/ref/anttasks/easyant"><a href="../../../history/trunk/ref/anttasks/easyant.html" >easyant</a></li><li id="xooki-history/trunk/ref/anttasks/findclasspath" class="submenu"><a href="../../../history/trunk/ref/anttasks/findclasspath.html" >findclasspath</a><ul class="closed"><li id="xooki-history/trunk/ref/anttasks/findclasspath/basic-configuration-strategy"><a href="../../../history/trunk/ref/anttasks/findclasspath/basic-configuration-strategy.html" >basic-configuration-strategy</a></li><li id="xooki-history/trunk/ref/anttasks/findclasspath/environment-strategy"><a href="../../../history/trunk/ref/anttasks/findclasspath/environment-strategy.html" >environment-strategy</a></li><li id="xooki-history/trunk/ref/anttasks/findclasspath/project-dependency-strategy"><a href="../../../history/trunk/
 ref/anttasks/findclasspath/project-dependency-strategy.html" >project-dependency-strategy</a></li></ul></li><li id="xooki-history/trunk/ref/anttasks/Importtask" class="submenu"><a href="../../../history/trunk/ref/anttasks/Importtask.html" >import</a><ul class="closed"><li id="xooki-history/trunk/ref/anttasks/plugintask"><a href="../../../history/trunk/ref/anttasks/plugintask.html" >plugin task</a></li><li id="xooki-history/trunk/ref/anttasks/buildtypetask"><a href="../../../history/trunk/ref/anttasks/buildtypetask.html" >buildtype task</a></li></ul></li><li id="xooki-history/trunk/ref/anttasks/menugenerator"><a href="../../../history/trunk/ref/anttasks/menugenerator.html" >menugenerator</a></li><li id="xooki-history/trunk/ref/anttasks/LoadModuletask"><a href="../../../history/trunk/ref/anttasks/LoadModuletask.html" >loadmodule</a></li><li id="xooki-history/trunk/ref/anttasks/Parametertask"><a href="../../../history/trunk/ref/anttasks/Parametertask.html" >parameter</a></li><l
 i id="xooki-history/trunk/ref/anttasks/Pathtask"><a href="../../../history/trunk/ref/anttasks/Pathtask.html" >path</a></li><li id="xooki-history/trunk/ref/anttasks/Property"><a href="../../../history/trunk/ref/anttasks/Property.html" >property</a></li><li id="xooki-history/trunk/ref/anttasks/registerartifact"><a href="../../../history/trunk/ref/anttasks/registerartifact.html" >registerartifact</a></li><li id="xooki-history/trunk/ref/anttasks/SubModuletask"><a href="../../../history/trunk/ref/anttasks/SubModuletask.html" >submodule</a></li></ul></li><li id="xooki-history/trunk/ref/buildtypes/buildtypes"><a href="../../../history/trunk/ref/buildtypes/buildtypes.html" >Build Types</a></li><li id="xooki-history/trunk/ref/plugins/plugins"><a href="../../../history/trunk/ref/plugins/plugins.html" >Plugins</a></li><li id="xooki-history/trunk/ref/EasyAntconfigurationfile"><a href="../../../history/trunk/ref/EasyAntconfigurationfile.html" >EasyAnt configuration file</a></li><li id="x
 ooki-history/trunk/ref/ProjectIvyInstance"><a href="../../../history/trunk/ref/ProjectIvyInstance.html" class="current">Project Ivy Instance</a></li></ul></li><li id="xooki-history/trunk/changelog" class="submenu"><a href="../../../history/trunk/changelog.html" >Changelog</a><ul class="closed"><li id="xooki-history/trunk/changelog/0.7"><a href="../../../history/trunk/changelog/0.7.html" >0.7</a></li></ul></li><li id="xooki-history/trunk/faq"><a href="../../../history/trunk/faq.html" >FAQ</a></li><li id="xooki-history/trunk/contact"><a href="../../../history/trunk/contact.html" >Contact</a></li></ul></li></ul></li><li id="xooki-contact" class="submenu"><a href="../../../contact.html" >Get Involved</a><ul class="closed"><li id="xooki-Mailinglist"><a href="../../../Mailinglist.html" >Mailing list</a></li><li id="xooki-Issuetracking"><a href="../../../Issuetracking.html" >Issue tracking</a></li><li id="xooki-Sourcerepository"><a href="../../../Sourcerepository.html" >Source repo
 sitory</a></li><li id="xooki-irc"><a href="../../../irc.html" >IRC</a></li></ul></li><li id="xooki-Team"><a href="../../../Team.html" >Team</a></li><li id="xooki-foundation" class="submenu"><a href="../../../foundation.html" >Foundation</a><ul class="closed"><li id="xooki-undefined"><a href="http://www.apache.org" >ASF</a></li><li id="xooki-undefined"><a href="http://www.apache.org/foundation/sponsorship.html" >Sponsorship</a></li><li id="xooki-undefined"><a href="http://www.apache.org/foundation/thanks.html" >Thanks</a></li></ul></li></ul>
+        </div>
+    </div>
+
+    <div id="posts">
+        <br class="xooki-br"/><h1>Project Ivy Instance</h2>
+The project ivy instance is in charge to configure the ivy instance used by your project (configure the repositories used to retrieve your projects dependencies for example).<br class="xooki-br"/><br class="xooki-br"/>In order to work as you want, EasyAnt sometimes need some settings. Actually, EasyAnt can work with no specific settings at all, see the default settings documentation for details about that. But ivy is able to work in very different contexts. You just have to configure it properly.<br class="xooki-br"/><br class="xooki-br"/>Settings are specified through an xml file, usually called ivysettings.xml. <br class="xooki-br"/>Here is an example of settings file :
+<pre>
+&lt;ivysettings&gt;<br class="xooki-br"/>        &lt;properties file="${ivy.settings.dir}/ivysettings-file.properties" /&gt;<br class="xooki-br"/>        &lt;settings defaultCache="${cache.dir}" defaultResolver="ibiblio" checkUpToDate="false" /&gt;<br class="xooki-br"/>        &lt;resolvers&gt;<br class="xooki-br"/>                &lt;ibiblio name="ibiblio" /&gt;<br class="xooki-br"/>                &lt;filesystem name="internal"&gt;<br class="xooki-br"/>                        &lt;ivy pattern="${repository.dir}/[module]/ivy-[revision].xml" /&gt;<br class="xooki-br"/>                        &lt;artifact pattern="${repository.dir}/[module]/[artifact]-[revision].[ext]" /&gt;<br class="xooki-br"/>                &lt;/filesystem&gt;<br class="xooki-br"/>        &lt;/resolvers&gt;<br class="xooki-br"/>        &lt;modules&gt;<br class="xooki-br"/>                &lt;module organisation="jayasoft" name=".*" resolver="internal" /&gt;<br class="xooki-br"/>        &lt;/modules&gt;<br 
 class="xooki-br"/>&lt;/ivysettings&gt;
+</pre>
+
+Mainly, the settings enable to configure the default cache directory used by ivy and the dependency resolvers that it will use to resolve dependencies.<br class="xooki-br"/><i>Note: To work, this settings file needs a property file named ivysettings-file.properties in the same directory as the settings file, with ivy variables you want in it.</i><br class="xooki-br"/>If you want to have more details on this settings file we strongly recommend you to read the <a href="http://ant.apache.org/ivy/history/2.1.0-rc1/settings.html">reference documentation of settings file</a><br class="xooki-br"/><br class="xooki-br"/><h2>How to configure a custom project ivy settings ?</h2>
+If you just need to add a resolver for your current project you just need to put a "valid" ivysettings.xml file a the root level of your project.<br class="xooki-br"/><br class="xooki-br"/>If this doesn't feel your need because you need to factorise this configuration somewhere you can still configure the location of this file through proeprties:<br class="xooki-br"/>Example:<br class="xooki-br"/>a property pointing to a file:
+<pre>
+   &lt;ea:property name="project.ivy.settings.file" value="/path/to/ivysetings.xml"/&gt;
+</pre>
+or a property pointing to an URL:
+<pre>
+  &lt;ea:property name="project.ivy.settings.url" value="<a href="http://url/to/ivysetings.xml">http://url/to/ivysetings.xml</a>"/&gt;
+</pre>
+
+If no one is specified, easyant will use the default one provided by ivy. See above to have more details.<br class="xooki-br"/><br class="xooki-br"/><h2>Default configuration of project ivy instance</h2>
+This default settings mainly consist of 3 kind of repositories:
+<ul>
+  <li>local: a repository which is private to the user.</li>
+  <li>shared: a repository which is shared between all the member of a team public</li>
+  <li>public: a repository on which most modules, and especially third party modules, can be found</li>
+</ul>
+
+<i>Note that if you work alone, the distinction between local and shared repository is not very important, but there are some things to know to distinguish them.</i><br class="xooki-br"/><br class="xooki-br"/>Now let's describe each of these repositories concept in more details. We will describe how they are setup physically later.<br class="xooki-br"/><h3>Local</h3>
+The local repository is particularly useful when you want to do something without being disturbed by anything else happening in the environment. This means that whenever ivy is able to locate a module in this repository it will be used, no matter of what is available in others.<br class="xooki-br"/><br class="xooki-br"/>For instance, if you have a module declaring a dependency on the module foo in revision latest.integration, then if a revision of foo is found in the local repository, it will be used, even if a more recent revision is available in other repositories.<br class="xooki-br"/><br class="xooki-br"/>This may be disturbing for some of you, but imagine you have to implement a new feature on a project, and in order to achieve that you need to modify two modules: you add a new method in module foo and exploit this new method in module bar. Then if you publish the module foo to your local repository, you will be sure to get it in your bar module, even if someone else pu
 blish a new revision of foo in the shared repository (this revision not having the new method you are currently adding).<br class="xooki-br"/><br class="xooki-br"/>But be careful, when you have finished your development and publish it on the shared you will have to clean your local repository to benefit from new versions published in the shared repository.<br class="xooki-br"/><br class="xooki-br"/>Note also that modules found in the local repository must be complete, i.e. they must provide both a module descriptor and the published artifacts.<br class="xooki-br"/><h3>Shared</h3>
+As its name suggest, the shared repository is aimed to be shared among a whole development team. It is a place where you can publish your team private modules for instance, and it's also a place where you can put modules not available in the public repository (sun jars, for instance), or simply not accurate (bad or incomplete module descriptors for instance).<br class="xooki-br"/><br class="xooki-br"/>Note that modules can be split across the shared repository and the public one: you can have the module descriptor in the shared repository and the artifacts in the public one, for instance.<br class="xooki-br"/><h3>Public</h3>
+The public repository is the place where most modules can be found, but which sometimes lack the information you need. It's usually a repository available through an internet connection only, even if this is not mandatory.<br class="xooki-br"/>
+    </div>
+    <!-- end #posts -->
+    <!-- end #links -->
+    <div style="clear: both;">&nbsp;</div>
+</div>
+<!-- end #content -->
+<div id="footer">
+    <p id="legal">
+        <i>Copyright &#169; 2011 The Apache Software Foundation, Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0.txt">Apache License, Version 2.0</a>.</i><br>
+        <i>Apache EasyAnt, Apache Ivy, Apache Ant, Ivy, Ant, Apache, the Apache Ivy logo, the Apache Ant logo and the Apache feather logo are trademarks of The Apache Software Foundation.</i><br>
+        <i>All other marks mentioned may be trademarks or registered trademarks of their respective owners. </i>
+    </p>
+</div>
+<!-- end #footer -->
+</body>
+</html>

Propchange: incubator/easyant/site/staging/history/trunk/ref/ProjectIvyInstance.html
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: incubator/easyant/site/staging/history/trunk/ref/ProjectIvyInstance.html
------------------------------------------------------------------------------
    svn:keywords = Date Revision Author HeadURL Id

Propchange: incubator/easyant/site/staging/history/trunk/ref/ProjectIvyInstance.html
------------------------------------------------------------------------------
    svn:mime-type = text/html



Mime
View raw message