avalon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nic...@apache.org
Subject svn commit: rev 20287 - in avalon/trunk/central/site/src/xdocs/central/laboratory/products: . tools tools/magic tools/magic/engine tools/magic/plugins tools/magic/plugins/artifact tools/magic/plugins/clean tools/magic/plugins/jar tools/magic/plugins/java tools/magic/plugins/plugin tools/magic/plugins/prepare tools/magic/plugins/xdoc
Date Mon, 24 May 2004 06:42:44 GMT
Author: niclas
Date: Sun May 23 23:42:43 2004
New Revision: 20287

Added:
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/engine/
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/artifact/
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/artifact/index.xml
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/artifact/methods.xml
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/artifact/navigation.xml
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/artifact/properties.xml
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/clean/
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/clean/index.xml
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/clean/methods.xml
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/clean/navigation.xml
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/clean/properties.xml
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/jar/
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/jar/index.xml
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/jar/methods.xml
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/jar/navigation.xml
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/jar/properties.xml
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/java/
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/java/index.xml
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/java/methods.xml
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/java/navigation.xml
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/java/properties.xml
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/plugin/
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/plugin/index.xml
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/plugin/methods.xml
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/plugin/navigation.xml
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/plugin/properties.xml
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/prepare/
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/prepare/index.xml
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/prepare/methods.xml
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/prepare/navigation.xml
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/prepare/properties.xml
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/xdoc/
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/xdoc/index.xml
      - copied unchanged from rev 20271, avalon/trunk/tools/magic/xdoc/src/xdocs/index.xml
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/xdoc/methods.xml
      - copied unchanged from rev 20271, avalon/trunk/tools/magic/xdoc/src/xdocs/methods.xml
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/xdoc/navigation.xml
      - copied, changed from rev 20271, avalon/trunk/tools/magic/xdoc/src/xdocs/navigation.xml
   avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/xdoc/properties.xml
      - copied unchanged from rev 20271, avalon/trunk/tools/magic/xdoc/src/xdocs/properties.xml
Log:
Added fundamental docs for the magic plugins.

Added: avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/artifact/index.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/artifact/index.xml	Sun May 23 23:42:43 2004
@@ -0,0 +1,42 @@
+<?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="niclas@apache.org">Niclas Hedhman</author>
+    <title>Magic Artifact Plugin</title>
+  </properties>
+
+  <body>
+
+    <section name="About Artifact Plugin">
+      <p>
+        The Artifact plugin handles the artifacts that the buildsystem
+        needs to operate, mainly the Jar files. It downloads them from
+        remote repositories if necessary, and handles the dependencies.
+      </p>
+    </section>
+  </body>
+</document>
+
+
+

Added: avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/artifact/methods.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/artifact/methods.xml	Sun May 23 23:42:43 2004
@@ -0,0 +1,120 @@
+<?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="niclas@apache.org">Niclas Hedhman</author>
+    <title>Magic Artifact Plugin</title>
+  </properties>
+
+  <body>
+
+    <section name="Artifact Plugin - Methods">
+      <p>
+        It is not meant for humans to directly invoke the Artifact plugin,
+        but for other plugins to request its service.
+      </p>
+      <p>
+       A typical usage as seen in the Javac plugin;
+      </p>
+      <source>
+    /* Casting required due to BeanShell.
+    ArtifactPlugin ap = (ArtifactPlugin) m_ArtifactPlugin;
+    
+    /* Add Class path defined in the build.properties  */
+    Path cp = javac.createClasspath();
+    Path.PathElement pe = cp.createPathElement();
+    pe.setPath( classpath );
+
+    /* Get hold of the artifactId */
+    String projectname = m_Context.getProjectName();
+    
+    /* Resolve it into an Atrifact */
+    Artifact thisArtifact = ap.locate( projectname );
+    
+    /* Get the dependencies */
+    Artifact[] deps = ap.getDependencies( thisArtifact );
+    
+    /* Fetch the classpath */
+    Path depPath = ap.getClassPath( deps );
+    
+    /* Add it */
+    cp.add( depPath );
+      </source>
+      <subsection name="Reference" >
+        <source>
+    Artifact resolve( String artifactId );
+        </source>
+        <p>
+          Resolves the artifactId into the project's current setting for
+          such Artifact.
+        </p>
+        <p>
+        </p>    
+        <source>
+    Artifact[] getDependencies( Artifact artifact );
+        </source>
+        <p>
+          Returns the all the dependencies of the given Artifact.
+        </p>
+        <p>
+        </p>    
+        <source>
+    org.apache.tools.ant.types.Path getClassPath( Artifact[] artifacts );
+        </source>
+        <p>
+          Builds an Ant Path object out of the artifacts.
+        </p>
+        <p>
+        </p>    
+        <source>
+    ClassLoader getClassLoader( Artifact[] artifacts );
+        </source>
+        <p>
+          Creates an URLClassloader with the given artifacts in it.
+        </p>
+        <p>
+        </p>    
+        <source>
+    URL[] getLocalURLs( Artifact[] artifacts );
+        </source>
+        <p>
+          Obtain local URLs (file:) of the given artifacts. If they are
+          not available they will be downloaded from the remote repository.
+        </p>
+        <p>
+        </p>    
+        <source>
+    void upload( Artifact artifact, File content );
+        </source>
+        <p>
+          Uploads the given to the remote repository.
+        </p>
+        <p>
+        </p>    
+      </subsection>
+    </section>
+  </body>
+</document>
+
+
+

