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 2006/02/09 01:26:32 UTC
svn commit: r376128 [34/34] - in /forrest/site: ./ docs_0_60/
docs_0_60/howto/ docs_0_60/howto/bugzilla-patch/ docs_0_60/howto/multi/
docs_0_70/ docs_0_70/howto/ docs_0_70/howto/cvs-ssh/ docs_0_70/howto/multi/
docs_0_80/ docs_0_80/howto/ docs_0_80/howt...
Added: forrest/site/themes/pelt.screen.css
URL: http://svn.apache.org/viewcvs/forrest/site/themes/pelt.screen.css?rev=376128&view=auto
==============================================================================
--- forrest/site/themes/pelt.screen.css (added)
+++ forrest/site/themes/pelt.screen.css Wed Feb 8 16:26:20 2006
@@ -0,0 +1,607 @@
+/*
+* Copyright 2002-2004 The Apache Software Foundation or its licensors,
+* as applicable.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+.breadtrail {
+ background: #CEDFEF;
+ color: #0F3660;
+ border-bottom: solid 1px white;
+ padding: 3px 10px;
+ font-size: 75%;
+}
+.breadtrail a:link { color: #0F3660; }
+.breadtrail a:visited { color: #0F3660; }
+.breadtrail a:hover { color: #000066; }
+
+#page .breadtrail {
+ clear:both;
+ position: relative;
+ border-bottom: solid 1px black;
+ border-top: solid 1px black;
+ padding: 0px 200px;
+ z-index:10;
+}
+
+#branding-tagline-name {
+ display: none;
+}
+
+#branding-tagline-tagline {
+ display: none;
+}
+
+a:link { color: #0F3660; }
+a:visited { color: #009999; }
+a:hover { color: #000066; }
+
+body {
+ margin: 0px 0px 0px 0px; font-family: Verdana, Helvetica, sans-serif;
+ background-color: #FFFFFF;
+ color: #000000;
+ font-size: 12px;
+}
+
+h1 { font-size : 160%; margin: 0px 0px 0px 0px; padding: 0px; }
+h2 { font-size : 140%; margin: 0.9em 0px 0px 0px; padding: 0px; font-weight : bold;}
+h3 { font-size : 120%; margin: 0.8em 0px 0px 0px; padding: 0px; font-weight : bold; }
+.h3 { margin: 22px 0px 3px 0px; }
+h4 { font-size : 100%; margin: 0.7em 0px 0px 0px; padding: 0px; font-weight : normal; text-align: left; }
+.h4 { margin: 18px 0px 0px 0px; }
+h4.faq { font-size : 100%; margin: 18px 0px 0px 0px; padding: 0px; font-weight : bold; text-align: left; }
+h5 { font-size : 80%; margin: 14px 0px 0px 0px; padding: 0px; font-weight : normal; text-align: left; }
+
+/**
+* table
+*/
+table .title { background-color: #000000; }
+.ForrestTable {
+ color: #ffffff;
+ background-color: #7099C5;
+ width: 100%;
+ font-size : 100%;
+ empty-cells: show;
+}
+table caption {
+ padding-left: 5px;
+ color: #000000;
+ text-align: left;
+ font-weight: bold;
+ background-color: #E5E4D9;
+}
+.ForrestTable td {
+ color: black;
+ background-color: #F0F0FF;
+}
+.ForrestTable th { text-align: center; }
+/**
+ * Page Header
+ */
+
+#container {
+ position: relative;
+ float: left;
+ width: 100%;
+ background-color: #FFFFFF; /* if you want a background in the header, put it here */
+}
+
+#container #header {
+ position: relative;
+ float: left;
+ width: 100%;
+ background: url("../themes/images/header_white_line.gif") repeat-x bottom;
+}
+
+/* branding-logo Template */
+#header .logo {
+ padding: 7px 0px 10px 10px;
+ float: left;
+ text-align: left;
+}
+
+#header .searchbox {
+ position: absolute;
+ margin: 0;
+ right: 10px;
+ height: 42px;
+ white-space: nowrap;
+ text-align: right;
+ color: #000000;
+ background-color: #E5E4D9;
+ z-index:0;
+ bottom: 18px; /* compensate for IE rendering issue */
+}
+/* DUC - Formerly searchbox */
+#header .search-input {
+ padding: 5px 10px;
+}
+
+#header .round-top-left-small {
+ background-repeat: no-repeat;
+ background-position: top left;
+ background-image: url(../themes/images/roundcorner-t-l-5-bgffffff-strokeE5E4D9-fgE5E4D9.png); ;
+ }
+#header .round-top-right-small {
+ background-repeat: no-repeat;
+ background-position: top right;
+ background-image: url(../themes/images/roundcorner-t-r-5-bgffffff-strokeE5E4D9-fgE5E4D9.png); ;
+ }
+.round-bottom-left-small {
+ background-repeat: no-repeat;
+ background-position: bottom left;
+ background-image: url(../themes/images/roundcorner-b-l-5-bgffffff-strokeE5E4D9-fgE5E4D9.png); ;
+ }
+.round-bottom-right-small {
+ background-repeat: no-repeat;
+ background-position: bottom right;
+ background-image: url(../themes/images/roundcorner-b-r-5-bgffffff-strokeE5E4D9-fgE5E4D9.png); ;
+ }
+.round-bottom-left-big {
+ background-repeat: no-repeat;
+ background-position: bottom left;
+ background-image: url(../themes/images/roundcorner-b-l-15-bgffffff-strokeE5E4D9-fgE5E4D9.png); ;
+ }
+.round-bottom-right-big {
+ background-repeat: no-repeat;
+ background-position: bottom right;
+ background-image: url(../themes/images/roundcorner-b-r-15-bgffffff-strokeE5E4D9-fgE5E4D9.png); ;
+ }
+
+#header .search-field {
+ float: left;
+}
+
+#nav-main {
+ clear: both;
+ padding-left: 10px;
+ margin: 0;
+ list-style: none;
+}
+
+#nav-main li {
+ float: left;
+ background-image: url(../themes/images/roundcorner-t-r-5-bgffffff-strokeF5F4E9-fgF5F4E9.png); ;
+ background-repeat: no-repeat;
+ background-position: top right;
+ background-color: #F5F4E9;
+ margin: 0 3px 0 0;
+ padding: 0;
+}
+
+#nav-main li a {
+ float: left;
+ display: block;
+ font-family: verdana, arial, sans-serif;
+ text-decoration: none;
+ color: black;
+ white-space: nowrap;
+ background-image: url(../themes/images/roundcorner-t-l-5-bgffffff-strokeF5F4E9-fgF5F4E9.png); ;
+ background-repeat: no-repeat;
+ background-position: top left;
+ padding: 5px 15px 4px;
+ width: .1em; /* IE/Win fix */
+}
+#nav-main li a:link { color: #000000; }
+#nav-main li a:visited { color: #000000; }
+#nav-main li a:hover { color: #000000; }
+
+#nav-main > li a { width: auto; } /* Rest of IE/Win fix */
+
+/* Commented Backslash Hack hides rule from IE5-Mac \*/
+#nav-main a { float: none; }
+/* End IE5-Mac hack */
+
+#nav-main .current {
+ background-color: #E5E4D9;
+ background-image: url(../themes/images/roundcorner-t-r-5-bgffffff-strokeE5E4D9-fgE5E4D9.png); ;
+ background-repeat: no-repeat;
+ background-position: top right;
+}
+#nav-main .current a {
+ font-weight: bold;
+ padding-bottom: 5px;
+ color: #000000;
+ background-image: url(../themes/images/roundcorner-t-l-5-bgffffff-strokeE5E4D9-fgE5E4D9.png); ;
+ background-repeat: no-repeat;
+ background-position: top left;
+}
+
+#nav-main .current a:link { color: #000000; }
+#nav-main .current a:visited { color: #000000; }
+#nav-main .current a:hover { color: #000000; }
+
+#publishedStrip {
+ position: relative;
+ background: #E5E4D9;
+ clear:both;
+ padding-right: 10px;
+ padding-left: 20px;
+ padding-top: 3px;
+ padding-bottom:3px;
+ color: #000000;
+ font-size : 80%;
+ font-weight: bold;
+ text-align:right;
+}
+
+#level2tabs {
+ color: #000000;
+ margin: 0;
+ float:left;
+ position:relative;
+ /*background-color: #4A6D8C ;*/
+}
+#level2tabs a{padding-right: 5px;}
+#level2tabs a:link { color: #000000; }
+#level2tabs a:visited { color: #000000; }
+#level2tabs a:hover { color: #000066; }
+/*
+* border-top: solid #4C6C8F 15px;
+*/
+#page {
+ position: relative;
+ background: white;
+ clear:both;
+}
+
+/**
+* Round corner
+*/
+#roundtop {
+ background-image: url(../themes/images/roundcorner-t-r-15-bgffffff-strokeE5E4D9-fgE5E4D9.png); ;
+ background-repeat: no-repeat;
+ background-position: top right;
+}
+
+#roundbottom {
+ background-image: url(../themes/images/roundcorner-b-r-15-bgffffff-strokeE5E4D9-fgE5E4D9.png); ;
+ background-repeat: no-repeat;
+ background-position: top right;
+}
+
+#roundbottomLeft {
+ background-image: url(../themes/images/roundcorner-b-l-15-bgffffff-strokeE5E4D9-fgE5E4D9.png); ;
+ background-repeat: no-repeat;
+ background-position: bottom left;
+}
+
+img.corner {
+ width: 15px;
+ height: 15px;
+ border: none;
+ display: block !important;
+}
+
+.roundtopsmall {
+ background-image: url(../themes/images/roundcorner-t-r-5-bgffffff-strokeE5E4D9-fgE5E4D9.png); ;
+ background-repeat: no-repeat;
+ background-position: top right;
+}
+
+#roundbottomsmall {
+ background-image: url(../themes/images/roundcorner-b-r-5-bgffffff-strokeE5E4D9-fgE5E4D9.png); ;
+ background-repeat: no-repeat;
+ background-position: top right;
+}
+
+img.cornersmall {
+ width: 5px;
+ height: 5px;
+ border: none;
+ display: block !important;
+}
+/**
+ * Side menu
+ */
+#leftbar a { font-weight: normal;}
+#leftbar a:link { color: #000000; }
+#leftbar a:visited { color: #000000; }
+#leftbar a:active { color: #000000; }
+#leftbar a:hover { color: #FFCF00; }
+
+#menuarea { width:10em;}
+
+#leftbar {
+ position: relative;
+ float: left;
+ width: 180px;
+ padding-top: 0px;
+ top:-16px;
+ left:10px;
+ z-index: 20;
+ border-color: #000000;
+ background-color: #E5E4D9;
+ font-size : 90%;
+ color: #000000;
+}
+
+#nav-section ul {
+ list-style: none;
+ margin: 0px;
+ padding: 0px;
+}
+
+.pagegroup ul {
+ list-style: none;
+}
+
+.pagegroup {
+ display: block;
+ cursor:pointer;
+}
+
+#nav-section span {
+ background-repeat: no-repeat;
+ background-position: center left;
+ margin-left: 10px;
+ padding: 3px 12px;
+ font-weight : bold;
+}
+#nav-section .pagegroup span {
+ background-image: url('../themes/images/chapter.gif'); ;
+ color: #000000;
+}
+.pagegroupselected span {
+ background-image: url('../themes/images/chapter_open.gif'); ;
+ color: #000000;
+}
+.pagegroupopen span {
+ background-image: url('../themes/images/chapter_open.gif'); ;
+ color: #000000;
+}
+
+.pagegroupselected {
+ display: block;
+ cursor:pointer;
+}
+
+.pagegroupopen {
+ display: block;
+ cursor:pointer;
+}
+#nav-section .menuitemgroup {
+ margin: 0px 0px 6px 8px;
+ padding: 0px;
+ font-weight : bold; }
+
+#nav-section .selectedmenuitemgroup{
+ margin: 0px 0px 6px 8px;
+ padding: 0px;
+ font-weight : bold; }
+
+#nav-section .menuitem {
+ padding: 0px 0px 2px 12px;
+ background-image: url('../themes/images/page.gif'); ;
+ background-repeat: no-repeat;
+ background-position: center left;
+ font-weight : normal;
+ margin-left: 10px;
+}
+
+#nav-section .menupage {
+ margin: 5px 0px 5px 10px;
+ padding: 0px 3px 0px 12px;
+ background-image: url('../themes/images/current.gif'); ;
+ background-repeat: no-repeat;
+ background-position: top left;
+ font-style : normal;
+}
+
+#nav-section .menupagetitle {
+ color: #000000;
+ padding: 0px 0px 0px 6px;
+ font-style : normal;
+ border-style: solid;
+ border-width: 1px;
+ margin-right: 10px;
+ border-color: #999999;
+ background-color: #CEDFEF;
+}
+
+#nav-section .menupageitemgroup {
+ padding: 3px 0px 4px 6px;
+ font-style : normal;
+ border-bottom: 1px solid ;
+ border-left: 1px solid ;
+ border-right: 1px solid ;
+ margin-right: 10px;
+ border-color: #999999;
+ background-color: #E5E4D9;
+}
+
+#nav-section .menupageitem {
+ color: #000000;
+ font-style : normal;
+ font-weight : normal;
+ border-width: 0px;
+ font-size : 90%;
+}
+#nav-section .menupageitem a:link { color: #000000;}
+#nav-section .menupageitem a:visited { color: #000000;}
+#nav-section .menupageitem a:hover {
+ background-color: #E5E4D9;
+ color: #000000;
+}
+
+#leftbar #credit {
+ text-align: center;
+}
+
+#leftbar #credit2 {
+ text-align: center;
+ padding: 3px 3px 3px 3px;
+ background-color: #ffffff;
+}
+
+/* DUC - Formerly searchbox */
+#leftbar .searchbox {
+ text-align: center;
+}
+#leftbar .search-input {
+ padding: 3px 3px;
+ margin: 0;
+}
+
+#content {
+ padding: 20px 20px 20px 200px;
+ margin: 0;
+ font : small Verdana, Helvetica, sans-serif;
+}
+
+#content ul {
+ margin: 0;
+ padding: 0 25px;
+}
+#content li {
+ padding: 0 5px;
+}
+#feedback {
+ color: black;
+ background: #CFDCED;
+ text-align:center;
+ margin-top: 5px;
+}
+#feedback #feedbackto {
+ font-size: 90%;
+ color: black;
+}
+#footer {
+ clear: both;
+ position: relative; /* IE bugfix (http://www.dracos.co.uk/web/css/ie6floatbug/) */
+ width: 100%;
+ background-color: #E5E4D9;
+ border-top: solid 1px #4C6C8F;
+ color: black;
+}
+#footer .copyright {
+ position: relative; /* IE bugfix cont'd */
+ padding: 5px;
+ margin: 0;
+ width: 45%;
+}
+#footer .lastmodified {
+ position: relative; /* IE bugfix cont'd */
+ float: right;
+ width: 45%;
+ padding: 5px;
+ margin: 0;
+ text-align: right;
+}
+#footer a { color: brown; }
+
+#footer #siteinfo-compliance-links {
+ text-align: left;
+}
+
+
+/**
+ * Misc Styles
+ */
+
+acronym { cursor: help; }
+.boxed { background-color: #E5E4D9;}
+.underlined_5 { border-bottom: solid 5px #E5E4D9;}
+.underlined_10 { border-bottom: solid 10px #E5E4D9;}
+.code { border-color: #CFDCED;}
+
+
+/* ==================== snail trail ============================ */
+
+.trail {
+ position: relative; /* IE bugfix cont'd */
+ float: left;
+ margin: -10px 5px 0px 5px;
+ padding: 0;
+}
+
+#content .motd-area {
+ position: relative; /* IE bugfix cont'd */
+ float: right;
+ width: 35%;
+ background-color: #f0f0ff;
+ border-top: solid 1px #4C6C8F;
+ border-bottom: solid 1px #4C6C8F;
+ margin-bottom: 15px;
+ margin-left: 15px;
+ margin-right: 10%;
+ padding-bottom: 5px;
+ padding-top: 5px;
+}
+
+#content-minitoc-area {
+ border-top: solid 1px #4C6C8F;
+ border-bottom: solid 1px #4C6C8F;
+ margin-bottom: 15px;
+ margin-left: 15px;
+ margin-right: 10%;
+ padding-bottom: 5px;
+ padding-top: 5px;
+}
+/*** CD : Lien en bleu lors du survol de la souris... **/
+#content-minitoc-area a:hover { border: 0px solid #a5b6c6; background: #CFDCED; }
+
+.minitoc {
+ list-style-image: url('../themes/images/current.gif'); ;
+ font-weight: normal;
+}
+
+li p {
+ margin: 0;
+ padding: 0;
+}
+
+#export-link {
+ position: relative; /* IE bugfix cont'd */
+ float: right;
+ margin: 5px 5px;
+ padding: 0;
+}
+#export-link .caption {
+ display: block;
+ font-size: 70%;
+ padding-left: 1px;
+}
+#export-link .format {
+ display: block;
+ text-align: center;
+ text-decoration: none;
+}
+
+.printlink {
+ float: right;
+}
+.printlink br {
+ margin-top: -10px;
+ padding-left: 1px;
+}
+.printlink a {
+ display: block;
+ font-size: 70%;
+ text-align: center;
+ margin: 0;
+ padding: 0;
+}
+.printlink img {
+ display: block;
+ height: 16px;
+ width: 16px;
+}
+
+p.instruction {
+ display: list-item;
+ list-style-image: url('../themes/images/instruction_arrow.png'); ;
+ list-style-position: outside;
+ margin-left: 2em;
+}
\ No newline at end of file
Propchange: forrest/site/themes/pelt.screen.css
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/site/tools/eclipse.source.xml
URL: http://svn.apache.org/viewcvs/forrest/site/tools/eclipse.source.xml?rev=376128&view=auto
==============================================================================
--- forrest/site/tools/eclipse.source.xml (added)
+++ forrest/site/tools/eclipse.source.xml Wed Feb 8 16:26:20 2006
@@ -0,0 +1,289 @@
+<?xml version="1.0" encoding="ISO-8859-1"?><!--
+ Copyright 2005 The Apache Software Foundation or its licensors,
+ as applicable.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+--><document>
+<header>
+ <title>
+ Apache Forrest: Eclipse Plugin
+ </title>
+ </header>
+<body>
+<section id="overview">
+ <title>
+ Eclipse Plugin
+ </title>
+ <warning>
+ The Forrest plugin for Eclipse is new and under rapid development. For up to the minute
+ details of available features see the dev list archives.
+ </warning>
+ </section>
+<section id="install">
+ <title>
+ Installation notes
+ </title>
+ <p>
+ To get you started while the documentation is being developed, see this forrest-dev mail thread:
+ <link href="http://marc.theaimsgroup.com/?t=112059632000001">
+ [eclipse] How to install?
+ </link>
+ .
+ </p>
+ </section>
+
+ <section>
+ <title>Wizards</title>
+ <p>A number of wizards are provided for perfomring common tasks. This section briefly describes
+ the available wizards.</p>
+
+ <section id="newProject">
+ <title>Creating a new Forrest Project</title>
+ <p>To create a new Forrest project select "New Project" from either the context menu in the package explorer or the
+ "New" menu and select Forrest -> Seed New Project.</p>
+ <p><strong>Project Name and Location</strong></p>
+ <p>A wizard will ask you for the name of the project and the location in which the project files are to be created
+ (by default the files will be in your current workspace). When you are done, click on Next</p>
+ <p><strong>Site options</strong></p>
+ <p>
+ Here you will see the Site Options page. This is where you can specify certain options for your new site.
+ Currently the available options are:</p>
+ <ul>
+ <li>Group Name</li>
+ <li>Project Name</li>
+ <li>Vendor</li>
+ <li>Copyright link</li>
+ <li>Disable PDF link</li>
+ <li>Disable POD link</li>
+ <li>Disable Print link</li>
+ <li>Disable Text link</li>
+ <li>Disable XML link</li>
+ </ul>
+ <p>There is also an option to save these sselections as your default settings. If this is done, the next time you create a project it will have the
+ same seelections that you have specified here. When you are finished with this page, click on Next</p>
+ <p><strong>Activate Plugins</strong></p>
+ <p>This page allows you to select the plugins that you would like your project to use. The list of available plugins is on the left
+ and list of plugins that you have chosen for your project is on the right. Once you have selected those plugins click on Finish to create your new Site Project.</p>
+ </section>
+
+ <section id="newXDoc">
+ <title>Creating a new XDoc</title>
+ <p>To create a new XDoc within yout Forrest project select "New -> Other..." and then select
+ "New XDoc" from the Forrest node.</p>
+ </section>
+ </section>
+
+ <section id="editors">
+ <title>Editors</title>
+ <p>A number of editors are provided for Forrest configuration files. This section describes those editors.</p>
+
+ <section id="siteXMLEditor">
+ <title>
+ site.xml Editor
+ </title>
+ <p>
+ First, you need to activate the Site.xml view. This can be done by:
+ <code>
+ Window -> Show View -> Other... -> Forrest -> SiteXML -> OK
+ </code>
+ Now you will see the the view open up in Eclipse. To view a tree, click on the project you are working and you should see the structure of the site.xml as a tree in the view.
+ </p>
+ <p>
+ There are two ways to add the note to the site.xml file.
+ </p>
+ <ol>
+ <li>
+ Drag a file from the Package Explorer to the tree. This will create a new element
+ with references to that dropped file(s).
+ </li>
+ <li>
+ Right click on an element in the site.xml tree and select "Add Element". A wizard will come up which will allow you to enter the HREF, Description, Label and Element name for the new element that is being added.
+ </li>
+ </ol>
+ <p>
+ To delete an element, right click on the element in the tree and click on "Delete Element".
+ </p>
+ <warning>
+ For the changes to show up when you run a test site for your project, you must save the changes. Right click on the tree and select
+ "Save". In a later version of the plugin this step will not be necessary.
+ </warning>
+ <fixme author="Anil Ramnanan">
+ Currently there is no easy way to edit an existing element. The element will be linked to the Properties View in Eclipse to allow for easy editing
+ </fixme>
+ </section>
+ <section id="tabsXMLEditor">
+ <title>
+ tabs.xml Editor
+ </title>
+ <p>
+ First, you need to activate the Tab.xml view. This can be done by:
+ <code>
+ Window -> Show View -> Other... -> Forrest -> TabXML -> OK
+ </code>
+ Now you will see the the view open up in Eclipse. To view a tree, click on the project you are working and you should see the structure of the tabs.xml as a tree in the view.
+ </p>
+ <p>
+ To add a new element to the tabs.xml file right click on an element in the tabs.xml tree and select "Add Element".
+ A wizard will come up which will allow you to enter the Id, Dir, Label and Index File for the new tab
+ element that is being added.
+ </p>
+ <p>
+ To delete an element, right click on the element in the tree and click on Delete Element
+ </p>
+ <warning>
+ For the changes to show up when you run a test site for your project, you must save the changes. Right
+ click on the tree and select "Save". In a later version of the plugin this step will not be necessary.
+ </warning>
+ <fixme author="Anil Ramnanan">
+ Currently there is no easy way to edit an element. The element will be linked to the Properties View in Eclipse to allow for easy editing
+ </fixme>
+ </section>
+
+ <section id="LocationmapEditor">
+ <title>
+ Locationmap.xml Editor
+ </title>
+ <p>
+ First, you need to activate the Locationmap view. This can be done by:
+ </p>
+ <p>
+ Window -> Show View -> Other... -> Forrest -> Locationmap -> OK
+ </p>
+ <p>
+ Now you will see the the view open up in Eclipse. To view a tree, click on the
+ project you are working and you should see the structure of the Locationmap.xml
+ as a tree in the view.
+ </p>
+ <p>
+ To add a match, you must rich click on the locater element and click on
+ "Add Match". A wizard will come up asking you to enter the Pattern or the Match.
+ </p>
+ <p>
+ Right click on the match you just created and click on "Add Location". This will allow you to enter the Location Source.
+ </p>
+ <p>
+ To delete an element, right click on the element in the tree and click on Delete Element
+ </p>
+ <p>
+ For the changes to show up when you run a test site for your project, you must save the changes. Right click on the tree and select
+ "Save".
+ </p>
+ <fixme author="Anil Ramnanan">
+ Currently there is no easy way to edit an element. The element will be linked to the Properties View in Eclipse to allow for easy editing
+ </fixme>
+ </section>
+
+ <section id="ForrestViews">
+ <title>
+ Activate Forrest:Views for a project
+ </title>
+ <p>
+ To activate views when seeding a new project:
+ </p>
+ <p>
+ File -> New -> Project -> Forrest -> Seed New Project -> Next
+ </p>
+ <p>
+ Type in the name of the project and click on Next. To Activate views for the new project, check off
+ "Activate Views" and click on Finish. When "Activate Views" is selected, the new project has
+ project.skin=leather-dev uncommented and the relevant plugins for views are added to
+ project.required.plugins
+ </p>
+ <p>
+ To add a new View doc (*.fv), click on New -> Other -> Forrest -> View Doc. Enter the file name of
+ the view document and click on Finish.
+ </p>
+ </section>
+
+ <section id="RepositoryBrowser">
+ <title>
+ Browse a remote Repostory
+ </title>
+ <p>
+ The Repository Browser allows you to browse a a remote repository and include the documents in a Forrest Project.
+ To show the Repository Browser view go to Window -> Show View - >Other. Expand the Forrest Tree and select Repository Browser.
+
+ </p>
+ <note>
+ Currently the repository Browser only has support for the Daisy repository
+ but support for other repoisotries can be easily added. If you have specific
+ need pleae join us on the dev list where we will be happy to assist.
+ </note>
+
+ <section>
+ <title>Daisy Repository</title>
+
+
+ <p>
+ For the Repository Browser to work with the <link href="http://www.cocoondev.org/daisy">Daisy repository</link>, the settings for the daisy repository must be configured.
+ </p>
+
+ <p>
+ Go to Windows -> Preferences. Chose Daisy. Here you will see a number of options to set for the daisy repository.
+ </p>
+
+ <ul>
+ <li>Repository Location - this is the http location of the repoistory browser. This can be a domain name or an IP address e.g. localhost or 127.0.0.1</li>
+ <li>Repository Port - This is the port that the repository runs on e.g. 9623</li>
+ <li>Repository Username - This is the username that is set for the repository</li>
+ <li>Repository Password - This is the password that is used to authenticate the user for the repository</li>
+ </ul>
+ </section>
+
+ <p>
+ To include a document from a Repository in a Forrest Project, click on the document in the Document list of the
+ repository browser and drag it to locator section in the Locationmap View.
+ </p>
+ </section>
+ </section>
+ <section id="ModifyandBuild">
+ <title>
+ Modify and Build Forrest Sites
+ </title>
+ <p>
+ Once a Forrest Project has been created the user can access the context menus to modify and build the site.
+ </p>
+ <section id="ModifySettings">
+ <title>
+ Modify Settings
+ </title>
+ <p>
+ In order to modify the settings of a project, right click on the project in the Package Explorer. At the bottom of the menu you
+ will find two meny items.
+ </p>
+ <ul>
+ <li>Modify Plugins Selection - This will let you add and remove Forrest plugins from your project</li>
+ <li>Modify Configurations - This allows you to modify the Site Option settings that were selected when the project was created.</li>
+ </ul>
+ </section>
+
+ <section id="BuildSettings">
+ <title>
+ Build Site Options
+ </title>
+ <p>
+ In order to build a project, right click on the project in the Package Explorer. At the bottom of the menu you
+ will find the Site menu item. This menu item has a number of sub items.
+ </p>
+ <ul>
+ <li>Start Test Server - This will start the project as a local webapp and open a browser window that will allow you to preview it.</li>
+ <li>Stop Test Server - This will stop the local webapp.</li>
+ <li>Build WAR File - This will build the site as a webapp in a war file located in the build folder of your project.</li>
+ <li>Build Site - This will build a static site from your project in the Build folder of your project.</li>
+ </ul>
+ </section>
+
+ </section>
+
+</body>
+</document>
\ No newline at end of file
Propchange: forrest/site/tools/eclipse.source.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/site/tools/forrestbar.source.xml
URL: http://svn.apache.org/viewcvs/forrest/site/tools/forrestbar.source.xml?rev=376128&view=auto
==============================================================================
--- forrest/site/tools/forrestbar.source.xml (added)
+++ forrest/site/tools/forrestbar.source.xml Wed Feb 8 16:26:20 2006
@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="ISO-8859-1"?><!--
+ Copyright 2002-2005 The Apache Software Foundation or its licensors,
+ as applicable.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+--><!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "http://forrest.apache.org/dtd/document-v12.dtd">
+<document>
+ <header>
+ <title>The ForrestBar</title>
+ </header>
+
+ <body>
+ <section>
+ <title>What's the ForrestBar?</title>
+ <p>The ForrestBar is a toolbar extension made for the
+ <link href="http://www.mozilla.org/products/mozilla1.x/">Mozilla</link>
+ and <link href="http://www.mozilla.org/products/firefox/">Firefox</link>
+ browsers that eases the navigation of online Forrest resources (including local
+ instances of Forrest running on jetty or as a webapp), Apache links
+ and other Apache projects.</p>
+ </section>
+ <section>
+ <title>Installing the ForrestBar</title>
+ <p>ForrestBar is currently compatible with Firefox 0.9 - 1.5 and Mozilla
+ 1.x browsers.</p>
+ <p><link href="forrestbar.xpi">Click here to install ForrestBar 0.7</link></p>
+ <p>If the extension does not automatically install for you when clicking
+ on the link, download ForrestBar by right clicking on the link and select Save
+ As... to save the file to your computer. To install, simply drag the
+ downloaded .xpi file into your browser's window and drop it.</p>
+ <p>To build ForrestBar locally rather than downloading, go to
+ FORREST_HOME/tools/forrestbar and run the following command:
+ <code>forrest -f build.xml</code> and the .xpi file will be built for you
+ in FORREST_HOME/tools/forrestbar/build. You can then install it by
+ dragging and dropping as indicated above.</p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: forrest/site/tools/forrestbar.source.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/site/tools/forrestbot-web-interface.source.xml
URL: http://svn.apache.org/viewcvs/forrest/site/tools/forrestbot-web-interface.source.xml?rev=376128&view=auto
==============================================================================
--- forrest/site/tools/forrestbot-web-interface.source.xml (added)
+++ forrest/site/tools/forrestbot-web-interface.source.xml Wed Feb 8 16:26:20 2006
@@ -0,0 +1,176 @@
+<?xml version="1.0" encoding="ISO-8859-1"?><!--
+ Copyright 2002-2005 The Apache Software Foundation or its licensors,
+ as applicable.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+--><!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "document-v12.dtd">
+<document>
+ <header>
+ <title>Forrestbot Web Interface</title>
+ </header>
+
+ <body>
+ <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>
+
+ <section>
+ <title>Build</title>
+
+ <p>To build the webapp from source, you need <link href="http://maven.apache.org/">Apache Maven</link> installed. From a
+ command prompt, go to the <code>forrest/tools/forrestbot/webapp</code>
+ directory and execute "<code>maven war</code>".</p>
+ </section>
+
+ <section>
+ <title>Requirements</title>
+
+ <ul>
+ <li>Forrest</li>
+
+ <li>A servlet container such as <link href="http://jakarta.apache.org/tomcat">Apache Tomcat</link></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>
+ </section>
+
+ <section>
+ <title>Installation</title>
+
+ <note>Most of this configuration is related to the <link href="http://www.opensymphony.com/osuser/">OpenSymphony OSUser</link>
+ authentication layer.</note>
+
+ <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>
+ </section>
+
+ <section>
+ <title>FAQ</title>
+
+ <section>
+ <title>The build and/or deploy commands don't seem to work</title>
+
+ <warning>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.</warning>
+
+ <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>
+ </section>
+
+ <section>
+ <title>Can I do anything with this besides just running the
+ forrestbot?</title>
+
+ <p>Sure. Create a wrapper script and specify it as forrest-exec in
+ settings.properties. Here's an example:</p>
+
+ <source xml:space="preserve">#!/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</source>
+ </section>
+ </section>
+
+ <section>
+ <title>TODO Wishlist</title>
+
+ <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>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: forrest/site/tools/forrestbot-web-interface.source.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/site/tools/forrestbot.source.xml
URL: http://svn.apache.org/viewcvs/forrest/site/tools/forrestbot.source.xml?rev=376128&view=auto
==============================================================================
--- forrest/site/tools/forrestbot.source.xml (added)
+++ forrest/site/tools/forrestbot.source.xml Wed Feb 8 16:26:20 2006
@@ -0,0 +1,868 @@
+<?xml version="1.0" encoding="ISO-8859-1"?><!--
+ Copyright 2002-2005 The Apache Software Foundation or its licensors,
+ as applicable.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+--><!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "http://forrest.apache.org/dtd/document-v12.dtd">
+<document>
+ <header>
+ <title>Forrestbot</title>
+ </header>
+
+ <body>
+ <section>
+ <title>Overview</title>
+
+ <p>Forrestbot lets you automate building and deploying websites. The
+ whole process gets the source docs, builds the site, then deploys it
+ where you want it to go. Forrestbot can also notify you afterwards, and
+ it keeps a log of the build process. To accomplish these tasks,
+ Forrestbot uses four "workstages" (getsrc, build, deploy, notify). Each
+ workstage has various implementations (e.g., getsrc has getsrc.cvs or
+ getsrc.svn or getsrc.local implementations), which have various
+ properties that may be set, depending upon the implementations
+ chosen.</p>
+ </section>
+
+ <section>
+ <title>Using Forrestbot</title>
+
+ <p>You need to create a customized buildfile directing Forrestbot's work
+ and then simply execute:</p>
+
+ <source xml:space="preserve">forrest -f mybuildfile.xml</source>
+
+ <p>This project buildfile is simply an Ant buildfile with specific
+ targets that control Forrestbot's operation. The next section explains
+ how to create such a buildfile. For details on the syntax of Ant
+ buildfiles and the operation of Ant itself consult the <link href="ext:ant">Ant documentation</link>.</p>
+ </section>
+
+ <section>
+ <title>Creating a Forrestbot Project Buildfile</title>
+
+ <p>Within the new buildfile, you need to first set properties needed by
+ the workstages you are going to use and then specify which
+ implementations will be used by each workstage. Note that the properties
+ need to be set at the global scope (as children of
+ <code><project></code>, i.e., outside of
+ <code><target></code> elements) in order for your settings to
+ override the defaults in the Forrestbot implementation. Other than that,
+ the property definitions can appear anywhere before the
+ <code><import></code> task.</p>
+
+ <p>This sample buildfile can be used as a base from which to customize
+ your own buildfile. The file starts with the project name and default
+ target, then sets the specific properties we need to get the source,
+ indicate the deployment location, and set up notification. It then
+ specifies which implementations we will use and finishes up with
+ importing the <code>forrestbot.xml</code> file. The 'main' target, which
+ is specified as the default here, is a convenience target (defined in
+ <code>forrestbot.xml</code>) that executes the four workstages (getsrc,
+ build, deploy, notify) sequentially.</p>
+
+ <source xml:space="preserve"><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>
+
+</source>
+
+ <section>
+ <title>Workstages</title>
+
+ <p>It is only necessary to include specific target implementations in
+ the buildfile if we want to override the default implementations. The
+ following table shows the various workstages, which implementations
+ may be used for each, and which one is the default.</p>
+
+ <table>
+ <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><link href="#getsrc.local">getsrc.local</link></li>
+
+ <li><link href="#getsrc.cvs">getsrc.cvs</link> (default)</li>
+
+ <li><link href="#getsrc.svn">getsrc.svn</link></li>
+ </ul></td>
+ </tr>
+
+ <tr>
+ <td colspan="1" rowspan="1">build</td>
+
+ <td colspan="1" rowspan="1"><ul>
+ <li><link href="#build.forrest">build.forrest</link></li>
+ </ul></td>
+ </tr>
+
+ <tr>
+ <td colspan="1" rowspan="1">deploy</td>
+
+ <td colspan="1" rowspan="1"><ul>
+ <li><link href="#deploy.local">deploy.local</link>
+ (default)</li>
+
+ <li><link href="#deploy.scp">deploy.scp</link></li>
+
+ <li><link href="#deploy.cvs">deploy.cvs</link></li>
+
+ <li><link href="#deploy.svn">deploy.svn</link></li>
+
+ <li><link href="#deploy.ftp">deploy.ftp</link></li>
+ </ul></td>
+ </tr>
+
+ <tr>
+ <td colspan="1" rowspan="1"><link href="#notify">notify</link></td>
+
+ <td colspan="1" rowspan="1"><ul>
+ <li><link href="#notify.local">notify.local</link>
+ (default)</li>
+
+ <li><link href="#notify.email">notify.email</link></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 <code><target
+ name="main" depends="getsrc, build, deploy, notify"/></code>,
+ create your own implementation of a workstage, or use any other ant
+ tasks to do additional work. In order to create your own workstage
+ implementation, define the workstage target in question in your
+ <code>mybuildfile.xml</code> anywhere before the
+ <code><import></code> task. This will override the default
+ implementation provided by Forrestbot.</p>
+
+ <p>Also, you can choose a different target as the default by changing
+ the <code>default</code> attribute of <code><project></code>.
+ For example, you will much more frequently do a 'build' without a
+ 'deploy' during the development of your website, and only at the end
+ do an actual 'deploy', so you might want to choose 'build' as your
+ default target.</p>
+
+ <section>
+ <title>Correct Use of getsrc.local</title>
+
+ <p>There is a wrinkle when using the 'getsrc.local' implementation
+ of the 'getsrc' workstage. If you define your own 'getsrc.local'
+ target, make sure it starts with the <code><property></code>
+ task given here:</p>
+
+ <source xml:space="preserve"><target name="getsrc.local">
+ <property name="build.home-dir" location="${getsrc.local.root-dir}"/>
+ [...]
+</target></source>
+
+ <p>Alternatively (and preferably), define your 'getsrc' target like
+ this:</p>
+
+ <source xml:space="preserve"><target name="getsrc" depends="getsrc.clean-workdir, getsrc.get, getsrc.local"/></source>
+
+ <p>and then implement the actual fetching of the sources in the
+ 'getsrc.get' target. This latter approach is safer since it is more
+ likely to be forward-compatible with future versions of
+ Forrestbot.</p>
+ </section>
+ </section>
+
+ <section>
+ <title>Workstage Properties</title>
+
+ <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>
+
+ <p>Many workstage properties use usernames and passwords. You may want
+ to keep them out of your project's Ant buildfile (especially if you
+ store that file in CVS or SVN). A nice way to do this is to create a
+ separate properties file (e.g., <code>auth.properties</code>) that
+ just sets those properties (don't include it in CVS/SVN). Then, at the
+ top of your project buildfile, have <code><property
+ file="auth.properties"/></code>.</p>
+
+ <section>
+ <title>Misc. Properties</title>
+
+ <table>
+ <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 colspan="1" rowspan="1">Yes</td>
+ </tr>
+ </table>
+ </section>
+
+ <section>
+ <title>getsrc.clean-workdir</title>
+
+ <p>This should be executed before a getsrc implementation is
+ executed, e.g., <code><target name="getsrc"
+ depends="getsrc.clean-workdir, getsrc.svn"/></code>.</p>
+ </section>
+
+ <section id="getsrc.local">
+ <title>getsrc.local</title>
+
+ <table>
+ <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 colspan="1" rowspan="1">Yes</td>
+ </tr>
+ </table>
+ </section>
+
+ <section id="getsrc.cvs">
+ <title>getsrc.cvs</title>
+
+ <table>
+ <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 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 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 for or the 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 colspan="1" rowspan="1">No</td>
+ </tr>
+ </table>
+ </section>
+
+ <section id="getsrc.svn">
+ <title>getsrc.svn</title>
+
+ <table>
+ <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 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>
+ </section>
+
+ <section id="build.forrest">
+ <title>build.forrest</title>
+
+ <table>
+ <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/${ant.project.name}</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>
+ </section>
+
+ <section id="deploy.local">
+ <title>deploy.local</title>
+
+ <table>
+ <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 - the dir that would be the
+ equivalant of build/site dir. Relative paths are relative to
+ ${basedir}, which defaults to the dir containing the Forrestbot
+ project buildfile (mybuildfile.xml).</td>
+
+ <td colspan="1" rowspan="1">sites/${ant.project.name}</td>
+
+ <td colspan="1" rowspan="1">No</td>
+ </tr>
+ </table>
+ </section>
+
+ <section id="deploy.scp">
+ <title>deploy.scp</title>
+
+ <p><code>${user.home}/.ssh/known_hosts</code> must properly
+ recognize the host, so you should manually make an ssh connection to
+ the host if you never have before.</p>
+
+ <table>
+ <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 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 colspan="1" rowspan="1">No. You will be prompted for it if it is not set.</td>
+ </tr>
+ </table>
+ </section>
+
+ <section id="deploy.cvs">
+ <title>deploy.cvs</title>
+
+ <p>This is only available on *nix operating systems.</p>
+
+ <table>
+ <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 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 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>
+ </section>
+
+ <section id="deploy.svn">
+ <title>deploy.svn</title>
+
+ <table>
+ <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 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 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 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>
+ </section>
+
+ <section id="deploy.ftp">
+ <title>deploy.ftp</title>
+
+ <table>
+ <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.ftp.server</td>
+
+ <td colspan="1" rowspan="1">FTP server to upload files to</td>
+
+ <td colspan="1" rowspan="1">localhost</td>
+
+ <td colspan="1" rowspan="1">No</td>
+ </tr>
+
+ <tr>
+ <td colspan="1" rowspan="1">deploy.ftp.user</td>
+
+ <td colspan="1" rowspan="1">FTP username to use for authenticating with the server</td>
+
+ <td colspan="1" rowspan="1">anonymous</td>
+
+ <td colspan="1" rowspan="1">No</td>
+ </tr>
+
+ <tr>
+ <td colspan="1" rowspan="1">deploy.ftp.password</td>
+
+ <td colspan="1" rowspan="1">Password for the FTP user</td>
+
+ <td colspan="1" rowspan="1">forrestbot@</td>
+
+ <td colspan="1" rowspan="1">No</td>
+ </tr>
+
+ <tr>
+ <td colspan="1" rowspan="1">deploy.ftp.remotedir</td>
+
+ <td colspan="1" rowspan="1">The directory to upload to (this can be an absolute path or
+ relative to the FTP user's default directory)</td>
+
+ <td colspan="1" rowspan="1">incoming</td>
+
+ <td colspan="1" rowspan="1">No</td>
+ </tr>
+ </table>
+ </section>
+
+ <section id="notify">
+ <title>notify</title>
+
+ <p>These settings are used by all notify implementations.</p>
+
+ <table>
+ <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 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 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 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 colspan="1" rowspan="1">No. Set by other workstage(s).</td>
+ </tr>
+ </table>
+ </section>
+
+ <section id="notify.local">
+ <title>notify.local</title>
+
+ <p>No properties.</p>
+ </section>
+
+ <section id="notify.email">
+ <title>notify.email</title>
+
+ <table>
+ <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>
+ </section>
+ </section>
+ </section>
+
+ <section>
+ <title>Forrestbot Design</title>
+
+ <p>Forrest and Forrestbot use Ant buildfiles extensively. Ant 1.6's
+ <code><import></code> 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 project buildfile (<code>mybuildfile.xml</code>)<ul>
+ <li><code>$FORREST_HOME/tools/forrestbot/core/forrestbot.xml</code><ul>
+ <li>Workstage buildfiles
+ (<code>$FORREST_HOME/tools/forrestbot/core/{getsrc,build,deploy,notify}.xml</code>)</li>
+
+ <li><code>$FORREST_HOME/main/forrest.build.xml</code></li>
+ </ul></li>
+ </ul></li>
+ </ul>
+
+ <p>The workstage buildfiles define the default workstage implementations
+ and set up the properties and files so that targets in the main Forrest
+ buildfile (<code>forrest.build.xml</code>) will run. After those targets
+ are executed, the targets in the workstage buildfiles can perform
+ reporting, deployment, or other post-build activities.</p>
+
+ <p>Your project buildfile specifies the workstages you want to use, sets
+ properties for them, and does any additional pre- and post-processing.
+ In addition, you can override the default workstage implementations by
+ defining the relevant targets in your project buildfile before the
+ <code><import></code> task (see the example above).</p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: forrest/site/tools/forrestbot.source.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/site/tools/index.source.xml
URL: http://svn.apache.org/viewcvs/forrest/site/tools/index.source.xml?rev=376128&view=auto
==============================================================================
--- forrest/site/tools/index.source.xml (added)
+++ forrest/site/tools/index.source.xml Wed Feb 8 16:26:20 2006
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="ISO-8859-1"?><!--
+ Copyright 2002-2005 The Apache Software Foundation or its licensors,
+ as applicable.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+--><document>
+ <header>
+ <title>Tools for Forrest</title>
+ </header>
+ <body>
+ <p>
+ These are various tools that assist the use of Forrest.
+ </p>
+ </body>
+</document>
\ No newline at end of file
Propchange: forrest/site/tools/index.source.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/site/tools/xxe.source.xml
URL: http://svn.apache.org/viewcvs/forrest/site/tools/xxe.source.xml?rev=376128&view=auto
==============================================================================
--- forrest/site/tools/xxe.source.xml (added)
+++ forrest/site/tools/xxe.source.xml Wed Feb 8 16:26:20 2006
@@ -0,0 +1,132 @@
+<?xml version="1.0" encoding="ISO-8859-1"?><!--
+ Copyright 2002-2005 The Apache Software Foundation or its licensors,
+ as applicable.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+--><!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "http://forrest.apache.org/dtd/document-v13.dtd">
+<document>
+ <header>
+ <title>XXE Forrest Configuration</title>
+ </header>
+
+ <body>
+ <note>This is not a particular endorsement of XXE over other xml editors.
+ It is just that we provide this tool to take advantage of XXE.</note>
+
+ <p><link href="http://www.xmlmind.com/xmleditor/">XMLmind XML Editor</link>
+ is a validating XML editor featuring a word processor-like view. We support
+ the Forrest plugin for XXE only, please direct all XXE-related questions to
+ XXE support or mailing lists.</p>
+
+ <section>
+ <title>Requirements</title>
+
+ <ul>
+ <li>XXE 3.0p1+ (version 1.3 of the tool works with XXE version 2.5p3 -
+ 3.0)</li>
+ <li>Forrest 0.5+</li>
+ </ul>
+ </section>
+
+ <section>
+ <title>Install</title>
+
+ <ol>
+ <li>Extract into the XXE application config directory (e.g.
+ <code>D:\Program Files\XMLmind_XML_Editor\config</code>)<br/>
+ <strong>OR</strong></li>
+ <li>Extract into your XXE user directory (e.g.
+ <code>~/.xxe/addon/config</code>) (only in version 1.3+ of this config).
+ For version 1.3+, this is the recommended installation location, as it
+ permits upgrading XXE without having to reinstall this config
+ <note>This location is new for XXE 2.10, and is not tested with earlier
+ releases!</note>
+ </li>
+ </ol>
+ </section>
+
+ <section>
+ <title>Upgrade</title>
+
+ <ol>
+ <li>Delete the <code>forrest</code> directory from the XXE application
+ config directory. (e.g. <code>D:\Program
+ Files\XMLmind_XML_Editor\config</code>)<br/>
+ <strong>OR</strong></li>
+ <li>Delete the 'forrest' directory from your user XXE config directory:
+ <ul>
+ <li>*nix-es: <code>~/.xxe/addon/</code></li>
+ <li>Windows: <code>%SystemDrive%\Documents and
+ Settings\user\Application Data\XMLmind\XMLeditor\</code></li>
+ </ul>
+ depending on where you installed the previous version of the tool
+ </li>
+
+ <li>Install normally</li>
+ </ol>
+ </section>
+
+ <section>
+ <title>Developer Instructions</title>
+
+ <p>To build the configuration:</p>
+
+ <ol>
+ <li>Make sure the FORREST_HOME environment variable is set</li>
+
+ <li>Change directory to <code>forrest/tools/xxe</code></li>
+
+ <li>Run <code>ant</code> in this directory</li>
+ </ol>
+
+ <p>To work directly with the SVN version, check out
+ http://svn.apache.org/repos/asf/forrest/trunk/tools/xxe/ into the
+ <code>forrest</code> folder in the XXE <code>addon</code> folder. Run the
+ build there to copy the DTDs</p>
+
+ <p><link href="http://www.xmlmind.com/xmleditor/_distrib/doc/configure/index.html">XXE
+ Custom Configuration Info</link></p>
+ </section>
+
+ <section>
+ <title>History</title>
+ <section>
+ <title>1.4</title>
+ <ul>
+ <li>Updated the tool to work with XXE 3.0p1. (FOR-779)
+ <note>This change is backwards INCOMPATIBLE, therefore the tool
+ now <em>requires</em> XXE 3.0p1+.</note>
+ </li>
+ <li>Added XXE-provided default rendering of tables</li>
+ </ul>
+ </section>
+ <section>
+ <title>1.3</title>
+ <ul>
+ <li>Fixed a bug that prevented this config to work with XXE 3.x
+ (FOR-720)</li>
+ <li>Fixed a bug that prevented correct loading of the common css
+ stylesheet (FOR-581)</li>
+ <li>Changed icon references to be installation independent
+ (FOR-581)</li>
+ <li>Added a Forrest menu, with more robust table manipulation, and for
+ v2 docs some link traversals (both taken from the XXE XHTML config)</li>
+ <li>Added more entries to the Table button (menu) in the Forrest
+ toolbar, replicating the entries in the Forrest menu</li>
+ <li>Added a History section to the README and documentation</li>
+ </ul>
+ </section>
+ </section>
+
+ </body>
+</document>
\ No newline at end of file
Propchange: forrest/site/tools/xxe.source.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/site/versions/index.source.xml
URL: http://svn.apache.org/viewcvs/forrest/site/versions/index.source.xml?rev=376128&view=auto
==============================================================================
--- forrest/site/versions/index.source.xml (added)
+++ forrest/site/versions/index.source.xml Wed Feb 8 16:26:20 2006
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="ISO-8859-1"?><!--
+ Copyright 2002-2005 The Apache Software Foundation or its licensors,
+ as applicable.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+--><document>
+ <header>
+ <title>Version Specific Documentation</title>
+ </header>
+ <body>
+ <p>
+ Documentation is available for various releases ...
+ </p>
+ <ul>
+ <li><link href="site:v0.60/documentation/index">0.6</link> - the past release</li>
+ <li><link href="site:v0.70/documentation/index">0.7</link> - the current release</li>
+ <li><link href="site:v0.80/documentation/index">0.8-dev</link> - the current development version</li>
+ </ul>
+ </body>
+</document>
\ No newline at end of file
Propchange: forrest/site/versions/index.source.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/site/who.source.xml
URL: http://svn.apache.org/viewcvs/forrest/site/who.source.xml?rev=376128&view=auto
==============================================================================
--- forrest/site/who.source.xml (added)
+++ forrest/site/who.source.xml Wed Feb 8 16:26:20 2006
@@ -0,0 +1,80 @@
+<?xml version="1.0" encoding="ISO-8859-1"?><!--
+ Copyright 2002-2005 The Apache Software Foundation or its licensors,
+ as applicable.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+--><document>
+ <header>
+ <title>Who we are</title>
+ </header>
+ <body>
+ <section id="community">
+ <title>The Forrest Community</title>
+ <p> The Forrest Project operates on a meritocracy: the more you do, the
+ more responsibility you will obtain. This page lists all of the people who have
+ gone the extra mile and are Committers. If you would like to get involved, the
+ first step is to join the mailing lists. </p>
+ <p>
+ Please do not send emails directly to individual developers asking for
+ free support - see the Important Notices at the
+ <link href="site:mail-lists">mailing lists</link> page.
+ </p>
+ </section>
+ <section id="active">
+ <title>Active Committers</title>
+ <ul>
+ <li><strong>[DB] - Dave Brondsema (brondsem.at.apache.org)</strong></li>
+ <li><strong><em>[DC] - David Crossley (crossley.at.apache.org)</em></strong></li>
+ <li><strong>[AG] - Antonio Gallardo (antonio.at.apache.org)</strong></li>
+ <li><strong>[RG] - Ross Gardler (rgardler.at.apache.org)</strong></li>
+ <li><strong>[JJP] - Juan Jose Pablos (cheche.at.apache.org)</strong></li>
+ <li><strong>[JS] - Johannes Schaefer (josch.at.apache.org)</strong></li>
+ <li><strong>[TS] - Thorsten Scherler (thorsten.at.apache.org)</strong></li>
+ <li><strong>[RFT] - Rick F. Tessner (rick.at.apache.org)</strong></li>
+ <li><strong>[FSO] - Ferdinand Soethe (ferdinand.at.apache.org)</strong></li>
+ <li><strong>[DG] - Diwaker Gupta (diwaker.at.apache.org)</strong></li>
+ <li><strong>[TW] - Tim Williams (twilliams.at.apache.org)</strong></li>
+ <li><strong>[CD] - Cyriaque Dupoirieux (cdupoirieux.at.apache.org)</strong></li>
+ </ul>
+ </section>
+ <section id="inactive">
+ <title>Inactive Committers</title>
+ <ul>
+ <li>[NKB] - Nicola Ken Barozzi (nicolaken.at.apache.org)</li>
+ <li>[SM] - Stefano Mazzocchi (stefano.at.apache.org)</li>
+ <li>[JM] - John Morrison (morrijr.at.apache.org)</li>
+ <li>[SN] - Steven Noels (stevenn.at.apache.org)</li>
+ <li>[KP] - Konstantin Piroumian (kpiroumian.at.apache.org)</li>
+ <li>[MP] - Marc Portier (mpo.at.apache.org)</li>
+ <li>[SR] - Sam Ruby (rubys.at.apache.org)</li>
+ <li>[JT] - Jeff Turner (jefft.at.apache.org)</li>
+ </ul>
+ </section>
+ <section id="notes">
+ <title>Notes</title>
+ <p>Strong type denotes <strong>PMC member</strong></p>
+ <p>Emphasis type denotes <em>PMC chair</em></p>
+ <p>See the <link href="http://apache.org/foundation/how-it-works.html#roles">ASF role definitions</link> for detailed role information.</p>
+ <p>
+ The term "active" is not measured by "number of svn commits".
+ A committer can be active simply by participating occasionally
+ on the mailing lists.
+ Some people go away for various reasons.
+ They are welcome to return at any time.
+ </p>
+ <p> All <link href="http://cocoon.apache.org/community/members.html">Apache Cocoon committers</link>
+ and <link href="http://lenya.apache.org/community/acknowledgements.html">Apache Lenya committers</link>
+ also have rights to commit to Forrest.</p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: forrest/site/who.source.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: forrest/site/zone.source.xml
URL: http://svn.apache.org/viewcvs/forrest/site/zone.source.xml?rev=376128&view=auto
==============================================================================
--- forrest/site/zone.source.xml (added)
+++ forrest/site/zone.source.xml Wed Feb 8 16:26:20 2006
@@ -0,0 +1,209 @@
+<?xml version="1.0" encoding="ISO-8859-1"?><!--
+ Copyright 2002-2005 The Apache Software Foundation or its licensors,
+ as applicable.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+--><document>
+ <header>
+ <title>Notes for forrest.zones.apache.org</title>
+ </header>
+ <body>
+ <section id="overview">
+ <title>Overview</title>
+ <p>
+ The server
+ <link href="ext:forrest-zone">forrest.zones.apache.org</link>
+ provides our testing and demonstration area.
+ It is managed by Apache Forrest committers.
+ </p>
+ </section>
+
+ <section id="configuration">
+ <title>Configuration</title>
+ <p>
+ Configuration files and directory structures are stored in SVN at
+ <code>https://svn.apache.org/repos/asf/forrest/zone</code>
+ </p>
+
+ <p>
+ <strong>config</strong>
+ </p>
+<!-- FIXME: create better layout for notes, just dumping text inside source elements for now. -->
+<source xml:space="preserve">
+creates /export/home/config ... $CONFIG
+directories /forrestbot-*/ are the forrestbot homes, see below.
+setenv*.sh ... these are sourced by the forrestbots and other
+ cronjobs and user configs, to set the environment.
+</source>
+
+ <p>
+ <strong>htdocs</strong>
+ </p>
+<source xml:space="preserve">
+creates /var/apache2/htdocs ... $DOC_ROOT
+directories /ft/ and /fts/ are the forrestbot config and results, see below.
+</source>
+
+ <p>
+ <strong>test-sources</strong>
+ </p>
+<source xml:space="preserve">
+A place to hold sources for various test sites.
+Normally these would be in the relevant project's SVN.
+Hold them here until building properly.
+</source>
+
+ <p>
+ All files are owned in the group "other" so any one of us can
+ edit/update. Make sure that your 'umask' is set properly so that
+ new files have group write permissions.
+ See the <link href="#admin-user">notes</link> about user administration.
+ FIXME: Add a proper group.
+ </p>
+ <p>
+ Cron runs the various Forrestbots and management tasks, such as
+ updating the forrest-trunk software; cleaning up old logfiles, etc.
+ FIXME: These are not yet managed under SVN, see ~crossley/my-crontab.txt
+ </p>
+ </section>
+
+ <section id="software">
+ <title>Software</title>
+ <p>
+ Global zone software is as described in
+ <link href="http://www.apache.org/dev/solaris-zones.html">zone administration</link>.
+ </p>
+ <p>
+ Various local software is installed in
+ <code>/export/opt/</code> (not managed with SVN) ...
+ </p>
+
+ <section id="s-forrest">
+ <title>Forrest</title>
+
+ <p>
+ <strong>forrest-trunk</strong>
+ </p>
+<source xml:space="preserve">
+svn checkout of trunk.
+automatically 'svn update' and 'build' via cron: $CONFIG/update-forrest-trunk.sh
+</source>
+
+ <p>
+ <strong>forrest-trunk-stable</strong>
+ </p>
+<source xml:space="preserve">
+svn checkout of trunk, manually updated as needed.
+</source>
+
+ <p>
+ <strong>forrest-release</strong>
+ </p>
+<source xml:space="preserve">
+svn checkout of current release branch, manually updated as needed.
+</source>
+
+ <p>
+ To manually update -stable or -release do this:
+ </p>
+ <source xml:space="preserve">
+source $CONFIG/setenv-java-14.sh
+cd /export/opt/forrest-trunk-stable
+svn up
+cd main
+./build.sh clean; ./build.sh
+</source>
+ </section>
+ </section>
+
+ <section id="fb">
+ <title>The forrestbots</title>
+ <p>
+ There are various forrestbots operating with different versions
+ of forrest.
+ Their home is at $CONFIG
+ </p>
+
+ <p>
+ <strong>$CONFIG/forrestbot-trunk</strong>
+ </p>
+<source xml:space="preserve">
+forrestbot operating with trunk.
+builds various sites automatically, triggered via cron.
+Configuration files and the generated results are at $DOC_ROOT/ft/
+FIXME: The web interface is coming soon.
+</source>
+
+ <p>
+ <strong>$CONFIG/forrestbot-trunk-stable</strong>
+ </p>
+<source xml:space="preserve">
+forrestbot operating with trunk-stable.
+builds various sites, only runs when needed, triggered via cron.
+Configuration files and the generated results are at $DOC_ROOT/fts/
+</source>
+
+ <p>
+ Forrestbot logs are at
+ $CONFIG/forrestbot-trunk*/logs/
+ and old ones are cleaned up by the crontab.
+ There is also a log file for each site that forrestbot builds
+ which captures the output of cron (cronout-*.txt).
+ Be sure to verify this logfile after making configuration changes.
+ </p>
+ </section>
+
+ <section id="admin">
+ <title>Administration</title>
+ <p>
+ See the general notes for the
+ <link href="http://www.apache.org/dev/solaris-zones.html">zone administration</link>.
+ </p>
+ <p>
+ The project chair is the root user.
+ Committers can ask on the dev list to get a user account added or modified.
+ </p>
+ <p>
+ Follow Leo's config ideas at
+ <link href="http://wiki.apache.org/gump/GumpZonesConfig">GumpZonesConfig</link>.
+ </p>
+ <p>
+ Also keep an occasional eye on
+ $CONFIG/update-forrest-trunk.log
+ This is the output of the cronjob to do svn update to trunk
+ and re-build.
+ </p>
+ <p>
+ FIXME:
+ Start apache2 on boot (using new Solaris init.d replacement called smf).
+ At the moment we need to realise that it is down and manually
+ restart as per http://www.apache.org/dev/solaris-zones.html
+ Also it seems that /var/run/apache2 is wiped out on reboot,
+ so need to mkdir again.
+ </p>
+
+ <section id="admin-user">
+ <title>User administration</title>
+ <p>After receiving your account, please be sure to configure it properly.</p>
+ <p>See some notes at
+ <link href="http://www.apache.org/dev/solaris-zones.html">zone administration</link>
+ and the general notes for
+ <link href="http://www.apache.org/dev/new-committers-guide.html#shell">new committers</link> (especially the part about 'umask').
+ </p>
+ <p>
+ Look at the setup of some other users on our zone.
+ </p>
+ </section>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: forrest/site/zone.source.xml
------------------------------------------------------------------------------
svn:eol-style = native