avalon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mcconn...@apache.org
Subject svn commit: rev 20720 - in avalon/trunk/central/site/src/xdocs/products/runtime/tools: . ant ant/meta maven maven/merlin maven/meta
Date Mon, 31 May 2004 22:45:17 GMT
Author: mcconnell
Date: Mon May 31 15:45:16 2004
New Revision: 20720

Added:
   avalon/trunk/central/site/src/xdocs/products/runtime/tools/ant/
   avalon/trunk/central/site/src/xdocs/products/runtime/tools/ant/index.xml
   avalon/trunk/central/site/src/xdocs/products/runtime/tools/ant/meta/
   avalon/trunk/central/site/src/xdocs/products/runtime/tools/ant/meta/index.xml
   avalon/trunk/central/site/src/xdocs/products/runtime/tools/ant/meta/navigation.xml
   avalon/trunk/central/site/src/xdocs/products/runtime/tools/ant/navigation.xml
   avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/merlin/
   avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/merlin/goals.xml
   avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/merlin/index.xml
   avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/merlin/navigation.xml
   avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/merlin/properties.xml
   avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/meta/
   avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/meta/goals.xml
   avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/meta/index.xml
   avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/meta/navigation.xml
   avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/meta/properties.xml
Modified:
   avalon/trunk/central/site/src/xdocs/products/runtime/tools/index.xml
   avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/index.xml
   avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/navigation.xml
   avalon/trunk/central/site/src/xdocs/products/runtime/tools/navigation.xml
Log:


Added: avalon/trunk/central/site/src/xdocs/products/runtime/tools/ant/index.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/products/runtime/tools/ant/index.xml	Mon May 31 15:45:16
2004
@@ -0,0 +1,48 @@
+<?xml version="1.0"?>
+
+<!-- 
+ Copyright 2004 Apache Software Foundation
+ Licensed  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.
+-->
+
+<document>
+
+  <properties>
+    <author email="mcconnell@apache.org">Stephen McConnell</author>
+    <title>Merlin Runtime</title>
+  </properties>
+
+  <body>
+
+    <section name="Ant Tasks">
+      <subsection name="Index">
+        <table>
+          <tr><th>Topic</th><th>Summary</th></tr>
+          <tr>
+            <td><a href="meta/index.html">Meta-Info Generation</a></td>
+            <td>
+              Ant task supporting the automated generation of component
+              meta-info descriptors based on javadoc tag references.
+            </td>
+          </tr>
+        </table>
+      </subsection>
+    </section>
+
+  </body>
+
+</document>
+
+

Added: avalon/trunk/central/site/src/xdocs/products/runtime/tools/ant/meta/index.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/products/runtime/tools/ant/meta/index.xml	Mon May
31 15:45:16 2004
@@ -0,0 +1,158 @@
+<?xml version="1.0"?>
+
+<document>
+  <properties>
+    <author email="mcconnell@apache.org">Stephen McConnell</author>
+    <title>Meta-Info Ganerator Ant Task</title>
+  </properties>
+  <body>
+    <section name="Ant Meta-Info Generator Task">
+      <p>
+The meta info generator task scans sources files for the present of an avalon.meta tags and
based on the tag set specification, generates either XML or serialized meta-info descriptors.
+      </p>
+
+      <subsection name="Parameters">
+<table>
+  <tr>
+   <th>Parameter</th><th>Required</th><th>Value</th>
+  </tr>
+  <tr>
+    <td>destDir</td><td>true</td>
+    <td>The directory into which the generated type and service defintions wil be created.</td>
+  </tr>
+  <tr>
+    <td>format</td><td>false</td>
+    <td>The output format. May be one of <strong>xml</strong> or <strong>serial</strong>.
 The xml format is less compact but more portable.  The serial format is appropriate when
