incubator-easyant-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jlboud...@apache.org
Subject svn commit: r1388609 - in /incubator/easyant/core/trunk/src/documentation: ./ ref/ ref/anttasks/
Date Fri, 21 Sep 2012 18:43:12 GMT
Author: jlboudart
Date: Fri Sep 21 18:43:12 2012
New Revision: 1388609

URL: http://svn.apache.org/viewvc?rev=1388609&view=rev
Log:
Update tasks documentations

Added:
    incubator/easyant/core/trunk/src/documentation/ref/anttasks/ConfigureBuildScopedRepository.html
    incubator/easyant/core/trunk/src/documentation/ref/anttasks/FindParentDir.html
    incubator/easyant/core/trunk/src/documentation/ref/anttasks/GoOffline.html
    incubator/easyant/core/trunk/src/documentation/ref/anttasks/SearchModule.html
    incubator/easyant/core/trunk/src/documentation/ref/anttasks/configureEasyantIvyInstance.html
    incubator/easyant/core/trunk/src/documentation/ref/anttasks/import-test-module.html
    incubator/easyant/core/trunk/src/documentation/ref/anttasks/plugin-report.html
Modified:
    incubator/easyant/core/trunk/src/documentation/ref/anttasks.html
    incubator/easyant/core/trunk/src/documentation/ref/anttasks/BindTarget.html
    incubator/easyant/core/trunk/src/documentation/toc.json

Modified: 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=1388609&r1=1388608&r2=1388609&view=diff
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks.html (original)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks.html Fri Sep 21 18:43:12 2012
@@ -24,7 +24,9 @@
 <body>
     <textarea id="xooki-source">
 <h1>Ant Tasks</h1>
-EasyAnt comes with a few Ant tasks.
+EasyAnt comes with a few Ant tasks, that can be used in your module.ant file or in your own
plugin.
+
+Most of them are already used by easyant itself.
 
 To use those tasks you should add the following namespace to your ant header.
 <code type="xml">

Modified: 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=1388609&r1=1388608&r2=1388609&view=diff
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/BindTarget.html (original)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/BindTarget.html Fri Sep 21
18:43:12 2012
@@ -27,8 +27,8 @@
 
 <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).
+This targets allow to change the mapping between targets and extensionPoint.
+Usually it's usefull when you want to attach some extra targets to the default lifecycle,
or to other plugin hooks.
 </p>
 
 <h2>Arguments</h2>
@@ -41,18 +41,18 @@ Usually it's usefull when you want to at
     </tr>
   </thead>
   <tbody>
-    <tr>
+    <tr id="mandatory">
       <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>extensionOf</td>
+      <td>specify extensionPoint 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>buildConfigurations</td>
       <td>specify one a many build configurations separated by a comma</td>
       <td> </td>
     </tr>
@@ -60,14 +60,14 @@ Usually it's usefull when you want to at
 </table>
 
 <h2>Example</h2>
-Bind test-jar:jar target to package phase
+Bind test-jar:jar target to package 
 <code type="xml">
-  <ea:bindtarget target="test-jar:jar" tophase="package"/>
+  <ea:bindtarget target="test-jar:jar" extensionOf="package"/>
 </code>
 
-Unbind mytarget target from current phase mapping
+Unbind mytarget target from current extensionPoint mapping
 <code type="xml">
-  <ea:bindtarget target="test-jar:jar" tophase="package"/>
+  <ea:bindtarget target="test-jar:jar"/>
 </code>
 </textarea>
 <script type="text/javascript">xooki.postProcess();</script>

