You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by cr...@apache.org on 2005/04/11 16:59:15 UTC
svn commit: r160895 [14/28] - in forrest/site/0.7: ./ docs/ docs/howto/
docs/images/ docs/plugins/
Added: forrest/site/0.7/docs/forrest-contract.html
URL: http://svn.apache.org/viewcvs/forrest/site/0.7/docs/forrest-contract.html?view=auto&rev=160895
==============================================================================
--- forrest/site/0.7/docs/forrest-contract.html (added)
+++ forrest/site/0.7/docs/forrest-contract.html Mon Apr 11 07:58:59 2005
@@ -0,0 +1,435 @@
+<!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.7-dev">
+<meta name="Forrest-skin-name" content="pelt">
+<meta-data></meta-data>
+<title>Our Contract (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:');" value="Search the site with google:" size="25" name="q" id="query" type="text">
+ <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+ |end search
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="base-not-selected" href="../index.html">Welcome</a>
+</li>
+<li>
+<a class="base-not-selected" href="../contrib.html">Project</a>
+</li>
+<li class="current">
+<a class="base-selected" href="../docs/index.html">0.7 Docs</a>
+</li>
+<li>
+<a class="base-not-selected" href="../docs/howto/index.html">0.7 How-To</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs">
+<a class="base-not-selected" href="..">Core</a> | <a class="base-not-selected" href="..">ForrestBot</a> | <a class="base-not-selected" href="..">ForrestBar</a>
+</div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript" language="JavaScript"><!--
+ document.write("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');">Documentation</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a title="" href="../docs/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/faq.html">FAQs</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/changes.html">Changes</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/todo.html">Todo</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/your-project.html">Using Forrest</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/validation.html">XML Validation</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/linking.html">Menus and Linking</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/searching.html">Searching</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/skins.html">Default Skins</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/skin-package.html">Skin Packages</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/plugins/usingPlugins.html">Plugins</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/views.html">Views-dev</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Our Contract</div>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/compliance.html">Standards Compliance</a>
+</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 title="" href="../docs/build.html">Building Forrest</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/catalog.html">Using DTD Catalogs</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/sitemap-ref.html">Sitemap Reference</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/project-sitemap.html">Project sitemap</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/plugins/pluginInfrastructure.html">Plugin Infrastructure</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/cap.html">Sourcetype Action</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.16', '../skin/')" id="menu_1.1.16Title" class="menutitle">Other versions</div>
+<div id="menu_1.1.16" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="http://forrest.apache.org/docs/../0.8/">0.8-dev</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/index.html">0.7 (current)</a>
+</div>
+<div class="menuitem">
+<a title="" href="http://forrest.apache.org/docs/../0.6/">0.6</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.17', '../skin/')" id="menu_1.1.17Title" class="menutitle">Upgrading</div>
+<div id="menu_1.1.17" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/upgrading_07.html">Upgrading to 0.7</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/upgrading_06.html">Upgrading to 0.6</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.18', '../skin/')" id="menu_1.1.18Title" class="menutitle">SubProjects</div>
+<div id="menu_1.1.18" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/forrestbar.html">ForrestBar</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/forrestbot.html">Forrestbot</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/forrestbot-web-interface.html">Forrestbot Webapp</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.19', '../skin/')" id="menu_1.1.19Title" class="menutitle">Reference docs</div>
+<div id="menu_1.1.19" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.1.19.1', '../skin/')" id="menu_1.1.19.1Title" class="menutitle">DTD documentation</div>
+<div id="menu_1.1.19.1" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/dtd-docs.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/document-v20.dtdx.html">document-v20</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/howto-v20.dtdx.html">howto-v20</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/faq-v20.dtdx.html">faq-v20</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/document-v13.dtdx.html">document-v13</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/howto-v13.dtdx.html">howto-v13</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/faq-v13.dtdx.html">faq-v13</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.19.2', '../skin/')" id="menu_1.1.19.2Title" class="menutitle">Doc samples</div>
+<div id="menu_1.1.19.2" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/document-v13.html">document-v13</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/document-v20.html">document-v20</a>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.20', '../skin/')" id="menu_1.1.20Title" class="menutitle">Older Docs</div>
+<div id="menu_1.1.20" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/primer.html">Forrest Primer</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/libre-intro.html">Libre</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/dreams.html">Dream list</a>
+</div>
+</div>
+</div>
+<div id="credit">
+<hr>
+ This is documentation for current release v0.7
+ (<a href="http://forrest.apache.org/docs.html">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>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="forrest-contract.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>Our Contract</h1>
+<div class="abstract">This document describes, in a very techy bullet-style way, how
+ to use Forrest.</div>
+<div id="motd-area">
+ This is documentation for current release v0.7
+ (<a href="http://forrest.apache.org/docs.html">More</a> ...)</div>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#forrest-will">Forrest will:</a>
+</li>
+<li>
+<a href="#project-must">TheProject must:</a>
+</li>
+<li>
+<a href="#project-can">TheProject can:</a>
+</li>
+</ul>
+</div>
+
+<div class="frame note">
+<div class="label">Note</div>
+<div class="content">
+ This document describes the formal contract between the
+ <strong>Forrest distribution code</strong>, hereafter referred as
+ "Forrest", and
+ the <strong>Project (team)</strong> that is using it for generating
+ its documentation and web-site, hereafter referred to as "TheProject".
+ </div>
+</div>
+
+<div class="frame note">
+<div class="label">Note</div>
+<div class="content">
+ Some terminology will assist: <span class="codefrag">{docroot}</span> is the location
+ inside TheProject's file hierarchy where all documentation related
+ resources are stored. Usually <span class="codefrag">{docroot}</span> equals to
+ <span class="codefrag">{projecthome}/src/documentation</span>
+
+</div>
+</div>
+
+
+<a name="N1002C"></a><a name="forrest-will"></a>
+<h2 class="underlined_10">Forrest will:</h2>
+<div class="section">
+<p>Provide infrastructure ...</p>
+<ul>
+
+<li>Provide document type definitions (DTDs), skins, default sitemaps,
+ Cocoon pipelines.
+ </li>
+
+<li>Provide a willing team of supporting developers at the forrest-dev
+ <a href="http://forrest.apache.org/mail-lists.html">mail list</a>.
+ </li>
+
+<li>Use Cocoon to generate the HTML and PDF documentation for
+ TheProject.</li>
+
+</ul>
+</div>
+
+
+<a name="N10046"></a><a name="project-must"></a>
+<h2 class="underlined_10">TheProject must:</h2>
+<div class="section">
+<p>Provide content and configuration ...</p>
+<ul>
+
+<li>Provide XML content in <span class="codefrag">{docroot}/content/xdocs</span>
+ according to the Forrest DTDs or one of the other input formats.
+ </li>
+
+<li>Provide navigation metadata using the configuration files
+ <span class="codefrag">site.xml</span> and <span class="codefrag">tabs.xml</span>
+
+</li>
+
+<li>Provide the skin configuation file in
+ <span class="codefrag">{projecthome}/skinconf.xml</span>
+
+</li>
+
+</ul>
+</div>
+
+
+<a name="N10068"></a><a name="project-can"></a>
+<h2 class="underlined_10">TheProject can:</h2>
+<div class="section">
+<p>Add extra abilities ...</p>
+<ul>
+
+<li>Provide its own skin in
+ <span class="codefrag">{docroot}/skins/{your-skin-name}</span> (Check the current
+ Forrest skins and the related pipelines to see what they are doing.
+ Bear in mind that the provided skins are able to be configured and
+ may already meet your needs.)</li>
+
+<li>Provide own DTDs to handle other specialised document types in
+ <span class="codefrag">{docroot}/resources/schema/dtd</span>
+
+<ul>
+
+<li>and extra stylesheets to convert own grammar to the
+ intermediate 'document' structure.</li>
+
+<li>and declare those extra DTDs in
+ <span class="codefrag">{docroot}/resources/schema/catalog.xcat</span>
+</li>
+
+</ul>
+
+</li>
+
+<li>Provide its own overwriting versions of sitemaps
+ (<span class="codefrag">{docroot}/sitemap.xmap</span> and other *.xmap files)
+ ... (be sure you know what you are doing since you are then leaving
+ the area where other Forresters can help you out.
+ </li>
+
+</ul>
+</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-2005 The Apache Software Foundation.</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Propchange: forrest/site/0.7/docs/forrest-contract.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/site/0.7/docs/forrest-contract.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/0.7/docs/forrest-contract.pdf?view=auto&rev=160895
==============================================================================
Binary file - no diff available.
Propchange: forrest/site/0.7/docs/forrest-contract.pdf
------------------------------------------------------------------------------
svn:mime-type = application/pdf
Added: forrest/site/0.7/docs/forrestbar.html
URL: http://svn.apache.org/viewcvs/forrest/site/0.7/docs/forrestbar.html?view=auto&rev=160895
==============================================================================
--- forrest/site/0.7/docs/forrestbar.html (added)
+++ forrest/site/0.7/docs/forrestbar.html Mon Apr 11 07:58:59 2005
@@ -0,0 +1,350 @@
+<!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.7-dev">
+<meta name="Forrest-skin-name" content="pelt">
+<meta-data></meta-data>
+<title>The ForrestBar (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:');" value="Search the site with google:" size="25" name="q" id="query" type="text">
+ <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+ |end search
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="base-not-selected" href="../index.html">Welcome</a>
+</li>
+<li>
+<a class="base-not-selected" href="../contrib.html">Project</a>
+</li>
+<li class="current">
+<a class="base-selected" href="../docs/index.html">0.7 Docs</a>
+</li>
+<li>
+<a class="base-not-selected" href="../docs/howto/index.html">0.7 How-To</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs">
+<a class="base-not-selected" href="..">Core</a> | <a class="base-not-selected" href="..">ForrestBot</a> | <a class="base-not-selected" href="..">ForrestBar</a>
+</div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript" language="JavaScript"><!--
+ document.write("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');">Documentation</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a title="" href="../docs/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/faq.html">FAQs</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/changes.html">Changes</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/todo.html">Todo</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/your-project.html">Using Forrest</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/validation.html">XML Validation</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/linking.html">Menus and Linking</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/searching.html">Searching</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/skins.html">Default Skins</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/skin-package.html">Skin Packages</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/plugins/usingPlugins.html">Plugins</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/views.html">Views-dev</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/forrest-contract.html">Our Contract</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/compliance.html">Standards Compliance</a>
+</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 title="" href="../docs/build.html">Building Forrest</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/catalog.html">Using DTD Catalogs</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/sitemap-ref.html">Sitemap Reference</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/project-sitemap.html">Project sitemap</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/plugins/pluginInfrastructure.html">Plugin Infrastructure</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/cap.html">Sourcetype Action</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.16', '../skin/')" id="menu_1.1.16Title" class="menutitle">Other versions</div>
+<div id="menu_1.1.16" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="http://forrest.apache.org/docs/../0.8/">0.8-dev</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/index.html">0.7 (current)</a>
+</div>
+<div class="menuitem">
+<a title="" href="http://forrest.apache.org/docs/../0.6/">0.6</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.17', '../skin/')" id="menu_1.1.17Title" class="menutitle">Upgrading</div>
+<div id="menu_1.1.17" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/upgrading_07.html">Upgrading to 0.7</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/upgrading_06.html">Upgrading to 0.6</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.1.18', '../skin/')" id="menu_selected_1.1.18Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">SubProjects</div>
+<div id="menu_selected_1.1.18" class="selectedmenuitemgroup" style="display: block;">
+<div class="menupage">
+<div class="menupagetitle">ForrestBar</div>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/forrestbot.html">Forrestbot</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/forrestbot-web-interface.html">Forrestbot Webapp</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.19', '../skin/')" id="menu_1.1.19Title" class="menutitle">Reference docs</div>
+<div id="menu_1.1.19" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.1.19.1', '../skin/')" id="menu_1.1.19.1Title" class="menutitle">DTD documentation</div>
+<div id="menu_1.1.19.1" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/dtd-docs.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/document-v20.dtdx.html">document-v20</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/howto-v20.dtdx.html">howto-v20</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/faq-v20.dtdx.html">faq-v20</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/document-v13.dtdx.html">document-v13</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/howto-v13.dtdx.html">howto-v13</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/faq-v13.dtdx.html">faq-v13</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.19.2', '../skin/')" id="menu_1.1.19.2Title" class="menutitle">Doc samples</div>
+<div id="menu_1.1.19.2" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/document-v13.html">document-v13</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/document-v20.html">document-v20</a>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.20', '../skin/')" id="menu_1.1.20Title" class="menutitle">Older Docs</div>
+<div id="menu_1.1.20" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/primer.html">Forrest Primer</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/libre-intro.html">Libre</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/dreams.html">Dream list</a>
+</div>
+</div>
+</div>
+<div id="credit">
+<hr>
+ This is documentation for current release v0.7
+ (<a href="http://forrest.apache.org/docs.html">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>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="forrestbar.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>The ForrestBar</h1>
+<div id="motd-area">
+ This is documentation for current release v0.7
+ (<a href="http://forrest.apache.org/docs.html">More</a> ...)</div>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#What%27s+the+Forrestbar%3F">What's the Forrestbar?</a>
+</li>
+<li>
+<a href="#Installing+the+Forrestbar">Installing the Forrestbar</a>
+</li>
+</ul>
+</div>
+
+<a name="N1000D"></a><a name="What%27s+the+Forrestbar%3F"></a>
+<h2 class="underlined_10">What's the Forrestbar?</h2>
+<div class="section">
+<p>The Forrestbar is a toolbar made for <a href="http://www.mozilla.org/">Mozilla</a>
+ (and <a href="http://www.mozilla.org/products/firefox/">Firefox</a> compatible)
+ that eases the navigation of Apache
+ projects and resources, and to the local Forrest running on your machine.</p>
+</div>
+
+<a name="N1001F"></a><a name="Installing+the+Forrestbar"></a>
+<h2 class="underlined_10">Installing the Forrestbar</h2>
+<div class="section">
+<div class="frame note">
+<div class="label">Note</div>
+<div class="content">Forrestbar does not currently work with Firefox 0.9+</div>
+</div>
+<p>To install the latest nightly version brought to you by
+ <a href="http://gump.apache.org/">Gump</a> in <a href="http://www.mozilla.org/">Mozilla</a>
+ or <a href="http://www.mozilla.org/products/firefox/">Firefox</a>, just
+ <a href="javascript:InstallTrigger.install( {'Forrestbar': 'forrestbar.xpi'} );">
+ install it</a> or <a href="forrestbar.xpi">download it</a>
+ and drop it on a mozilla window.</p>
+<p>To get the latest and greatest version run the forrestbar target of the Forrest build.</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-2005 The Apache Software Foundation.</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Propchange: forrest/site/0.7/docs/forrestbar.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/site/0.7/docs/forrestbar.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/0.7/docs/forrestbar.pdf?view=auto&rev=160895
==============================================================================
Binary file - no diff available.
Propchange: forrest/site/0.7/docs/forrestbar.pdf
------------------------------------------------------------------------------
svn:mime-type = application/pdf
Added: forrest/site/0.7/docs/forrestbar.xpi
URL: http://svn.apache.org/viewcvs/forrest/site/0.7/docs/forrestbar.xpi?view=auto&rev=160895
==============================================================================
Binary file - no diff available.
Propchange: forrest/site/0.7/docs/forrestbar.xpi
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: forrest/site/0.7/docs/forrestbot-web-interface.html
URL: http://svn.apache.org/viewcvs/forrest/site/0.7/docs/forrestbot-web-interface.html?view=auto&rev=160895
==============================================================================
--- forrest/site/0.7/docs/forrestbot-web-interface.html (added)
+++ forrest/site/0.7/docs/forrestbot-web-interface.html Mon Apr 11 07:58:59 2005
@@ -0,0 +1,522 @@
+<!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.7-dev">
+<meta name="Forrest-skin-name" content="pelt">
+<meta-data></meta-data>
+<title>Forrestbot Web Interface (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:');" value="Search the site with google:" size="25" name="q" id="query" type="text">
+ <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+ |end search
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="base-not-selected" href="../index.html">Welcome</a>
+</li>
+<li>
+<a class="base-not-selected" href="../contrib.html">Project</a>
+</li>
+<li class="current">
+<a class="base-selected" href="../docs/index.html">0.7 Docs</a>
+</li>
+<li>
+<a class="base-not-selected" href="../docs/howto/index.html">0.7 How-To</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs">
+<a class="base-not-selected" href="..">Core</a> | <a class="base-not-selected" href="..">ForrestBot</a> | <a class="base-not-selected" href="..">ForrestBar</a>
+</div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript" language="JavaScript"><!--
+ document.write("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');">Documentation</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a title="" href="../docs/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/faq.html">FAQs</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/changes.html">Changes</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/todo.html">Todo</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/your-project.html">Using Forrest</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/validation.html">XML Validation</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/linking.html">Menus and Linking</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/searching.html">Searching</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/skins.html">Default Skins</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/skin-package.html">Skin Packages</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/plugins/usingPlugins.html">Plugins</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/views.html">Views-dev</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/forrest-contract.html">Our Contract</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/compliance.html">Standards Compliance</a>
+</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 title="" href="../docs/build.html">Building Forrest</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/catalog.html">Using DTD Catalogs</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/sitemap-ref.html">Sitemap Reference</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/project-sitemap.html">Project sitemap</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/plugins/pluginInfrastructure.html">Plugin Infrastructure</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/cap.html">Sourcetype Action</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.16', '../skin/')" id="menu_1.1.16Title" class="menutitle">Other versions</div>
+<div id="menu_1.1.16" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="http://forrest.apache.org/docs/../0.8/">0.8-dev</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/index.html">0.7 (current)</a>
+</div>
+<div class="menuitem">
+<a title="" href="http://forrest.apache.org/docs/../0.6/">0.6</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.17', '../skin/')" id="menu_1.1.17Title" class="menutitle">Upgrading</div>
+<div id="menu_1.1.17" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/upgrading_07.html">Upgrading to 0.7</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/upgrading_06.html">Upgrading to 0.6</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.1.18', '../skin/')" id="menu_selected_1.1.18Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">SubProjects</div>
+<div id="menu_selected_1.1.18" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a title="" href="../docs/forrestbar.html">ForrestBar</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/forrestbot.html">Forrestbot</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Forrestbot Webapp</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.19', '../skin/')" id="menu_1.1.19Title" class="menutitle">Reference docs</div>
+<div id="menu_1.1.19" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.1.19.1', '../skin/')" id="menu_1.1.19.1Title" class="menutitle">DTD documentation</div>
+<div id="menu_1.1.19.1" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/dtd-docs.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/document-v20.dtdx.html">document-v20</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/howto-v20.dtdx.html">howto-v20</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/faq-v20.dtdx.html">faq-v20</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/document-v13.dtdx.html">document-v13</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/howto-v13.dtdx.html">howto-v13</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/faq-v13.dtdx.html">faq-v13</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.19.2', '../skin/')" id="menu_1.1.19.2Title" class="menutitle">Doc samples</div>
+<div id="menu_1.1.19.2" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/document-v13.html">document-v13</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/document-v20.html">document-v20</a>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.20', '../skin/')" id="menu_1.1.20Title" class="menutitle">Older Docs</div>
+<div id="menu_1.1.20" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/primer.html">Forrest Primer</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/libre-intro.html">Libre</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/dreams.html">Dream list</a>
+</div>
+</div>
+</div>
+<div id="credit">
+<hr>
+ This is documentation for current release v0.7
+ (<a href="http://forrest.apache.org/docs.html">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>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="forrestbot-web-interface.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>Forrestbot Web Interface</h1>
+<div id="motd-area">
+ This is documentation for current release v0.7
+ (<a href="http://forrest.apache.org/docs.html">More</a> ...)</div>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#Build">Build</a>
+</li>
+<li>
+<a href="#Requirements">Requirements</a>
+</li>
+<li>
+<a href="#Installation">Installation</a>
+</li>
+<li>
+<a href="#FAQ">FAQ</a>
+<ul class="minitoc">
+<li>
+<a href="#The+build+and%2For+deploy+commands+don%27t+seem+to+work">The build and/or deploy commands don't seem to work</a>
+</li>
+<li>
+<a href="#Can+I+do+anything+with+this+besides+just+running+the%0A++++++++forrestbot%3F">Can I do anything with this besides just running the
+ forrestbot?</a>
+</li>
+</ul>
+</li>
+<li>
+<a href="#TODO+Wishlist">TODO Wishlist</a>
+</li>
+</ul>
+</div>
+
+<p>This webapp implements a website staging application for sites built with
+ Apache Forrest. The webapp hosts HTML for a number of managed websites. The
+ user can regenerate these sites at will. Once the user is satisfied with the
+ site, they may 'deploy' the site, making it live.</p>
+
+
+<a name="N10010"></a><a name="Build"></a>
+<h2 class="underlined_10">Build</h2>
+<div class="section">
+<p>To build the webapp from source, you need <a href="http://maven.apache.org/">Apache Maven</a> installed. From a
+ command prompt, go to the <span class="codefrag">forrest/tools/forrestbot/webapp</span>
+ directory and execute "<span class="codefrag">maven war</span>".</p>
+</div>
+
+
+<a name="N10024"></a><a name="Requirements"></a>
+<h2 class="underlined_10">Requirements</h2>
+<div class="section">
+<ul>
+
+<li>Forrest</li>
+
+
+<li>A servlet container such as <a href="http://jakarta.apache.org/tomcat">Apache Tomcat</a>
+</li>
+
+
+<li>Directories for:</li>
+
+
+<ul>
+
+<li>forrestbot buildfiles</li>
+
+
+<li>source and working files</li>
+
+
+<li>log files</li>
+
+
+<li>built websites (this is not their deployed location)</li>
+
+</ul>
+
+
+<li>A webserver to view the sites in the build directory</li>
+
+</ul>
+<p>The server does not need local access to the sites' source nor final
+ deployed location. The buildfiles configure the transfer of those
+ files.</p>
+</div>
+
+
+<a name="N1004F"></a><a name="Installation"></a>
+<h2 class="underlined_10">Installation</h2>
+<div class="section">
+<div class="frame note">
+<div class="label">Note</div>
+<div class="content">Most of this configuration is related to the <a href="http://www.opensymphony.com/osuser/">OpenSymphony OSUser</a>
+ authentication layer.</div>
+</div>
+<ol>
+
+<li>Extract the war to an empty directory</li>
+
+
+<li>Modify welcome.local.html</li>
+
+
+<li>Modify WEB-INF/classes/osuser.xml if you want to use an
+ authenticator other than XML files</li>
+
+
+<li>Modify projects.xml, groups.xml, and users.xml (all in
+ WEB-INF/classes) according to your needs</li>
+
+
+<li>Optionally modify logging via WEB-INF/classes/log4j.properties</li>
+
+
+<li>Modify WEB-INF/classes/settings.properties according to the server's
+ specific setup</li>
+
+
+<li>Deploy the webapp in Tomcat or some other servlet container (you may
+ want to repackage the war file)</li>
+
+
+<li>Make sure tomcat has permissions to write in forrestbot's build,
+ work, and log directories.</li>
+
+</ol>
+<p>Optional: set up "cron jobs" to execute forrestbot. This is completely
+ independent of the forrestbot web interface, but is often useful. A
+ suggested practice is to build the sites regularly and deploy them as
+ desired through the web interface.</p>
+</div>
+
+
+<a name="N1007B"></a><a name="FAQ"></a>
+<h2 class="underlined_10">FAQ</h2>
+<div class="section">
+<a name="N10081"></a><a name="The+build+and%2For+deploy+commands+don%27t+seem+to+work"></a>
+<h3 class="underlined_5">The build and/or deploy commands don't seem to work</h3>
+<div class="frame warning">
+<div class="label">Warning</div>
+<div class="content">The only environment variable available is FORREST_HOME, which
+ is set by forrest-home in the settings.properties file. Use a wrapper
+ script (see below) if you need other environment variables.</div>
+</div>
+<p>Currently forrestbot only logs the forrest part of it's execution,
+ not the whole thing. And the web interface starts a forrestbot process
+ and doesn't watch it's progress directly.</p>
+<p>Set debug-exec=true in settings.properties and make sure
+ log4j.properties logs at the DEBUG level. This will log all the thread
+ output.</p>
+<p>Then look at the debugging output for the command executed and the
+ working directory used. Log into the server as the use the Tomcat server
+ uses and cd to the working directory and then execute the command. This
+ will fairly accurately simulate what the web interface does.</p>
+<a name="N10094"></a><a name="Can+I+do+anything+with+this+besides+just+running+the%0A++++++++forrestbot%3F"></a>
+<h3 class="underlined_5">Can I do anything with this besides just running the
+ forrestbot?</h3>
+<p>Sure. Create a wrapper script and specify it as forrest-exec in
+ settings.properties. Here's an example:</p>
+<pre class="code">#!/bin/bash
+
+# get env vars
+. /home/user/.profile
+
+# group writable for easier sharing of files with others who run forrestbot
+umask g+w
+
+# you can preprocess something here
+xmlfile=$2
+if [ "${xmlfile##*.}" = "xml" ] # everything after last .
+then
+ target=$3
+ if [ "$target" != "deploy" ] # don't run preprocess task on a deploy
+ then
+ projectTarget=${xmlfile%.*} # everything before last .
+ # do something special for $projectTarget here
+ fi
+else
+ echo "Syntax: forrest_wrapper.sh -f myapp.xml [build|deploy|...]"
+ exit
+fi
+
+# run forrest(bot) with all the parameters
+forrest $*
+
+# you can postprocess something here</pre>
+</div>
+
+
+<a name="N100A3"></a><a name="TODO+Wishlist"></a>
+<h2 class="underlined_10">TODO Wishlist</h2>
+<div class="section">
+<ul>
+
+<li>seperate authorization of 'build' and 'deploy'</li>
+
+
+<li>log everything, not just the build</li>
+
+
+<li>view old log files</li>
+
+
+<li>ability to reload all config files on the fly</li>
+
+
+<li>put date at top of viewlog_body page</li>
+
+</ul>
+</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-2005 The Apache Software Foundation.</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Propchange: forrest/site/0.7/docs/forrestbot-web-interface.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/site/0.7/docs/forrestbot-web-interface.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/0.7/docs/forrestbot-web-interface.pdf?view=auto&rev=160895
==============================================================================
Binary file - no diff available.
Propchange: forrest/site/0.7/docs/forrestbot-web-interface.pdf
------------------------------------------------------------------------------
svn:mime-type = application/pdf
Added: forrest/site/0.7/docs/forrestbot.html
URL: http://svn.apache.org/viewcvs/forrest/site/0.7/docs/forrestbot.html?view=auto&rev=160895
==============================================================================
--- forrest/site/0.7/docs/forrestbot.html (added)
+++ forrest/site/0.7/docs/forrestbot.html Mon Apr 11 07:58:59 2005
@@ -0,0 +1,1240 @@
+<!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.7-dev">
+<meta name="Forrest-skin-name" content="pelt">
+<meta-data></meta-data>
+<title>Forrestbot (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:');" value="Search the site with google:" size="25" name="q" id="query" type="text">
+ <input name="Search" value="Search" type="submit">
+</form>
+</div>
+<!--+
+ |end search
+ +-->
+<!--+
+ |start Tabs
+ +-->
+<ul id="tabs">
+<li>
+<a class="base-not-selected" href="../index.html">Welcome</a>
+</li>
+<li>
+<a class="base-not-selected" href="../contrib.html">Project</a>
+</li>
+<li class="current">
+<a class="base-selected" href="../docs/index.html">0.7 Docs</a>
+</li>
+<li>
+<a class="base-not-selected" href="../docs/howto/index.html">0.7 How-To</a>
+</li>
+</ul>
+<!--+
+ |end Tabs
+ +-->
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<!--+
+ |start Subtabs
+ +-->
+<div id="level2tabs">
+<a class="base-not-selected" href="..">Core</a> | <a class="base-not-selected" href="..">ForrestBot</a> | <a class="base-not-selected" href="..">ForrestBar</a>
+</div>
+<!--+
+ |end Endtabs
+ +-->
+<script type="text/javascript" language="JavaScript"><!--
+ document.write("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');">Documentation</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a title="" href="../docs/index.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/faq.html">FAQs</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/changes.html">Changes</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/todo.html">Todo</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/your-project.html">Using Forrest</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/validation.html">XML Validation</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/linking.html">Menus and Linking</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/searching.html">Searching</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/skins.html">Default Skins</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/skin-package.html">Skin Packages</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/plugins/usingPlugins.html">Plugins</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/views.html">Views-dev</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/forrest-contract.html">Our Contract</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/compliance.html">Standards Compliance</a>
+</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 title="" href="../docs/build.html">Building Forrest</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/catalog.html">Using DTD Catalogs</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/sitemap-ref.html">Sitemap Reference</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/project-sitemap.html">Project sitemap</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/plugins/pluginInfrastructure.html">Plugin Infrastructure</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/cap.html">Sourcetype Action</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.16', '../skin/')" id="menu_1.1.16Title" class="menutitle">Other versions</div>
+<div id="menu_1.1.16" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="http://forrest.apache.org/docs/../0.8/">0.8-dev</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/index.html">0.7 (current)</a>
+</div>
+<div class="menuitem">
+<a title="" href="http://forrest.apache.org/docs/../0.6/">0.6</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.17', '../skin/')" id="menu_1.1.17Title" class="menutitle">Upgrading</div>
+<div id="menu_1.1.17" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/upgrading_07.html">Upgrading to 0.7</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/upgrading_06.html">Upgrading to 0.6</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_selected_1.1.18', '../skin/')" id="menu_selected_1.1.18Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">SubProjects</div>
+<div id="menu_selected_1.1.18" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a title="" href="../docs/forrestbar.html">ForrestBar</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Forrestbot</div>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/forrestbot-web-interface.html">Forrestbot Webapp</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.19', '../skin/')" id="menu_1.1.19Title" class="menutitle">Reference docs</div>
+<div id="menu_1.1.19" class="menuitemgroup">
+<div onclick="SwitchMenu('menu_1.1.19.1', '../skin/')" id="menu_1.1.19.1Title" class="menutitle">DTD documentation</div>
+<div id="menu_1.1.19.1" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/dtd-docs.html">Overview</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/document-v20.dtdx.html">document-v20</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/howto-v20.dtdx.html">howto-v20</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/faq-v20.dtdx.html">faq-v20</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/document-v13.dtdx.html">document-v13</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/howto-v13.dtdx.html">howto-v13</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/faq-v13.dtdx.html">faq-v13</a>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.19.2', '../skin/')" id="menu_1.1.19.2Title" class="menutitle">Doc samples</div>
+<div id="menu_1.1.19.2" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/document-v13.html">document-v13</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/document-v20.html">document-v20</a>
+</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.1.20', '../skin/')" id="menu_1.1.20Title" class="menutitle">Older Docs</div>
+<div id="menu_1.1.20" class="menuitemgroup">
+<div class="menuitem">
+<a title="" href="../docs/primer.html">Forrest Primer</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/libre-intro.html">Libre</a>
+</div>
+<div class="menuitem">
+<a title="" href="../docs/dreams.html">Dream list</a>
+</div>
+</div>
+</div>
+<div id="credit">
+<hr>
+ This is documentation for current release v0.7
+ (<a href="http://forrest.apache.org/docs.html">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>
+<!--+
+ |end Menu
+ +-->
+<!--+
+ |start content
+ +-->
+<div id="content">
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="forrestbot.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>Forrestbot</h1>
+<div id="motd-area">
+ This is documentation for current release v0.7
+ (<a href="http://forrest.apache.org/docs.html">More</a> ...)</div>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#Overview">Overview</a>
+</li>
+<li>
+<a href="#Using+Forrestbot">Using Forrestbot</a>
+</li>
+<li>
+<a href="#Creating+a+buildfile">Creating a buildfile</a>
+<ul class="minitoc">
+<li>
+<a href="#Workstage+Properties">Workstage Properties</a>
+<ul class="minitoc">
+<li>
+<a href="#Misc+Properties">Misc Properties</a>
+</li>
+<li>
+<a href="#getsrc.clean-workdir">getsrc.clean-workdir</a>
+</li>
+<li>
+<a href="#getsrc.local">getsrc.local</a>
+</li>
+<li>
+<a href="#getsrc.cvs">getsrc.cvs</a>
+</li>
+<li>
+<a href="#getsrc.svn">getsrc.svn</a>
+</li>
+<li>
+<a href="#build.forrest">build.forrest</a>
+</li>
+<li>
+<a href="#deploy.scp">deploy.local</a>
+</li>
+<li>
+<a href="#deploy.local">deploy.scp</a>
+</li>
+<li>
+<a href="#deploy.cvs">deploy.cvs</a>
+</li>
+<li>
+<a href="#deploy.svn">deploy.svn</a>
+</li>
+<li>
+<a href="#notify">notify</a>
+</li>
+<li>
+<a href="#notify.local">notify.local</a>
+</li>
+<li>
+<a href="#notify.email">notify.email</a>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>
+<a href="#Forrestbot+design">Forrestbot design</a>
+</li>
+</ul>
+</div>
+
+<a name="N1000D"></a><a name="Overview"></a>
+<h2 class="underlined_10">Overview</h2>
+<div class="section">
+<p>Forrestbot lets you automate building & deploying websites. There
+ are implementations to get source from various locations, build it, then
+ deploy it somewhere. It can notify you afterwards, and it keeps a log of
+ the build process. Each workstage has multiple implementations; you can
+ use one or more of each.</p>
+</div>
+
+
+<a name="N10017"></a><a name="Using+Forrestbot"></a>
+<h2 class="underlined_10">Using Forrestbot</h2>
+<div class="section">
+<p>Simply execute:</p>
+<pre class="code">forrest -f mybuildfile.xml</pre>
+<p>The next section explains how to create your buildfile.</p>
+</div>
+
+
+<a name="N10028"></a><a name="Creating+a+buildfile"></a>
+<h2 class="underlined_10">Creating a buildfile</h2>
+<div class="section">
+<p>A sample buildfile:</p>
+<pre class="code"><project name="mysampleproject" default="main">
+ <property name="notify.email.host" value="smtp.myhost.com"/>
+ <property name="notify.email.to" value="me@domain.com"/>
+ <property name="notify.administrator" value="Your Name &lt;me@domain.com>"/>
+ <property name="getsrc.cvs.user" value="anoncvs"/>
+ <property name="getsrc.cvs.password" value="anoncvs"/>
+ <property name="getsrc.cvs.root" value="/home/cvspublic"/>
+ <property name="getsrc.cvs.host" value="cvs.myhost.com"/>
+ <property name="getsrc.cvs.module" value="myproject"/>
+ <property name="deploy.scp.dest" value="username@myhost.com:/var/www/mydomain/htdocs"/>
+
+ <!-- here we specify to use two notification implementations -->
+ <target name="notify" depends="notify.local, notify.email"/>
+
+ <!-- here we specify to deploy with the scp implementation -->
+ <target name="deploy" depends="deploy.scp"/>
+
+ <!-- the default implementation for getsrc is getsrc.cvs, which is what we want -->
+
+ <!-- assumes FORREST_HOME has been set as an environment variable -->
+ <property environment="env"/>
+ <import file="${env.FORREST_HOME}/tools/forrestbot/core/forrestbot.xml"/>
+</project>
+
+</pre>
+<p>First, set properties needed by the workstages you are going to use.
+ Here, we set properties that will be used by notify.email and getsrc.cvs.
+ Next, specify what implementations will be used by each workstage.</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="1" rowspan="1">Workstage</th>
+
+ <th colspan="1" rowspan="1">Implementations</th>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">getsrc</td>
+
+ <td colspan="1" rowspan="1">
+<ul>
+
+<li>
+<a href="#getsrc.local">getsrc.local</a>
+</li>
+
+
+<li>
+<a href="#getsrc.cvs">getsrc.cvs</a> (default)</li>
+
+
+<li>
+<a href="#getsrc.svn">getsrc.svn</a>
+</li>
+
+</ul>
+</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">build</td>
+
+ <td colspan="1" rowspan="1">
+<ul>
+
+<li>
+<a href="#build.forrest">build.forrest</a>
+</li>
+
+</ul>
+</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">deploy</td>
+
+ <td colspan="1" rowspan="1">
+<ul>
+
+<li>
+<a href="#deploy.local">deploy.local</a> (default)</li>
+
+
+<li>
+<a href="#deploy.scp">deploy.scp</a>
+</li>
+
+
+<li>
+<a href="#deploy.cvs">deploy.cvs</a>
+</li>
+
+
+<li>
+<a href="#deploy.svn">deploy.svn</a>
+</li>
+
+</ul>
+</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1"><a href="#notify">notify</a></td>
+
+ <td colspan="1" rowspan="1">
+<ul>
+
+<li>
+<a href="#notify.local">notify.local</a> (default)</li>
+
+
+<li>
+<a href="#notify.email">notify.email</a>
+</li>
+
+</ul>
+</td>
+
+</tr>
+
+</table>
+<p>If you want to do more advanced processing for your project, you can
+ override the 'main' target, which by default is <span class="codefrag"><target
+ name="main" depends="getsrc, build, deploy, notify"/></span>, create
+ your own implementation of a workstage, or use any other ant tasks to do
+ additional work.</p>
+<p></p>
+<p>Many workstages use usernames and passwords. You may want to keep them
+ out of your project's xml file (especially if you store that file in CVS
+ or SVN). A nice way to do this is make a simple buildfile (e.g.
+ my-settings.xml) that just sets those properties (don't include it in
+ CVS/SVN!). Then in your project buildfile, have <span class="codefrag"><import
+ file="my-settings.xml"/></span>.</p>
+<a name="N100C5"></a><a name="Workstage+Properties"></a>
+<h3 class="underlined_5">Workstage Properties</h3>
+<p>Each workstage implementation is configurable with properties. The
+ following tables describe each property and whether or not you are
+ required to set it in your buildfile.</p>
+<a name="N100CE"></a><a name="Misc+Properties"></a>
+<h4>Misc Properties</h4>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="1" rowspan="1">Property</th>
+
+ <th colspan="1" rowspan="1">Description</th>
+
+ <th colspan="1" rowspan="1">Default Value</th>
+
+ <th colspan="1" rowspan="1">Required?</th>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">ant.project.name (you specify this by <project
+ name="____"> in your buildfile)</td>
+
+ <td colspan="1" rowspan="1">This must be unique for each project.</td>
+
+ <td colspan="1" rowspan="1"></td>
+
+ <td colspan="1" rowspan="1">Yes</td>
+
+</tr>
+
+</table>
+<a name="N10105"></a><a name="getsrc.clean-workdir"></a>
+<h4>getsrc.clean-workdir</h4>
+<p>This should be executed before a getsrc implementation is executed.
+ For example, <span class="codefrag"><target name="getsrc"
+ depends="getsrc.clean-workdir, getsrc.svn"/></span>
+</p>
+<a name="N10111"></a><a name="getsrc.local"></a>
+<h4>getsrc.local</h4>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="1" rowspan="1">Property</th>
+
+ <th colspan="1" rowspan="1">Description</th>
+
+ <th colspan="1" rowspan="1">Default Value</th>
+
+ <th colspan="1" rowspan="1">Required?</th>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">getsrc.local.root-dir</td>
+
+ <td colspan="1" rowspan="1">Absolute path to the project's root directory on the local
+ computer. Use <strong>location=</strong> instead of <strong>value=</strong> for this <property></td>
+
+ <td colspan="1" rowspan="1"></td>
+
+ <td colspan="1" rowspan="1">Yes</td>
+
+</tr>
+
+</table>
+<a name="N1014E"></a><a name="getsrc.cvs"></a>
+<h4>getsrc.cvs</h4>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="1" rowspan="1">Property</th>
+
+ <th colspan="1" rowspan="1">Description</th>
+
+ <th colspan="1" rowspan="1">Default Value</th>
+
+ <th colspan="1" rowspan="1">Required?</th>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">getsrc.cvs.user</td>
+
+ <td colspan="1" rowspan="1">CVS username</td>
+
+ <td colspan="1" rowspan="1"></td>
+
+ <td colspan="1" rowspan="1">Yes</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">getsrc.cvs.password</td>
+
+ <td colspan="1" rowspan="1">CVS password</td>
+
+ <td colspan="1" rowspan="1"></td>
+
+ <td colspan="1" rowspan="1">Yes</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">getsrc.cvs.root</td>
+
+ <td colspan="1" rowspan="1">CVS root directory</td>
+
+ <td colspan="1" rowspan="1">/home/cvsroot</td>
+
+ <td colspan="1" rowspan="1">Yes</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">getsrc.cvs.host</td>
+
+ <td colspan="1" rowspan="1">CVS host</td>
+
+ <td colspan="1" rowspan="1">cvs.apache.org</td>
+
+ <td colspan="1" rowspan="1">Yes</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">getsrc.cvs.module</td>
+
+ <td colspan="1" rowspan="1">CVS module name (an alias, or full path) to the directory that
+ contains forrest.properties</td>
+
+ <td colspan="1" rowspan="1">${ant.project.name}</td>
+
+ <td colspan="1" rowspan="1">Yes</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">getsrc.cvs.tag</td>
+
+ <td colspan="1" rowspan="1">CVS tag or branch name</td>
+
+ <td colspan="1" rowspan="1"></td>
+
+ <td colspan="1" rowspan="1">No</td>
+
+</tr>
+
+</table>
+<a name="N101F6"></a><a name="getsrc.svn"></a>
+<h4>getsrc.svn</h4>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="1" rowspan="1">Property</th>
+
+ <th colspan="1" rowspan="1">Description</th>
+
+ <th colspan="1" rowspan="1">Default Value</th>
+
+ <th colspan="1" rowspan="1">Required?</th>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">getsrc.svn.url</td>
+
+ <td colspan="1" rowspan="1">Full repository URL for project (this directory must contain
+ forrest.properties)</td>
+
+ <td colspan="1" rowspan="1"></td>
+
+ <td colspan="1" rowspan="1">Yes</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">getsrc.svn.revision</td>
+
+ <td colspan="1" rowspan="1">Revision number to fetch</td>
+
+ <td colspan="1" rowspan="1">HEAD</td>
+
+ <td colspan="1" rowspan="1">No</td>
+
+</tr>
+
+</table>
+<a name="N10244"></a><a name="build.forrest"></a>
+<h4>build.forrest</h4>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="1" rowspan="1">Property</th>
+
+ <th colspan="1" rowspan="1">Description</th>
+
+ <th colspan="1" rowspan="1">Default Value</th>
+
+ <th colspan="1" rowspan="1">Required?</th>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">build.work-dir</td>
+
+ <td colspan="1" rowspan="1">Directory to temporarily hold working files</td>
+
+ <td colspan="1" rowspan="1">work</td>
+
+ <td colspan="1" rowspan="1">No</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">build.log-dir</td>
+
+ <td colspan="1" rowspan="1">Directory to hold log files</td>
+
+ <td colspan="1" rowspan="1">logs</td>
+
+ <td colspan="1" rowspan="1">No</td>
+
+</tr>
+
+</table>
+<a name="N10293"></a><a name="deploy.scp"></a>
+<h4>deploy.local</h4>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="1" rowspan="1">Property</th>
+
+ <th colspan="1" rowspan="1">Description</th>
+
+ <th colspan="1" rowspan="1">Default Value</th>
+
+ <th colspan="1" rowspan="1">Required?</th>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">deploy.local.dir</td>
+
+ <td colspan="1" rowspan="1">Path to deploy site to. Relative paths will be relative to
+ ${bot.home}</td>
+
+ <td colspan="1" rowspan="1">sites/${ant.project.name}</td>
+
+ <td colspan="1" rowspan="1">No</td>
+
+</tr>
+
+</table>
+<a name="N102CB"></a><a name="deploy.local"></a>
+<h4>deploy.scp</h4>
+<p>${user.home}/.ssh/known_hosts must properly recognize the host, so
+ you should manually make an ssh connection to the host if you never
+ have before.</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="1" rowspan="1">Property</th>
+
+ <th colspan="1" rowspan="1">Description</th>
+
+ <th colspan="1" rowspan="1">Default Value</th>
+
+ <th colspan="1" rowspan="1">Required?</th>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">deploy.scp.dest</td>
+
+ <td colspan="1" rowspan="1">Full destination reference in the format
+ user@host:/directory/path</td>
+
+ <td colspan="1" rowspan="1"></td>
+
+ <td colspan="1" rowspan="1">Yes</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">deploy.scp.password</td>
+
+ <td colspan="1" rowspan="1">Password for user@host</td>
+
+ <td colspan="1" rowspan="1"></td>
+
+ <td colspan="1" rowspan="1">No. You will be prompted for it if it is not set.</td>
+
+</tr>
+
+</table>
+<a name="N1031B"></a><a name="deploy.cvs"></a>
+<h4>deploy.cvs</h4>
+<p>This is only available on *nix operating systems.</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="1" rowspan="1">Property</th>
+
+ <th colspan="1" rowspan="1">Description</th>
+
+ <th colspan="1" rowspan="1">Default Value</th>
+
+ <th colspan="1" rowspan="1">Required?</th>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">deploy.cvs.user</td>
+
+ <td colspan="1" rowspan="1">CVS username to use when committing changes</td>
+
+ <td colspan="1" rowspan="1"></td>
+
+ <td colspan="1" rowspan="1">Yes</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">deploy.cvs.password</td>
+
+ <td colspan="1" rowspan="1">CVS password</td>
+
+ <td colspan="1" rowspan="1"></td>
+
+ <td colspan="1" rowspan="1">Yes</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">deploy.cvs.root</td>
+
+ <td colspan="1" rowspan="1">CVS root</td>
+
+ <td colspan="1" rowspan="1">/home/cvs</td>
+
+ <td colspan="1" rowspan="1">Yes</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">deploy.cvs.host</td>
+
+ <td colspan="1" rowspan="1">CVS host</td>
+
+ <td colspan="1" rowspan="1">cvs.apache.org</td>
+
+ <td colspan="1" rowspan="1">Yes</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">deploy.cvs.module</td>
+
+ <td colspan="1" rowspan="1">CVS module</td>
+
+ <td colspan="1" rowspan="1">${ant.project.name}</td>
+
+ <td colspan="1" rowspan="1">Yes</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">deploy.cvs.commit-message</td>
+
+ <td colspan="1" rowspan="1">Message to use when committing. You probably want to put a
+ machine name or person's name here.</td>
+
+ <td colspan="1" rowspan="1">Automatic publish from forrestbot</td>
+
+ <td colspan="1" rowspan="1">No</td>
+
+</tr>
+
+</table>
+<a name="N103C7"></a><a name="deploy.svn"></a>
+<h4>deploy.svn</h4>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="1" rowspan="1">Property</th>
+
+ <th colspan="1" rowspan="1">Description</th>
+
+ <th colspan="1" rowspan="1">Default Value</th>
+
+ <th colspan="1" rowspan="1">Required?</th>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">deploy.svn.user</td>
+
+ <td colspan="1" rowspan="1">SVN username to use when committing changes</td>
+
+ <td colspan="1" rowspan="1"></td>
+
+ <td colspan="1" rowspan="1">Yes</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">deploy.svn.password</td>
+
+ <td colspan="1" rowspan="1">SVN password</td>
+
+ <td colspan="1" rowspan="1"></td>
+
+ <td colspan="1" rowspan="1">Yes</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">deploy.svn.url</td>
+
+ <td colspan="1" rowspan="1">Full repository URL</td>
+
+ <td colspan="1" rowspan="1"></td>
+
+ <td colspan="1" rowspan="1">Yes</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">deploy.svn.commit-message</td>
+
+ <td colspan="1" rowspan="1">Message to use when committing. You probably want to put a
+ machine name or person's name here.</td>
+
+ <td colspan="1" rowspan="1">Automatic publish from forrestbot</td>
+
+ <td colspan="1" rowspan="1">No</td>
+
+</tr>
+
+</table>
+<a name="N10441"></a><a name="notify"></a>
+<h4>notify</h4>
+<p>These settings are used by all notify implementations.</p>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="1" rowspan="1">Property</th>
+
+ <th colspan="1" rowspan="1">Description</th>
+
+ <th colspan="1" rowspan="1">Default Value</th>
+
+ <th colspan="1" rowspan="1">Required?</th>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">notify.administrator</td>
+
+ <td colspan="1" rowspan="1">Name and email address of the forrestbot administrator</td>
+
+ <td colspan="1" rowspan="1"></td>
+
+ <td colspan="1" rowspan="1">Yes</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">notify.on.failure</td>
+
+ <td colspan="1" rowspan="1">On a build failure, notification will happen if this is
+ true.</td>
+
+ <td colspan="1" rowspan="1">true</td>
+
+ <td colspan="1" rowspan="1">No</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">notify.on.success</td>
+
+ <td colspan="1" rowspan="1">On a succesful build, notification will happen if this is
+ true.</td>
+
+ <td colspan="1" rowspan="1">true</td>
+
+ <td colspan="1" rowspan="1">No</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">notify.log</td>
+
+ <td colspan="1" rowspan="1">Log file</td>
+
+ <td colspan="1" rowspan="1"></td>
+
+ <td colspan="1" rowspan="1">No. Set by other workstage(s).</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">notify.deploy-location</td>
+
+ <td colspan="1" rowspan="1">Deployed location</td>
+
+ <td colspan="1" rowspan="1"></td>
+
+ <td colspan="1" rowspan="1">No. Set by other workstage(s).</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">notify.completion-status</td>
+
+ <td colspan="1" rowspan="1">Result of the build</td>
+
+ <td colspan="1" rowspan="1"></td>
+
+ <td colspan="1" rowspan="1">No. Set by other workstage(s).</td>
+
+</tr>
+
+</table>
+<a name="N104EB"></a><a name="notify.local"></a>
+<h4>notify.local</h4>
+<p>No properties.</p>
+<a name="N104F5"></a><a name="notify.email"></a>
+<h4>notify.email</h4>
+<table class="ForrestTable" cellspacing="1" cellpadding="4">
+
+<tr>
+
+<th colspan="1" rowspan="1">Property</th>
+
+ <th colspan="1" rowspan="1">Description</th>
+
+ <th colspan="1" rowspan="1">Default Value</th>
+
+ <th colspan="1" rowspan="1">Required?</th>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">notify.email.host</td>
+
+ <td colspan="1" rowspan="1">SMTP host through which the email will be sent.</td>
+
+ <td colspan="1" rowspan="1">localhost</td>
+
+ <td colspan="1" rowspan="1">Yes</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">notify.email.to</td>
+
+ <td colspan="1" rowspan="1">Email address to send notification to.</td>
+
+ <td colspan="1" rowspan="1">${user.name}@localhost</td>
+
+ <td colspan="1" rowspan="1">Yes</td>
+
+</tr>
+
+
+<tr>
+
+<td colspan="1" rowspan="1">notify.email.from</td>
+
+ <td colspan="1" rowspan="1">From: address in the email</td>
+
+ <td colspan="1" rowspan="1">Forrestbot</td>
+
+ <td colspan="1" rowspan="1">No, but some mailers may require a valid email address.</td>
+
+</tr>
+
+</table>
+</div>
+
+
+<a name="N1055D"></a><a name="Forrestbot+design"></a>
+<h2 class="underlined_10">Forrestbot design</h2>
+<div class="section">
+<p>Forrest and forrestbot use ant buildfiles extensively. Ant 1.6's import
+ task is used to import multiple buildfiles into a single build. The
+ following is the flow of control when running forrestbot:</p>
+<ul>
+
+<li>Your buildfile<ul>
+
+<li>forrestbot.xml<ul>
+
+<li>workstage buildfiles</li>
+
+
+<li>forrest.build.xml</li>
+
+</ul>
+</li>
+
+</ul>
+</li>
+
+</ul>
+<p>The workstage buildfiles set up the properties and files so that the
+ main forrest buildfile (forrest.build.xml) will run. After it is run,
+ other workstages buildfiles can implement reporting, deployment, or other
+ post-build activities.</p>
+<p>Your buildfile can specify which workstages you want to use, set
+ properties for them, and do any additional pre- and post-processing.</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-2005 The Apache Software Foundation.</div>
+<!--+
+ |end bottomstrip
+ +-->
+</div>
+</body>
+</html>
Propchange: forrest/site/0.7/docs/forrestbot.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/site/0.7/docs/forrestbot.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/0.7/docs/forrestbot.pdf?view=auto&rev=160895
==============================================================================
Binary file - no diff available.
Propchange: forrest/site/0.7/docs/forrestbot.pdf
------------------------------------------------------------------------------
svn:mime-type = application/pdf