adammurdoch 2002/06/02 07:05:56
Modified: site/docs buildfile.html running.html
site/src/xdocs buildfile.xml running.xml
site/src/xdocs/stylesheets project.xml
Log:
Some doc updates.
Revision Changes Path
1.6 +35 -10 jakarta-ant-myrmidon/site/docs/buildfile.html
Index: buildfile.html
===================================================================
RCS file: /home/cvs/jakarta-ant-myrmidon/site/docs/buildfile.html,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- buildfile.html 19 May 2002 13:37:50 -0000 1.5
+++ buildfile.html 2 Jun 2002 14:05:55 -0000 1.6
@@ -11,7 +11,7 @@
<meta name="author" value="Adam Murdoch">
<meta name="email" value="[EMAIL PROTECTED]">
- <title>Apache Myrmidon - User Guide</title>
+ <title>Apache Myrmidon - Using Myrmidon</title>
</head>
<body bgcolor="#ffffff" text="#000000" link="#525D76">
@@ -84,20 +84,45 @@
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica,sanserif">
- <a name="Project File"><strong>Project File</strong></a>
+ <a name="Overview"><strong>Overview</strong></a>
</font>
</td></tr>
<tr><td>
<blockquote>
<p>
-A project file is an XML file that describes which tasks to execute, and in
-which order to execute them in. A project can be broken up into several
steps,
-or <i>targets</i>. A target is simply a list of the tasks that need to be
-executed to perform the step. A target may also include some dependency
-information. Myrmidon makes sure that targets are executed in the correct
order,
-so that a target is executed before the targets that depend on it.</p>
- <p>The project file format is very similar
to the format used in Ant 1. The
-root element of a project file must be a <code><project></code>
element.
+You define a build process using a <a href="#project">project</a>. A project
+describes what needs to be done to perform the build. You define a project
+by breaking it up into several smaller steps, or <b>targets</b>. Targets
+represent the main stages of your build. For example, a project might have
+a target that compiles the Java source files, another target that runs unit
+tests, and a third target that assembles a distribution.
+</p>
+ <p>
+A <a href="#targets">target</a> may <b>depend on</b> other targets. For
example,
+a target that builds a distribution, cannot do its work until the source
files
+have been compiled. Myrmidon makes sure that targets are executed in the
+correct order, so that a target is executed before the targets that depend
on it.
+</p>
+ <p>
+You define a target using basic units of work called <a
href="#tasks">tasks</a>.
+Tasks can range from the most simple operations, such as copying a file, or
+setting a property, up to complex operations like compiling Java source, or
+running a test suite.
+</p>
+ </blockquote>
+ </td></tr>
+ </table>
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#525D76">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="project"><strong>The Project File</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+A project file is an XML file that defines a single project. The root
element
+of a project file must be a <code><project></code> element.
It can take the following attributes:
</p>
<table>
1.3 +15 -0 jakarta-ant-myrmidon/site/docs/running.html
Index: running.html
===================================================================
RCS file: /home/cvs/jakarta-ant-myrmidon/site/docs/running.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- running.html 19 May 2002 13:37:50 -0000 1.2
+++ running.html 2 Jun 2002 14:05:55 -0000 1.3
@@ -84,6 +84,21 @@
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="Installing Myrmidon"><strong>Installing
Myrmidon</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p>Installing Myrmidon is easy. Simply extract the
contents of the
+ distribution zip or tar file, to whichever install directory you like.
You
+ should also add the distribution's <code>bin</code> directory to the
+ <code>PATH</code> environment variable.</p>
+ </blockquote>
+ </td></tr>
+ </table>
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#525D76">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
<a name="Running Myrmidon"><strong>Running
Myrmidon</strong></a>
</font>
</td></tr>
1.4 +30 -10 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.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- buildfile.xml 12 May 2002 11:18:39 -0000 1.3
+++ buildfile.xml 2 Jun 2002 14:05:55 -0000 1.4
@@ -2,23 +2,43 @@
<properties>
<author email="[EMAIL PROTECTED]">Adam Murdoch</author>
-<title>User Guide</title>
+<title>Using Myrmidon</title>
</properties>
<body>
-<section name="Project File">
+<section name="Overview">
<p>
-A project file is an XML file that describes which tasks to execute, and in
-which order to execute them in. A project can be broken up into several
steps,
-or <i>targets</i>. A target is simply a list of the tasks that need to be
-executed to perform the step. A target may also include some dependency
-information. Myrmidon makes sure that targets are executed in the correct
order,
-so that a target is executed before the targets that depend on it.</p>
+You define a build process using a <a href="#project">project</a>. A project
+describes what needs to be done to perform the build. You define a project
+by breaking it up into several smaller steps, or <a
href="#targets">targets</a>.
+Targets represent the main stages of your build. For example, a project
might
+have a target that compiles the Java source files, another target that runs
unit
+tests, and a third target that assembles a distribution.
+</p>
-<p>The project file format is very similar to the format used in Ant 1. The
-root element of a project file must be a <code><project></code>
element.
+<p>
+A target may <b>depend on</b> other targets. For example, a target that
+builds a distribution, cannot do its work until the source files have been
+compiled. Myrmidon makes sure that targets are executed in the correct
order,
+so that a target is executed before the targets that depend on it.
+</p>
+
+<p>
+You define a target using basic units of work called <a
href="#tasks">tasks</a>.
+Tasks can range from the most simple operations, such as copying a file, or
+setting a property, up to complex operations like compiling Java source, or
+running a test suite.
+</p>
+
+</section>
+
+<section name="The Project File" anchor="project">
+
+<p>
+A project file is an XML file that defines a single project. The root
element
+of a project file must be a <code><project></code> element.
It can take the following attributes:
</p>
1.2 +9 -0 jakarta-ant-myrmidon/site/src/xdocs/running.xml
Index: running.xml
===================================================================
RCS file: /home/cvs/jakarta-ant-myrmidon/site/src/xdocs/running.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- running.xml 9 May 2002 07:39:23 -0000 1.1
+++ running.xml 2 Jun 2002 14:05:55 -0000 1.2
@@ -7,6 +7,15 @@
<body>
+ <section name="Installing Myrmidon">
+
+ <p>Installing Myrmidon is easy. Simply extract the contents of the
+ distribution zip or tar file, to whichever install directory you like.
You
+ should also add the distribution's <code>bin</code> directory to the
+ <code>PATH</code> environment variable.</p>
+
+ </section>
+
<section name="Running Myrmidon">
<p>
1.6 +1 -1
jakarta-ant-myrmidon/site/src/xdocs/stylesheets/project.xml
Index: project.xml
===================================================================
RCS file:
/home/cvs/jakarta-ant-myrmidon/site/src/xdocs/stylesheets/project.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- project.xml 12 May 2002 11:15:34 -0000 1.5
+++ project.xml 2 Jun 2002 14:05:55 -0000 1.6
@@ -12,7 +12,7 @@
<menu name="User Guide">
<item name="Installing and Running" href="/running.html"/>
- <item name="Project File" href="/buildfile.html"/>
+ <item name="Using Myrmidon" href="/buildfile.html"/>
<item name="Virtual File System" href="/vfs.html"/>
<item name="Ant 1 Compatibility Layer" href="/ant1compat.html"/>
<item name="Differences to Ant 1" href="/differences.html"/>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
