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 [12/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/ref/anttasks/SubModuletask.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/SubModuletask.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/SubModuletask.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/SubModuletask.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,86 @@
+<!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>submodule task</h1>
+
+<h2>Description</h2>
+<p>
+This task is used to manage orchestration of submodules.
+</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>buildpath</td>
+ <td>the buildpath to be used to find sub-projects.</td>
+ <td rowspan="2">one of these</td>
+ </tr>
+ <tr id="mandatory">
+ <td>buildpathRef</td>
+ <td>Buildpath to use, by reference</td>
+ </tr>
+ <tr>
+ <td>useBuildRepository</td>
+ <td>Specify if should use build repository or not (default value : false)</td>
+ <td> </td>
+ </tr>
+
+ <tr>
+ <td>overwrite</td>
+ <td>Specify if publication in build repository should overwrite existing artifacts (default value : true)</td>
+ <td> </td>
+ </tr>
+ <tr>
+ <td>target</td>
+ <td>The target to call on the different sub-builds. Set to "" to execute the default target</td>
+ <td> </td>
+ </tr>
+ <tr>
+ <td>verbose</td>
+ <td>Enable/ disable verbose log messages showing when each sub-build path is entered/ exited (default value : false)</td>
+ <td> </td>
+ </tr>
+ <tr>
+ <td>failOnError</td>
+ <td>Sets whether to fail with a build exception on error, or go on (default value : true)</td>
+ <td> </td>
+ </tr>
+ </tbody>
+</table>
+
+
+<h2>Example</h2>
+<code type="xml">
+ <ea:submodule target="package"/>
+</code></textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/SubModuletask.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/SubModuletask.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/SubModuletask.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/anttasks/buildtypetask.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/buildtypetask.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/buildtypetask.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/buildtypetask.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,92 @@
+<!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>buildtype task</h1>
+This task is an extension of <a href="Importtask.html">import</a> task that specify the default organisation for build types(org.apache.easyant.buildtypes).
+
+<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>organisation</td>
+ <td>plugin organisation name (default value: org.apache.easyant.buildtypes)</td>
+ <td> </td>
+ </tr>
+ <tr id="mandatory">
+ <td>module</td>
+ <td>plugin module name</td>
+ <td rowspan="2">true (if using exploded style)</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>Example</h2>
+<code type="xml">
+<ea:build module="build-std-java" revision="0.2"/>
+</code>
+
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/buildtypetask.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/buildtypetask.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/buildtypetask.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/anttasks/checkresolver.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/checkresolver.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/checkresolver.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/checkresolver.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,73 @@
+<!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>checkresolver task</h1>
+
+<h2>Description</h2>
+<p>
+This task is responsible of checking existance of a resolver in a given ivy instance.
+</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>resolver</td>
+ <td>resolver name to check</td>
+ <td>true</td>
+ </tr>
+ <tr>
+ <td>description</td>
+ <td>the error message to display if checkresolver 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:checkresolver resolver="myResolver">
+ This is my falling message.
+ </ea:checkresolver>
+</code>
+
+<h2>Example</h2>
+<code type="xml">
+ <ea:checkresolver resolver="message" />
+</code>
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/checkresolver.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/checkresolver.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/checkresolver.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/anttasks/easyant.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/easyant.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/easyant.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/easyant.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,119 @@
+<!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>easyant task</h1>
+
+<h2>Description</h2>
+<p>
+Runs EasyAnt on a supplied buildmodule. This can be used to build easyant subprojects.
+When the buildmodule attribute is omitted, the file "module.ivy" in the supplied directory (dir attribute) is used.
+
+If no target attribute is supplied, the default target of the new project is used.
+</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>targets</td>
+ <td>targets to run</td>
+ <td> </td>
+ </tr>
+ <tr>
+ <td>fork</td>
+ <td>specify if the easyant process should be in a separated ant context or use the current one<br/> <i>Default: true</i></td>
+ <td> </td>
+ </tr>
+
+ <tr>
+ <td>buildModule</td>
+ <td>name of the build module <br/> <i>Default: module.ivy</i></td>
+ <td> </td>
+ </tr>
+ <tr>
+ <td>buildFile</td>
+ <td>name of the additional ant file <br/> <i>Default: module.ant</i></td>
+ <td> </td>
+ </tr>
+ <tr>
+ <td>buildConfiguration</td>
+ <td>activate some <a href="../../howto/BuildConfigurations.html">build configurations</a></td>
+ <td> </td>
+ </tr>
+
+ <tr>
+ <td>configurationFile</td>
+ <td>path to easyant configuration file. This File is used to configure system plugins, global properties, etc... See this <a href="../EasyAntconfigurationfile.html">page</a> for more informations. If not set easyant will use the default one.</td>
+ <td> </td>
+ </tr>
+ <tr>
+ <td>configurationUrl</td>
+ <td>path to easyant configuration url. This File is used to configure system plugins, global properties, etc... See this <a href="../EasyAntconfigurationfile.html">page</a> for more informations. If not set easyant will use the default one.</td>
+ <td> </td>
+ </tr>
+ </tbody>
+</table>
+
+<h2>Example</h2>
+Run package phase in a separated context (forked)
+<code type="xml">
+ <ea:easyant targets="package" />
+<code>
+
+Run default targets in a separated context (forked)
+<code type="xml">
+ <ea:easyant fork="false" targets="package"/>
+</code>
+
+Import easyant build types plugins and execute package phase in the current ant context
+<code type="xml">
+ <ea:easyant fork="false" targets="package"/>
+</code>
+
+Import easyant build types and plugins in current ant context without executing any targets. Everything defined in easyant project will be accessible trough easyant. You can compare this with <i>ant import</i> mechanism.
+<code type="xml">
+ <ea:easyant fork="false"/>
+</code>
+
+Suppose you have the following build.xml
+<code type="xml">
+<project name="myAntProject"
+ <ea:easyant fork="false"/>
+</project>
+</code>
+Running ant -p will display all targets, phases defined by easyant.
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/easyant.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/easyant.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/easyant.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,134 @@
+<!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>findclasspath task</h1>
+
+<h2>Description</h2>
+<p>The <findclasspath> task is designed to locate the right version of a SDK (for groovy / scala, but maybe for others SDK like android etc...).
+Implementation is based on the pattern chain of responsability.
+</p>
+
+Really basic sample :
+<code type="xml">
+<ea:findclasspath org="org.codehaus.groovy" module="groovy-all" revision="1.0"/>
+</code>
+
+By default if you do not specify anything inside the findclasspath task, easyant will use the default strategies :
+<ul>
+ <li>ProjectDependencyStrategy : will check if the specified dependency is contained as a project dependencies. If there is no exact match it will give a try based on organisation name. If found easyant will use the specified version in the project dependencies.</li>
+ <li>BasicConfiguration : will use the specified dependency (declared in <b>findclasspath</b>)</li>
+</ul>
+
+<h3>Using additional strategy</h3>
+
+You can define (or override) the default behavior and plug your own strategy.
+By default, EasyAnt came with an additional strategy : environment strategy.
+
+This strategy can be referenced as a nested element of <findclasspath>.
+If you choose to use additionnal strategy you need to define the whole chain (ordered). This allow you to interfer with the two default strategies
+
+Say for example you want to :
+<ul>
+ <li>check project dependencies</li>
+ <li>if not found check environment variables</li>
+ <li>if not found use the specified version in findclasspath argument</li>
+</ul>
+The task will looks like this :
+<code type="xml">
+<ea:findclasspath org="org.codehaus.groovy" module="groovy-all" revision="1.0">
+ <project-dependency-strategy/>
+ <environment-strategy env="GROOVY_HOME"/>
+ <basic-configuration-strategy/>
+</ea:findclasspath>
+</code>
+
+<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>name of the path id to fill</td>
+ <td>true</td>
+ </tr>
+ <tr>
+ <td>organisation</td>
+ <td>organisation name to search (used by nested strategies extending BasicConfigurationStrategy)</td>
+ <td> </td>
+ </tr>
+ <tr>
+ <td>module</td>
+ <td>module name to search (used by nested strategies extending BasicConfigurationStrategy)</td>
+ <td> </td>
+ </tr>
+ <tr>
+ <td>revision</td>
+ <td>revision number to search (used by nested strategies extending BasicConfigurationStrategy)</td>
+ <td> </td>
+ </tr>
+ <tr>
+ <td>conf</td>
+ <td>configuration name (used by nested strategies extending BasicConfigurationStrategy) <br/><i>Default: default</i></td>
+ <td> </td>
+ </tr>
+
+ </tbody>
+</table>
+
+<h2>Nested Elements</h2>
+This task can have nested elements extending <i>org.apache.easyant.tasks.findclasspathAbstractFindClassPathStrategy</i>.
+By default it comes with three implementation :
+<ul>
+ <li><a href="findclasspath/basic-configuration-strategy.html">basic-configuration-strategy</a></li>
+ <li><a href="findclasspath/environment-strategy.html">environment-strategy</a></li>
+ <li><a href="findclasspath/project-dependency-strategy.html">project-dependency-strategy</a></li>
+</ul>
+
+
+<h2>Example</h2>
+Really basic sample :
+<code type="xml">
+<ea:findclasspath org="org.codehaus.groovy" module="groovy-all" revision="1.0"/>
+</code>
+Using nested strategies :
+<code type="xml">
+<ea:findclasspath org="org.codehaus.groovy" module="groovy-all" revision="1.0">
+ <project-dependency-strategy/>
+ <environment-strategy env="GROOVY_HOME"/>
+ <basic-configuration-strategy/>
+</ea:findclasspath>
+</code>
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath/basic-configuration-strategy.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath/basic-configuration-strategy.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath/basic-configuration-strategy.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath/basic-configuration-strategy.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,85 @@
+<!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: 3};</script>
+ <script type="text/javascript" src="../../../xooki/xooki.js"></script>
+</head>
+<body>
+ <textarea id="xooki-source">
+<h1>basic-configuration-strategy</h1>
+
+<h2>Description</h2>
+<p>This strategy contains the logic to fill a classpath with given arguments
+</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>name of the path id to fill</td>
+ <td>true</td>
+ </tr>
+ <tr>
+ <td>organisation</td>
+ <td>organisation name to search</td>
+ <td> </td>
+ </tr>
+ <tr>
+ <td>module</td>
+ <td>module name to search</td>
+ <td> </td>
+ </tr>
+ <tr>
+ <td>revision</td>
+ <td>revision number to search</td>
+ <td> </td>
+ </tr>
+ <tr>
+ <td>conf</td>
+ <td>configuration name<br/><i>Default: default</i></td>
+ <td> </td>
+ </tr>
+
+ <tr>
+ <td>settingsRef</td>
+ <td>A reference to the ivy settings that must be used by this task<br/><i>Default: easyant.ivy.instance</i></td>
+ <td> </td>
+ </tr>
+ </tbody>
+</table>
+
+<h2>Example</h2>
+<code type="xml">
+<ea:basic-configuration-strategy org="org.codehaus.groovy" module="groovy-all" revision="1.0" />
+</code>
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath/basic-configuration-strategy.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath/basic-configuration-strategy.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath/basic-configuration-strategy.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath/environment-strategy.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath/environment-strategy.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath/environment-strategy.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath/environment-strategy.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,68 @@
+<!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: 3};</script>
+ <script type="text/javascript" src="../../../xooki/xooki.js"></script>
+</head>
+<body>
+ <textarea id="xooki-source">
+<h1>environment-strategy</h1>
+
+<h2>Description</h2>
+<p>This strategy contains the logic to fill a classpath by checking an Environment variable (example: GROOVY_HOME)</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>env</td>
+ <td>environment variable to check</td>
+ <td>true</td>
+ </tr>
+ <tr>
+ <td>layout</td>
+ <td>layout directory used to locate elements added on the classpath<br/><i>Default: /lib</i></td>
+ <td> </td>
+ </tr>
+ <tr>
+ <td>filter</td>
+ <td>a filter used to select only a few elements (can be a ant regexp like **/*.jar)</td>
+ <td> </td>
+ </tr>
+ </tbody>
+</table>
+
+<h2>Example</h2>
+<code type="xml">
+<ea:environment-strategy env="GROOVY_HOME" />
+</code>
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath/environment-strategy.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath/environment-strategy.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath/environment-strategy.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath/project-dependency-strategy.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath/project-dependency-strategy.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath/project-dependency-strategy.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath/project-dependency-strategy.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,86 @@
+<!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: 3};</script>
+ <script type="text/javascript" src="../../../xooki/xooki.js"></script>
+</head>
+<body>
+ <textarea id="xooki-source">
+<h1>project-dependency-strategy</h1>
+
+<h2>Description</h2>
+<p>This strategy can be used to check if the classpath entry is in project dependencies.
+</p>
+
+<p>
+It will look if one project dependency matches with given organisation and given module name.
+If found, it will use the revision specified in the dependency.
+If not found it will look if one project dependency matches with given organisation. If found it will use both module name and revision specified in the dependency
+</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>name of the path id to fill</td>
+ <td>true</td>
+ </tr>
+ <tr>
+ <td>organisation</td>
+ <td>organisation name to search</td>
+ <td> </td>
+ </tr>
+ <tr>
+ <td>module</td>
+ <td>module name to search</td>
+ <td> </td>
+ </tr>
+ <tr>
+ <td>conf</td>
+ <td>configuration name<br/><i>Default: default</i></td>
+ <td> </td>
+ </tr>
+
+ <tr>
+ <td>settingsRef</td>
+ <td>A reference to the ivy settings that must be used by this task<br/><i>Default: ${project.ivy.instance}</i></td>
+ <td> </td>
+ </tr>
+ </tbody>
+</table>
+
+<h2>Example</h2>
+<code type="xml">
+<ea:project-dependency-strategy org="org.codehaus.groovy" module="groovy-all" revision="1.0" />
+</code>
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath/project-dependency-strategy.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath/project-dependency-strategy.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/findclasspath/project-dependency-strategy.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/anttasks/menugenerator.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/menugenerator.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/menugenerator.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/menugenerator.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,115 @@
+<!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>menugenerator task</h1>
+
+<h2>What is a menu generator ?</h2>
+
+A menu generator is supposed to generate menu. It provides some methods to write menu entries in a given menu file.
+
+<h2>Writing your own menugenerator</h2>
+To write your own menu generator you must write a java class implementing the org.apache.easyant.core.menu.MenuGenerator interface.
+This interface allow you to implements the logic to generate menu entries in a menu file.
+
+When you're own implementation is ready you'll need to register it in easyant this is done through a menu generator registry.
+
+<h2>What is a menu generator registry ?</h2>
+A menu generator registry is used to reference all the menu generator for a given context.
+As explained before a menu generator is supposed to generate menu entries in one given file.
+But maybe in a project we can have multiple menu files.
+Let's take the example of easyant documentation, we have a root menu and we also have submenus for plugins and buildtypes.
+So behind we have three different files :
+<ul>
+ <li>the root menu</li>
+ <li>submenu for plugins</li>
+ <li>submenu for buildtypes</li>
+
+How can we handle this with easyant ?
+The answer is by using context.
+
+We can ask easyant to manage a registry by context (if not specified the default context will be "default").
+Plugins can register their menugenerator implementation is the registry for a given context.
+
+<h2>Registering a menugenerator</h2>
+
+The syntax looks like this
+<code type="xml">
+<ea:registermenugenerator classname="org.mycompany.menugenerators.MyOwnMenuGenerator" file="my.file" context="root"/>
+</code>
+
+The <b>registermenugenerator</b> task support classpath and classpathref attribute.
+<code type="xml">
+<ea:registermenugenerator classname="org.mycompany.menugenerators.MyOwnMenuGenerator" file="my.file" context="root" classpathref="my.classpath"/>
+</code>
+
+It also support nested classpath
+<code type="xml">
+<ea:registermenugenerator classname="org.mycompany.menugenerators.MyOwnMenuGenerator" file="my.file" context="root">
+ <classpath>
+ <fileset dir="/path/to/directory" incluse="**/*.jar"/>
+ </classpath>
+</ea:registermenugenerator>
+</code>
+So get back to our example talking about easyant documentation to understand the meaning of context.
+We have three files so we need to register three menugenerators in different context.
+Here we consider that i only uses Xooki as a documentation layer.
+So the xooki plugins should do :
+<code type="xml">
+<ea:registermenugenerator classname="org.mycompany.menugenerators.XookiMenuGenerator" file="${basedir}/toc.json" context="root"/>
+<ea:registermenugenerator classname="org.mycompany.menugenerators.XookiMenuGenerator" file="/path/to/plugins/toc.json" context="plugins"/>
+<ea:registermenugenerator classname="org.mycompany.menugenerators.XookiMenuGenerator" file="/path/to/buildtypes/toc.json" context="buildtypes"/>
+</code>
+Here we've registered the same implementation for three different context.
+
+We will now play with menu entries
+
+<h2>Adding a simple menu entry</h2>
+
+The syntax looks like this :
+<code type="xml">
+<ea:addmenuentry context="test" title="mytitle" targetlink="foobar"/>
+</code>
+The title is the label of the link in the menu. The target link means is a URL(can be relative).
+The context similar as the one in <ea:registermenugenerator> task.
+
+What happens behind ?
+EasyAnt will retrieve the right registry for this context, loop and all registered menu generator implementation, and process the generation of the link.
+
+This task also supported nested <menuentry> elements.
+
+<h2>Adding a multiple menu entries</h2>
+<code type="xml">
+<ea:addmenuentry context="test">
+ <ea:menuentry title="foo" targetlink="bar"/>
+ <ea:menuentry title="bla" targetlink="plop"/>
+ <ea:menuentry title="test" targetlink="test"/>
+</ea:addmenuentry>
+</code>
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/menugenerator.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/menugenerator.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/menugenerator.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/anttasks/plugintask.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/plugintask.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/plugintask.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/plugintask.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,91 @@
+<!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>plugin task</h1>
+This task is an extension of <a href="Importtask.html">import</a> task that specify the default organisation (org.apache.easyant.plugins) for plugins.
+
+<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>organisation</td>
+ <td>plugin organisation name (default value: org.apache.easyant.plugins)</td>
+ <td> </td>
+ </tr>
+ <tr id="mandatory">
+ <td>module</td>
+ <td>plugin module name</td>
+ <td rowspan="2">true (if using exploded style)</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>Example</h2>
+<code type="xml">
+<ea:plugin module="run-java" revision="0.1" as="run"/>
+</code>
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/plugintask.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/plugintask.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/plugintask.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/anttasks/registerartifact.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/registerartifact.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/registerartifact.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/registerartifact.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,90 @@
+<!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>registerartifact task</h1>
+
+<h2>Description</h2>
+<p>
+This targets is in charge to register a given artifact to ivy context. In other words, this targets is responsible of generating the right <publications> elements in the publicated module.ivy file.
+This targets is pretty usefull for plugin writers if they want to hide some complexities to the end user.
+End user will not have to define <publications> elements if they use test-jar plugins for example.
+registerartifact is a PostResolveTask
+</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>name</td>
+ <td>the name of the published artifact. This name must not include revision.</td>
+ <td>No, default to the name of the module</td>
+ </tr>
+ <tr>
+ <td>type</td>
+ <td>the type of the published artifact. It's usually its extension, but not necessarily. For instance, ivy files are of type 'ivy' but have 'xml' extension</td>
+ <td>No, defautls to jar</td>
+ </tr>
+ <tr>
+ <td>ext</td>
+ <td>the extension of the published artifact</td>
+ <td>No, defaults to type</td>
+ </tr>
+ <tr>
+ <td>conf</td>
+ <td>comma separated list of public configurations in which this artifact is published. '*' wildcard can be used to designate all public configurations of this module.</td>
+ <td>No, defaults to defaultconf attribute value on parent publications elements</td>
+ </tr>
+
+ <tr>
+ <td>classifier</td>
+ <td>acts as a maven classifier.</td>
+ <td> </td>
+ </tr>
+ </tbody>
+</table>
+
+<h2>Example</h2>
+Register test-jar artifact with type "test-jar"
+<code type="xml">
+ <ea:registerartifact ext="jar" type="test-jar" settingsRef="${project.ivy.instance}"/>
+</code>
+
+Register test-jar artifact with type "test-jar" and classifier "test" to be maven compatible
+<code type="xml">
+ <ea:registerartifact ext="jar" type="test-jar" classifier="test" settingsRef="${project.ivy.instance}"/>
+</code>
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/registerartifact.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/registerartifact.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/anttasks/registerartifact.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/buildtypes/buildtypes.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/buildtypes/buildtypes.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/buildtypes/buildtypes.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/buildtypes/buildtypes.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,37 @@
+<!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>
+ <title>EasyAnt Build Types</title>
+</head>
+<body>
+ <textarea id="xooki-source">
+<h1>Build Types</h1>
+
+<p>A "Build Type" identifies at a high level how you want a single module in your project to be built. Building a module typically includes many steps like compilation, source generation, unit testing, packaging, and build reporting. For example, the build type <a href="build-webapp-java.html">build-webapp-java</a> compiles, tests, and packages a Java WAR file.</p>
+
+<p>A BuildType is typically implemented as an Ant script, an Ivy descriptor, and a properties file. The Ivy descriptor is used by EasyAnt to load the Build Type as runtime. The Ant Script is executed whenever you build a module using that Build Type. Most Build Type scripts simply import a set of <a href="../plugins/plugins.html">EasyAnt Plugins</a>, each plugin contributing one step to the build process. For example, the <a href="build-std-java.html">build-std-java</a> Build Type imports the <a href="../plugins/compile-java.html">compile-java</a> plugin to compile Java sources and the <a href="../plugins/package-jar.html">package-jar</a> plugin to bundle the results as a JAR file. A Build Type's properties file then contains default parameter settings used by the plugins; for example, the expected location of Java source and test files in a project directory.</p>
+ </textarea>
+ <script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/buildtypes/buildtypes.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/buildtypes/buildtypes.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/buildtypes/buildtypes.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/buildtypes/toc.json
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/buildtypes/toc.json?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/buildtypes/toc.json (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/buildtypes/toc.json Thu Feb 17 17:01:07 2011
@@ -0,0 +1,4 @@
+{
+ "id": "buildtypes",
+ "children":[]
+}
Added: incubator/easyant/core/trunk/src/documentation/ref/features.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/features.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/features.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/features.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,36 @@
+<!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>Features</h1>
+
+Easyant is a toolbox focusing on easing project build processes.
+It's based on Apache Ant and Apache Ivy, and allows for maximum flexibily, improved integration in existing build systems and provides conventions and guidelines.
+
+If you don't see why you should use a flexible build-system at all, or have any question concerning EasyAnt in general, have a look at the <a href="../faq.html">FAQ</a> and at the Mailing lists.</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/features.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/features.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/features.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/phases.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/phases.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/phases.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/phases.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,65 @@
+<!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>Understanding phases</h1>
+<p>
+ a phase is a kind of target with special features:
+ <ul>
+ <li>have no body, only dependencies</li>
+ <li>dependencies are created on the fly (when a target is assigned to a phase)</li>
+ <li>order of dependencies is not guaranteed</li>
+ <li>are not prefixed in 'include', and never overriden</li>
+ </ul>
+</p>
+<p>This is useful to make build modules easily reusable in a standard build (with standard phases), without requiring any specific orchestration.<p>
+<h2>Example</h2>
+module A:
+<code type="xml">
+<phase name="foo" description="do foo" />
+
+<target name=":bar" phase="foo" >
+ <dobar />
+</target>
+</code>
+module B:
+<code type="xml">
+<ea:include module="A"/>
+<target name=":another-bar" phase="foo" >
+</code>
+
+
+By calling to
+<code>
+easyant foo
+</code>
+
+You will run ALL the targets bound the "foo" phase (:bar and :another-bar in my previous example)
+
+In a module plugin it's possible to assign a target to a phase which is not declared in the build module. It makes the module dependent on the caller to declare the phase prior to the use call, and as such becomes a requirement of the module. </textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/phases.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/phases.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/phases.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/plugins/plugins.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/plugins/plugins.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/plugins/plugins.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/plugins/plugins.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,39 @@
+<!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>
+ <title>EasyAnt Plugins</title>
+</head>
+<body>
+ <textarea id="xooki-source">
+<h1>Plugins</h1>
+
+<p>An EasyAnt plugin defines a single small "task" performed by EasyAnt, for example: run unit tests, generate a build report, or package a jar. Plugins can then be included into buildtypes or other plugins to define more complicated tasks (like "build a complete web application"). You can also include a plugin directly into your project's Ivy file to customize the way your project is built.</p>
+
+<p>A typical plugin consists of an Ivy descriptor and a short Ant script, and is stored in the EasyAnt Ivy repository. The Ivy descriptor indicates which libraries are required by your plugin; for example, the junit jar is needed by the test-junit plugin. The Ant script contributes logic to one or more <a href="../phases.html">build phases</a>. Most plugins can be fine-tuned with Ant property settings.</p>
+
+<p>If you want to add support for a new build tool to EasyAnt, you should probably start by writing a plugin for it. See the <a href="../../howto/writePlugins.html">Plugins Tutorial</a> to get started. Before writing your own plugin, be sure to check here to see if a plugin doesn't already exist.</p>
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/ref/plugins/plugins.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/ref/plugins/plugins.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/ref/plugins/plugins.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/ref/plugins/toc.json
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/plugins/toc.json?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/plugins/toc.json (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/plugins/toc.json Thu Feb 17 17:01:07 2011
@@ -0,0 +1,4 @@
+{
+ "id": "plugins",
+ "children":[]
+}
Added: incubator/easyant/core/trunk/src/documentation/reference.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/reference.html?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/reference.html (added)
+++ incubator/easyant/core/trunk/src/documentation/reference.html Thu Feb 17 17:01:07 2011
@@ -0,0 +1,222 @@
+<!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: 0};</script>
+ <script type="text/javascript" src="xooki/xooki.js"></script>
+</head>
+<body>
+ <textarea id="xooki-source">
+<h1>Reference</h1>
+
+If you don't know EasyAnt at all, give a glance at its <a href="ref/features.html">features</a>, the <a href="faq.html">FAQ</a> and the <a href="tutorials.html">tutorials</a> before digging into this reference documentation.
+
+<h2>How does it work?</h2>
+Since 0.6, easyant-core.jar is in charge of :
+<ul>
+ <li>Loading the ivy instance used by easyant internal (used to retrieve buildtypes / plugins)</li>
+ <li>Loading all the system plugins.
+</ul>
+This can be configured in a <a href="ref/EasyAntconfigurationfile.html">configuration file</a>.
+
+Then it uses the <a href="ref/anttasks/LoadModuletask.html">loadmodule task</a> provided by easyant, which basically parses an Ivy file (module.ivy) and looks for instructions in the Ivy file for easyant (similar to the pom concept actually).
+
+Finally easyant tries to import an optional file called module.ant in the user directory (the module to build). In the examples, there is no such file, but this would let the user customize the build with an Ant script if necessary.
+
+<h2>EasyAnt instructions in module.ivy</h2>
+A module.ivy looks like this
+<code type="xml">
+<ea:build organisation="org.apache.easyant.buildtypes" module="build-std-java" revision="0.2">
+ <ea:property name="run.main.classname" value="org.apache.easyant.example.Example"/>
+ <ea:property name="target.artifacts" value="dist"/>
+ <ea:plugin module="emma" revision="0.1"/>
+</ea:build>
+</code>
+
+The idea is to have a very limited options of customizing the build in the Ivy file: settings properties, and telling which main build module should be imported. If you need more, you can use a module.ant file.
+
+Let's try to understand how to use it.
+'ea:build' tag is the main instruction. Type argument in easyant tag references a build type, which tells which build module should be imported (considered as an <a href="ref/anttasks/Importtask.html">import</a>), see below.
+Example:
+<code type="xml">
+<ea:build organisation="org.apache.easyant.buildtypes" module="build-std-java" revision="0.2">
+</code>
+You can also have property definition, as you would have in an Ant script
+Example:
+<code type="xml">
+<ea:property name="target.artifacts" value="dist"/>
+</code>
+Usually build-type does the basic stuff. But sometimes we need something more (Source code management feature / code coverage etc...).
+You can load several plugins using the plugin tag.
+Example:
+<code type="xml">
+<ea:plugin module="emma" revision="0.1"/>
+</code>
+
+In this example emma module is loaded as a plugin(considered as an <a href="ref/anttasks/Importtask.html">include</a>).
+As easyant proceeds with execution, all targets are imported in current project prefixed by the project name.
+This means all targets included in emma module will be prefixed by org.apache.easyant.plugins#emma.
+Example :
+<code type="xml">
+org.apache.easyant.plugins#emma:emma generate emma covera report
+</code>
+
+As the name is not really "user-friendly" you can use an alias for the prefix using "as" attribute.
+Example:
+<code type="xml">
+<ea:plugin module="emma" revision="0.1" as="emma"/>
+</code>
+Doing this, all targets included in emma module will be prefixed by "emma"
+Example :
+<code type="xml">
+emma:emma generate emma coverage report
+</code>
+
+<h2>build plugins:</h2>
+There is three types of build modules:
+<ul>
+<li>build types</li>
+<li>phase description</li>
+<li>plugins</li>
+</ul>
+
+<h3>build types:</h3>
+The main build script are build type (build-std-java in my previous example).
+
+Build types are intended to provide a full build for a particular type of project (simple java, war, ear, ...). EasyAnt comes with a set of build types modules, but users could extend/replace these types as they want. Then in most cases they could simply define which build type to import for each module (either standard or custom), and that's pretty much all. Hence you usually import only one build type module at a time.
+<table>
+ <thead>
+ <tr>
+ <td>Module name</td>
+ <td>Description</td>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>build-std-java</td>
+ <td>a standard build for simple java modules, relying on standard phases, and providing compilation, execution and unit tests</td>
+ </tr>
+ <tr>
+ <td>build-webapp-java</td>
+ <td>a standard build for webapp java modules, relying on standard phases, and providing compilation, execution and unit tests</td>
+ </tr>
+ <tr>
+ <td>build-std-scala</td>
+ <td>a standard build for simple scala modules, relying on standard phases, and providing compilation, execution and unit tests</td>
+ </tr>
+ </tbody>
+</table>
+
+<h3>phases description:</h3>
+Phases define an ordered set of build phases. Build phases are responsible for the build choreography at macro level. They are inspired by the same concept in Maven. In practice they are very similar to Ant targets, except that their dependencies can be defined by the dependency target using a syntax like this:
+
+<code type="xml">
+<target name="xxx" phase="yyy" />
+</code>
+This basically adds the target "xxx" to the list of dependencies of the phase "yyy".
+Usually you use only one phases definition build module.
+<table>
+ <thead>
+ <tr>
+ <td>Module name</td>
+ <td>Description</td>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>phases-std</td>
+ <td>describes the standard phases of a build. These phase are directly inspired by maven 2 standard phases.</td>
+ </tr>
+ </tbody>
+</table>
+
+See <a href="ref/phases.html">Understanding phases</a> to have more informations on phases.
+
+<h3>Plugins</h3>
+Build plugins are there to actually define each block of the build system. They interact with each other by relying on the file system and properties (for instance run-java expect java classes to be in directory pointed by ${target.main.classes}). For the whole build choreography they rely on phases. Each build plugin define the expected "parameters" (i.e. the expected properties, paths and phases) by using a parameter task like this:
+
+<code type="xml">
+<ea:parameter property="src.main.java" required="true" description="directory where sources to be compiled are" />
+</code>
+
+This is intended to be used both for validation and documentation, ATM only basic validation is performed.
+<ul>
+ <li>Java plugins
+ <ul>
+ <li>Java compilation</li>
+ <li>Javadoc generation</li>
+ <li>Run java application</li>
+ </ul>
+ </li>
+ <li>Scala plugins
+ <ul>
+ <li>Scala compilation</li>
+ <li>Scaladoc</li>
+ </ul>
+ </li>
+ <li>Packaging plugins
+ <ul>
+ <li>Manifest plugins</li>
+ <li>Packaging jar application</li>
+ <li>Packaging war application</li>
+ <li>Source packaging</li>
+ </ul>
+ </li>
+ <li>Test plugins
+ <ul>
+ <li>abstract tests (used by all *tests plugins)</li>
+ <li>Junit tests</li>
+ <li>TestNG tests</li>
+ </ul>
+ </li>
+ <li>Dependency / Publication
+ <ul>
+ <li>Common ivy tasks (Reports, clean-cache, etc...)</li>
+ <li>Dependency management (using Apache Ivy)</li>
+ <li>Publication (using Apache Ivy)</li>
+ </ul>
+ </li>
+ <li>Source Code Management Plugins
+ <ul>
+ <li>SVN</li>
+ </ul>
+ </li>
+ <li>Documentation Plugins
+ <ul>
+ <li>Documentation generation</li>
+ <li>Xooki</li>
+ </ul>
+ </li>
+ <li>Others Plugins
+ <ul>
+ <li>Clean</li>
+ <li>Resource standard</li>
+ <li>Emma coverage</li>
+ <li>Checkstyle</li>
+ <li>Jetty deployment</li>
+ <li>Skeleton plugins (manages skeleton of projects)</li>
+ </ul>
+ </li>
+</ul>
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>
Propchange: incubator/easyant/core/trunk/src/documentation/reference.html
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/reference.html
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/reference.html
------------------------------------------------------------------------------
svn:mime-type = text/html
Added: incubator/easyant/core/trunk/src/documentation/sortable.js
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/sortable.js?rev=1071697&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/sortable.js (added)
+++ incubator/easyant/core/trunk/src/documentation/sortable.js Thu Feb 17 17:01:07 2011
@@ -0,0 +1,323 @@
+/*
+Table sorting script by Joost de Valk, check it out at http://www.joostdevalk.nl/code/sortable-table/.
+Based on a script from http://www.kryogenix.org/code/browser/sorttable/.
+Distributed under the MIT license: http://www.kryogenix.org/code/browser/licence.html .
+
+Copyright (c) 1997-2007 Stuart Langridge, Joost de Valk.
+
+Version 1.5.7
+*/
+
+/* You can change these values */
+var image_path = "http://www.joostdevalk.nl/code/sortable-table/";
+var image_up = "arrow-up.gif";
+var image_down = "arrow-down.gif";
+var image_none = "arrow-none.gif";
+var europeandate = true;
+var alternate_row_colors = true;
+
+/* Don't change anything below this unless you know what you're doing */
+addEvent(window, "load", sortables_init);
+
+var SORT_COLUMN_INDEX;
+var thead = false;
+
+function sortables_init() {
+ // Find all tables with class sortable and make them sortable
+ if (!document.getElementsByTagName) return;
+ tbls = document.getElementsByTagName("table");
+ for (ti=0;ti<tbls.length;ti++) {
+ thisTbl = tbls[ti];
+ if (((' '+thisTbl.className+' ').indexOf("sortable") != -1) && (thisTbl.id)) {
+ ts_makeSortable(thisTbl);
+ }
+ }
+}
+
+function ts_makeSortable(t) {
+ if (t.rows && t.rows.length > 0) {
+ if (t.tHead && t.tHead.rows.length > 0) {
+ var firstRow = t.tHead.rows[t.tHead.rows.length-1];
+ thead = true;
+ } else {
+ var firstRow = t.rows[0];
+ }
+ }
+ if (!firstRow) return;
+
+ // We have a first row: assume it's the header, and make its contents clickable links
+ for (var i=0;i<firstRow.cells.length;i++) {
+ var cell = firstRow.cells[i];
+ var txt = ts_getInnerText(cell);
+ if (cell.className != "unsortable" && cell.className.indexOf("unsortable") == -1) {
+ cell.innerHTML = '<a href="#" class="sortheader" onclick="ts_resortTable(this, '+i+');return false;">'+txt+'<span class="sortarrow"> <img src="'+ image_path + image_none + '" alt="↓"/></span></a>';
+ }
+ }
+ if (alternate_row_colors) {
+ alternate(t);
+ }
+}
+
+function ts_getInnerText(el) {
+ if (typeof el == "string") return el;
+ if (typeof el == "undefined") { return el };
+ if (el.innerText) return el.innerText; //Not needed but it is faster
+ var str = "";
+
+ var cs = el.childNodes;
+ var l = cs.length;
+ for (var i = 0; i < l; i++) {
+ switch (cs[i].nodeType) {
+ case 1: //ELEMENT_NODE
+ str += ts_getInnerText(cs[i]);
+ break;
+ case 3: //TEXT_NODE
+ str += cs[i].nodeValue;
+ break;
+ }
+ }
+ return str;
+}
+
+function ts_resortTable(lnk, clid) {
+ var span;
+ for (var ci=0;ci<lnk.childNodes.length;ci++) {
+ if (lnk.childNodes[ci].tagName && lnk.childNodes[ci].tagName.toLowerCase() == 'span') span = lnk.childNodes[ci];
+ }
+ var spantext = ts_getInnerText(span);
+ var td = lnk.parentNode;
+ var column = clid || td.cellIndex;
+ var t = getParent(td,'TABLE');
+ // Work out a type for the column
+ if (t.rows.length <= 1) return;
+ var itm = "";
+ var i = 0;
+ while (itm == "" && i < t.tBodies[0].rows.length) {
+ var itm = ts_getInnerText(t.tBodies[0].rows[i].cells[column]);
+ itm = trim(itm);
+ if (itm.substr(0,4) == "<!--" || itm.length == 0) {
+ itm = "";
+ }
+ i++;
+ }
+ if (itm == "") return;
+ sortfn = ts_sort_caseinsensitive;
+ if (itm.match(/^\d\d[\/\.-][a-zA-z][a-zA-Z][a-zA-Z][\/\.-]\d\d\d\d$/)) sortfn = ts_sort_date;
+ if (itm.match(/^\d\d[\/\.-]\d\d[\/\.-]\d\d\d{2}?$/)) sortfn = ts_sort_date;
+ if (itm.match(/^-?[£$Û¢´]\d/)) sortfn = ts_sort_numeric;
+ if (itm.match(/^-?(\d+[,\.]?)+(E[-+][\d]+)?%?$/)) sortfn = ts_sort_numeric;
+ SORT_COLUMN_INDEX = column;
+ var firstRow = new Array();
+ var newRows = new Array();
+ for (k=0;k<t.tBodies.length;k++) {
+ for (i=0;i<t.tBodies[k].rows[0].length;i++) {
+ firstRow[i] = t.tBodies[k].rows[0][i];
+ }
+ }
+ for (k=0;k<t.tBodies.length;k++) {
+ if (!thead) {
+ // Skip the first row
+ for (j=1;j<t.tBodies[k].rows.length;j++) {
+ newRows[j-1] = t.tBodies[k].rows[j];
+ }
+ } else {
+ // Do NOT skip the first row
+ for (j=0;j<t.tBodies[k].rows.length;j++) {
+ newRows[j] = t.tBodies[k].rows[j];
+ }
+ }
+ }
+ newRows.sort(sortfn);
+ if (span.getAttribute("sortdir") == 'down') {
+ ARROW = ' <img src="'+ image_path + image_down + '" alt="↓"/>';
+ newRows.reverse();
+ span.setAttribute('sortdir','up');
+ } else {
+ ARROW = ' <img src="'+ image_path + image_up + '" alt="↑"/>';
+ span.setAttribute('sortdir','down');
+ }
+ // We appendChild rows that already exist to the tbody, so it moves them rather than creating new ones
+ // don't do sortbottom rows
+ for (i=0; i<newRows.length; i++) {
+ if (!newRows[i].className || (newRows[i].className && (newRows[i].className.indexOf('sortbottom') == -1))) {
+ t.tBodies[0].appendChild(newRows[i]);
+ }
+ }
+ // do sortbottom rows only
+ for (i=0; i<newRows.length; i++) {
+ if (newRows[i].className && (newRows[i].className.indexOf('sortbottom') != -1))
+ t.tBodies[0].appendChild(newRows[i]);
+ }
+ // Delete any other arrows there may be showing
+ var allspans = document.getElementsByTagName("span");
+ for (var ci=0;ci<allspans.length;ci++) {
+ if (allspans[ci].className == 'sortarrow') {
+ if (getParent(allspans[ci],"table") == getParent(lnk,"table")) { // in the same table as us?
+ allspans[ci].innerHTML = ' <img src="'+ image_path + image_none + '" alt="↓"/>';
+ }
+ }
+ }
+ span.innerHTML = ARROW;
+ alternate(t);
+}
+
+function getParent(el, pTagName) {
+ if (el == null) {
+ return null;
+ } else if (el.nodeType == 1 && el.tagName.toLowerCase() == pTagName.toLowerCase()) {
+ return el;
+ } else {
+ return getParent(el.parentNode, pTagName);
+ }
+}
+
+function sort_date(date) {
+ // y2k notes: two digit years less than 50 are treated as 20XX, greater than 50 are treated as 19XX
+ dt = "00000000";
+ if (date.length == 11) {
+ mtstr = date.substr(3,3);
+ mtstr = mtstr.toLowerCase();
+ switch(mtstr) {
+ case "jan": var mt = "01"; break;
+ case "feb": var mt = "02"; break;
+ case "mar": var mt = "03"; break;
+ case "apr": var mt = "04"; break;
+ case "may": var mt = "05"; break;
+ case "jun": var mt = "06"; break;
+ case "jul": var mt = "07"; break;
+ case "aug": var mt = "08"; break;
+ case "sep": var mt = "09"; break;
+ case "oct": var mt = "10"; break;
+ case "nov": var mt = "11"; break;
+ case "dec": var mt = "12"; break;
+ // default: var mt = "00";
+ }
+ dt = date.substr(7,4)+mt+date.substr(0,2);
+ return dt;
+ } else if (date.length == 10) {
+ if (europeandate == false) {
+ dt = date.substr(6,4)+date.substr(0,2)+date.substr(3,2);
+ return dt;
+ } else {
+ dt = date.substr(6,4)+date.substr(3,2)+date.substr(0,2);
+ return dt;
+ }
+ } else if (date.length == 8) {
+ yr = date.substr(6,2);
+ if (parseInt(yr) < 50) {
+ yr = '20'+yr;
+ } else {
+ yr = '19'+yr;
+ }
+ if (europeandate == true) {
+ dt = yr+date.substr(3,2)+date.substr(0,2);
+ return dt;
+ } else {
+ dt = yr+date.substr(0,2)+date.substr(3,2);
+ return dt;
+ }
+ }
+ return dt;
+}
+
+function ts_sort_date(a,b) {
+ dt1 = sort_date(ts_getInnerText(a.cells[SORT_COLUMN_INDEX]));
+ dt2 = sort_date(ts_getInnerText(b.cells[SORT_COLUMN_INDEX]));
+
+ if (dt1==dt2) {
+ return 0;
+ }
+ if (dt1<dt2) {
+ return -1;
+ }
+ return 1;
+}
+function ts_sort_numeric(a,b) {
+ var aa = ts_getInnerText(a.cells[SORT_COLUMN_INDEX]);
+ aa = clean_num(aa);
+ var bb = ts_getInnerText(b.cells[SORT_COLUMN_INDEX]);
+ bb = clean_num(bb);
+ return compare_numeric(aa,bb);
+}
+function compare_numeric(a,b) {
+ var a = parseFloat(a);
+ a = (isNaN(a) ? 0 : a);
+ var b = parseFloat(b);
+ b = (isNaN(b) ? 0 : b);
+ return a - b;
+}
+function ts_sort_caseinsensitive(a,b) {
+ aa = ts_getInnerText(a.cells[SORT_COLUMN_INDEX]).toLowerCase();
+ bb = ts_getInnerText(b.cells[SORT_COLUMN_INDEX]).toLowerCase();
+ if (aa==bb) {
+ return 0;
+ }
+ if (aa<bb) {
+ return -1;
+ }
+ return 1;
+}
+function ts_sort_default(a,b) {
+ aa = ts_getInnerText(a.cells[SORT_COLUMN_INDEX]);
+ bb = ts_getInnerText(b.cells[SORT_COLUMN_INDEX]);
+ if (aa==bb) {
+ return 0;
+ }
+ if (aa<bb) {
+ return -1;
+ }
+ return 1;
+}
+function addEvent(elm, evType, fn, useCapture)
+// addEvent and removeEvent
+// cross-browser event handling for IE5+, NS6 and Mozilla
+// By Scott Andrew
+{
+ if (elm.addEventListener){
+ elm.addEventListener(evType, fn, useCapture);
+ return true;
+ } else if (elm.attachEvent){
+ var r = elm.attachEvent("on"+evType, fn);
+ return r;
+ } else {
+ alert("Handler could not be removed");
+ }
+}
+function clean_num(str) {
+ str = str.replace(new RegExp(/[^-?0-9.]/g),"");
+ return str;
+}
+function trim(s) {
+ return s.replace(/^\s+|\s+$/g, "");
+}
+function alternate(table) {
+ // Take object table and get all it's tbodies.
+ var tableBodies = table.getElementsByTagName("tbody");
+ // Loop through these tbodies
+ for (var i = 0; i < tableBodies.length; i++) {
+ // Take the tbody, and get all it's rows
+ var tableRows = tableBodies[i].getElementsByTagName("tr");
+ // Loop through these rows
+ // Start at 1 because we want to leave the heading row untouched
+ for (var j = 0; j < tableRows.length; j++) {
+ // Check if j is even, and apply classes for both possible results
+ if ( (j % 2) == 0 ) {
+ if ( !(tableRows[j].className.indexOf('odd') == -1) ) {
+ tableRows[j].className = tableRows[j].className.replace('odd', 'even');
+ } else {
+ if ( tableRows[j].className.indexOf('even') == -1 ) {
+ tableRows[j].className += " even";
+ }
+ }
+ } else {
+ if ( !(tableRows[j].className.indexOf('even') == -1) ) {
+ tableRows[j].className = tableRows[j].className.replace('even', 'odd');
+ } else {
+ if ( tableRows[j].className.indexOf('odd') == -1 ) {
+ tableRows[j].className += " odd";
+ }
+ }
+ }
+ }
+ }
+}
Propchange: incubator/easyant/core/trunk/src/documentation/sortable.js
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: incubator/easyant/core/trunk/src/documentation/sortable.js
------------------------------------------------------------------------------
svn:keywords = Date Revision Author HeadURL Id
Propchange: incubator/easyant/core/trunk/src/documentation/sortable.js
------------------------------------------------------------------------------
svn:mime-type = text/plain