You are viewing a plain text version of this content. The canonical link for it is here.
Posted to easyant-commits@incubator.apache.org by hi...@apache.org on 2011/02/17 17:01:56 UTC
svn commit: r1071697 [11/42] - in /incubator/easyant: buildtypes/
buildtypes/trunk/ buildtypes/trunk/build-osgi-bundle-java/
buildtypes/trunk/build-osgi-bundle-java/src/
buildtypes/trunk/build-osgi-bundle-java/src/main/
buildtypes/trunk/build-osgi-bund...
Added: incubator/easyant/core/trunk/src/documentation/js/jquery.treeview.js
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/js/jquery.treeview.js?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/js/jquery.treeview.js (added)
+++ incubator/easyant/core/trunk/src/documentation/js/jquery.treeview.js Thu Feb 17 17:01:07 2011
@@ -0,0 +1,239 @@
+/*
+ * Treeview 1.2 - jQuery plugin to hide and show branches of a tree
+ *
+ * Copyright (c) 2006 Jörn Zaefferer, Myles Angell
+ *
+ * Dual licensed under the MIT and GPL licenses:
+ * http://www.opensource.org/licenses/mit-license.php
+ * http://www.gnu.org/licenses/gpl.html
+ *
+ * Revision: $Id$
+ *
+ */
+
+/**
+ * Takes an unordered list and makes all branches collapsable.
+ *
+ * The "treeview" class is added if not already present.
+ *
+ * To hide branches on first display, mark their li elements with
+ * the class "closed". If the "collapsed" option is used, mark intially open
+ * branches with class "open".
+ *
+ * @example .treeview, .treeview ul {
+ * padding: 0;
+ * margin: 0;
+ * list-style: none;
+ * }
+ *
+ * .treeview li {
+ * margin: 0;
+ * padding: 4px 0 3px 20px;
+ * }
+ *
+ * .treeview li { background: url(images/tv-item.gif) 0 0 no-repeat; }
+ * .treeview .collapsable { background-image: url(images/tv-collapsable.gif); }
+ * .treeview .expandable { background-image: url(images/tv-expandable.gif); }
+ * .treeview .last { background-image: url(images/tv-item-last.gif); }
+ * .treeview .lastCollapsable { background-image: url(images/tv-collapsable-last.gif); }
+ * .treeview .lastExpandable { background-image: url(images/tv-expandable-last.gif); }
+ * @desc The following styles are necessary in your stylesheet. There is are alternative sets of images available.
+ *
+ * @example $("ul").Treeview();
+ * @before <ul>
+ * <li>Item 1
+ * <ul>
+ * <li>Item 1.1</li>
+ * </ul>
+ * </li>
+ * <li class="closed">Item 2 (starts closed)
+ * <ul>
+ * <li>Item 2.1
+ * <ul>
+ * <li>Item 2.1.1</li>
+ * <li>Item 2.1.2</li>
+ * </ul>
+ * </li>
+ * <li>Item 2.2</li>
+ * </ul>
+ * </li>
+ * <li>Item 3</li>
+ * </ul>
+ * @desc Basic usage example
+ *
+ * @example $("ul").Treeview({ speed: "fast", collapsed: true});
+ * @before <ul>
+ * <li class="open">Item 1 (starts open)
+ * <ul>
+ * <li>Item 1.1</li>
+ * </ul>
+ * </li>
+ * <li>Item 2
+ * <ul>
+ * <li>Item 2.1</li>
+ * <li>Item 2.2</li>
+ * </ul>
+ * </li>
+ * </ul>
+ * @desc Create a treeview that starts collapsed. Toggling branches is animated.
+ *
+ * @example $("ul").Treeview({ control: #treecontrol });
+ * @before <div id="treecontrol">
+ * <a href="#">Collapse All</a>
+ * <a href="#">Expand All</a>
+ * <a href="#">Toggle All</a>
+ * </div>
+ * @desc Creates a treeview that can be controlled with a few links.
+ * Very likely to be changed/improved in future versions.
+ *
+ * @param Map options Optional settings to configure treeview
+ * @option String|Number speed Speed of animation, see animate() for details. Default: none, no animation
+ * @option Boolean collapsed Start with all branches collapsed. Default: none, all expanded
+ * @option <Content> control Container for a treecontrol, see last example.
+ * @option Boolean unique Set to allow only one branch on one level to be open
+ * (closing siblings which opening). Default: none
+ * @option Function toggle Callback when toggling a branch.
+ * Arguments: "this" refers to the UL that was shown or hidden.
+ * Works only with speed option set (set speed: 1 to enable callback without animations).
+ * Default: none
+ * @type jQuery
+ * @name Treeview
+ * @cat Plugins/Treeview
+ */
+
+(function($) {
+
+ // classes used by the plugin
+ // need to be styled via external stylesheet, see first example
+ var CLASSES = {
+ open: "open",
+ closed: "closed",
+ expandable: "expandable",
+ collapsable: "collapsable",
+ lastCollapsable: "lastCollapsable",
+ lastExpandable: "lastExpandable",
+ last: "last",
+ hitarea: "hitarea"
+ };
+
+ // styles for hitareas
+ var hitareaCSS = {
+ height: 15,
+ width: 30, // custom size used in xooki
+ marginLeft: "-30px", // custom size used in xooki
+ "float": "left",
+ cursor: "pointer"
+ };
+
+ // ie specific styles for hitareas
+ if( $.browser.msie ) {
+ $.extend( hitareaCSS, {
+ background: "#fff",
+ filter: "alpha(opacity=0)",
+ display: "inline"
+ });
+ }
+
+ $.extend($.fn, {
+ swapClass: function(c1, c2) {
+ return this.each(function() {
+ var $this = $(this);
+ if ( $.className.has(this, c1) )
+ $this.removeClass(c1).addClass(c2);
+ else if ( $.className.has(this, c2) )
+ $this.removeClass(c2).addClass(c1);
+ });
+ },
+ replaceclass: function(c1, c2) {
+ return this.each(function() {
+ var $this = $(this);
+ if ( $.className.has(this, c1) )
+ $this.removeClass(c1).addClass(c2);
+ });
+ },
+ Treeview: function(settings) {
+
+ // currently no defaults necessary, all implicit
+ settings = $.extend({}, settings);
+
+ // factory for treecontroller
+ function treeController(tree, control) {
+ // factory for click handlers
+ function handler(filter) {
+ return function() {
+ // reuse toggle event handler, applying the elements to toggle
+ // start searching for all hitareas
+ toggler.apply( $("div." + CLASSES.hitarea, tree).filter(function() {
+ // for plain toggle, no filter is provided, otherwise we need to check the parent element
+ return filter ? $(this).parent("." + filter).length : true;
+ }) );
+ return false;
+ }
+ }
+ // click on first element to collapse tree
+ $(":eq(0)", control).click( handler(CLASSES.collapsable) );
+ // click on second to expand tree
+ $(":eq(1)", control).click( handler(CLASSES.expandable) );
+ // click on third to toggle tree
+ $(":eq(2)", control).click( handler() );
+ }
+
+ // handle toggle event
+ function toggler() {
+ // this refers to hitareas, we need to find the parent lis first
+ $( this ).parent()
+ // swap classes
+ .swapClass( CLASSES.collapsable, CLASSES.expandable )
+ .swapClass( CLASSES.lastCollapsable, CLASSES.lastExpandable )
+ // find child lists
+ .find( ">ul" )
+ // toggle them
+ .toggle( settings.speed, settings.toggle );
+ if ( settings.unique ) {
+ $( this ).parent()
+ .siblings()
+ .replaceclass( CLASSES.collapsable, CLASSES.expandable )
+ .replaceclass( CLASSES.lastCollapsable, CLASSES.lastExpandable )
+ .find( ">ul" )
+ .hide( settings.speed, settings.toggle );
+ }
+ }
+
+ // add treeview class to activate styles
+ this.addClass("treeview");
+
+ // mark last tree items
+ $("li:last-child", this).addClass(CLASSES.last);
+
+ // collapse whole tree, or only those marked as closed, anyway except those marked as open
+ $( (settings.collapsed ? "li" : "li." + CLASSES.closed) + ":not(." + CLASSES.open + ") > ul", this).hide();
+
+ // find all tree items with child lists
+ $("li[ul]", this)
+ // handle closed ones first
+ .filter("[>ul:hidden]")
+ .addClass(CLASSES.expandable)
+ .swapClass(CLASSES.last, CLASSES.lastExpandable)
+ .end()
+ // handle open ones
+ .not("[>ul:hidden]")
+ .addClass(CLASSES.collapsable)
+ .swapClass(CLASSES.last, CLASSES.lastCollapsable)
+ .end()
+ // append hitarea
+ .prepend("<div class=\"" + CLASSES.hitarea + "\">")
+ // find hitarea
+ .find("div." + CLASSES.hitarea)
+ // apply styles to hitarea
+ .css(hitareaCSS)
+ // apply toggle event to hitarea
+ .toggle( toggler, toggler );
+
+ // if control option is set, create the treecontroller
+ if ( settings.control )
+ treeController(this, settings.control);
+
+ return this;
+ }
+ });
+})(jQuery);
\ No newline at end of file
Propchange: incubator/easyant/core/trunk/src/documentation/js/jquery.treeview.js
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/js/jquery.treeview.js
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/js/jquery.treeview.js
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added: incubator/easyant/core/trunk/src/documentation/logo.gif
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/logo.gif?rev=1071697&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/easyant/core/trunk/src/documentation/logo.gif
------------------------------------------------------------------------------
svn:mime-type = image/gif
Added: incubator/easyant/core/trunk/src/documentation/printTemplate.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/printTemplate.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/printTemplate.html (added)
+++ incubator/easyant/core/trunk/src/documentation/printTemplate.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,10 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+<head>
+ <title>${title}</title>
+ <link rel="stylesheet" type"text/css" href="style.css" media="screen">
+</head>
+<body>
+${body}
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/printTemplate.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/printTemplate.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/printTemplate.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/Defaultlifecycle.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/Defaultlifecycle.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/Defaultlifecycle.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/Defaultlifecycle.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,38 @@
+<!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>
+ <script type="text/javascript" src="../xooki/xooki.js"></script>
+</head>
+<body>
+ <textarea id="xooki-source">
+<h1>Default lifecycle</h1>
+EasyAnt cames with a default lifecycle. This default lifecycle is a set of predefined <a href="plugins/phases-std.html">phases</a> for the common needs.
+Each phase is considered as an essential step of the build process.
+Note : Even if EasyAnt provides you a default lifecycle we never lock you in. So you're able to add your own phases or to override existing ones.
+
+Here is a graphical representation of the default lifecycle.
+
+<img src="../images/phases.jpg"/></textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/Defaultlifecycle.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/Defaultlifecycle.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/Defaultlifecycle.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/Directorystructure.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/Directorystructure.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/Directorystructure.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/Directorystructure.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,95 @@
+<!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>
+ <script type="text/javascript" src="../xooki/xooki.js"></script>
+</head>
+<body>
+ <textarea id="xooki-source">
+<h1>Directory structure</h1>
+EasyAnt cames with a lot of convention, most of them are inspired by maven conventions.
+
+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.
+
+<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...).
+This tests doesn't make sense at all to be shipped during the packaging phase of your application.
+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.
+
+<h3>Separating source code and resources</h3>
+To clarify the directory structure source files and resources are separated in two directory.
+
+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>
+Note: this also apply with non-java project (like groovy / scala project).
+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>.
+This can be adapted through the property <i>src.main.webapp</i>
+
+<h2>Documentation files</h2>
+By convention, documentation files are stored in <i>src/documentation</i>.
+You can configure it through the property named <i>src.documentation.dir</i>.</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/Directorystructure.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/Directorystructure.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/Directorystructure.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/EasyAntconfigurationfile.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/EasyAntconfigurationfile.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/EasyAntconfigurationfile.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/EasyAntconfigurationfile.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,235 @@
+<!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>
+ <script type="text/javascript" src="../xooki/xooki.js"></script>
+</head>
+<body>
+ <textarea id="xooki-source">
+<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>
+<code type="xml">
+<easyant-config>
+ <!-- Configure the easyant ivy instance -->
+ <ivysettings file="${easyant.home}/ivysettings.xml"/>
+ <!-- Configure system plugins -->
+ <system-plugins>
+ <plugin organisation="org.apache.easyant.plugins" module="skeleton" revision="0.1" as="skeleton"/>
+ <plugin organisation="org.apache.easyant.plugins" module="ivy-repo-management" revision="0.1" as="repo-management"/>
+ </system-plugins>
+ <!-- Configuring user properties -->
+ <properties>
+ <property name="my.property" value="foobar"/>
+ </properties>
+</easyant-config>
+</code>
+
+<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.
+
+Easyant ivy instance is not used to retrieve project dependencies.
+If you want to configure the project ivy instance you should look at <a href="ref/ProjectIvyInstance.html">this page</a>.
+
+You can configure / override the easyant ivy instance through the following tag
+<code type="xml">
+<ivysettings file="/path/to/ivysettings.xml"/>
+</code>
+or
+<code type="xml">
+<ivysettings url="/path/to/ivysettings.xml"/>
+</code>
+
+
+<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.
+
+<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>.
+This file preconfigure :
+<ul>
+ <li>easyant cache in $USER_HOME/.easyant/easyant-cache</li>
+ <li>default repositories:
+ <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>.
+
+<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...
+
+This can be done writting your own ivysettings including if necessary the default configuration :
+<code type="xml">
+<ivysettings>
+ <!-- import the default ivy settings -->
+ <include url="${easyant.default.ivysettings.url}"/>
+ <!-- define your own default resolver, here a chain that include a new repo + the default chain provided by easyant -->
+ <settings defaultResolver="my-chain"/>
+ <resolvers>
+ <filesystem name="my-custom-repo">
+ <ivy pattern="/path/to/your/repo/[organisation]/[module]/ivy-[revision].xml"/>
+ <artifact pattern="/path/to/your/repo/[organisation]/[module]/[type]s/[artifact]-[revision].[ext]"/>
+ </filesystem>
+
+ <chain name="my-chain">
+ <resolver ref="my-custom-repo" />
+ <resolver ref="easyant-default-chain" />
+ </chain>
+ </resolvers>
+</ivysettings>
+</code>
+
+<h2>Configuring system plugins</h2>
+A system plugin can provide some additionnal functionnalities that can be used from everywhere.
+To reference a set of plugins you can use the following syntax :
+<code type="xml">
+<plugin organisation="org.apache.easyant.plugins" module="skeleton" revision="0.1" as="skeleton"/>
+</code>
+<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>
+<code type="xml">
+<!-- Using exploded style -->
+<plugin organisation="org.apache.easyant.plugins" module="skeleton" revision="0.1" as="skeleton"/>
+<!-- shorter form -->
+<plugin org="org.apache.easyant.plugins" module="skeleton" rev="0.1" as="skeleton"/>
+<!-- Using a mrid style -->
+<plugin mrid="org.apache.easyant.plugins#skeleton;0.1" as="skeleton"/>
+</code>
+
+<h2>Defining user properties</h2>
+You can also define user properties. Those properties will be available from everywhere when invoking easyant.
+<code type="xml">
+<property name="my.property" value="foobar"/>
+<property file="/path/to/mycompany.properties"/>
+<property url="/path/to/mycompany.properties"/>
+</code>
+<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></textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/EasyAntconfigurationfile.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/EasyAntconfigurationfile.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/EasyAntconfigurationfile.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/Modulefiles.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/Modulefiles.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/Modulefiles.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/Modulefiles.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,230 @@
+<!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>
+ <script type="text/javascript" src="../xooki/xooki.js"></script>
+</head>
+<body>
+ <textarea id="xooki-source">
+<h1>Module files</h1>
+A project using EasyAnt <b>MUST</b> contain a file named module.ivy and an optional file named module.ant.
+
+<h2>The module.ivy file</h2>
+<p />
+This file is the module descriptor of your project.
+It contains several informations like your company name, the module name, dependencies, and Easyant build information.
+
+<h3>A short example</h3>
+<code type="xml">
+<ivy-module version="2.0" xmlns:ea="http://www.easyant.org">
+ <info organisation="org.mycompany" module="myJavaApp" status="integration" >
+ <ea:build organisation="org.apache.easyant.buildtypes" module="build-std-java" revision="0.2"/>
+ </info>
+ <configurations>
+ <conf name="default" visibility="public" description="runtime dependencies and master artifact can be used with this conf"/>
+ <conf name="test" visibility="private" description="this scope indicates
+ that the dependency is not required for normal use of the application, and is
+only available for the test compilation and execution phases."/>
+ </configurations>
+</ivy-module>
+</code>
+In this module descriptor, we have an application named myJavaApp created by org.mycompany.
+To use easyant you must declare the easyant namespace
+<code type="xml">
+xmlns:ea="http://www.easyant.org"
+</code>
+Pay attention to the <b>ea:build</b> tag.
+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).
+A few seconds later, you will have the generated jar in your_project/target/artifacts/myJavaApp.jar.
+
+<h3>Changing build-system properties</h3>
+So now we want to change several things on this build system.
+For example, we want to have the generated jar in "dist" directory instead of "targets/artifacts".
+We will add additional informations inside <easyant> tag.
+<code type="xml">
+<ea:build organisation="org.apache.easyant.buildtypes" module="build-std-java" revision="0.2"/>
+ <ea:property name="target.artifacts" value="dist"/>
+</ea:build>
+</code>
+Running "easyant" will generate the output jar in "dist" directory.
+
+<h3>Adding dependencies</h3>
+Dependencies are defined in the module.ivy files.
+There is a section dedicated to <b>dependencies</b>
+Let's consider that our project needs an artifact named foo provided by acme in revision 2.0
+The dependencies section will look like this :
+<code type="xml">
+<dependencies>
+<dependency org="acme" name="foo" rev="2.0" conf="default"/>
+</dependencies>
+</code>
+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>
+
+<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.
+If your project needs to use a specific plugin, you can use the <b>ea:plugin</b> tag inside <b>ea:build</b> tag.
+Example:
+Suppose we want to use code coverage feature.
+<code type="xml">
+<ea:build organisation="org.apache.easyant.buildtypes" module="build-std-java" revision="0.2"/>
+ <ea:property name="target.artifacts" value="dist"/>
+ <ea:plugin org="org.apache.easyant.plugins" module="emma" revision="0.1"/>
+</ea:build>
+</code>
+Calling to "easyant -p" we should see the emma public target :
+<code type="xml">
+org.apache.easyant.plugins#emma.:emma generate emma covera report
+</code>
+As you can see the target is prefixed by the project name.
+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.
+<code type="xml">
+<ea:build organisation="org.apache.easyant.buildtypes" module="build-std-java" revision="0.2"/>
+ <ea:property name="target.artifacts" value="dist"/>
+ <ea:plugin org="org.apache.easyant.plugins" module="emma" revision="0.1" as="emma"/>
+</ea:build>
+</code>
+Calling to "easyant -p" we should see the emma public target :
+<code type="xml">
+emma.:emma generate emma covera report
+</code>
+<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.
+<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.
+<p />
+<u>Example:</u>
+Consider the following module.ivy file:
+<p />
+<code type="xml">
+<ivy-module version="2.0">
+ <info organisation="org.apache.easyant" module="standard-java-app" status="integration" >
+ <ea:build organisation="org.apache.easyant.buildtypes" module="build-std-java" revision="0.2">
+ <ea:plugin organisation="org.apache.easyant.plugins" module="checkstyle" revision="0.1"/>
+ </ea:build>
+ </info>
+ <configurations>
+ <conf name="default" visibility="public" description="runtime dependencies and master artifact"/>
+ <conf name="test" visibility="private" description="this scope indicates this is only available for the test compilation and execution phases."/>
+ </configurations>
+ <dependencies>
+ <dependency org="hsqldb" name="hsqldb" rev="1.8.0.7" conf="default->default"/>
+ <dependency org="junit" name="junit" rev="4.4" conf="test->default" />
+ </dependencies>
+</ivy-module>
+
+</code>
+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:
+
+<code type="xml">
+<project name="org.apache.easyant.buildtypes#standard-java-app"
+ xmlns:ea="antlib:org.apache.easyant">
+ <ea:build organisation="org.apache.easyant.buildtypes" module="build-std-java" revision="0.2"/>
+ <ea:plugin organisation="org.apache.easyant.plugins" module="checkstyle" revision="0.1"/>
+</project>
+</code>
+<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.
+
+<h2>Mixing module.ivy and module.ant</h2>
+EasyAnt offer the possibility to mix both files.
+This make sense if we need to use buildtypes/plugins and additional targets specific to your project.
+
+Let's try to add a target name hello world in the project.
+The module ivy looks like this :
+<code type="xml">
+<ivy-module version="2.0">
+ <info organisation="org.apache.easyant" module="standard-java-app" status="integration" >
+ <ea:build organisation="org.apache.easyant.buildtypes" module="build-std-java" revision="0.2"/>
+ </info>
+ <configurations>
+ <conf name="default" visibility="public" description="runtime dependencies and master artifact"/>
+ <conf name="test" visibility="private" description="this scope indicates this is only available for the test compilation and execution phases."/>
+ </configurations>
+ <dependencies/>
+</ivy-module>
+</code>
+
+Here we're able to run any phase/target provided by the <b>build-std-java</b> build type.
+
+Now we will add our helloWorld target in module.ant
+<code type="xml">
+<project name="org.apache.easyant.buildtypes#standard-java-app"
+ xmlns:ea="antlib:org.apache.easyant">
+ <target name="helloWorld" description="display a helloWorld message">
+ <echo message="Hello World!"/>
+ </target>
+</project>
+</code>
+
+Running a easyant -p should display our new target helloWorld. This target should be available if we launch easyant helloWorld.
+
+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.
+This complete the basic needs.
+
+<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.
+We need to keep in mind that ant-based system works with a useFirst mechanism.
+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 :
+ * the module.ivy
+ * the module.ant
+
+This means that you're not able to override target/phases in the module.ant.
+Fortunately EasyAnt provides a way to do it.
+The real choregraphy is to load :
+ * the override.module.ant
+ * the module.ivy
+ * the module.ant
+
+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.
+
+For example suppose we want to introduce a new phase named my-phase run before the default package phase.
+<code type="xml">
+<project name="org.apache.easyant.buildtypes#standard-java-app"
+ xmlns:ea="antlib:org.apache.easyant">
+ <!-- Define a new phase -->
+ <phase name="my-phase" description="foobar"/>
+ <!-- Override the package phase that depends on my-phase and the default package phase -->
+ <phase name="package" depends="my-phase, org.apache.easyant.plugins#phases-std.package" description="package the application"/>
+</project>
+</code>
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/Modulefiles.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/Modulefiles.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/Modulefiles.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/ProjectIvyInstance.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/ProjectIvyInstance.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/ProjectIvyInstance.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/ProjectIvyInstance.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,102 @@
+<!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>
+ <script type="text/javascript" src="../xooki/xooki.js"></script>
+</head>
+<body>
+ <textarea id="xooki-source">
+<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).
+
+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.
+
+Settings are specified through an xml file, usually called ivysettings.xml.
+Here is an example of settings file :
+<code type="xml">
+<ivysettings>
+ <properties file="${ivy.settings.dir}/ivysettings-file.properties" />
+ <settings defaultCache="${cache.dir}" defaultResolver="ibiblio" checkUpToDate="false" />
+ <resolvers>
+ <ibiblio name="ibiblio" />
+ <filesystem name="internal">
+ <ivy pattern="${repository.dir}/[module]/ivy-[revision].xml" />
+ <artifact pattern="${repository.dir}/[module]/[artifact]-[revision].[ext]" />
+ </filesystem>
+ </resolvers>
+ <modules>
+ <module organisation="jayasoft" name=".*" resolver="internal" />
+ </modules>
+</ivysettings>
+</code>
+
+Mainly, the settings enable to configure the default cache directory used by ivy and the dependency resolvers that it will use to resolve dependencies.
+<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>
+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>
+
+<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.
+
+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:
+Example:
+a property pointing to a file:
+<code type="xml">
+ <ea:property name="project.ivy.settings.file" value="/path/to/ivysetings.xml"/>
+</code>
+or a property pointing to an URL:
+<code type="xml">
+ <ea:property name="project.ivy.settings.url" value="http://url/to/ivysetings.xml"/>
+</code>
+
+If no one is specified, easyant will use the default one provided by ivy. See above to have more details.
+
+<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>
+
+Now let's describe each of these repositories concept in more details. We will describe how they are setup physically later.
+<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.
+
+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.
+
+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 publish a new revision of foo in the shared repository (this revision not having the new method you are currently adding).
+
+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.
+
+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.
+<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).
+
+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.
+<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.
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/ProjectIvyInstance.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/ProjectIvyInstance.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/ProjectIvyInstance.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/ProjectMancommand.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/ProjectMancommand.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/ProjectMancommand.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/ProjectMancommand.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,282 @@
+<!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>
+ <script type="text/javascript" src="../xooki/xooki.js"></script>
+</head>
+<body>
+ <textarea id="xooki-source">
+<h1>ProjectMan commands</h1>
+EasyAnt 0.7 cames with a few new switches usable from the command line that allow you to obtain several informations on a given project.
+
+<ul>
+ <li>listTargets : Lists all targets available</li>
+ <li>listTargets [arg] : Lists all targets associated with the specified phase / plugin as argument</li>
+ <li>listPhases : Lists all phases available</li>
+ <li>listPugins : Lists all plugins imported in the current project</li>
+ <li>listProps [plugin] : Lists all properties available in the specified plugin</li>
+ <li>describe [arg] : Describes a phase / target / property specified by argument</li>
+</ul>
+
+<h2>listTargets</h2>
+Lists all targets available :
+<code type="shell">
+> easyant -listTargets
+</code>
+Should print :
+<code type="shell">
+--- Available Targets for current project: standard-java-app ---
+
+No Phase / Plugin specified. Listing all targets available in the project.
+ Target: doit Phase: NONE
+ Description: NONE
+ Depends: verify
+ IF: NONE
+ UNLESS: NONE
+...
+ Target: run:doit
+ Phase: NONE
+ Description: NONE
+ Depends: :init, :run
+ IF: NONE
+ UNLESS: NONE
+
+--- End Of (Phases Listing) ---
+
+</code>
+
+<h2>listTargets [arg]</h2>
+Lists all targets associated with the specified phase / plugin as argument :
+<code type="shell">
+> easyant -listTargets package
+</code>
+Should print :
+<code type="shell">
+Project Manual
+--------------
+
+--- Available Targets for current project: standard-java-app ---
+Targets for Phase: package
+ Target: jar:jar
+ Phase: package
+ Description: NONE
+ Depends: validate, compile,prepare-package
+ IF: NONE
+ UNLESS: skip.jar.package
+
+Targets for Module: package
+ Target: :init
+ Phase: validate
+ Description: NONE
+ Depends: NONE
+ IF: NONE
+ UNLESS: NONE
+ Target: :run
+ Phase: NONE
+ Description: run the application
+ Depends: validate, compile, process-resources
+ IF: NONE
+ UNLESS: NONE
+ Target: :doit
+ Phase: NONE
+ Description: NONE
+ Depends: :init, :run
+ IF: NONE
+ UNLESS: NONE
+
+
+For more information on a Phase, run:
+ easyant -describe <PHASE>
+
+--- End Of (Phases Listing) ---
+</code>
+
+
+<h2>listPhases</h2>
+Lists all phases available:
+<code type="shell">
+> easyant -listPhases
+</code>
+Should print :
+<code type="shell">
+Project Manual
+--------------
+
+--- Available Phases for current project: standard-java-app ---
+ clean
+ validate
+ provision
+ generate-sources
+ process-sources
+ generate-resources
+ process-resources
+ compile
+ process-classes
+ test-provision
+ test-generate-sources
+ test-process-sources
+ test-generate-resources
+ test-process-resources
+ test-compile
+ test
+ prepare-package
+ package
+ pre-integration-test
+ integration-test
+ post-integration-test
+ verify
+ generate-local-version
+ generate-shared-version
+ generate-release-version
+ publish-local
+ publish-shared
+ release
+ report
+ process-documentation-resources
+ documentation
+
+
+For more information on a Phase, run:
+ easyant -describe <PHASE>
+
+--- End Of (Phases Listing) ---
+</code>
+
+
+<h2>listPlugins</h2>
+Lists all plugins imported in the current project:
+<code type="shell">
+> easyant -listPlugins
+</code>
+Should print :
+<code type="shell">
+Project Manual
+--------------
+
+--- Available Plugins for current project: standard-java-app ---
+ org.apache.easyant.buildtypes#build-std-java;0.2
+ org.apache.easyant.plugins#run-java;0.1: Known as run
+
+
+For more information on a Plugin, run:
+ easyant -describe <PLUGIN>
+
+--- End Of (Plugins Listing) ---
+</code>
+
+
+<h2>listProps [plugin]</h2>
+Lists all properties available in the specified plugin:
+<code type="shell">
+> easyant -listProps run
+</code>
+Should print :
+<code type="shell">
+Project Manual
+--------------
+
+--- Available Properties for current project: standard-java-app:: Plugin: run ---
+ Property: run.main.classname
+ Property: target.main.classes
+
+
+For more information on a Property, run:
+ easyant -describe <PROPERTY>
+
+--- End Of (Properties Listing) ---
+</code>
+
+
+
+
+<h2>describe [arg]</h2>
+Describes a phase / target / property specified by argument:
+<h3>Example with a property</h3>
+<code type="shell">
+> easyant -describe run.main.classname
+</code>
+Should print :
+<code type="shell">
+Project Manual
+--------------
+
+--- Available references for: run.main.classname in current project: standard-java-app ---
+ No Phase found for name: run.main.classname
+ No Target found for name: run.main.classname
+ Property: run.main.classname
+ Description: name of the main class to run
+ Default: NONE
+ Required: true
+
+--- End Of (Describe) ---
+</code>
+
+
+<h3>Example with a phase</h3>
+<code type="shell">
+> easyant -describe package
+</code>
+Should print :
+<code type="shell">
+Project Manual
+--------------
+
+--- Available references for: package in current project: standard-java-app ---
+ Phase: package
+ Description: take the compiled code and package it in its distributable format, such as a JAR.
+ Depends: prepare-package
+
+ For information on targets attached to this phase, run:
+ easyant -listTargets package
+ No Target found for name: package
+ No Property found for name: package
+
+--- End Of (Describe) ---
+</code>
+
+
+<h3>Example with a target</h3>
+<code type="shell">
+> easyant -describe run:run
+</code>
+Should print :
+<code type="shell">
+Project Manual
+--------------
+
+--- Available references for: run:run in current project: standard-java-app ---
+ No Phase found for name: run:run
+ Target: run:run
+ Phase: NONE
+ Description: NONE
+ Depends: validate, compile, process-resources
+ IF: NONE
+ UNLESS: NONE
+ No Property found for name: run:run
+
+--- End Of (Describe) ---
+
+</code>
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/ProjectMancommand.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/ProjectMancommand.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/ProjectMancommand.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/anttasks.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,51 @@
+<!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>
+ <script type="text/javascript" src="../xooki/xooki.js"></script>
+</head>
+<body>
+ <textarea id="xooki-source">
+<h1>Ant Tasks</h1>
+EasyAnt comes with a few Ant tasks.
+
+To use those tasks you should add the following namespace to your ant header.
+<code type="xml">
+xmlns:ea="antlib:org.apache.easyant"
+</code>
+
+Example :
+<code type="xml">
+<project name="foobar" xmlns:ea="antlib:org.apache.easyant">
+</code>
+
+Then you could be able to call the EasyAnt ant tasks with the prefix "ea".
+Example :
+<code type="xml">
+<project name="foobar" xmlns:ea="antlib:org.apache.easyant">
+ <ea:core-version requiredrevision="[0.6,+]" />
+</project>
+</code>
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/anttasks/BindTarget.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/BindTarget.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/BindTarget.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/BindTarget.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,77 @@
+<!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: 2};</script>
+ <script type="text/javascript" src="../../xooki/xooki.js"></script>
+</head>
+<body>
+ <textarea id="xooki-source">
+<h1>bindtarget task</h1>
+
+<h2>Description</h2>
+<p>
+This targets allow to change the mapping between target and phases.
+Usually it's usefull when you want to attach some extra targets to the default lifecycle (phases).
+</p>
+
+<h2>Arguments</h2>
+<table class="sortable" id="arguments">
+ <thead>
+ <tr>
+ <th>Parameter name</th>
+ <th class="unsortable">Description</th>
+ <th>Mandatory</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>target</td>
+ <td>the target that we're going to attach / detach</td>
+ <td>true</td>
+ </tr>
+ <tr>
+ <td>tophase</td>
+ <td>specify the phase that will be used by the mapping. If null / empty, the target will just be unbound.</td>
+ <td> </td>
+ </tr>
+ <tr>
+ <td>conf</td>
+ <td>specify one a many build configurations separated by a comma</td>
+ <td> </td>
+ </tr>
+ </tbody>
+</table>
+
+<h2>Example</h2>
+Bind test-jar:jar target to package phase
+<code type="xml">
+ <ea:bindtarget target="test-jar:jar" tophase="package"/>
+</code>
+
+Unbind mytarget target from current phase mapping
+<code type="xml">
+ <ea:bindtarget target="test-jar:jar" tophase="package"/>
+</code>
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/BindTarget.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/BindTarget.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/BindTarget.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/anttasks/CoreVersiontask.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/CoreVersiontask.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/CoreVersiontask.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/CoreVersiontask.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,84 @@
+<!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: 2};</script>
+ <script type="text/javascript" src="../../xooki/xooki.js"></script>
+</head>
+<body>
+ <textarea id="xooki-source">
+<h1>core-version task</h1>
+
+<h2>Description</h2>
+<p>
+The core-version task is used to define the compatibility between core and modules.
+
+This tasks support :
+<ul>
+<li>static version (Example : 0.5)</li>
+<li>dynamic version (Example : latest.revision) even if we do not recommand to use it</li>
+<li>listed version (Example : (0.1,0.3,0.5) )</li>
+<li>range version (Example : [0.5,0.8] means from 0.5 to 0.8. Example2 : [0.5,+] means all version superior to 0.5)</li>
+</ul>
+
+If the property skip.corerevision.checker is set to true, this check will be skipped. We strongly recommend you to keep this check enabled in production environnement.
+
+</p>
+
+<h2>Arguments</h2>
+<table class="sortable" id="arguments">
+ <thead>
+ <tr>
+ <th>Parameter name</th>
+ <th class="unsortable">Description</th>
+ <th>Mandatory</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr id="mandatory">
+ <td>requiredRevision</td>
+ <td>specify the required revision</td>
+ <td>true</td>
+ </tr>
+ <tr>
+ <td>message</td>
+ <td>the error message to display if the core revision check fails (note: the message could also be put as a nested text of this ant task)</td>
+ <td> </td>
+ </tr>
+ </tbody>
+</table>
+
+<h2>Nested Elements</h2>
+This task support nested text as error message.
+<code type="xml">
+ <ea:core-version requiredrevision="[0.7,+]">
+ This is my falling message.
+ </ea:core-version>
+</code>
+
+<h2>Example</h2>
+<code type="xml">
+ <ea:core-version requiredrevision="[0.7,+]" />
+</code>
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/CoreVersiontask.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/CoreVersiontask.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/CoreVersiontask.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/anttasks/Importtask.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/Importtask.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/Importtask.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/Importtask.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,143 @@
+<!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: 2};</script>
+ <script type="text/javascript" src="../../xooki/xooki.js"></script>
+</head>
+<body>
+ <textarea id="xooki-source">
+<h1>import task</h1>
+
+<h2>Description</h2>
+<p>
+This task is used to include / import scripts.
+
+The include mechanism is similar to the current import task, excepts that it automatically prefixes all targets of the used build module (=ant script).
+The prefix used by default is the name of the imported project, but it can be overriden when calling "include".
+
+This is useful to use features provided by a build module, while preserving a namespace isolation to avoid names collisions.
+
+While possible, overriding a target defined in a included module is not recommended. To do so, the import mechanism is preferred.
+
+The import mechanism is equivalent to the current import mechanism.
+
+This tasks also support build configurations feature.
+</p>
+
+<h2>Arguments</h2>
+<table class="sortable" id="arguments">
+ <thead>
+ <tr>
+ <th>Parameter name</th>
+ <th class="unsortable">Description</th>
+ <th>Mandatory</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr id="mandatory">
+ <td>organisation</td>
+ <td>plugin organisation name</td>
+ <td rowspan="3">true (if using exploded style)</td>
+ </tr>
+ <tr id="mandatory">
+ <td>module</td>
+ <td>plugin module name</td>
+ </tr>
+ <tr id="mandatory">
+ <td>revision</td>
+ <td>plugin revision id</td>
+ </tr>
+
+ <tr id="mandatory">
+ <td>mrid</td>
+ <td>a module revision id(Syntax: organisation#module;revision)</td>
+ <td>true (if using mrid style)</td>
+ </tr>
+ <tr>
+ <td>as</td>
+ <td>an alias for imported/included targets</td>
+ <td> </td>
+ </tr>
+ <tr>
+ <td>mode</td>
+ <td>specify if we want to import or include</td>
+ <td> </td>
+ </tr>
+ <tr>
+ <td>modulesDir</td>
+ <td>specify a directory where modules will be retrieved</td>
+ <td> </td>
+ </tr>
+ <tr>
+ <td>buildConfigurations</td>
+ <td>specify one a many build configurations separated by a comma</td>
+ <td> </td>
+ </tr>
+ </tbody>
+</table>
+
+<h2>Examples</h2>
+module A:
+<code type="xml">
+<target name=":bar" >
+ <dobar />
+</target>
+
+<target name=":baz" depends=":bar" />
+</code>
+module B:
+<code type="xml">
+<ea:include module="A" />
+</code>
+
+This is equivalent to:
+<code type="xml">
+<target name="A:bar" >
+ <dobar />
+</target>
+
+<target name="A:baz" depends="A:bar" />
+</code>
+OR for module B:
+<code type="xml">
+<ea:include module="A" id="C" />
+</code>
+which is equivalent to:
+<code type="xml">
+<target name="C:bar" >
+ <dobar />
+</target>
+
+<target name="C:baz" depends="C:bar" />
+</code>
+
+
+<h2>Example using build configurations</h2>
+<code type="xml">
+<ea:include module="A" buildConfigurations="myconf,myotherconf"/>
+</code>
+The module A will be included only if one of the following build configuration is active : myconf or myotherconf
+
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/Importtask.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/Importtask.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/Importtask.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/anttasks/LoadModuletask.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/LoadModuletask.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/LoadModuletask.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/LoadModuletask.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,75 @@
+<!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: 2};</script>
+ <script type="text/javascript" src="../../xooki/xooki.js"></script>
+</head>
+<body>
+ <textarea id="xooki-source">
+<h1>loadmodule tasks</h1>
+
+<h2>Description</h2>
+<p>
+This task is the main class, used to parse module.ivy and execute the all the statement behind the easyant tag.
+</p>
+
+<h2>Arguments</h2>
+<table class="sortable" id="arguments">
+ <thead>
+ <tr>
+ <th>Parameter name</th>
+ <th class="sortable">Description</th>
+ <th>Mandatory</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>buildModule</td>
+ <td>reference an ivy module descriptor file that contains easyant tag (default: module.ivy)</td>
+ <td> </td>
+ </tr>
+ <tr>
+ <td>buildFile</td>
+ <td>a pure ant file (default: module.ant)</td>
+ <td> </td>
+ </tr>
+ <tr>
+ <td>useBuildRepository</td>
+ <td>true if this module should use a build-scoped repository and cache to find artifacts generated by other modules in the same build.</td>
+ <td> </td>
+ </tr>
+ <tr>
+ <td>easyAntMDParserClassName</td>
+ <td>class name of the easyant module descriptor parser</td>
+ <td> </td>
+ </tr>
+ </tbody>
+</table>
+
+<h2>Example</h2>
+<code type="xml">
+<ea:loadmodule buildModule="module.ivy"/>
+</code>
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/LoadModuletask.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/LoadModuletask.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/LoadModuletask.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/anttasks/Parametertask.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/Parametertask.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/Parametertask.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/Parametertask.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,126 @@
+<!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: 2};</script>
+ <script type="text/javascript" src="../../xooki/xooki.js"></script>
+</head>
+<body>
+ <textarea id="xooki-source">
+<h1>parameter task</h1>
+
+<h2>Description</h2>
+<p>
+parameter tasks is used to :
+<ul>
+<li>document properties / paths / phases</li>
+<li>check if properties /paths / phases are required</li>
+<li>set default values if properties are not set</li>
+</ul>
+This could be useful in precondition of each modules, to check if property/phase/path are set. And much more useful to document our modules.
+</p>
+
+<h2>Arguments</h2>
+<table class="sortable" id="arguments">
+ <thead>
+ <tr><th>Parameter name</th><th class="unsortable">Description</th><th>Mandatory</th></tr>
+ </thead>
+ <tbody>
+ <tr id="mandatory">
+ <td>path</td>
+ <td>specify the path id to check</td>
+ <td rowspan="3">One of these</td>
+ </tr>
+ <tr id="mandatory">
+ <td>phase</td>
+ <td>specify the phase id to check</td>
+ </tr>
+ <tr id="mandatory">
+ <td>property</td>
+ <td>give a description to the property / path / phase</td>
+ </tr>
+ <tr id="mandatory">
+ <td>description</td>
+ <td>specify the path id to check</td>
+ <td>true</td>
+ </tr>
+ <tr>
+ <td>required</td>
+ <td>specify if the property / path is mandatory</td>
+ <td> </td>
+ </tr>
+ <tr>
+ <td>defaultValue</td>
+ <td>specify a default value (only available for property)</td>
+ <td> </td>
+ </tr>
+ </tbody>
+</table>
+
+
+<h2>Examples</h2>
+<h3>Mandatory property</h3>
+<code type="xml">
+<ea:parameter property="src.main.java" required="true" description="directory where sources to be compiled are" />
+</code>
+Here the src.main.java property is mandatory and will make a build failed if this property is not set displaying the following error message :
+<code type="xml">
+BUILD FAILED
+expected property 'src.main.java': directory where sources to be compiled are
+</code>
+<h3>Non mandatory property</h3>
+<code type="xml">
+<ea:parameter property="src.main.java" description="directory where sources to be compiled are" />
+</code>
+Here the src.main.java property is not mandatory and no check will be done on it.
+Even if no check is done, this could be usefull to document your build-script (ie. give a description to your properties)
+<h3>Non mandatory property with default value</h3>
+<code type="xml">
+<ea:parameter property="src.main.java" default="src/main/java" description="directory where sources to be compiled are" />
+</code>
+Here the src.main.java property is not mandatory.
+If the property is not set easyant will initialise this property with a default value.
+
+<h3>Mandatory path</h3>
+<code type="xml">
+<ea:parameter path="mypath" required="true" description="my path is used to ..." />
+</code>
+Here mypath is mandatory and will make a build failed if this path is not set displaying the following error message :
+<code type="xml">
+BUILD FAILED
+expected path 'mypath': my path is used to ...
+</code>
+
+<h3>Phase</h3>
+<code type="xml">
+<ea:parameter phase="myphase" description="my phase is used to ..." />
+</code>
+Here we say that our build script should know the phase named "myphase" if not it will make a build failed with the following message :
+<code type="xml">
+BUILD FAILED
+expected phase 'myphase': my phase is used to ...
+</code>
+
+
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/Parametertask.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/Parametertask.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/Parametertask.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/anttasks/Pathtask.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/Pathtask.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/Pathtask.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/Pathtask.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,69 @@
+<!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: 2};</script>
+ <script type="text/javascript" src="../../xooki/xooki.js"></script>
+</head>
+<body>
+ <textarea id="xooki-source">
+<h1>path task</h1>
+
+<h2>Description</h2>
+<p>
+This task is similar to path task provided by ant but add an override attribute with these values:
+<ul>
+ <li>true: new definition will take precedence over preceding one if any</li>
+ <li>false: new definition will be discarded if any definition already exists</li>
+ <li>append: new definition will be added to the existing one if any</li>
+ <li>prepend: new definition will be added at the beginning of the existing one if any</li>
+</ul>
+</p>
+
+<h2>Arguments</h2>
+<table class="sortable" id="arguments">
+ <thead>
+ <tr><th>Parameter name</th><th class="unsortable">Description</th><th>Mandatory</th></tr>
+ </thead>
+ <tbody>
+ <tr id="mandatory">
+ <td>pathid</td>
+ <td>used to give a name to the path</td>
+ <td>true</td>
+ </tr>
+ <tr>
+ <td>overwrite</td>
+ <td>specify if easyant should overwrite the path (Possible values are true/false/append/prepend)</td>
+ <td> </td>
+ </tr>
+ </tbody>
+</table>
+
+<h2>Examples</h2>
+<code type="xml">
+<ea:path pathid="compile.main.classpath" overwrite="true">
+ <fileset dir="foobar"/>
+</ea:path>
+</code>
+Here we overwrite the path "compile.main.classpath"</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/Pathtask.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/Pathtask.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/Pathtask.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/anttasks/Property.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/Property.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/Property.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/Property.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,66 @@
+<!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: 2};</script>
+ <script type="text/javascript" src="../../xooki/xooki.js"></script>
+</head>
+<body>
+ <textarea id="xooki-source">
+<h1>property task</h1>
+
+<h2>Description</h2>
+<p>
+This task is similar to the Property task provided by ant except that you can specify build configurations If no build configurations are specified the property will be loaded in all cases, otherwise the property will be loaded only if the build configuration is active.
+</p>
+
+<h2>Arguments</h2>
+<table class="sortable" id="arguments">
+ <thead>
+ <tr>
+ <th>Parameter name</th>
+ <th class="unsortable">Description</th>
+ <th>Mandatory</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>buildConfigurations</td>
+ <td>specify one a many build configurations separated by a comma</td>
+ <td> </td>
+ </tr>
+ </tbody>
+</table>
+
+
+<h2>Examples</h2>
+In the above example :
+<code type="xml">
+<ea:property name="foo" value="bar" buildConfigurations="myconf"/>
+<ea:property name="foo" value="bar" buildConfigurations="myconf, myotherconf"/>
+</code>
+The propery foo will be intialized only if the build configuration myconf is active.
+
+
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/Property.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/Property.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/Property.html
------------------------------------------------------------------------------
svn:mime-type = text/html