Added: avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/artifact/navigation.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/artifact/navigation.xml	Sun May 23 23:42:43 2004
@@ -0,0 +1,33 @@
+<?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>Avalon Magic Plugins</title>
+ <body>
+    <menu>
+      <item name="About XDoc Plugin" href="index.html"/>
+      <item name="Properties" href="properties.html"/>
+      <item name="Methods" href="methods.html"/>
+    </menu>
+ </body>
+
+</project>

Added: avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/artifact/properties.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/artifact/properties.xml	Sun May 23 23:42:43 2004
@@ -0,0 +1,63 @@
+<?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="niclas@apache.org">Niclas Hedhman</author>
+    <title>Magic Artifact Plugin</title>
+  </properties>
+
+  <body>
+    <section name="Artifact Plugin - Properties">
+      <p>
+        The following properties are used by teh XDoc Plugin. 
+      </p>
+      <table>
+        <tr>
+          <th>Property name</th>
+          <th>Default value</th>
+          <th>Description</th>
+        </tr>
+        <tr>
+          <td>
+            artifact.local.repository.dir
+           </td>
+          <td>
+            ${user.home}/.maven/repository
+          </td>
+          <td>
+          </td>
+        </tr>
+        <tr>
+          <td>
+            artifact.repository
+           </td>
+          <td>
+            http://www.ibiblio.org/maven
+          </td>
+          <td>
+          </td>
+        </tr>
+      </table>
+    </section>
+  </body>
+</document>

Added: avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/clean/index.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/clean/index.xml	Sun May 23 23:42:43 2004
@@ -0,0 +1,39 @@
+<?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="niclas@apache.org">Niclas Hedhman</author>
+    <title>Magic Clean Plugin</title>
+  </properties>
+
+  <body>
+
+    <section name="About Clean Plugin">
+      <p>
+      </p>
+    </section>
+  </body>
+</document>
+
+
+

Added: avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/clean/methods.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/clean/methods.xml	Sun May 23 23:42:43 2004
@@ -0,0 +1,58 @@
+<?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="niclas@apache.org">Niclas Hedhman</author>
+    <title>Magic Clean Plugin</title>
+  </properties>
+
+  <body>
+
+    <section name="Magic Clean Plugin - Methods">
+      <p>
+        The following methods has been defined in the Clean Plugin.
+      </p>
+      <table>
+        <tr>
+          <th>
+            Method
+          </th>
+          <th>
+            Description
+          </th>
+        </tr>
+        <tr>
+          <td>
+            clean
+          </td>
+          <td>
+            Removes all the content in the target directories.
+          </td>
+        </tr>
+      </table>
+    </section>
+  </body>
+</document>
+
+
+

Added: avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/clean/navigation.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/clean/navigation.xml	Sun May 23 23:42:43 2004
@@ -0,0 +1,33 @@
+<?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>Avalon Magic Plugins</title>
+ <body>
+    <menu>
+      <item name="About Clean Plugin" href="index.html"/>
+      <item name="Properties" href="properties.html"/>
+      <item name="Methods" href="methods.html"/>
+    </menu>
+ </body>
+
+</project>

