Author: mcconnell
Date: Sun Jun 20 14:06:45 2004
New Revision: 21518
Modified:
avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/filter.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/info.xml
Log:
more docs
Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/filter.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/filter.xml (original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/filter.xml Sun Jun 20 14:06:45 2004
@@ -9,7 +9,86 @@
<body>
<section name="Filter Task">
<p>
- </p>
+ The filter task establish a classic ant filter values
+ based on project information.
+ </p>
+ <p>
+ The following example demonstrates the resolution of
+ a artifact uri feature for a project identified by the
+ key "avalon-activation-impl".
+ </p>
+
+<source><![CDATA[
+<x:filter
+ key="avalon-activation-impl"
+ feature="uri"
+ token="STANDARD_RUNTIME"/>
+]]></source>
+
+ <subsection name="Features">
+
+ <p>
+ Features that may be aquired from any defintion (resource,
+ project, or plugin) are shown in the following table along
+ with example output.
+ </p>
+
+ <table>
+ <tr>
+ <th>Feature</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>name</td>
+ <td>The name of the resource, project or plugin.
+<source><![CDATA[
+avalon-activation-impl
+]]></source>
+</td>
+ </tr>
+ <tr>
+ <td>group</td>
+ <td>The group within which the resource, project or plugin
+ is defined under.
+<source><![CDATA[
+avalon/activation
+]]></source>
+ </td>
+ </tr>
+ <tr>
+ <td>version</td>
+ <td>The version of the resource, project or plugin.
+<source><![CDATA[
+2.0.0
+]]></source>
+ </td>
+ </tr>
+ <tr>
+ <td>uri</td>
+ <td>An artifact uri.
+<source><![CDATA[
+artifact:jar:avalon/activation/avalon-activation-impl#2.0.0
+]]></source>
+ </td>
+ </tr>
+ </table>
+
+ <p>
+ The following two features may be aquired from a project
+ definition. The value returned is a string build from the
+ runtime path definition containing fully expanded repository
+ filesnames prepended with the string %MAGIC_SCD% for windows
+ and $MAGIC_SCD on unix - suitable for use in a application
+ script or command file.
+ </p>
+
+ <pre>
+ system-classpath-for-windows
+ system-classpath-for-unix
+ </pre>
+
+ </subsection>
+
</section>
</body>
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 Sun Jun 20 14:06:45 2004
@@ -24,6 +24,17 @@
<li>initialization of the project model</li>
</ul>
+ <p>
+ The following example demonstrates the initialization of
+ a home using a default ${project.home}/index.xml.
+ </p>
+
+<source><![CDATA[
+ <property name="project.home" value=".."/>
+
+ <x:home/>
+]]></source>
+
<subsection name="Property Loading">
<p>
@@ -76,7 +87,20 @@
</p>
</subsection>
- <subsection name="Usage">
+ <subsection name="Project Identification">
+
+ <p>
+ A project build.xml identifies itself to magic using the
+ property ${project.name}. The value of ${project.name}
+ is the name of a project within the model. If no ${project.name}
+ property is defined, the name of the project (build file name)
+ will be used as the key. Subsequent version, project group,
+ dependency and plugin requirements will be resolved relative to
+ the project defintion identified by the key.
+ </p>
+
+ </subsection>
+ <subsection name="Examples">
<p>
The following example demonstrates the initialization of
@@ -93,7 +117,7 @@
</p>
<source><![CDATA[
- <property name="project.home" value="../.."/>
+ <property name="project.home" value=".."/>
<x:home/>
]]></source>
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 Sun Jun 20 14:06:45 2004
@@ -9,7 +9,24 @@
<body>
<section name="Info Task">
<p>
- </p>
+ The info task logs the value of ${project.name}.
+ </p>
+
+<source><![CDATA[
+ <x:info/>
+]]></source>
+
+ <p>
+ The above declaration will result in the following output.
+ </p>
+
+<pre>
+info:
+------------------------------------------------------------------------
+name: avalon-tutorial-hello
+------------------------------------------------------------------------
+</pre>
+
</section>
</body>
lmpx.com only provides a reader for public news (NNTP) servers. It is not
affiliated with the servers or forums shown here and is not responsible for
the content of articles, which is written by their respective authors.