Added: incubator/easyant/core/trunk/src/documentation/ref/anttasks/ConfigureBuildScopedRepository.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/ConfigureBuildScopedRepository.html?rev=1388609&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/ConfigureBuildScopedRepository.html
(added)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/ConfigureBuildScopedRepository.html
Fri Sep 21 18:43:12 2012
@@ -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: 2};</script>	
+	<script type="text/javascript" src="../../xooki/xooki.js"></script>
+</head>
+<body>
+	<textarea id="xooki-source">
+<h1>configure-build-scoped-repository</h1>
+
+<h2>Description</h2>
+<p>
+This task is used to configure a build scoped repository This can be particularly usefull
if we are working in a multi-module project with interdependencies. But it can also be used
to configure dynamix filesystem resolvers.
+</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>resolver name</td>
+      <td> </td>
+    </tr>
+    <tr>
+      <td>target</td>
+      <td>basedir of the build repository</td>
+      <td> </td>
+    </tr>
+    <tr>
+      <td>dictator</td>
+      <td>specify if this repository should acts as dictator resolver<i>Default:
false</i></td>
+      <td> </td>
+    </tr>
+    <tr>
+      <td>generateWrapperResolver</td>
+      <td>specify if this repository should generate a wrapper resolver of existing
resolvers (ignore when using dictator true) <i>Default: true</i></td>
+      <td> </td>
+    </tr>
+    <tr>
+      <td>ivyPattern</td>
+      <td>specify ivyPattern <i>Default: /[organisation]/[module]/[revision]/[module].ivy</i></td>
+      <td> </td>
+    </tr>
+    <tr>
+      <td>artifactPattern</td>
+      <td>specify artifactPattern <i>Default: /[organisation]/[module]/[revision]/[artifact](-[classifier]).[ext]</i></td>
+      <td> </td>
+    </tr>
+  </tbody>
+</table>
+
+<h2>Example</h2>
+<code type="xml">
+  <ea:configure-build-scoped-repository name="my-own-repo" target="/path/to/basedir"/>
+</code>
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>

Added: incubator/easyant/core/trunk/src/documentation/ref/anttasks/FindParentDir.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/FindParentDir.html?rev=1388609&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/FindParentDir.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/FindParentDir.html Fri Sep
21 18:43:12 2012
@@ -0,0 +1,79 @@
+<!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>findparentdir task</h1>
+
+<h2>Description</h2>
+<p>Find parent directory containing a given file.
+</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>filename</td>
+      <td>file name to find</td>
+      <td>true</td>
+    </tr>
+    <tr id="mandatory">
+      <td>property</td>
+      <td>property name where result will be stored</td>
+      <td>true</td>
+    </tr>
+    <tr>
+      <td>haltonmissing</td>
+      <td>Specifiy if we should stop when parent directory doesn't contain the requested
filename <i>Default: true</i></td>
+      <td> </td>
+    </tr>
+    <tr>
+      <td>haltonfirstfound</td>
+      <td>Specify if we should stop when first requested filename is found. Set it
to false if you want to find the highest directory containing the requested file. <i>Default:
false</i></td>
+      <td> </td>
+    </tr>
+  </tbody>
+</table>
+
+<h2>Example</h2> 
+Find the highest module.ivy
+<code type="xml">
+  <ea:findparentdir filename="module.ivy" property="highest.parent.module.ivy"/>
+</code>
+
+Locate the first module.ivy we assume that a user can be in a subdirectory of the project
+<code type="xml">
+  <ea:findparentdir filename="module.ivy" property="highest.parent.module.ivy" haltonfirstfound="true"/>
+</code></textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>

Added: incubator/easyant/core/trunk/src/documentation/ref/anttasks/GoOffline.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/GoOffline.html?rev=1388609&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/GoOffline.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/GoOffline.html Fri Sep 21
18:43:12 2012
@@ -0,0 +1,71 @@
+<!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>go-offline task</h1>
+
+<h2>Description</h2>
+<p>
+ Provide go offline feature. It retrieves all easyant modules used by the project (plugins,
buildtype) and all project dependencies. You can then define target resolver name where all
artifacts will get installed. You can combine
+ GoOffline task with ConfigureBuildScopeRepository, to have everything embedded in your project
directory
+</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>moduleIvy</td>
+      <td>module ivy file</td>
+      <td>true</td>
+    </tr>
+    <tr>
+      <td>projectResolverName</td>
+      <td>a project resolver name where project dependencies could be stored for offline
use</td>
+      <td> </td>
+    </tr>
+    <tr>
+      <td>easyantResolverName</td>
+      <td>a easyant resolver name where plugin and their dependencies could be stored
for offline use</td>
+      <td> </td>
+    </tr>
+  </tbody>
+</table>
+
+<h2>Example</h2>
+<code type="xml">
+  <ea:go-offline moduleIvy="module.ivy" projectResolverName="myProjectResolverName" easyantResolverName="myEasyAntResolverName"/>
+</code>
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>