usage is know to be in the context of the Avalon Meta API.  The serial format is a serialized
representation of the corresponding Task or Service instance.</td>
+  </tr>
+  <tr>
+    <td>force</td><td>false</td>
+    <td>A boolean flag to force regenerating of the meta-files. <strong>false</strong>
(default) will generate the meta-file if the source is newer than the exisiting meta-file
or if the meta-file does not exist. <strong>true</strong> will overwrite any existing
meta-file irrespective of the modification date.</td>
+  </tr>
+  <tr>
+    <td>postfix</td><td>false</td>
+    <td>Select between "xinfo" and "xtype" as the meta-info file type that is generated.
The xtype postfix is convinient when generating meta info descriptors that must cooexist with
the Phoenix platform.</td>
+  </tr>
+</table>
+      </subsection>
+      <subsection name="Nested Elements">
+<table>
+  <tr>
+   <th>Element</th><th>Required</th><th>Value</th>
+  </tr>
+  <tr>
+    <td>fileset</td><td>true</td>
+    <td>A fileset containing the defintion of the source files to be included in the
scanning phase.</td>
+  </tr>
+</table>
+      </subsection>
+
+      <subsection name="Ant Example">
+<source><![CDATA[
+  <target name="meta" description="Generates the XML descriptors" depends="build">
+    <mkdir dir="${meta.dir}" />
+    <taskdef name="meta" classname="org.apache.avalon.meta.info.ant.MetaTask">
+      <classpath refid="project.class.path" />
+    </taskdef>
+    <meta destDir="${meta.dir}" format="xml">
+      <fileset dir="${src}">
+        <include name="**/*.java"/>
+      </fileset>
+    </meta>
+  </target>
+]]></source>
+      </subsection>
+    </section>
+    <section name="Example">
+      <subsection name="Java source with Tag markup">
+<source><![CDATA[
+
+import java.io.File;
+
+import org.apache.avalon.framework.logger.Logger;
+import org.apache.avalon.framework.logger.AbstractLogEnabled;
+import org.apache.avalon.framework.service.Serviceable;
+import org.apache.avalon.framework.service.ServiceManager;
+import org.apache.avalon.framework.service.ServiceException;
+import org.apache.avalon.framework.context.Context;
+import org.apache.avalon.framework.context.Contextualizable;
+import org.apache.avalon.framework.context.ContextException;
+
+/**
+ * An example component containing meta info under javadoc tags.
+ *
+ * @avalon.component name="secondary-component" version="2.4" lifestyle="singleton"
+ * @avalon.service type="SecondaryService:0.1"
+ */
+public class Secondary extends AbstractLogEnabled 
+  implements Serviceable, SecondaryService, Contextualizable
+{
+    private Logger m_system = null;
+    private File m_home = null;
+    private PrimaryService m_primary = null;
+
+   /**
+    * Supply of a logging channel to the component.
+    * @param logger the logging channel
+    * @avalon.logger name="system"
+    */
+    public void enableLogging( Logger logger )
+    {
+        super.enableLogging( logger );
+        m_system = logger.getChildLogger( "system" );
+    }
+
+   /**
+    * Supply of the runtime context by the container.
+    * @param context the runtime context
+    * @avalon.entry key="home" type="java.io.File"
+    */
+    public void contextualize( Context context ) throws ContextException
+    {
+        m_home = (File) context.get("home");
+    }    
+
+   /**
+    * Supply of dependent services to this component by the container.
+    * @param manager the service manager
+    * @avalon.dependency type="PrimaryService" version="1.3" key="primary"
+    */
+    public void service( ServiceManager manager ) throws ServiceException
+    {
+        m_primary = (PrimaryService) manager.lookup( "primary" );
+        m_system.info( "resolved primary service reference" );
+    }
+}
+]]></source>
+      </subsection>
+      <subsection name="Generated meta-info descriptor">
+<source><![CDATA[
+<?xml version="1.0" ?>
+<!DOCTYPE type PUBLIC "-//AVALON/Type DTD Version 1.0//EN" 
+  "http://avalon.apache.org/dtds/meta/type_1_1.dtd" >
+
+<type>
+  <info>
+    <name>secondary-component</name>
+    <version>2.4.0</version>
+    <lifestyle>singleton</lifestyle>
+  </info>
+  <loggers>
+    <logger name="system"/>
+  </loggers>
+  <context>
+    <entry key="home" type="java.io.File"/>
+  </context>
+  <services>
+    <service type="SecondaryService" version="0.1.0"/>
+  </services>
+  <dependencies>
+    <dependency key="primary" type="PrimaryService" version="1.3.0"/>
+  </dependencies>
+</type>
+]]></source>
+      </subsection>
+    </section>
+  </body>
+</document>
+
+