Added: avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/clean/properties.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/clean/properties.xml	Sun May 23 23:42:43 2004
@@ -0,0 +1,53 @@
+<?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="niclas@apache.org">Niclas Hedhman</author>
+    <title>Magic Clean Plugin</title>
+  </properties>
+
+  <body>
+    <section name="Clean Plugin - Properties">
+      <p>
+        The following properties are used by the Clean Plugin. 
+      </p>
+      <table>
+        <tr>
+          <th>Property name</th>
+          <th>Default value</th>
+          <th>Description</th>
+        </tr>
+        <tr>
+          <td>
+            clean.dirs
+           </td>
+          <td>
+            ${prepare.dest.dir}
+          </td>
+          <td>
+          </td>
+        </tr>
+      </table>
+    </section>
+  </body>
+</document>

Added: avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/jar/index.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/jar/index.xml	Sun May 23 23:42:43 2004
@@ -0,0 +1,39 @@
+<?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="niclas@apache.org">Niclas Hedhman</author>
+    <title>Magic Jar Plugin</title>
+  </properties>
+
+  <body>
+
+    <section name="About Jar Plugin">
+      <p>
+      </p>
+    </section>
+  </body>
+</document>
+
+
+

Added: avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/jar/methods.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/jar/methods.xml	Sun May 23 23:42:43 2004
@@ -0,0 +1,64 @@
+<?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="niclas@apache.org">Niclas Hedhman</author>
+    <title>Magic Jar Plugin</title>
+  </properties>
+
+  <body>
+
+    <section name="Magic Jar Plugin - Methods">
+      <p>
+        The following methods has been defined in the Jar Plugin.
+      </p>
+      <table>
+        <tr>
+          <th>
+            Method
+          </th>
+          <th>
+            Intermediaries
+          </th>
+          <th>
+            Description
+          </th>
+        </tr>
+        <tr>
+          <td>
+            jar
+          </td>
+          <td>
+            manifest-created
+          </td>
+          <td>
+            Builds a Jar file from the class files and defined resources.
+          </td>
+        </tr>
+      </table>
+    </section>
+  </body>
+</document>
+
+
+

Added: avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/jar/navigation.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/jar/navigation.xml	Sun May 23 23:42:43 2004
@@ -0,0 +1,33 @@
+<?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>Avalon Magic Plugins</title>
+ <body>
+    <menu>
+      <item name="About Jar Plugin" href="index.html"/>
+      <item name="Properties" href="properties.html"/>
+      <item name="Methods" href="methods.html"/>
+    </menu>
+ </body>
+
+</project>

Added: avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/jar/properties.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/jar/properties.xml	Sun May 23 23:42:43 2004
@@ -0,0 +1,83 @@
+<?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="niclas@apache.org">Niclas Hedhman</author>
+    <title>Magic Jar Plugin</title>
+  </properties>
+
+  <body>
+    <section name="Jar Plugin - Properties">
+      <p>
+        The following properties are used by the Jar Plugin. 
+      </p>
+      <table>
+        <tr>
+          <th>Property name</th>
+          <th>Default value</th>
+          <th>Description</th>
+        </tr>
+        <tr>
+          <td>
+            jar.build.src.dir
+           </td>
+          <td>
+            ${java.build.dest.dir}
+          </td>
+          <td>
+          </td>
+        </tr>
+        <tr>
+          <td>
+            jar.build.dest.dir
+           </td>
+          <td>
+            ${prepare.dest.dir}
+          </td>
+          <td>
+          </td>
+        </tr>
+        <tr>
+          <td>
+            jar.manifest
+           </td>
+          <td>
+            ${prepare.src.dir}/etc/manifest.MF
+          </td>
+          <td>
+          </td>
+        </tr>
+        <tr>
+          <td>
+            jar.manifest.build.dir
+           </td>
+          <td>
+            ${prepare.build.src.dir}/etc
+          </td>
+          <td>
+          </td>
+        </tr>
+      </table>
+    </section>
+  </body>
+</document>

Added: avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/java/index.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/java/index.xml	Sun May 23 23:42:43 2004
@@ -0,0 +1,39 @@
+<?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="niclas@apache.org">Niclas Hedhman</author>
+    <title>Magic Java Plugin</title>
+  </properties>
+
+  <body>
+
+    <section name="About Java Plugin">
+      <p>
+      </p>
+    </section>
+  </body>
+</document>
+
+
+

