forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: r527010 [25/26] - in /forrest/trunk/site-author/content: ./ skins/ xdocs/ xdocs/docs_0_70/ xdocs/docs_0_70/howto/ xdocs/docs_0_70/howto/bugzilla-patch/ xdocs/docs_0_70/howto/cvs-ssh/ xdocs/docs_0_70/howto/multi/ xdocs/docs_0_80/ xdocs/docs_...
Date Tue, 10 Apr 2007 03:48:57 GMT
Modified: forrest/trunk/site-author/content/xdocs/tools/eclipse.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/tools/eclipse.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/tools/eclipse.xml (original)
+++ forrest/trunk/site-author/content/xdocs/tools/eclipse.xml Mon Apr  9 20:48:52 2007
@@ -17,141 +17,172 @@
 -->
 <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
 <document>
-<header>
-        <title>
+  <header>
+    <title>
           Apache Forrest: Eclipse Plugin
         </title>
-      </header>
-<body>
-<section id="overview">
-        <title>
+  </header>
+  <body>
+    <section id="overview">
+      <title>
           Eclipse Plugin
         </title>
-        <warning>
-          The Forrest plugin for Eclipse is new and under development.
-        </warning>
-      </section>
-<section id="install">
-        <title>
+      <warning>
+        The Forrest plugin for Eclipse is new and under development.
+      </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:
+        <a href="http://marc.theaimsgroup.com/?t=112059632000001"> [eclipse] How
+        to install? </a> .
+      </p>
+    </section>
+    <section>
+      <title>Wizards</title>
+      <p>
+        A number of wizards are provided for performing 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>
-          To get you started while the documentation is being developed, see this forrest-dev mail thread:
-          <a href="http://marc.theaimsgroup.com/?t=112059632000001">
-            [eclipse] How to install?
-          </a>
-          .
+          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>
-        <title>Wizards</title>
-        <p>A number of wizards are provided for performing 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 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 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>
+    </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>
+        <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>
+          <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>
+        </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.
+          <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.
+          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
+          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.
+          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
+          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">
+      <section id="LocationmapEditor">
         <title>
           Locationmap.xml Editor
         </title>
@@ -159,32 +190,35 @@
           First, you need to activate the Locationmap view. This can be done by:
         </p>
         <p>
-          Window ->  Show View ->  Other... -> Forrest -> Locationmap -> OK
+          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.
+          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.
+          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.
+          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
+          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".
+          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
+          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
@@ -193,99 +227,99 @@
           To activate views when seeding a new project:
         </p>
         <p >
-          File ->  New -> Project -> Forrest -> Seed New Project -> Next
+          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
+          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.
+          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">
+      <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.
-		  
+          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.
+          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>
+        <section>
           <title>Daisy Repository</title>
-        
-        
+          <p>
+            For the Repository Browser to work with the
+            <a href="http://www.cocoondev.org/daisy">Daisy repository</a>, 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>
-		For the Repository Browser to work with the <a href="http://www.cocoondev.org/daisy">Daisy repository</a>, the settings for the daisy repository must be configured.
+          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>
-		
-        <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>
+    <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">
+      <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">
+          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>
-
+          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>
-
-</body>    
+    </section>
+  </body>
 </document>

Modified: forrest/trunk/site-author/content/xdocs/tools/forrestbar.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/tools/forrestbar.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/tools/forrestbar.xml (original)
+++ forrest/trunk/site-author/content/xdocs/tools/forrestbar.xml Mon Apr  9 20:48:52 2007
@@ -20,32 +20,45 @@
   <header>
     <title>The ForrestBar</title>
   </header>
-
   <body>
     <section>
       <title>What's the ForrestBar?</title>
-      <p>The ForrestBar is a toolbar extension made for the
+      <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>
-      <p>Navigation and developer assistance for Apache Forrest-related documentation frameworks.</p>
+        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>
+      <p>
+        Navigation and developer assistance for Apache Forrest-related
+        documentation frameworks.
+      </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>Select this link to <link href="forrestbar.xpi">install</link> ForrestBar.</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
+      <p>
+        ForrestBar is currently compatible with Firefox 0.9 - 1.5+ and Mozilla
+        1.x browsers.
+      </p>
+      <p>
+        Select this link to <link href="forrestbar.xpi">install</link>
+        ForrestBar.
+      </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 the FORREST_HOME/tools/forrestbar/build directory. You can then install it by
-        dragging and dropping as indicated above.</p>
+        <code>forrest -f build.xml</code> and the .xpi file will be built for
+        you in the FORREST_HOME/tools/forrestbar/build directory. You can then
+        install it by dragging and dropping as indicated above.
+      </p>
     </section>
   </body>
 </document>