Added: incubator/easyant/core/trunk/src/documentation/ref/anttasks/SearchModule.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/SearchModule.html?rev=1388609&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/SearchModule.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/SearchModule.html Fri Sep
21 18:43:12 2012
@@ -0,0 +1,107 @@
+<!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>searchmodule task</h1>
+
+<h2>Description</h2>
+<p>
+This is an interactive task designed to search ivy modules, ask user to select a result and
store user selected item in properties.
+Properties needs to be prefixed like :
+<ul>
+  <li>MYPREFIX.org</li>
+  <li>MYPREFIX.module</li>
+  <li>MYPREFIX.rev</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>organisation</td>
+      <td>organisation name to search</td>
+      <td>true</td>
+    </tr>
+
+    <tr id="mandatory">
+      <td>module</td>
+      <td>module name to search</td>
+      <td>true</td>
+    </tr>
+
+    <tr id="mandatory">
+      <td>revision</td>
+      <td>revision to search</td>
+      <td>true</td>
+    </tr>
+
+    <tr id="mandatory">
+      <td>propertyPrefix</td>
+      <td>property prefix used to store results</td>
+      <td>true</td>
+    </tr>
+
+    <tr>
+      <td>branch</td>
+      <td>branch name to search <i>Default: *</i></td>
+      <td> </td>
+    </tr>
+
+    <tr>
+      <td>matcher</td>
+      <td>matcher name user for search <i>Default: exactOrRegexp</i></td>
+      <td> </td>
+    </tr>
+
+    <tr>
+      <td>resolver</td>
+      <td>restrict search on the specified resolver name<i>Default: default resolver
configured in ivy instance</i></td>
+      <td> </td>
+    </tr>
+  </tbody>
+</table>
+
+<h2>Example</h2>
+Select all skeletons and all their versions. 
+<code type="xml">
+  <ea:searchmodule organisation="org.apache.easyant.skeletons" module="*" revision="*"
propertyPrefix="MYPREFIX" />
+</code>
+
+<div id="note">
+This is for example performed in skeleton plugin.
+</div>
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>

Added: incubator/easyant/core/trunk/src/documentation/ref/anttasks/configureEasyantIvyInstance.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/configureEasyantIvyInstance.html?rev=1388609&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/configureEasyantIvyInstance.html
(added)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/configureEasyantIvyInstance.html
Fri Sep 21 18:43:12 2012
@@ -0,0 +1,60 @@
+<!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>configure-easyant-ivy-instance task</h1>
+
+<h2>Description</h2>
+<p>
+Configure easyant ivy instance in current project
+</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>easyantConfiguration</td>
+      <td>path to easyant configuration file</td>
+      <td> </td>
+    </tr>
+  </tbody>
+</table>
+
+<h2>Example</h2>
+<code type="xml">
+  <ea:configure-easyant-ivy-instance />
+</code>
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>

Added: incubator/easyant/core/trunk/src/documentation/ref/anttasks/import-test-module.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/import-test-module.html?rev=1388609&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/import-test-module.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/import-test-module.html Fri
Sep 21 18:43:12 2012
@@ -0,0 +1,99 @@
+<!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-test-module</h1>
+
+<h2>Description</h2>
+
+Alternative <a href="Importtask.html">Import</a> module implementation. 
+This implementation is designed for plugin's test purpose. It doesn't take in consideration
: skipping module or buildConfiguration features.
+
+<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>moduleIvy</td>
+      <td>moduleIvy file name</td>
+      <td>true</td>
+    </tr>
+    <tr id="mandatory">
+      <td>sourceDirectory</td>
+      <td>directory containing ant files</td>
+      <td>true</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>
+    <tr>
+      <td>mainConf</td>
+      <td>list of main ivy configurations used for artifact resolution serated by commas<br/><i>Default:
default</i></td>
+      <td> </td>
+    </tr>
+    <tr>
+      <td>providedConf</td>
+      <td>list of provided ivy configurations used for artifact resolution serated
by commas<br/><i>Default: provided</i></td>
+      <td> </td>
+    </tr>
+    <tr>
+      <td>changing</td>
+      <td>specify if easyant should check changing artifacts on each call<br/><i>Default:
false</i></td>
+      <td> </td>
+    </tr>
+  </tbody>
+</table>
+
+<h2>Examples</h2>
+<code type="xml">
+<ea:import-test-module moduleIvy="/path/to/module.ivy" sourceDirectory="/path/to/sourcedirectory"/>
+</code></textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>