Added: avalon/trunk/central/site/src/xdocs/products/runtime/tools/ant/meta/navigation.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/products/runtime/tools/ant/meta/navigation.xml	Mon
May 31 15:45:16 2004
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!-- 
+ Copyright 2004 Apache Software Foundation
+ Licensed  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.
+-->
+
+<project>
+
+  <title>Merlin</title>
+
+  <body>
+    <menu>
+    </menu>
+  </body>
+
+</project>

Added: avalon/trunk/central/site/src/xdocs/products/runtime/tools/ant/navigation.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/products/runtime/tools/ant/navigation.xml	Mon May
31 15:45:16 2004
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!-- 
+ Copyright 2004 Apache Software Foundation
+ Licensed  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.
+-->
+
+<project>
+
+  <title>Merlin</title>
+
+  <body>
+    <menu>
+      <item name="Meta" href="meta/index.html"/>
+    </menu>
+  </body>
+
+</project>

Modified: avalon/trunk/central/site/src/xdocs/products/runtime/tools/index.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/products/runtime/tools/index.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/products/runtime/tools/index.xml	Mon May 31 15:45:16
2004
@@ -32,39 +32,23 @@
 The Merlin platform includes a set of developer tools that assist in the automation
 of different process contributing to reliable and consistant component development.
 These tools include an ant task supporting meta info generation for component types
-and services, and an equivalent Maven plugin. 
+and services and an equivalent Maven plugin. 
       </p>
       <subsection name="Index">
         <table>
           <tr><th>Topic</th><th>Summary</th></tr>
           <tr>
-            <td><a href="maven/index.html">Maven Plugin</a></td>
+            <td><a href="ant/index.html">Ant Tasks</a></td>
             <td>
-              The Merlin plugin for Maven that provides support for 
-              meta infor generation when building with the Maven tool.
-            </td>
-          </tr>
-        </table>
-      </subsection>
-      <subsection name="Related Resources">
-        <table>
-          <tr><th>Topic</th><th>Summary</th></tr>
-          <tr>
-            <td>
-<a href="http://avalon.apache.org/meta/tools/index.html">Avalon Meta Plugin</a></td>
-            <td>
-              Plugin for Maven and supporting ant task that provides automatic 
-              generation of meta-info component type descriptors.
-            </td>
-          </tr>
-          <tr>
-            <td>
-<a href="http://avalon.apache.org/meta/tools/index.html">Javadoc Tags</a></td>
-            <td>
-              Reference specification of the Javadoc Tags used to 
-              support automation of component and service metainfo.
+              Custom tasks supporting ant based development environments.
             </td>
           </tr>
+          <tr>
+            <td><a href="maven/index.html">Maven Plugins</a></td>
+            <td>
+              Custom plugins supporting the Maven development environment.
+            </td>
+          </tr>
         </table>
       </subsection>
     </section>

Modified: avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/index.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/index.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/index.xml	Mon May 31
15:45:16 2004
@@ -35,17 +35,16 @@
         <table>
           <tr><th>Topic</th><th>Summary</th></tr>
           <tr>
-            <td><a href="deploy.html">Goals</a></td>
-            <td>
-              Goals supporting simulated and operational component 
-              deployment within Maven.
-            </td>
+            <td><a href="meta/index.html">Meta-Info Generation</a></td>
+            <td>
+              Goal supporting the automated generation of component
+              meta-info descriptors based on javadoc tag references.
+            </td>
           </tr>
           <tr>
-            <td><a href="properties.html">Properties</a></td>
+            <td><a href="merlin/index.html">Merlin Deployment</a></td>
             <td>