Modified: forrest/trunk/site-author/content/xdocs/tools/forrestbot-web-interface.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/tools/forrestbot-web-interface.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/tools/forrestbot-web-interface.xml (original)
+++ forrest/trunk/site-author/content/xdocs/tools/forrestbot-web-interface.xml Mon Apr  9 20:48:52 2007
@@ -21,118 +21,108 @@
   <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>
-
+    <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>
+      <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>
+      <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>
-
+      <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>
+      <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>
+        <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>
-
+        <p>
+          Sure. Create a wrapper script and specify it as forrest-exec in
+          settings.properties. Here's an example:
+        </p>
         <source>#!/bin/bash
 
 # get env vars
@@ -162,19 +152,13 @@
 # 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>

Modified: forrest/trunk/site-author/content/xdocs/tools/forrestbot.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/tools/forrestbot.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/tools/forrestbot.xml (original)
+++ forrest/trunk/site-author/content/xdocs/tools/forrestbot.xml Mon Apr  9 20:48:52 2007
@@ -21,61 +21,61 @@
   <header>
     <title>Forrestbot - automated building and deploying</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>
+      <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>
-
+      <p>
+        You need to create a customized buildfile directing Forrestbot's work
+        and then simply execute:
+      </p>
       <source>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>
+      <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>&lt;project&gt;</code>, i.e., outside of
-      <code>&lt;target&gt;</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>&lt;import&gt;</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><![CDATA[
+      <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>&lt;project&gt;</code>, i.e.,
+        outside of <code>&lt;target&gt;</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>&lt;import&gt;</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>
+<![CDATA[
 <project name="mysampleproject" default="main">
   <property name="notify.email.host" value="smtp.myhost.com"/>
   <property name="notify.email.to" value="me@domain.com"/>
@@ -104,450 +104,345 @@
   <property environment="env"/>
   <import file="${env.FORREST_HOME}/tools/forrestbot/core/forrestbot.xml"/>
 </project>
-]]></source>
-
+]]>
+      </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>
-
+        <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>Workstage</th>
-
             <th>Implementations</th>
           </tr>
-
           <tr>
             <td>getsrc</td>
-
-            <td><ul>
+            <td>
+              <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>
+              </ul>
+            </td>
           </tr>
-
           <tr>
             <td>build</td>
-
-            <td><ul>
+            <td>
+              <ul>
                 <li><link href="#build.forrest">build.forrest</link></li>
-              </ul></td>
+              </ul>
+            </td>
           </tr>
-
           <tr>
             <td>deploy</td>
-
-            <td><ul>
+            <td>
+              <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>
+              </ul>
+            </td>
           </tr>
-
           <tr>
-            <td><link href="#notify">notify</link></td>
-
-            <td><ul>
+            <td><link href="#notify">notify</link>
+            </td>
+            <td>
+              <ul>
                 <li><link href="#notify.local">notify.local</link>
                 (default)</li>
-
                 <li><link href="#notify.email">notify.email</link></li>
-              </ul></td>
+              </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>&lt;target
-        name="main" depends="getsrc, build, deploy, notify"/&gt;</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>&lt;import&gt;</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>&lt;project&gt;</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>
-
+        <p>
+          If you want to do more advanced processing for your project, you can
+          override the 'main' target, which by default is <code>&lt;target
+          name="main" depends="getsrc, build, deploy, notify"/&gt;</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>&lt;import&gt;</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>&lt;project&gt;</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 id="checksums">
           <title>Deploying only modified files</title>
-          <p>Use the <link href="site:faq/checksums">checkums</link> feature of the Cocoon CLI.
-            This enables Forrest to keep track of which generated files have actually
-            been changed. The Ant tasks used by Forrestbot will then deploy only the
-            modified files. Ant keeps a <code>cache.properties</code> file.
-            If you need to deploy all files then remove this file and let it
-            be re-generated.
+          <p>
+            Use the <link href="site:faq/checksums">checkums</link> feature of
+            the Cocoon CLI. This enables Forrest to keep track of which
+            generated files have actually been changed. The Ant tasks used by
+            Forrestbot will then deploy only the modified files. Ant keeps a
+            <code>cache.properties</code> file. If you need to deploy all files
+            then remove this file and let it be re-generated.
           </p>
