avalon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mcconn...@apache.org
Subject svn commit: rev 21533 - in avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks: common extras production
Date Mon, 21 Jun 2004 10:42:48 GMT
Author: mcconnell
Date: Mon Jun 21 03:42:47 2004
New Revision: 21533

Added:
   avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/extras/init.xml
Removed:
   avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/init.xml
Modified:
   avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/clean.xml
   avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/home.xml
   avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/index.xml
   avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/info.xml
   avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/prepare.xml
   avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/extras/index.xml
   avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/extras/navigation.xml
   avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/extras/plugin.xml
   avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/index.xml
   avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/javac.xml
   avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/navigation.xml
Log:
more docs

Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/clean.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/clean.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/clean.xml	Mon Jun
21 03:42:47 2004
@@ -12,7 +12,7 @@
       The clean task deletes the ${basedir}/target directory.
       </p>
 <source><![CDATA[
-    <x:clean/>
+<x:clean/>
 ]]></source>
 
       <p><i>Example output of the clean task:</i></p>

Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/home.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/home.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/home.xml	Mon Jun
21 03:42:47 2004
@@ -30,9 +30,8 @@
       </p>
 
 <source><![CDATA[
-  <property name="project.home" value=".."/>
-
-  <x:home/>
+<property name="project.home" value=".."/>
+<x:home/>
 ]]></source>
 
 <pre>
@@ -112,7 +111,7 @@
       </p>
 
 <source><![CDATA[
-  <x:home index="../../released-packages.xml"/>
+<x:home index="../../released-packages.xml"/>
 ]]></source>
 
       <p>
@@ -121,9 +120,8 @@
       </p>
 
 <source><![CDATA[
-  <property name="project.home" value=".."/>
-
-  <x:home/>
+<property name="project.home" value=".."/>
+<x:home/>
 ]]></source>
 
       <p>

Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/index.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/index.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/index.xml	Mon Jun
21 03:42:47 2004
@@ -9,6 +9,9 @@
   <body>
     <section name="Common Tasks">
       <p>
+      The common tasks provide support for the establish of the Magic
+      project model, parameterized filters, build preperation, and 
+      cleaning.
       </p>
     </section>
   </body>

Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/info.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/info.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/info.xml	Mon Jun
21 03:42:47 2004
@@ -13,7 +13,7 @@
       </p>
 
 <source><![CDATA[
-    <x:info/>
+<x:info/>
 ]]></source>
 
       <p>

Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/prepare.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/prepare.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/prepare.xml	Mon Jun
21 03:42:47 2004
@@ -19,7 +19,7 @@
       </p>
 
 <source><![CDATA[
-    <x:prepare/>
+<x:prepare/>
 ]]></source>
 
 <pre>

Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/extras/index.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/extras/index.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/extras/index.xml	Mon Jun
21 03:42:47 2004
@@ -7,8 +7,12 @@
   </properties> 
 
   <body>
-    <section name="Production Tasks">
+    <section name="Plugin Management Tasks">
       <p>
+      A set of tasks are provided that support plugin meta-data generation,
+      initialization of dependendent plugin loading relative to a project
+      defintion, plugin classloader creation and plugin deployment, and 
+      tasks supporting repository-enabled factory meta-data creation. 
       </p>
     </section>
   </body>

Added: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/extras/init.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/extras/init.xml	Mon Jun
21 03:42:47 2004
@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+
+  <properties>
+    <author email="dev@avalon.apache.org">Avalon Documentation Team</author>
+    <title>Avalon Central</title>
+  </properties> 
+
+  <body>
+    <section name="Init Task">
+      <p>
+      The init task loads and initializes any plugins declared 
+      as dependents by a project defintion. 
+      </p>
+<source><![CDATA[
+<x:init/>
+]]></source>
+<pre>
+init:
+   [plugin] Install "plugin:avalon/meta/avalon-meta-tools"
+   [plugin] Task "plugin:avalon/meta/avalon-meta-tools:meta"
+</pre>
+    </section>
+  </body>
+
+</document>
+

Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/extras/navigation.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/extras/navigation.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/extras/navigation.xml	Mon
Jun 21 03:42:47 2004
@@ -23,10 +23,11 @@
 
  <body>
     <menu>
-      <item name="Reactor" href="reactor.html"/>
+      <item name="Init" href="init.html"/>
       <item name="Plugin" href="plugin.html"/>
       <item name="Declare" href="declare.html"/>
       <item name="Artifact" href="artifact.html"/>
