| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html> |
| <head> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta content="Apache Forrest" name="Generator"> |
| <meta name="Forrest-version" content="0.8-dev"> |
| <meta name="Forrest-skin-name" content="pelt"> |
| <title>How to run Forrest from within Maven (v0.7)</title> |
| <link type="text/css" href="../../skin/basic.css" rel="stylesheet"> |
| <link media="screen" type="text/css" href="../../skin/screen.css" rel="stylesheet"> |
| <link media="print" type="text/css" href="../../skin/print.css" rel="stylesheet"> |
| <link type="text/css" href="../../skin/profile.css" rel="stylesheet"> |
| <script src="../../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../../skin/fontsize.js" language="javascript" type="text/javascript"></script> |
| <link rel="shortcut icon" href="../../favicon.ico"> |
| </head> |
| <body onload="init()"> |
| <script type="text/javascript">ndeSetTextSize();</script> |
| <div id="top"> |
| <!--+ |
| |breadtrail |
| +--> |
| <div class="breadtrail"> |
| <a href="http://www.apache.org/">apache</a> > <a href="http://forrest.apache.org/">forrest</a><script src="../../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script> |
| </div> |
| <!--+ |
| |header |
| +--> |
| <div class="header"> |
| <!--+ |
| |start group logo |
| +--> |
| <div class="grouplogo"> |
| <a href="http://www.apache.org/"><img class="logoImage" alt="Apache" src="../../images/apache-forrest.png" title="The Apache Software Foundation"></a> |
| </div> |
| <!--+ |
| |end group logo |
| +--> |
| <!--+ |
| |start Project Logo |
| +--> |
| <div class="projectlogo"> |
| <a href="http://forrest.apache.org/"><img class="logoImage" alt="Forrest" src="../../images/project-logo.gif" title="Apache Forrest"></a> |
| </div> |
| <!--+ |
| |end Project Logo |
| +--> |
| <!--+ |
| |start Search |
| +--> |
| <div class="searchbox"> |
| <form action="http://www.google.com/search" method="get" class="roundtopsmall"> |
| <input value="forrest.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google');" size="25" name="q" id="query" type="text" value="Search the site with google"> |
| <input name="Search" value="Search" type="submit"> |
| </form> |
| </div> |
| <!--+ |
| |end search |
| +--> |
| <!--+ |
| |start Tabs |
| +--> |
| <ul id="tabs"> |
| <li> |
| <a class="unselected" href="../../index.html">Welcome</a> |
| </li> |
| <li> |
| <a class="unselected" href="../../contrib.html">Developers</a> |
| </li> |
| <li class="current"> |
| <a class="selected" href="../../versions/index.html">Versioned Docs</a> |
| </li> |
| <li> |
| <a class="unselected" href="../../pluginDocs/index.html">Plugins</a> |
| </li> |
| <li> |
| <a class="unselected" href="../../tools/index.html">Tools</a> |
| </li> |
| </ul> |
| <!--+ |
| |end Tabs |
| +--> |
| </div> |
| </div> |
| <div id="main"> |
| <div id="publishedStrip"> |
| <!--+ |
| |start Subtabs |
| +--> |
| <div id="level2tabs"> |
| <a class="selected" href="../../docs_0_70/index.html">0.70 (current)</a><a class="unselected" href="../../docs_0_80/index.html">0.80-dev (under development)</a><a class="unselected" href="../../docs_0_60/index.html">0.60 (past)</a> |
| </div> |
| <!--+ |
| |end Endtabs |
| +--> |
| <script type="text/javascript"><!-- |
| document.write("Last Published: " + document.lastModified); |
| // --></script> |
| </div> |
| <!--+ |
| |breadtrail |
| +--> |
| <div class="breadtrail"> |
| |
| |
| </div> |
| <!--+ |
| |start Menu, mainarea |
| +--> |
| <!--+ |
| |start Menu |
| +--> |
| <div id="menu"> |
| <div onclick="SwitchMenu('menu_selected_1.1', '../../skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('../../skin/images/chapter_open.gif');">0.70</div> |
| <div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;"> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/index.html">Overview</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/faq.html">FAQs</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/changes.html">Changes</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/todo.html">Todo</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/your-project.html">Using Forrest</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/validation.html">XML Validation</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/linking.html">Menus and Linking</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/searching.html">Searching</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/skins.html">Default Skins</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/skin-package.html">Skin Packages</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/views.html">Views-dev</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/forrest-contract.html">Our Contract</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/compliance.html">Standards Compliance</a> |
| </div> |
| <div onclick="SwitchMenu('menu_selected_1.1.14', '../../skin/')" id="menu_selected_1.1.14Title" class="menutitle" style="background-image: url('../../skin/images/chapter_open.gif');">How-To</div> |
| <div id="menu_selected_1.1.14" class="selectedmenuitemgroup" style="display: block;"> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/howto/index.html">Overview</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/howto/howto-howto.html">Write a How-to</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/howto/howto-asf-mirror.html">Download mirror</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/howto/howto-pdf-tab.html">Create tab PDF</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/howto/howto-editcss.html">Edit CSS (WYSIWYG)</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/howto/howto-corner-images.html">CSS corner SVG</a> |
| </div> |
| <div class="menupage"> |
| <div class="menupagetitle">Maven Integration</div> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/howto/howto-buildPlugin.html">Build a Plugin</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/howto/howto-custom-html-source.html">Custom html source</a> |
| </div> |
| <div onclick="SwitchMenu('menu_1.1.14.10', '../../skin/')" id="menu_1.1.14.10Title" class="menutitle">Multipage HowTo</div> |
| <div id="menu_1.1.14.10" class="menuitemgroup"> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/howto/multi/howto-multi.html">Introduction</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/howto/multi/step1.html">Step 1</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/howto/multi/step2.html">Step 2</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/howto/multi/step3.html">Step 3</a> |
| </div> |
| </div> |
| <div onclick="SwitchMenu('menu_1.1.14.11', '../../skin/')" id="menu_1.1.14.11Title" class="menutitle">Views</div> |
| <div id="menu_1.1.14.11" class="menuitemgroup"> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/howto/howto-view-install.html">Install views</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/howto/howto-view-dsl.html">forrest:view DSL</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/howto/howto-view-contracts.html">contract implementations</a> |
| </div> |
| </div> |
| </div> |
| <div onclick="SwitchMenu('menu_1.1.15', '../../skin/')" id="menu_1.1.15Title" class="menutitle">Advanced Topics</div> |
| <div id="menu_1.1.15" class="menuitemgroup"> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/build.html">Building Forrest</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/catalog.html">Using DTD Catalogs</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/sitemap-ref.html">Sitemap Reference</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/project-sitemap.html">Project sitemap</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/cap.html">Sourcetype Action</a> |
| </div> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/upgrading_07.html">Upgrading to 0.7</a> |
| </div> |
| <div onclick="SwitchMenu('menu_1.1.17', '../../skin/')" id="menu_1.1.17Title" class="menutitle">Reference docs</div> |
| <div id="menu_1.1.17" class="menuitemgroup"> |
| <div onclick="SwitchMenu('menu_1.1.17.1', '../../skin/')" id="menu_1.1.17.1Title" class="menutitle">DTD documentation</div> |
| <div id="menu_1.1.17.1" class="menuitemgroup"> |
| <div class="menuitem"> |
| <a href="../../dtdx/dtd-docs.html">Overview</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../dtdx/document-v20.dtdx.html">document-v20</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../dtdx/howto-v20.dtdx.html">howto-v20</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../dtdx/faq-v20.dtdx.html">faq-v20</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../dtdx/document-v13.dtdx.html">document-v13</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../dtdx/howto-v13.dtdx.html">howto-v13</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../dtdx/faq-v13.dtdx.html">faq-v13</a> |
| </div> |
| </div> |
| <div onclick="SwitchMenu('menu_1.1.17.2', '../../skin/')" id="menu_1.1.17.2Title" class="menutitle">Doc samples</div> |
| <div id="menu_1.1.17.2" class="menuitemgroup"> |
| <div class="menuitem"> |
| <a href="../../dtdx/document-v13.html">document-v13</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../dtdx/document-v20.html">document-v20</a> |
| </div> |
| </div> |
| </div> |
| <div onclick="SwitchMenu('menu_1.1.18', '../../skin/')" id="menu_1.1.18Title" class="menutitle">Older Docs</div> |
| <div id="menu_1.1.18" class="menuitemgroup"> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/primer.html">Forrest Primer</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/libre-intro.html">Libre</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/dreams.html">Dream list</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../../docs_0_70/howto/cvs-ssh/howto-cvs-ssh.html">CVS over SSH</a> |
| </div> |
| </div> |
| </div> |
| <div id="credit"> |
| <hr> |
| This is documentation for current version v0.7 |
| (<a href="http://forrest.apache.org/versions/">More</a>)</div> |
| <div id="roundbottom"> |
| <img style="display: none" class="corner" height="15" width="15" alt="" src="../../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div> |
| <!--+ |
| |alternative credits |
| +--> |
| <div id="credit2"> |
| <a href="http://apachecon.com/2007/EU/"><img border="0" title="ApacheCon Europe 2007" alt="ApacheCon Europe 2007 - logo" src="http://apache.org/ads/ApacheCon/2007-europe-125x125.png" style="width: 125px;height: 125px;"></a><a href="http://people.apache.org/calendar.html#200711"><img border="0" title="ApacheCon US 2007" alt="ApacheCon US 2007 - logo" src="http://apache.org/ads/ApacheCon/2007-usa-125x125.png" style="width: 125px;height: 125px;"></a> |
| </div> |
| </div> |
| <!--+ |
| |end Menu |
| +--> |
| <!--+ |
| |start content |
| +--> |
| <div id="content"> |
| <div title="Portable Document Format" class="pdflink"> |
| <a class="dida" href="howto-forrest-from-maven.pdf"><img alt="PDF -icon" src="../../skin/images/pdfdoc.gif" class="skin"><br> |
| PDF</a> |
| </div> |
| <div class="trail">Font size: |
| <input value="Reset" class="resetfont" title="Reset text" onclick="ndeSetTextSize('reset'); return false;" type="button"> |
| <input value="-a" class="smallerfont" title="Shrink text" onclick="ndeSetTextSize('decr'); return false;" type="button"> |
| <input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button"> |
| </div> |
| <h1>How to run Forrest from within Maven</h1> |
| <div class="abstract">This How-To describes how to run Forrest from within |
| Maven.</div> |
| <div id="motd-area"> |
| This is documentation for current version v0.7 |
| (<a href="http://forrest.apache.org/versions/">More</a>)</div> |
| <div id="minitoc-area"> |
| <ul class="minitoc"> |
| <li> |
| <a href="#Intended Audience">Intended Audience</a> |
| </li> |
| <li> |
| <a href="#Purpose">Purpose</a> |
| </li> |
| <li> |
| <a href="#Prerequisites">Prerequisites</a> |
| </li> |
| <li> |
| <a href="#Steps">Steps</a> |
| <ul class="minitoc"> |
| <li> |
| <a href="#set-maven-home">Set the FORREST_HOME environment variable</a> |
| </li> |
| <li> |
| <a href="#define-ant-environment-prop">Initialize an Ant environment property at the top of |
| maven.xml</a> |
| </li> |
| <li> |
| <a href="#add-forrest-goal-to-maven-xml">Add forrest goal to maven.xml</a> |
| </li> |
| <li> |
| <a href="#Alternative+file">Alternative file</a> |
| </li> |
| </ul> |
| </li> |
| <li> |
| <a href="#Feedback">Feedback</a> |
| </li> |
| </ul> |
| </div> |
| <a name="N10010"></a><a name="Intended Audience"></a> |
| <h2 class="underlined_10">Intended Audience</h2> |
| <div class="section"> |
| <p>Users who want to run Forrest from within Maven.</p> |
| </div> |
| <a name="N10018"></a><a name="Purpose"></a> |
| <h2 class="underlined_10">Purpose</h2> |
| <div class="section"> |
| <p>One may want to generate their project's documentation and/or website |
| using Forrest in lieu of Maven's site plugin.</p> |
| </div> |
| <a name="N10020"></a><a name="Prerequisites"></a> |
| <h2 class="underlined_10">Prerequisites</h2> |
| <div class="section"> |
| <ul> |
| |
| <li>Understand how to add goals to <a href="http://maven.apache.org/reference/user-guide.html#maven_xml">maven.xml</a>.</li> |
| |
| </ul> |
| </div> |
| <a name="N1002F"></a><a name="Steps"></a> |
| <h2 class="underlined_10">Steps</h2> |
| <div class="section"> |
| <p>The procedure outlined below describes how to add a goal to your |
| project's maven.xml that will invoke Forrest's <span class="codefrag">site</span> |
| target.</p> |
| <a name="N1003A"></a><a name="set-maven-home"></a> |
| <h3 class="underlined_5">Set the FORREST_HOME environment variable</h3> |
| <p>Make sure the FORREST_HOME environment variable points to your |
| Forrest home directory (i.e. the directory that contains |
| <span class="codefrag">forrest.build.xml</span>) (e.g. C:\opt\apache-forrest-0.7)</p> |
| <a name="N10047"></a><a name="define-ant-environment-prop"></a> |
| <h3 class="underlined_5">Initialize an Ant environment property at the top of |
| maven.xml</h3> |
| <p>Paste the following line at the top of your maven.xml:</p> |
| <pre class="code"> |
| <property environment="env" /> |
| </pre> |
| <a name="N10055"></a><a name="add-forrest-goal-to-maven-xml"></a> |
| <h3 class="underlined_5">Add forrest goal to maven.xml</h3> |
| <p>Paste the following goal into your project's maven.xml:</p> |
| <pre class="code"> |
| <goal name="forrest" description="runs Forrest"> |
| <property name="forrest.home" location="${env.FORREST_HOME}" /> |
| <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"> |
| <include name="*.jar" /> |
| </fileset> |
| <pathelement path="${java.home}/../lib/tools.jar" /> |
| </classpath> |
| <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.home}/lib/endorsed" /> |
| <arg line="-f ${forrest.home}/main/forrest.build.xml" /> |
| </java> |
| </goal> |
| </pre> |
| <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> |
| <a name="N10066"></a><a name="Alternative+file"></a> |
| <h3 class="underlined_5">Alternative file</h3> |
| <p>Under <span class="codefrag">$FORREST_HOME/tools/targets/maven.xml</span> |
| </p> |
| </div> |
| <a name="N10072"></a><a name="Feedback"></a> |
| <h2 class="underlined_10">Feedback</h2> |
| <div class="section"> |
| <p>Please provide feedback about this document via the <a href="../../mail-lists.html">mailing lists</a>.<!-- Original author: Ian Springer (ips AT apache DOT org) --></p> |
| </div> |
| </div> |
| <!--+ |
| |end content |
| +--> |
| <div class="clearboth"> </div> |
| </div> |
| <div id="footer"> |
| <!--+ |
| |start bottomstrip |
| +--> |
| <div class="lastmodified"> |
| <script type="text/javascript"><!-- |
| document.write("Last Published: " + document.lastModified); |
| // --></script> |
| </div> |
| <div class="copyright"> |
| Copyright © |
| 2002-2007 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a> |
| </div> |
| <!--+ |
| |end bottomstrip |
| +--> |
| </div> |
| </body> |
| </html> |