-          <p>Note that the deplo.svn and deploy.cvs workstages handle modified files
-            with their own mechanism.
+          <p>
+            Note that the deplo.svn and deploy.cvs workstages handle modified
+            files with their own mechanism.
           </p>
         </section>
-
         <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>&lt;property&gt;</code>
-          task given here:</p>
-
+          <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>&lt;property&gt;</code>
+            task given here:
+          </p>
           <source>&lt;target name="getsrc.local"&gt;
   &lt;property name="build.home-dir" location="${getsrc.local.root-dir}"/&gt;
   [...]
 &lt;/target&gt;</source>
-
-          <p>Alternatively (and preferably), define your 'getsrc' target like
-          this:</p>
-
+          <p>
+            Alternatively (and preferably), define your 'getsrc' target like
+            this:
+          </p>
           <source>&lt;target name="getsrc" depends="getsrc.clean-workdir, getsrc.get, getsrc.local"/&gt;</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>
+          <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>&lt;property
-        file="auth.properties"/&gt;</code>.</p>
-
+        <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>&lt;property
+          file="auth.properties"/&gt;</code>.
+        </p>
         <section>
           <title>Misc. Properties</title>
-
           <table>
             <tr>
               <th>Property</th>
-
               <th>Description</th>
-
               <th>Default Value</th>
-
               <th>Required?</th>
             </tr>
-
             <tr>
               <td>ant.project.name (you specify this by &lt;project
               name="____"&gt; in your buildfile)</td>
-
               <td>This must be unique for each project.</td>
-
               <td></td>
-
               <td>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>&lt;target name="getsrc"
-          depends="getsrc.clean-workdir, getsrc.svn"/&gt;</code>.</p>
+          <p>
+            This should be executed before a getsrc implementation is executed,
+            e.g., <code>&lt;target name="getsrc" depends="getsrc.clean-workdir,
+            getsrc.svn"/&gt;</code>.
+          </p>
         </section>
-
         <section id="getsrc.local">
           <title>getsrc.local</title>
-
           <table>
             <tr>
               <th>Property</th>
-
               <th>Description</th>
-
               <th>Default Value</th>
-
               <th>Required?</th>
             </tr>
-
             <tr>
               <td>getsrc.local.root-dir</td>
-
               <td>Absolute path to the project's root directory on the local
               computer. Use <strong>location=</strong> instead of
               <strong>value=</strong> for this &lt;property&gt;</td>
-
               <td></td>
-
               <td>Yes</td>
             </tr>
           </table>
         </section>
-
         <section id="getsrc.cvs">
           <title>getsrc.cvs</title>
-
           <table>
             <tr>
               <th>Property</th>
-
               <th>Description</th>
-
               <th>Default Value</th>
-
               <th>Required?</th>
             </tr>
-
             <tr>
               <td>getsrc.cvs.user</td>
-
               <td>CVS username</td>
-
               <td></td>
-
               <td>Yes</td>
             </tr>
-
             <tr>
               <td>getsrc.cvs.password</td>
-
               <td>CVS password</td>
-
               <td></td>
-
               <td>Yes</td>
             </tr>
-
             <tr>
               <td>getsrc.cvs.root</td>
-
               <td>CVS root directory</td>
-
               <td>/home/cvsroot</td>
-
               <td>Yes</td>
             </tr>
-
             <tr>
               <td>getsrc.cvs.host</td>
-
               <td>CVS host</td>
-
               <td>cvs.apache.org</td>
-
               <td>Yes</td>
             </tr>
-
             <tr>
               <td>getsrc.cvs.module</td>
-
               <td>CVS module name (an alias for or the full path to the
               directory that contains forrest.properties)</td>
-
               <td>${ant.project.name}</td>
-
               <td>Yes</td>
             </tr>
-
             <tr>
               <td>getsrc.cvs.tag</td>
-
               <td>CVS tag or branch name</td>
-
               <td></td>
-
               <td>No</td>
             </tr>
           </table>
         </section>
-
         <section id="getsrc.svn">
           <title>getsrc.svn</title>
-
           <table>
             <tr>
               <th>Property</th>
-
               <th>Description</th>