Added: incubator/easyant/core/trunk/src/documentation/ref/anttasks/plugin-report.html
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/ref/anttasks/plugin-report.html?rev=1388609&view=auto
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/ref/anttasks/plugin-report.html (added)
+++ incubator/easyant/core/trunk/src/documentation/ref/anttasks/plugin-report.html Fri Sep
21 18:43:12 2012
@@ -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: 2};</script>	
+	<script type="text/javascript" src="../../xooki/xooki.js"></script>
+</head>
+<body>
+	<textarea id="xooki-source">
+<h1>plugin-report task</h1>
+
+<h2>Description</h2>
+<p>
+This task will generate plugin documentation.
+</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>moduleIvy</td>
+      <td>moduleIvy file used to extract plugin metadata (dependencies, versino etc...)</td>
+      <td>true</td>
+    </tr>
+    <tr id="mandatory">
+      <td>sourceDirectory</td>
+      <td>source directory where plugin file are</td>
+      <td>true</td>
+    </tr>
+
+    <tr>
+      <td>xslext</td>
+      <td>extension name of produced file<i>Default : html</i></td>
+      <td></td>
+    </tr>
+
+    <tr>
+      <td>todir</td>
+      <td>targed directory where documentation will be generated<i>Default :
${basedir}</i></td>
+      <td></td>
+    </tr>
+
+    <tr>
+      <td>conf</td>
+      <td>Ivy conf used in the report<i>Default : *</i></td>
+      <td></td>
+    </tr>
+
+    <tr>
+      <td>xslFile</td>
+      <td>Xsl used to generate output file<i>Default : default one of easyant</i></td>
+      <td></td>
+    </tr>
+
+    <tr>
+      <td>outputpattern</td>
+      <td>Output pattern for produced files<i>Default : [organisation]-[module]-[conf].[ext]</i></td>
+      <td></td>
+    </tr>
+  </tbody>
+</table>
+
+<h2>Example</h2>
+<code type="xml">
+<ea:plugin-report moduleIvy="${basedir}/module.ivy" sourceDirectory="${basedir}/src/main/resources"
conf="default"/>
+</code>
+</textarea>
+<script type="text/javascript">xooki.postProcess();</script>
+</body>
+</html>

Modified: incubator/easyant/core/trunk/src/documentation/toc.json
URL: http://svn.apache.org/viewvc/incubator/easyant/core/trunk/src/documentation/toc.json?rev=1388609&r1=1388608&r2=1388609&view=diff
==============================================================================
--- incubator/easyant/core/trunk/src/documentation/toc.json (original)
+++ incubator/easyant/core/trunk/src/documentation/toc.json Fri Sep 21 18:43:12 2012
@@ -110,6 +110,20 @@
                             ]
                         },
                         {
+                          "id":"ref/anttasks/ConfigureBuildScopedRepository",
+                          "title":"configure-build-scoped-repository",
+                          "children": [
+
+                            ]
+                        },
+                        {
+                          "id":"ref/anttasks/configureEasyantIvyInstance",
+                          "title":"configure-easyant-ivy-instance",
+                          "children": [
+
+                            ]
+                        },
+                        {
                           "id":"ref/anttasks/CoreVersiontask",
                           "title":"core-version",
                           "children": [
@@ -151,6 +165,20 @@
                             ]
                         },
                         {
+                          "id":"ref/anttasks/FindParentDir",
+                          "title":"findparentdir",
+                          "children": [
+
+                            ]
+                        },
+                        {
+                          "id":"ref/anttasks/GoOffline",
+                          "title":"go-offline",
+                          "children": [
+
+                            ]
+                        },
+                        {
                           "id":"ref/anttasks/Importtask",
                           "title":"import",
                           "children": [
@@ -167,6 +195,13 @@
                                 "children": [
 
                                   ]
+                              },
+                              {
+                                "id":"ref/anttasks/import-test-module",
+                                "title":"import-test-module",
+                                "children": [
+
+                                  ]
                               }
                             ]
                         },
@@ -192,6 +227,13 @@
                             ]
                         },
                         {
+                          "id":"ref/anttasks/plugin-report",
+                          "title":"plugin-report",
+                          "children": [
+
+                            ]
+                        },
+                        {
                           "id":"ref/anttasks/Property",
                           "title":"property",
                           "children": [
@@ -206,6 +248,13 @@
                             ]
                         },
                         {
+                          "id":"ref/anttasks/SearchModule",
+                          "title":"searchmodule",
+                          "children": [
+
+                            ]
+                        },
+                        {
                           "id":"ref/anttasks/SubModuletask",
                           "title":"submodule",
                           "children": [



Mime
View raw message