Added: avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/java/methods.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/java/methods.xml	Sun May 23 23:42:43 2004
@@ -0,0 +1,64 @@
+<?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="niclas@apache.org">Niclas Hedhman</author>
+    <title>Magic Java Plugin</title>
+  </properties>
+
+  <body>
+
+    <section name="Magic Java Plugin - Methods">
+      <p>
+        The following methods has been defined in the Java Plugin.
+      </p>
+      <table>
+        <tr>
+          <th>
+            Method
+          </th>
+          <th>
+            Intermediary
+          </th>
+          <th>
+            Description
+          </th>
+        </tr>
+        <tr>
+          <td>
+            compile
+          </td>
+          <td>
+           -
+          </td>
+          <td>
+            Removes all the content in the target directories.
+          </td>
+        </tr>
+      </table>
+    </section>
+  </body>
+</document>
+
+
+

Added: avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/java/navigation.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/java/navigation.xml	Sun May 23 23:42:43 2004
@@ -0,0 +1,33 @@
+<?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>Avalon Magic Plugins</title>
+ <body>
+    <menu>
+      <item name="About Java Plugin" href="index.html"/>
+      <item name="Properties" href="properties.html"/>
+      <item name="Methods" href="methods.html"/>
+    </menu>
+ </body>
+
+</project>

Added: avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/java/properties.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/java/properties.xml	Sun May 23 23:42:43 2004
@@ -0,0 +1,73 @@
+<?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="niclas@apache.org">Niclas Hedhman</author>
+    <title>Magic Java Plugin</title>
+  </properties>
+
+  <body>
+    <section name="Clean Plugin - Properties">
+      <p>
+        The following properties are used by teh Java Plugin. 
+      </p>
+      <table>
+        <tr>
+          <th>Property name</th>
+          <th>Default value</th>
+          <th>Description</th>
+        </tr>
+        <tr>
+          <td>
+            java.src.dir
+           </td>
+          <td>
+            ${prepare.src.dir}/java
+          </td>
+          <td>
+          </td>
+        </tr>
+        <tr>
+          <td>
+            java.build.src.dir
+           </td>
+          <td>
+            ${prepare.build.src.dir}/java
+          </td>
+          <td>
+          </td>
+        </tr>
+        <tr>
+          <td>
+            java.build.dest.dir
+           </td>
+          <td>
+            ${prepare.dest.dir}/classes
+          </td>
+          <td>
+          </td>
+        </tr>
+      </table>
+    </section>
+  </body>
+</document>

Added: avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/plugin/index.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/plugin/index.xml	Sun May 23 23:42:43 2004
@@ -0,0 +1,39 @@
+<?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="niclas@apache.org">Niclas Hedhman</author>
+    <title>Magic Plugin Plugin</title>
+  </properties>
+
+  <body>
+
+    <section name="About Plugin Plugin">
+      <p>
+      </p>
+    </section>
+  </body>
+</document>
+
+
+

Added: avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/plugin/methods.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/plugin/methods.xml	Sun May 23 23:42:43 2004
@@ -0,0 +1,80 @@
+<?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="niclas@apache.org">Niclas Hedhman</author>
+    <title>Magic Plugin Plugin</title>
+  </properties>
+
+  <body>
+
+    <section name="Magic Plugin Plugin - Methods">
+      <p>
+        The following methods has been defined in the Plugin Plugin.
+      </p>
+      <table>
+        <tr>
+          <th>
+            Method
+          </th>
+          <th>
+            Intermediary
+          </th>
+          <th>
+            Description
+          </th>
+        </tr>
+        <tr>
+          <td>
+            validate
+          </td>
+          <td>
+           -
+          </td>
+          <td>
+            Copies the script file to a temporary directory, and then 
+            invokes the JDK javac compiler, to ensure that the plugin
+            is syntactically correct. The output class is cached in the
+            Magic system directory, for later compilation of other
+            plugins, that has dependencies.
+          </td>
+        </tr>
+        <tr>
+          <td>
+            install
+          </td>
+          <td>
+           -
+          </td>
+          <td>
+            It first calls the validate method and then installs the current
+            project as a plugin into the Magic system plugins/ directory.
+          </td>
+        </tr>
+      </table>
+    </section>
+  </body>
+</document>
+
+
+

Added: avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/plugin/navigation.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/plugin/navigation.xml	Sun May 23 23:42:43 2004
@@ -0,0 +1,33 @@
+<?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>Avalon Magic Plugins</title>
+ <body>
+    <menu>
+      <item name="About Plugin Plugin" href="index.html"/>
+      <item name="Properties" href="properties.html"/>
+      <item name="Methods" href="methods.html"/>
+    </menu>
+ </body>
+
+</project>