-
               <th>Default Value</th>
-
               <th>Required?</th>
             </tr>
-
             <tr>
               <td>getsrc.svn.url</td>
-
               <td>Full repository URL for project (this directory must contain
               forrest.properties)</td>
-
               <td></td>
-
               <td>Yes</td>
             </tr>
-
             <tr>
               <td>getsrc.svn.revision</td>
-
               <td>Revision number to fetch</td>
-
               <td>HEAD</td>
-
               <td>No</td>
             </tr>
           </table>
         </section>
-
         <section id="build.forrest">
           <title>build.forrest</title>
-
           <table>
             <tr>
               <th>Property</th>
-
               <th>Description</th>
-
               <th>Default Value</th>
-
               <th>Required?</th>
             </tr>
-
             <tr>
               <td>build.work-dir</td>
-
               <td>Directory to temporarily hold working files</td>
-
               <td>work/${ant.project.name}</td>
-
               <td>No</td>
             </tr>
-
             <tr>
               <td>build.log-dir</td>
-
               <td>Directory to hold log files</td>
-
               <td>logs</td>
-
               <td>No</td>
             </tr>
           </table>
         </section>
-
         <section id="deploy.local">
           <title>deploy.local</title>
-
           <table>
             <tr>
               <th>Property</th>
-
               <th>Description</th>
-
               <th>Default Value</th>
-
               <th>Required?</th>
             </tr>
-
             <tr>
               <td>deploy.local.dir</td>
-
               <td>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>sites/${ant.project.name}</td>
-
               <td>No</td>
             </tr>
           </table>
         </section>
-
         <section id="deploy.scp">
           <title>deploy.scp</title>
-
-          <p>The <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>
-
-          <p>If <code>${deploy.scp.keyfile}</code>is defined, then it will use
-          key-based authentication in preference. Otherwise it will use
-          <code>${deploy.scp.password}</code></p>
-
+          <p>
+            The <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>
+          <p>
+            If <code>${deploy.scp.keyfile}</code>is defined, then it will use
+            key-based authentication in preference. Otherwise it will use
+            <code>${deploy.scp.password}</code>
+          </p>
           <table>
             <tr>
               <th>Property</th>
-
               <th>Description</th>
-
               <th>Default Value</th>
-
               <th>Required?</th>
             </tr>
-
             <tr>
               <td>deploy.scp.dest</td>
-
               <td>Full destination reference in the format
               user@host:/directory/path</td>
-
               <td></td>
-
               <td>Yes</td>
             </tr>
-
             <tr>
               <td>deploy.scp.keyfile</td>
-
               <td>Location of the local file holding the private key.
               Usually /home/me/.ssh/id_dsa or /home/me/.ssh/id_rsa
               <br />
               Note that the deploy.scp.passphrase must also be supplied.
               </td>
-
               <td></td>
-
               <td>No. However, if this is not supplied then scp will fallback
               to use the less secure deploy.scp.password</td>
             </tr>
-
             <tr>
               <td>deploy.scp.passphrase</td>
-
               <td>Local passphrase for your private key.</td>
-
               <td></td>
-
               <td>No. You will be prompted if it is not set.</td>
             </tr>
-
             <tr>
               <td>deploy.scp.password</td>
-
               <td>Password for user@host</td>
-
               <td></td>
-
               <td>No. You will be prompted if it is not set.
               <br />
               Not needed if using the preferred
@@ -556,364 +451,250 @@
             </tr>
           </table>
         </section>
-
         <section id="deploy.cvs">
           <title>deploy.cvs</title>
-
-          <p>This is only available on *nix operating systems.</p>
-
+          <p>
+            This is only available on *nix operating systems.
+          </p>
           <table>
             <tr>
               <th>Property</th>
-
               <th>Description</th>
-
               <th>Default Value</th>
-
               <th>Required?</th>
             </tr>
-
             <tr>
               <td>deploy.cvs.user</td>
-
               <td>CVS username to use when committing changes</td>
-
               <td></td>
-
               <td>Yes</td>
             </tr>
-
             <tr>
               <td>deploy.cvs.password</td>
-
               <td>CVS password</td>
-
               <td></td>
-
               <td>Yes</td>
             </tr>
-
             <tr>
               <td>deploy.cvs.root</td>
-
               <td>CVS root</td>
-
               <td>/home/cvs</td>
-
               <td>Yes</td>
             </tr>
