svn commit: rev 22912 - avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common
| Newsgroups | gmane.comp.jakarta.avalon.cvs |
|---|---|
| Message-ID | <[email protected]> |
Author: mcconnell
Date: Wed Jul 14 11:55:14 2004
New Revision: 22912
Added:
avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/property.xml
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/navigation.xml
Log:
addition of docs on immutable project properties and the addition of the property task description
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 Wed Jul 14 11:55:14 2004
@@ -38,7 +38,67 @@
[x:home] Building system definition.
</pre>
- <subsection name="Property Loading">
+ <subsection name="Project Properties">
+
+ <p>
+ The creation of a home automatically establishes the following set
+ of immutable project properrties. These properties can be referenced
+ anywhere in an ant script following the home declaration.
+ </p>
+
+ <table>
+ <tr><th>Property</th><th>Description</th></tr>
+ <tr>
+ <td>${project.key}</td>
+ <td>The unique project key.</td>
+ </tr>
+ <tr>
+ <td>${project.name}</td>
+ <td>The project name.</td>
+ </tr>
+ <tr>
+ <td>${project.group}</td>
+ <td>The name of the group that the project is a part of.</td>
+ </tr>
+ <tr>
+ <td>${project.version}</td>
+ <td>The project version.</td>
+ </tr>
+ <tr>
+ <td>${project.type}</td>
+ <td>The project artifact type.</td>
+ </tr>
+ <tr>
+ <td>${project.basedir}</td>
+ <td>The project basedir.</td>
+ </tr>
+ <tr>
+ <td>${project.uri}</td>
+ <td>The full artifact uri.</td>
+ </tr>
+ <tr>
+ <td>${project.path}</td>
+ <td>A relative file path that can be used to a locate the artifact
+ produced by the project relative to a repository root.</td>
+ </tr>
+ <tr>
+ <td>${project.spec}</td>
+ <td>Short form of uri. The spec value is equivalent to the
+ uri with the "artifact:" protocol identifier.</td>
+ </tr>
+ <tr>
+ <td>filename</td>
+ <td>The filename of the final artifact that the resource represents.</td>
+ </tr>
+ <tr>
+ <td>short-filename</td>
+ <td>The filename without the file type suffix.</td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ <subsection name="Property File Loading">
<p>
The home task will automatically load properties into the
Modified: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/navigation.xml
==============================================================================
--- avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/navigation.xml (original)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/navigation.xml Wed Jul 14 11:55:14 2004
@@ -26,6 +26,7 @@
<item name="Home" href="home.html"/>
<item name="Info" href="info.html"/>
<item name="Filter" href="filter.html"/>
+ <item name="Property" href="property.html"/>
<item name="Prepare" href="prepare.html"/>
<item name="Clean" href="clean.html"/>
</menu>
Added: avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/property.xml
==============================================================================
--- (empty file)
+++ avalon/trunk/central/site/src/xdocs/central/tools/magic/tasks/common/property.xml Wed Jul 14 11:55:14 2004
@@ -0,0 +1,83 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document>
+
+ <properties>
+ <author email="[email protected]">Avalon Documentation Team</author>
+ <title>Avalon Central</title>
+ </properties>
+
+ <body>
+ <section name="Property Task">
+ <p>
+ The property task can be used to assign a value of a feature
+ of a magic resource or project to a named ant property value.
+ The property creates a new property using the supplied 'name'
+ and assigns to this property the favlue of the requested 'feature'
+ from the resource identified by the value of the 'key' attribute.
+ </p>
+
+<source><![CDATA[
+ <x:property name="spec" key="cornerstone-threads-impl" feature="spec"/>
+ <echo message="${spec}"/>
+]]></source>
+
+<pre>
+ [echo] artifact:jar:avalon/cornerstone/cornerstone-threads-impl#2.0.0
+</pre>
+
+ <subsection name="Features">
+
+ <p>
+ Valid feature names supported by the property task are detailed in
+ the following table.
+ </p>
+
+ <table>
+ <tr><th>Property</th><th>Description</th></tr>
+ <tr>
+ <td>name</td>
+ <td>The resource name.</td>
+ </tr>
+ <tr>
+ <td>group</td>
+ <td>The resource group.</td>
+ </tr>
+ <tr>
+ <td>version</td>
+ <td>The resource version.</td>
+ </tr>
+ <tr>
+ <td>type</td>
+ <td>The resource type.</td>
+ </tr>
+ <tr>
+ <td>uri</td>
+ <td>The full artifact uri.</td>
+ </tr>
+ <tr>
+ <td>path</td>
+ <td>A relative file path that can be used to a locate an artifact
+ relative to a repository root.</td>
+ </tr>
+ <tr>
+ <td>spec</td>
+ <td>Short form of uri. The spec value is equivalent to the
+ uri with the "artifact:" protocol identifier.</td>
+ </tr>
+ <tr>
+ <td>filename</td>
+ <td>The filename of the final artifact that the resource represents.</td>
+ </tr>
+ <tr>
+ <td>short-filename</td>
+ <td>The filename without the file type suffix.</td>
+ </tr>
+ </table>
+
+ </subsection>
+
+ </section>
+ </body>
+
+</document>
+