Thread: [FOray-commit] SF.net SVN: foray: [8643] trunk/foray (Page 6)

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Revision: 8643
          http://svn.sourceforge.net/foray/?rev=8643&view=rev
Author:   victormote
Date:     2007-02-10 08:04:40 -0800 (Sat, 10 Feb 2007)

Log Message:
-----------
Add doc for the build environment.

Modified Paths:
--------------
    trunk/foray/doc/web/00-rsrc/include/leftmenu-dev.html
    trunk/foray/scripts/foray-build.properties

Added Paths:
-----------
    trunk/foray/doc/web/dev/env.html

Modified: trunk/foray/doc/web/00-rsrc/include/leftmenu-dev.html
===================================================================

--- trunk/foray/doc/web/00-rsrc/include/leftmenu-dev.html	2007-02-10 15:47:06 UTC (rev 8642)
+++ trunk/foray/doc/web/00-rsrc/include/leftmenu-dev.html	2007-02-10 16:04:40 UTC (rev 8643)
@@ -52,6 +52,12 @@
     <tr>
       <td class="Bullet1">&nbsp;</td>
       <td class="Menu1">
+        <a class="Menu" href="/dev/env.html">Environment</a>
+      </td>
+    </tr>
+    <tr>
+      <td class="Bullet1">&nbsp;</td>
+      <td class="Menu1">
         <a class="Menu" href="/dev/extensions.html">Extensions</a>
       </td>
     </tr>

Added: trunk/foray/doc/web/dev/env.html
===================================================================
--- trunk/foray/doc/web/dev/env.html	                        (rev 0)
+++ trunk/foray/doc/web/dev/env.html	2007-02-10 16:04:40 UTC (rev 8643)
@@ -0,0 +1,87 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html
+    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
+
+<head>
+  <title>FOray: Testing</title>
+  <meta name="content-revised"
+    content="$Date$"/>
+  <!--#include virtual="/00-rsrc/include/standard-head.html" -->
+</head>
+
+<body>
+<!--#include virtual="/00-rsrc/include/leftmenu-dev.html" -->
+
+<h1>FOray: Development Environment</h1>
+
+<h2>Contents</h2>
+<ul>
+  <li><a href="#tools">Tools</a></li>
+  <li><a href="#config">Configuration</a></li>
+  <li><a href="#eclipse">Eclipse IDE Quick-Start</a></li>
+</ul>
+
+<h2><a name="tools"/>Tools</h2>
+<p>The following tools are needed for FOray development:</p>
+<ul>
+  <li>A Java Integrated Development Environment (IDE) running JDK 1.5 or
+  higher.
+  Although it is theoretically possible to develop without an IDE, it is not
+  practical.
+  If you do not have a Java IDE, consider Eclipse, which is free, and suitable
+  for FOray development (see below for details).</li>
+  <li>A Subversion client. Most IDEs have one built-in.</li>
+  <li>Ant</li>
+  <li>Checkstyle</li>
+  <li>JUnit</li>
+</ul>
+
+<h2><a name="config"/>Configuration</h2>
+<p>The problem with configuring development environments for a team of
+developers is that there are differences in the local environments that must be
+handled flexibly.
+And yet, we wish to hard-code as much information as possible, to prevent each
+developer from needing to deal with the details of setting up the various
+projects, finding the libraries, configuring checkstyle, etc.
+To achieve these contradictory goals, FOray uses a centralized build
+configuration properties file and makes that file available through the local
+environment.
+This file is always named "foray-build.properties" and should be placed in a
+directory whose location can be found by java at FORAY_CONFIG.
+The FORAY_CONFIG variable can be set either in your local environment or by
+using the -D switch when starting up your various Java processes, including your
+IDE.
+It is usually easier to set it in your local environment.</p>
+
+<p>A documented, pro-forma example of "foray-build.properties" is located in
+the "scripts" directory.
+Please be sure to set up the various properties noted there.</p>
+
+<h2><a name="eclipse"/>Eclipse IDE Quick-Start</h2>
+<p>Install <a href="http://www.eclipse.org">Eclipse</a>.</p>
+<p>The following Eclipse plugins should be installed:</p>
+<ul>
+  <li><a href="http://eclipse-cs.sourceforge.net/">Eclipse-CS</a>, a checkstyle
+  plugin.
+  After plugin installation, create the Check configuration for FOray.
+  Open the Window/Preferences menu.
+  Select the "Checkstyle" page.
+  Click the "New" button.
+  Select Type "External Configuration".
+  Enter the name "FOray Checkstyle". (Enter this exactly so that the FOray
+  modules will automatically attach to it).
+  Enter the location that corresponds to your
+  ${foray.sandbox}/scripts/checkstyle-config.xml.
+  Click the "Additional Properties" button, and create a property
+  "foray.sandbox" which points to your ${foray.sandbox}.
+  (This is necessary because there is no way to tell Eclipse-CS to read your
+  foray-build.properties file.)</li>
+</ul>
+
+
+<!--#include virtual="/00-rsrc/include/leftmenu-end.html" -->
+</body>
+</html>


Property changes on: trunk/foray/doc/web/dev/env.html
___________________________________________________________________
Name: svn:keywords
   + "Author Id Rev Date URL"
Name: svn:eol-style
   + native

Modified: trunk/foray/scripts/foray-build.properties
===================================================================
--- trunk/foray/scripts/foray-build.properties	2007-02-10 15:47:06 UTC (rev 8642)
+++ trunk/foray/scripts/foray-build.properties	2007-02-10 16:04:40 UTC (rev 8643)
@@ -1,8 +1,9 @@
 # This is a default Java properties file for the FOray build.
 # 1. It is accessed from FOray build.xml files to obtain property values that
 #    are customized to a particular environment.
-# 2. It can be modified in place or it can be copied to another location and
-#    modified there.
+# 2. It should be copied to another location and modified there.
+#    Please do not modify it in-place, as it may then be accidentally checked
+#    in to the repository.
 # 3. For the build scripts to find it in another location, the file name must
 #    remain "foray-build.properties" and the FORAY_CONFIG environment
 #    variable must be set to the directory in which the properties file is


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.




Thread: [FOray-commit] SF.net SVN: foray: [8643] trunk/foray (Page 6)

Modular XSL-FO Implementation for Java.

foray-commit