-
             <tr>
               <td>deploy.cvs.host</td>
-
               <td>CVS host</td>
-
               <td>cvs.apache.org</td>
-
               <td>Yes</td>
             </tr>
-
             <tr>
               <td>deploy.cvs.module</td>
-
               <td>CVS module</td>
-
               <td>${ant.project.name}</td>
-
               <td>Yes</td>
             </tr>
-
             <tr>
               <td>deploy.cvs.commit-message</td>
-
               <td>Message to use when committing. You probably want to put a
               machine name or person's name here.</td>
-
               <td>Automatic publish from forrestbot</td>
-
               <td>No</td>
             </tr>
           </table>
         </section>
-
         <section id="deploy.svn">
           <title>deploy.svn</title>
-
           <table>
             <tr>
               <th>Property</th>
-
               <th>Description</th>
-
               <th>Default Value</th>
-
               <th>Required?</th>
             </tr>
-
             <tr>
               <td>deploy.svn.user</td>
-
               <td>SVN username to use when committing changes</td>
-
               <td></td>
-
               <td>Yes</td>
             </tr>
-
             <tr>
               <td>deploy.svn.password</td>
-
               <td>SVN password</td>
-
               <td></td>
-
               <td>Yes</td>
             </tr>
-
             <tr>
               <td>deploy.svn.url</td>
-
               <td>Full repository URL</td>
-
               <td></td>
-
               <td>Yes</td>
             </tr>
-
             <tr>
               <td>deploy.svn.commit-message</td>
-
               <td>Message to use when committing. You probably want to put a
               machine name or person's name here.</td>
-
               <td>Automatic publish from forrestbot</td>
-
               <td>No</td>
             </tr>
           </table>
         </section>
-
         <section id="deploy.ftp">
           <title>deploy.ftp</title>
-
           <table>
             <tr>
               <th>Property</th>
-
               <th>Description</th>
-
               <th>Default Value</th>
-
               <th>Required?</th>
             </tr>
-
             <tr>
               <td>deploy.ftp.server</td>
-
               <td>FTP server to upload files to</td>
-
               <td>localhost</td>
-
               <td>No</td>
             </tr>
-
             <tr>
               <td>deploy.ftp.user</td>
-
               <td>FTP username to use for authenticating with the server</td>
-
               <td>anonymous</td>
-
               <td>No</td>
             </tr>
-
             <tr>
               <td>deploy.ftp.password</td>
-
               <td>Password for the FTP user</td>
-
               <td>forrestbot@</td>
-
               <td>No</td>
             </tr>
-
             <tr>
               <td>deploy.ftp.remotedir</td>
