adammurdoch 2002/07/06 00:54:15
Modified: site/src/xdocs vfs.xml task.xml extending.xml
configuring.xml building.xml buildfile.xml
Log:
Some tidy-ups.
Revision Changes Path
1.2 +0 -2 jakarta-ant-myrmidon/site/src/xdocs/vfs.xml
Index: vfs.xml
===================================================================
RCS file: /home/cvs/jakarta-ant-myrmidon/site/src/xdocs/vfs.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- vfs.xml 10 Apr 2002 23:43:46 -0000 1.1
+++ vfs.xml 6 Jul 2002 07:54:15 -0000 1.2
@@ -104,7 +104,6 @@
<p>An example:</p>
<source><![CDATA[
-
<v-fileset dir="src">
<name pattern="org/apache/tools/ant/**"/>
<is-file/>
@@ -124,7 +123,6 @@
<p>An example:</p>
<source><![CDATA[
-
<v-copy todir="dist/lib">
<flat-fileset>
<v-fileset dir="build/lib">
1.2 +7 -11 jakarta-ant-myrmidon/site/src/xdocs/task.xml
Index: task.xml
===================================================================
RCS file: /home/cvs/jakarta-ant-myrmidon/site/src/xdocs/task.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- task.xml 10 Apr 2002 23:43:46 -0000 1.1
+++ task.xml 6 Jul 2002 07:54:15 -0000 1.2
@@ -16,7 +16,7 @@
<ol>
<li>
Create a Java class that extends
- <code>org.apache.myrmidon.api.AbstractTask</code>
+ <classname>org.apache.myrmidon.api.AbstractTask</classname>.
</li>
<li>
For each attribute, write a setter method. The setter method
@@ -46,15 +46,15 @@
</li>
<li>
Write a public void method named "execute" with no arguments that
- throws a TaskException. This is the method called to do the
- actual work of the task.
+ throws a <classname>org.apache.myrmidon.api.TaskException</classname>.
This
+ is the method called to do the actual work of the task.
</li>
</ol>
<subsection name="A Basic Example">
-<p>So a basic task that has one attribute named "message" and just prints
-out this message is as simple as;</p>
+<p>So a basic task that has one attribute named <code>message</code> and
+just prints out this message is as simple as;</p>
<source>
package org.realityforge.tasks;
@@ -85,9 +85,7 @@
<p>To use this task you <em>could</em> create a library but instead we will
just use <taskdef> to define the task. An example usage would be;</p>
-<source>
-<![CDATA[
-
+<source><![CDATA[
<?xml version="1.0"?>
<project version="2.0">
@@ -100,9 +98,7 @@
<printer message="Hello World!"/>
</target>
</project>
-]]>
-
-</source>
+]]></source>
</subsection>
1.3 +2 -2 jakarta-ant-myrmidon/site/src/xdocs/extending.xml
Index: extending.xml
===================================================================
RCS file: /home/cvs/jakarta-ant-myrmidon/site/src/xdocs/extending.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- extending.xml 20 Jun 2002 00:18:02 -0000 1.2
+++ extending.xml 6 Jul 2002 07:54:15 -0000 1.3
@@ -21,11 +21,11 @@
in mind. There are three main elements that must be understood
when
customizing ant; roles, types and services.</p>
- <p><a href="types.xml#roles">Roles</a> can be thought of as java
+ <p><a href="types.html#Roles">Roles</a> can be thought of as java
interfaces with associated meta-info. They define an interface
or
contract via which types interact.</p>
- <p><a href="types.xml#types">Types</a> can be thought of as
+ <p><a href="types.html#Types">Types</a> can be thought of as
implementations of roles. Usually they corespond to java classes
that implement the java interface associated with one or more
roles.</p>
1.5 +13 -11 jakarta-ant-myrmidon/site/src/xdocs/configuring.xml
Index: configuring.xml
===================================================================
RCS file: /home/cvs/jakarta-ant-myrmidon/site/src/xdocs/configuring.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- configuring.xml 20 Jun 2002 00:34:22 -0000 1.4
+++ configuring.xml 6 Jul 2002 07:54:15 -0000 1.5
@@ -64,18 +64,20 @@
<section name="Modeller">
<p>Currently the representation of object are stored in a
hierarchial
- tree of
<code>org.apache.myrmidon.api.metadata.ModelElement</code>
- objects. Each ModelElement has a number of attributes and can
have
- either content or sub-elements.</p>
+ tree of
<classname>org.apache.myrmidon.api.metadata.ModelElement</classname>
+ objects. Each <code>ModelElement</code> has a number of
attributes
+ and can have either content or sub-elements.</p>
<p>In most cases it is the responsibility of the runtime to map
- the ModelElement onto an object. However in some cases it may be
useful
- for the object to get access to it's own model and for it to
explicitly
- manage it's own configuration. In this case the object should
implement
- the <code>org.apache.myrmidon.api.metadata.Modeller</code>
interface
- which will provide the mechanism for the object to receive its
own
- representation and configure itself.</p>
- <p>Note that the Modeller mechanism should be avoided if possible
- as it adds considerable complexity to the implementing
object.</p>
+ the <code>ModelElement</code> onto an object. However in some
cases
+ it may be useful for the object to get access to it's own model
and
+ for it to explicitly manage it's own configuration. In this case
the
+ object should implement the
+ <classname>org.apache.myrmidon.api.metadata.Modeller</classname>
+ interface which will provide the mechanism for the object to
receive
+ its own representation and configure itself.</p>
+ <p>Note that the <code>Modeller</code> mechanism should be
avoided
+ if possible as it adds considerable complexity to the
implementing
+ object.</p>
</section>
<section name="Attributes">
1.3 +1 -1 jakarta-ant-myrmidon/site/src/xdocs/building.xml
Index: building.xml
===================================================================
RCS file: /home/cvs/jakarta-ant-myrmidon/site/src/xdocs/building.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- building.xml 23 Jun 2002 10:32:37 -0000 1.2
+++ building.xml 6 Jul 2002 07:54:15 -0000 1.3
@@ -12,7 +12,7 @@
<p>
First, you will need to fetch the Myrmidon source from CVS. The source
can be found in the <code>jakarta-ant-myrmidon</code> CVS module. Details
can
-be found <a href="http://jakarta.apache.org/site/cvsindex.html";>here</a>.
+be found <a href="/site/cvsindex.html">here</a>.
</p>
<p>
1.6 +1 -1 jakarta-ant-myrmidon/site/src/xdocs/buildfile.xml
Index: buildfile.xml
===================================================================
RCS file: /home/cvs/jakarta-ant-myrmidon/site/src/xdocs/buildfile.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- buildfile.xml 6 Jun 2002 12:53:40 -0000 1.5
+++ buildfile.xml 6 Jul 2002 07:54:15 -0000 1.6
@@ -45,7 +45,7 @@
class files into a Jar file.
</p>
- <source><![CDATA[
+<source><![CDATA[
<project version="2.0" default="build-jar">
<!-- Compile the Java source -->
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