Added: avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/plugin/properties.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/plugin/properties.xml	Sun May 23 23:42:43 2004
@@ -0,0 +1,36 @@
+<?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="niclas@apache.org">Niclas Hedhman</author>
+    <title>Magic Plugin Plugin</title>
+  </properties>
+
+  <body>
+    <section name="Plugin Plugin - Properties">
+      <p>
+        There are no properties for the Plugin Plugin.
+      </p>
+    </section>
+  </body>
+</document>

Added: avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/prepare/index.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/prepare/index.xml	Sun May 23 23:42:43 2004
@@ -0,0 +1,39 @@
+<?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="niclas@apache.org">Niclas Hedhman</author>
+    <title>Magic Prepare Plugin</title>
+  </properties>
+
+  <body>
+
+    <section name="About Prepare Plugin">
+      <p>
+      </p>
+    </section>
+  </body>
+</document>
+
+
+

Added: avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/prepare/methods.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/prepare/methods.xml	Sun May 23 23:42:43 2004
@@ -0,0 +1,63 @@
+<?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="niclas@apache.org">Niclas Hedhman</author>
+    <title>Magic Prepare Plugin</title>
+  </properties>
+
+  <body>
+
+    <section name="Magic Prepare Plugin - Methods">
+      <p>
+        It is not meant for humans to directly invoke the Prepare plugin,
+        but for other plugins to request its service.
+      </p>
+      <table>
+        <tr>
+          <th>
+            Method
+          </th>
+          <th>
+            Intermediary
+          </th>
+          <th>
+            Description
+          </th>
+        </tr>
+        <tr>
+          <td>
+            init
+          </td>
+          <td>
+            Makes all the required copies with and without filtering to 
+            the build source directories.
+          </td>
+        </tr>
+      </table>
+    </section>
+  </body>
+</document>
+
+
+

Added: avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/prepare/navigation.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/prepare/navigation.xml	Sun May 23 23:42:43 2004
@@ -0,0 +1,33 @@
+<?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>Avalon Magic Plugins</title>
+ <body>
+    <menu>
+      <item name="About Prepare Plugin" href="index.html"/>
+      <item name="Properties" href="properties.html"/>
+      <item name="Methods" href="methods.html"/>
+    </menu>
+ </body>
+
+</project>

Added: avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/prepare/properties.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/prepare/properties.xml	Sun May 23 23:42:43 2004
@@ -0,0 +1,83 @@
+<?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="niclas@apache.org">Niclas Hedhman</author>
+    <title>Magic Prepare Plugin</title>
+  </properties>
+
+  <body>
+    <section name="Prepare Plugin - Properties">
+      <p>
+        The following properties are used by the Prepare Plugin. 
+      </p>
+      <table>
+        <tr>
+          <th>Property name</th>
+          <th>Default value</th>
+          <th>Description</th>
+        </tr>
+        <tr>
+          <td>
+            prepare.src.dir
+           </td>
+          <td>
+            src/
+          </td>
+          <td>
+          </td>
+        </tr>
+        <tr>
+          <td>
+            prepare.dest.dir
+           </td>
+          <td>
+            target/
+          </td>
+          <td>
+          </td>
+        </tr>
+        <tr>
+          <td>
+            prepare.build.src.dir
+           </td>
+          <td>
+            ${prepare.dest.dir}/src/
+          </td>
+          <td>
+          </td>
+        </tr>
+        <tr>
+          <td>
+            prepare.filtered.files
+           </td>
+          <td>
+            **/*.xml, **/*.java, **/*.html, **/*.sh, **/*.bat, **/*.prop*
+          </td>
+          <td>
+          </td>
+        </tr>
+      </table>
+    </section>
+  </body>
+</document>

Copied: avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/xdoc/navigation.xml (from rev 20271, avalon/trunk/tools/magic/xdoc/src/xdocs/navigation.xml)
==============================================================================
--- avalon/trunk/tools/magic/xdoc/src/xdocs/navigation.xml	(original)
+++ avalon/trunk/central/site/src/xdocs/central/laboratory/products/tools/magic/plugins/xdoc/navigation.xml	Sun May 23 23:42:43 2004
@@ -23,13 +23,6 @@
 
  <title>Avalon Magic Plugins</title>
  <body>
-
-    <links>
-      <item name="Central" href="http://merlin.apache.org/central/" />
-      <item name="Products" href="http://merlin.apache.org/products/" />
-      <item name="Planet" href="http://merlin.apache.org/planet/" />
-    </links>
-
     <menu>
       <item name="About XDoc Plugin" href="index.html"/>
       <item name="Properties" href="properties.html"/>

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


Mime
View raw message