-
               <td>The directory to upload to (this can be an absolute path or
               relative to the FTP user's default directory)</td>
-
               <td>incoming</td>
-
               <td>No</td>
             </tr>
           </table>
         </section>
-
         <section id="notify">
           <title>notify</title>
-
-          <p>These settings are used by all notify implementations.</p>
-
+          <p>
+            These settings are used by all notify implementations.
+          </p>
           <table>
             <tr>
               <th>Property</th>
-
               <th>Description</th>
-
               <th>Default Value</th>
-
               <th>Required?</th>
             </tr>
-
             <tr>
               <td>notify.administrator</td>
-
               <td>Name and email address of the forrestbot administrator</td>
-
               <td></td>
-
               <td>Yes</td>
             </tr>
-
             <tr>
               <td>notify.on.failure</td>
-
               <td>On a build failure, notification will happen if this is
               true.</td>
-
               <td>true</td>
-
               <td>No</td>
             </tr>
-
             <tr>
               <td>notify.on.success</td>
-
               <td>On a succesful build, notification will happen if this is
               true.</td>
-
               <td>true</td>
-
               <td>No</td>
             </tr>
-
             <tr>
               <td>notify.log</td>
-
               <td>Log file</td>
-
               <td></td>
-
               <td>No. Set by other workstage(s).</td>
             </tr>
-
             <tr>
               <td>notify.deploy-location</td>
-
               <td>Deployed location</td>
-
               <td></td>
-
               <td>No. Set by other workstage(s).</td>
             </tr>
-
             <tr>
               <td>notify.completion-status</td>
-
               <td>Result of the build</td>
-
               <td></td>
-
               <td>No. Set by other workstage(s).</td>
             </tr>
           </table>
         </section>
-
         <section id="notify.local">
           <title>notify.local</title>
-
-          <p>No properties.</p>
+          <p>
+            No properties.
+          </p>
         </section>
-
         <section id="notify.email">
           <title>notify.email</title>
-
           <table>
             <tr>
               <th>Property</th>
-
               <th>Description</th>
-
               <th>Default Value</th>
-
               <th>Required?</th>
             </tr>
-
             <tr>
               <td>notify.email.host</td>
-
               <td>SMTP host through which the email will be sent.</td>
-
               <td>localhost</td>
-
               <td>Yes</td>
             </tr>
-
             <tr>
               <td>notify.email.to</td>
-
               <td>Email address to send notification to.</td>
-
               <td>${user.name}@localhost</td>
-
               <td>Yes</td>
             </tr>
-
             <tr>
               <td>notify.email.from</td>
-
               <td>From: address in the email</td>
-
               <td>Forrestbot</td>
-
               <td>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>&lt;import&gt;</code> task is used to import multiple buildfiles
-      into a single build. The following is the flow of control when running
-      Forrestbot:</p>
-
+      <p>
+        Forrest and Forrestbot use Ant buildfiles extensively. Ant 1.6's
+        <code>&lt;import&gt;</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><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>&lt;import&gt;</code> task (see the example above).</p>
+      <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>&lt;import&gt;</code> task (see the example above).
+      </p>
     </section>
   </body>
 </document>

Modified: forrest/trunk/site-author/content/xdocs/tools/xxe.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/tools/xxe.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/tools/xxe.xml (original)
+++ forrest/trunk/site-author/content/xdocs/tools/xxe.xml Mon Apr  9 20:48:52 2007
@@ -22,12 +22,16 @@
     <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>
+    <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>
@@ -38,13 +42,17 @@
     </section>
     <section id="build">
       <title>Build</title>
-      <p>To build the configuration:</p>
+      <p>
+        To build the configuration:
+      </p>
       <ol>
         <li>Make sure the FORREST_HOME environment variable is set</li>
         <li>Change directory to <code>$FORREST_HOME/tools/xxe</code></li>
         <li>Run <code>ant</code> in this directory</li>
       </ol>
-      <p>e.g.</p>
+      <p>
+        e.g.
+      </p>
       <source>you@yourHost:~/src/apache/forrest-trunk$ cd tools/xxe 
         you@yourHost:~/src/apache/forrest-trunk/tools/xxe$ ant Buildfile: 
         build.xml -init: clean: copy-dtds: [copy] Copying 71 files to 
@@ -54,29 +62,33 @@
         /home/you/src/apache/forrest-trunk/tools/xxe/dist [zip] Building zip: 
         /home/you/src/apache/forrest-trunk/tools/xxe/dist/XXE_forrest_config-1.4.zip 
         BUILD SUCCESSFUL Total time: 9 seconds</source>
-      <p><strong>Developer note:</strong><br/>To work directly with the SVN 
-        version of the configuration, 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>
+        <strong>Developer note:</strong>
+        <br/>
+        To work directly with the SVN version of the configuration, 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>
+        XXE Custom Configuration Info</link>
       </p>
     </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>
+          <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>
+          this config <note>
+            This location is new for XXE 2.10, and is not tested with earlier
+            releases!
+          </note></li>
       </ol>
     </section>
     <section>
@@ -84,11 +96,14 @@
       <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>
+          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: 
+          <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 
+          Data\XMLmind\XMLeditor\</code></li>
+          </ul> depending on where you 
           installed the previous version of the tool </li>
         <li>Install normally</li>
       </ol>
@@ -98,9 +113,10 @@
       <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>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>
@@ -123,4 +139,4 @@
       </section>
     </section>
   </body>
-</document>
\ No newline at end of file
+</document>

Modified: forrest/trunk/site-author/content/xdocs/trash/docs_0_50/index.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/trash/docs_0_50/index.xml?view=diff&rev=527010&r1=527009&r2=527010
==============================================================================
--- forrest/trunk/site-author/content/xdocs/trash/docs_0_50/index.xml (original)
+++ forrest/trunk/site-author/content/xdocs/trash/docs_0_50/index.xml Mon Apr  9 20:48:52 2007
@@ -23,9 +23,6 @@
   <body>
     <section>
       <title>Welcome!</title>
-      
     </section>
-
-    
   </body>
 </document>



Mime
View raw message