-              Plugin properties enabling customization of plugin
-              behaviour.
+              Plugin that enabled simpluated deployment of a merlin block.
             </td>
           </tr>
         </table>

Added: avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/merlin/goals.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/merlin/goals.xml	Mon
May 31 15:45:16 2004
@@ -0,0 +1,54 @@
+<?xml version="1.0"?>
+
+<!-- 
+ Copyright 2004 Apache Software Foundation
+ Licensed  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.
+-->
+
+<document>
+  <properties>
+    <author email="mcconnell@apache.org">Stephen McConnell</author>
+    <title>Merlin Runtime</title>
+  </properties>
+  <body>
+    <section name="Merlin Plugin for Maven">
+      <subsection name="Goals">
+        <table>
+          <tr><th>Goal</th><th>Description</th></tr>
+          <tr>
+            <td>merlin:simulate</td>
+            <td>
+             <p>Initiates the deployment of a block based on a 
+             ${maven.build.dir}/classes/BLOCK-INF/block.xml directive. Classes 
+             under the ${maven.build.dir}/classes directory are implicity added
+             to the container classloader.</p>
+            </td>
+          </tr>
+          <tr>
+            <td>merlin:deploy</td>
+            <td>
+             <p>Initiates the deployment of a block based on a block.xml directive
+             contained in the generated jar file under the path 
+             ${maven.build.dir}/${maven.final.name}.jar.  The jar file is impliicity 
+             included within the deployment classpath.</p>
+            </td>
+          </tr>
+        </table>
+      </subsection>
+    </section>
+  </body>
+</document>
+
+

Added: avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/merlin/index.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/merlin/index.xml	Mon
May 31 15:45:16 2004
@@ -0,0 +1,59 @@
+<?xml version="1.0"?>
+
+<!-- 
+ Copyright 2004 Apache Software Foundation
+ Licensed  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.
+-->
+
+<document>
+
+  <properties>
+    <author email="mcconnell@apache.org">Stephen McConnell</author>
+    <title>Merlin Runtime</title>
+  </properties>
+
+  <body>
+
+    <section name="Merlin Plugin for Maven">
+
+      <p>
+The Merlin Plugin for Maven includes a number of developer requirements covering meta-info
generation, simulated and actual component deployment, and maven to merlin repository replication.

+      </p>
+      <subsection name="Index">
+        <table>
+          <tr><th>Topic</th><th>Summary</th></tr>
+          <tr>
+            <td><a href="goals.html">Goals</a></td>
+            <td>
+              Goals supporting simulated and operational component 
+              deployment within Maven.
+            </td>
+          </tr>
+          <tr>
+            <td><a href="properties.html">Properties</a></td>
+            <td>
+              Plugin properties enabling customization of plugin
+              behaviour.
+            </td>
+          </tr>
+        </table>
+      </subsection>
+    </section>
+
+  </body>
+
+</document>
+
+

Added: avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/merlin/navigation.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/merlin/navigation.xml
Mon May 31 15:45:16 2004
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!-- 
+ Copyright 2004 Apache Software Foundation
+ Licensed  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.
+-->
+
+<project>
+
+  <title>Merlin</title>
+
+  <body>
+    <menu>
+      <item name="Goals" href="goals.html"/>
+      <item name="Properties" href="properties.html"/>
+    </menu>
+  </body>
+
+</project>

