You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by ch...@apache.org on 2004/12/04 16:40:54 UTC
svn commit: r109805 - /forrest/trunk/docs-author/content/xdocs/howto/howto-forrest-from-maven.xml
Author: cheche
Date: Sat Dec 4 07:40:54 2004
New Revision: 109805
URL: http://svn.apache.org/viewcvs?view=rev&rev=109805
Log:
Update how-to to be used with in 0.7
Modified:
forrest/trunk/docs-author/content/xdocs/howto/howto-forrest-from-maven.xml
Modified: forrest/trunk/docs-author/content/xdocs/howto/howto-forrest-from-maven.xml
Url: http://svn.apache.org/viewcvs/forrest/trunk/docs-author/content/xdocs/howto/howto-forrest-from-maven.xml?view=diff&rev=109805&p1=forrest/trunk/docs-author/content/xdocs/howto/howto-forrest-from-maven.xml&r1=109804&p2=forrest/trunk/docs-author/content/xdocs/howto/howto-forrest-from-maven.xml&r2=109805
==============================================================================
--- forrest/trunk/docs-author/content/xdocs/howto/howto-forrest-from-maven.xml (original)
+++ forrest/trunk/docs-author/content/xdocs/howto/howto-forrest-from-maven.xml Sat Dec 4 07:40:54 2004
@@ -1,5 +1,4 @@
-<?xml version="1.0"?>
-
+<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright 2002-2004 The Apache Software Foundation
@@ -15,64 +14,53 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
-<!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V2.0//EN" "http://forrest.apache.org/dtd/howto-v20.dtd">
-
+<!DOCTYPE howto PUBLIC "-//APACHE//DTD How-to V2.0//EN"
+"http://forrest.apache.org/dtd/howto-v20.dtd">
<howto>
+ <header>
+ <title>How to run Forrest from within Maven</title>
- <header>
- <title>How to run Forrest from within Maven</title>
- <abstract>
- This How-To describes how to run Forrest from within Maven.
- </abstract>
- <last-modified-content-date date="2004-11-12"/>
- </header>
+ <abstract>This How-To describes how to run Forrest from within
+ Maven.</abstract>
+
+ <last-modified-content-date date="2004-11-12" />
+ </header>
<audience title="Intended Audience">
- <p>
- Users who want to run Forrest from within Maven.
- </p>
+ <p>Users who want to run Forrest from within Maven.</p>
</audience>
-
+
<purpose title="Purpose">
- <p>
- One may want to generate their project's documentation and/or website
- using Forrest in lieu of Maven's site plugin.
- </p>
+ <p>One may want to generate their project's documentation and/or website
+ using Forrest in lieu of Maven's site plugin.</p>
</purpose>
<prerequisites title="Prerequisites">
<ul>
- <li>Understand how to add goals to
- <a href="http://maven.apache.org/reference/user-guide.html#maven_xml">maven.xml</a>.</li>
+ <li>Understand how to add goals to <a
+ href="http://maven.apache.org/reference/user-guide.html#maven_xml">maven.xml</a>.</li>
</ul>
</prerequisites>
<steps title="Steps">
- <p>
- The procedure outlined below describes how to add a goal to your
- project's maven.xml that will invoke Forrest's <code>site</code> target.
- </p>
+ <p>The procedure outlined below describes how to add a goal to your
+ project's maven.xml that will invoke Forrest's <code>site</code>
+ target.</p>
<section id="set-maven-home">
<title>Set the FORREST_HOME environment variable</title>
- <p>
- Make sure the FORREST_HOME environment variable points to your Forrest home directory
- (i.e. the directory that contains <code>forrest.build.xml</code>)
- (e.g. C:\opt\apache-forrest-0.6\src\core)
- </p>
-
- <fixme author="rdg">Under Forrest 0.7 the directories for
- Forrest have been restructured. Consequently, FORREST_HOME is no
- longer set to the directory containing <code>forrest.build.xml</code>.
- Update this document to reflect what should be done under 0.7.</fixme>
+
+ <p>Make sure the FORREST_HOME environment variable points to your
+ Forrest home directory (i.e. the directory that contains
+ <code>forrest.build.xml</code>) (e.g. C:\opt\apache-forrest-0.7)</p>
</section>
<section id="define-ant-environment-prop">
- <title>Initialize an Ant environment property at the top of maven.xml</title>
- <p>
- Paste the following line at the top of your maven.xml:
- </p>
+ <title>Initialize an Ant environment property at the top of
+ maven.xml</title>
+
+ <p>Paste the following line at the top of your maven.xml:</p>
+
<source>
<property environment="env" />
</source>
@@ -80,14 +68,13 @@
<section id="add-forrest-goal-to-maven-xml">
<title>Add forrest goal to maven.xml</title>
- <p>
- Paste the following goal into your project's maven.xml:
- </p>
+
+ <p>Paste the following goal into your project's maven.xml:</p>
+
<source>
<goal name="forrest" description="runs Forrest">
<property name="forrest.home" location="${env.FORREST_HOME}" />
- <property name="forrest.install.dir" location="${forrest.home}/../.." />
- <property name="forrest.ant.home" location="${forrest.install.dir}/tools/ant" />
+ <property name="forrest.ant.home" location="${forrest.home}/tools/ant" />
<java classname="org.apache.tools.ant.Main" fork="true" failonerror="true" maxmemory="128M">
<classpath>
<fileset dir="${forrest.ant.home}/lib">
@@ -98,26 +85,21 @@
<sysproperty key="ant.home" value="${forrest.ant.home}" />
<sysproperty key="forrest.home" value="${forrest.home}" />
<sysproperty key="basedir" value="${basedir}" />
- <sysproperty key="java.endorsed.dirs" value="${forrest.install.dir}/lib/endorsed" />
- <arg line="-f ${forrest.home}/forrest.build.xml" />
+ <sysproperty key="java.endorsed.dirs" value="${forrest.home}/lib/endorsed" />
+ <arg line="-f ${forrest.home}/main/forrest.build.xml" />
</java>
</goal>
</source>
- <p>
- It is necessary to fork a separate java process because Maven 1.0
- embeds Ant 1.5.2, but Forrest's forrest.build.xml requires Ant 1.6.
- The goal makes use of the copy of Ant 1.6 that is bundled with
- Forrest, so it's not even necessary to have Ant 1.6 installed separately.
- </p>
+
+ <p>It is necessary to fork a separate java process because Maven 1.0
+ embeds Ant 1.5.2, but Forrest's forrest.build.xml requires Ant 1.6. The
+ goal makes use of the copy of Ant 1.6 that is bundled with Forrest, so
+ it's not even necessary to have Ant 1.6 installed separately.</p>
</section>
</steps>
<feedback title="Feedback">
- <p>
- Please provide feedback about this document via the
- <a href="ext:mail-lists">mailing lists</a>.
- <!-- Original author: Ian Springer (ips AT apache DOT org) -->
- </p>
+ <p>Please provide feedback about this document via the <a
+ href="ext:mail-lists">mailing lists</a>. <!-- Original author: Ian Springer (ips AT apache DOT org) --></p>
</feedback>
-
-</howto>
+</howto>
\ No newline at end of file