+      <item name="Reactor" href="reactor.html"/>
     </menu>
  </body>
 

Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/extras/plugin.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/extras/plugin.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/extras/plugin.xml	Mon Jun
21 03:42:47 2004
@@ -25,11 +25,49 @@
 <x:plugin artifact="plugin:avalon/meta/avalon-meta-tools#1.4.0"/>
 ]]></source>
       <p>
-      Plugins referenced by the plugin task should use the 
-      <a href="prepare.html">declare</a> task to genrate and register the 
-      appropriate plugin meta-data. 
+      An example of the plugins meta-data generated by the 
+      <a href="declare.html">declare</a> and used by the plugin task
+      to construct the plugin classloader, tasks and listeners is
+      shown below.
       </p>
-
+
+<source><![CDATA[
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<plugin>
+  <info>
+    <name>avalon-meta-tools</name>
+    <group>avalon/meta</group>
+    <version>1.4.0</version>
+    <type>plugin</type>
+  </info>
+  <tasks>
+    <taskdef name="meta" class="org.apache.avalon.meta.info.ant.MetaTask"/>
+  </tasks>
+  <listeners>
+    <listener class="org.apache.avalon.meta.info.ant.MetaBuildListener"/>
+  </listeners>
+  <classpath>
+    <jar>avalon/meta/avalon-meta-impl#1.4.0</jar>
+    <jar>avalon/meta/avalon-meta-spi#1.4.0</jar>
+    <jar>avalon/meta/avalon-meta-api#1.4.0</jar>
+    <jar>avalon/framework/avalon-framework-api#4.2.1</jar>
+    <jar>avalon/util/avalon-util-i18n#1.0.0</jar>
+    <jar>avalon/util/avalon-util-configuration#1.0.0</jar>
+    <jar>avalon/framework/avalon-framework-impl#4.2.1</jar>
+    <jar>avalon/framework/avalon-framework-legacy#4.2.1</jar>
+    <jar>avalon/logkit/avalon-logkit#2.0.0</jar>
+    <jar>log4j/log4j#1.2.8</jar>
+    <jar>servletapi/servletapi#2.3</jar>
+    <jar>avalon/tools/mailapi#1.3.1</jar>
+    <jar>avalon/tools/jms#1.1</jar>
+    <jar>qdox/qdox#1.3</jar>
+    <jar>avalon/meta/avalon-meta-tools#1.4.0</jar>
+  </classpath>
+</plugin>
+
+]]></source>
+
     </section>
   </body>
 

Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/index.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/index.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/index.xml	Mon
Jun 21 03:42:47 2004
@@ -9,7 +9,10 @@
   <body>
     <section name="Production Tasks">
       <p>
-      </p>
+      The production tasks provide support for plugin auto-loading, 
+      java source compilation, jar and bar file creation, junit testing,
+      and deliverable installation into the artifact repository.
+      </p>
     </section>
   </body>
 

Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/javac.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/javac.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/javac.xml	Mon
Jun 21 03:42:47 2004
@@ -9,10 +9,46 @@
   <body>
     <section name="Javac Task">
       <p>
+      Compiles source in ${basedir}/target/build/main to classes
+      under the ${basedir}/target/classes directory. Any files 
+      in build/main excluding java sources and package.html files 
+      are copied to the classes directory along with all files
+      from the target/build/etc/main directory.
       </p>
 <source><![CDATA[
-    <x:javac/>
+<x:javac/>
 ]]></source>
+
+<pre>
+build:
+    [javac] Compiling 5 source files to F:\dev\avalon\planet\tutorials\dynamics\target\classes
+     [copy] Copying 1 file to F:\dev\avalon\planet\tutorials\dynamics\target\classes
+</pre>
+
+    <subsection name="Properties">
+      
+      <p>
+      The following properties may be used to customize the 
+      input paths for source content.
+      </p>
+
+      <table>
+        <tr><th>Property</th><th>Description</th></tr>
+        <tr>
+          <td>${java.compile.debug}</td>
+          <td>Sets the debug compilation mode to 'true' or 'false'.
+           Default is false.</td>
+        </tr>
+        <tr>
+          <td>${java.compile.fork}</td>
+          <td>Sets the javac fork option to 'true' or 'false'.
+           Default is false.</td>
+        </tr>
+      </table>
+
+    </subsection>
+
+
     </section>
   </body>
 

Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/navigation.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/navigation.xml
(original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/production/navigation.xml
Mon Jun 21 03:42:47 2004
@@ -23,7 +23,6 @@
 
  <body>
     <menu>
-      <item name="Init" href="init.html"/>
       <item name="Javac" href="javac.html"/>
       <item name="Jar" href="jar.html"/>
       <item name="Bar" href="bar.html"/>

---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@avalon.apache.org
For additional commands, e-mail: cvs-help@avalon.apache.org


Mime
View raw message