Added: avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/merlin/properties.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/merlin/properties.xml
Mon May 31 15:45:16 2004
@@ -0,0 +1,74 @@
+<?xml version="1.0"?>
+
+<!-- 
+ Copyright 2004 Apache Software Foundation
+ Licensed  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.
+-->
+
+<document>
+  <properties>
+    <author email="mcconnell@apache.org">Stephen McConnell</author>
+    <title>Merlin Runtime</title>
+  </properties>
+  <body>
+    <section name="Merlin Plugin for Maven">
+      <subsection name="Properties">
+        <table>
+          <tr><th>Property</th><th>Description</th></tr>
+          <tr>
+            <td>merlin.anchor.dir</td>
+            <td>
+             <p>Optional base directory against which classpath library directory
+                references will be resolved.</p>
+            </td>
+          </tr>
+          <tr>
+            <td>merlin.repository.local</td>
+            <td>
+             <p>Declaration of an alternative bootstrap repository.</p>
+            </td>
+          </tr>
+          <tr>
+            <td>merlin.kernel</td>
+            <td>
+             <p>Relative or absolute file path to the kernel configuration.</p>
+            </td>
+          </tr>
+          <tr>
+            <td>merlin.config</td>
+            <td>
+             <p>Relative or absolute file path to the target override configuration.</p>
+            </td>
+          </tr>
+          <tr>
+            <td>merlin.info</td>
+            <td>
+             <p>Merlin info flag "true" or "false" controling the generation of 
+                deployment context information on startup.</p>
+            </td>
+          </tr>
+          <tr>
+            <td>merlin.debug</td>
+            <td>
+             <p>Merlin debug flag "true" or "false".</p>
+            </td>
+          </tr>
+        </table>
+      </subsection>
+    </section>
+  </body>
+</document>
+
+

Added: avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/meta/goals.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/meta/goals.xml	Mon May
31 15:45:16 2004
@@ -0,0 +1,65 @@
+<?xml version="1.0"?>
+
+<document>
+  <properties>
+    <author email="mcconnell@apache.org">Stephen McConnell</author>
+    <title>Avalon Plugin for Maven</title>
+  </properties>
+  <body>
+    <section name="Avalon Meta Plugin for Maven">
+      <subsection name="Goals">
+        <table>
+          <tr><th>Goal</th><th>Description</th></tr>
+          <tr>
+            <td>avalon:meta</td>
+            <td>
+          <p>Generates meta info descriptors for service and component types
+          based on javadoc tags within the java source files.  Source class files
+          are scanned for the presence of an @avalon.component or @avalon service tag and
if 
+          present, a meta descriptor is generated.</p>
+          
+          <p>Meta info generation process includes:</p>
+          <ul>
+            <li>Scan source files for avalon.type or @avalon.service tags</li>
+            <li>Build Type and Service descriptors</li>
+            <li>Externalize descriptors to serial or xml format</li>
+          </ul>
+          <p>Resulting meta info descriptors are placed int the ${basedir}/target/src
directory.  Typical application scenario is to define a preGoal to handle meta-info generation
under the maven.xml file and inclusion of the output meta info under the project.xml jar resources.</p>
+<p><i>maven.xml example</i></p>
+<source><![CDATA[
+  <project default="jar:jar">
+    <preGoal name="jar:jar">
+      <attainGoal name="avalon:meta"/>
+    </preGoal>
+  </project>
+]]></source>
+<p><i>project.xml example</i></p>
+<source><![CDATA[
+  <project>
+    <!-- other stuff -->
+    <build>
+      <!-- more stuff -->
+      <resources>
+        <!-- include the generated meta-info 
+            descriptors into you jar file -->
+        <resource>
+          <directory>${basedir}/target/src</directory> 
+          <includes>
+            <!-- meta info desriptors -->
+            <include>**/*.x*</include> 
+          </includes>
+        </resource>
+      </resources>
+    </build>
+  </project>
+]]></source>
+            </td>
+          </tr>
+        </table>
+      </subsection>
+    </section>
+  </body>
+</document>
+
+
+

Added: avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/meta/index.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/meta/index.xml	Mon May
31 15:45:16 2004
@@ -0,0 +1,20 @@
+<?xml version="1.0"?>
+
+<document>
+  <properties>
+    <author email="mcconnell@apache.org">Stephen McConnell</author>
+    <title>Avalon Plugin for Maven</title>
+  </properties>
+  <body>
+    <section name="Avalon Meta Plugin for Maven">
+      <subsection name="Meta Generation">
+      <p>
+The Avalon Plugin for Maven provides support for developers in the management of Maven based
projects that leverage the Avalon component model.  This plugin will be progressively extended
with Avalon and related sub-system utilities.  Currently the plugin provides support for a
meta info generation process based on javadoc tags within class and interface source files.
+      </p>
+      </subsection>
+    </section>
+  </body>
+</document>
+
+
+

Added: avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/meta/navigation.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/meta/navigation.xml	Mon
May 31 15:45:16 2004
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!-- 
+ Copyright 2004 Apache Software Foundation
+ Licensed  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.
+-->
+
+<project>
+
+  <title>Merlin</title>
+
+  <body>
+    <menu>
+      <item name="Goals" href="goals.html"/>
+      <item name="Properties" href="properties.html"/>
+    </menu>
+  </body>
+
+</project>

Added: avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/meta/properties.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/meta/properties.xml	Mon
May 31 15:45:16 2004
@@ -0,0 +1,83 @@
+<?xml version="1.0"?>
+
+<document>
+  <properties>
+    <author email="mcconnell@apache.org">Stephen McConnell</author>
+    <title>Avalon Plugin for Maven</title>
+  </properties>
+  <body>
+    <section name="Avalon Meta Plugin for Maven">
+      <subsection name="Properties">
+      <table>
+        <tr>
+          <th>Property name</th>
+          <th>Optional?</th>
+          <th>Description</th>
+        </tr>
+        <tr>
+          <td>avalon.meta.format</td>
+          <td>Yes</td>
+          <td>
+<p>Output format specification.  Valid values include 'xml' or 'serial'.
+The xml value instructs the meta generator to create meta descriptions
+in an XML format whereas the 'serial' value generates a serialized 
+description of the descriptor.  Serial format is more efficient.  The 
+XML format is more portable.</p>
+<p>
+Default behaviour:
+</p>
+<source><![CDATA[
+avalon.meta.format = xml
+]]></source>
+          </td>
+        </tr>
+        <tr>
+          <td>avalon.meta.force</td>
+          <td>Yes</td>
+          <td>
+<p>Policy controlling the regeneration of meta descriptors independently
+of the descriptor data.  This value default to false. </p>
+<p>
+Default behaviour:
+</p>
+<source><![CDATA[
+avalon.meta.force = false
+]]></source>
+          </td>
+        </tr>
+        <tr>
+          <td>avalon.meta.type.postfix</td>
+          <td>No</td>
+          <td>
+<p>
+Avalon will default to the generation of XML type descriptors under
+the .xinfo file type.  When generating meta-info descriptors targetted
+for deployment in both Merlin and Phoenix, the xinfo type will conflict
+with the Phoenix meta-info descriptor. Avalon Plugin provides support for 
+generation of meta info under the alternative .xtype.  To control the 
+type of file generated, you can declare either "xinfo" or "xtype" under
+this property. 
+</p>
+<p>
+Default behaviour:
+</p>
+<source><![CDATA[
+avalon.meta.type.postfix= xinfo
+]]></source>
+<p>
+Alternative xtype behaviour:
+</p>
+<source><![CDATA[
+avalon.meta.type.postfix = xtype
+]]></source>
+
+          </td>
+        </tr>
+      </table>
+      </subsection>
+    </section>
+  </body>
+</document>
+
+
+

Modified: avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/navigation.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/navigation.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/products/runtime/tools/maven/navigation.xml	Mon May
31 15:45:16 2004
@@ -23,8 +23,8 @@
 
   <body>
     <menu>
-      <item name="Goals" href="deploy.html"/>
-      <item name="Properties" href="properties.html"/>
+      <item name="Meta" href="meta/index.html"/>
+      <item name="Merlin" href="merlin/index.html"/>
     </menu>
   </body>
 

Modified: avalon/trunk/central/site/src/xdocs/products/runtime/tools/navigation.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/products/runtime/tools/navigation.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/products/runtime/tools/navigation.xml	Mon May 31 15:45:16
2004
@@ -23,7 +23,8 @@
 
   <body>
     <menu>
-      <item name="Maven Plugins" href="maven/index.html"/>
+      <item name="Ant" href="ant/index.html"/>
+      <item name="Maven" href="maven/index.html"/>
     </menu>
   </body>
 

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


Mime
View raw message