You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tuscany.apache.org by ri...@apache.org on 2006/05/26 00:36:49 UTC

svn commit: r409493 - in /incubator/tuscany/site/src/site: resources/setenv.bat resources/setenv.sh xdoc/maven.xml xdoc/projectjava.xml xdoc/quicksubversion.xml

Author: rineholt
Date: Thu May 25 15:36:48 2006
New Revision: 409493

URL: http://svn.apache.org/viewvc?rev=409493&view=rev
Log:
TUSCANY-345
http://issues.apache.org/jira/browse/TUSCANY-345

Added:
    incubator/tuscany/site/src/site/resources/setenv.bat
    incubator/tuscany/site/src/site/resources/setenv.sh
    incubator/tuscany/site/src/site/xdoc/maven.xml
    incubator/tuscany/site/src/site/xdoc/quicksubversion.xml
Modified:
    incubator/tuscany/site/src/site/xdoc/projectjava.xml

Added: incubator/tuscany/site/src/site/resources/setenv.bat
URL: http://svn.apache.org/viewvc/incubator/tuscany/site/src/site/resources/setenv.bat?rev=409493&view=auto
==============================================================================
--- incubator/tuscany/site/src/site/resources/setenv.bat (added)
+++ incubator/tuscany/site/src/site/resources/setenv.bat Thu May 25 15:36:48 2006
@@ -0,0 +1,27 @@
+REM set JAVA_HOME to the full path of where Java JDK  was installed
+set JAVA_HOME=E:\bin\jdk1.5.0_06
+
+REM set MAVEN_HOME to the full path of where Maven was installed
+set MAVEN_HOME=e:\bin\maven-2.0.4
+
+REM set ANT_HOME to the full path of where Ant was installed
+set ANT_HOME=E:\bin\apache-ant-1.6.5
+
+REM set SVN_HOME to the full path of where Subversion was installed
+set SVN_HOME=E:\bin\svn-win32-1.3.1
+
+set PATH=%PATH%;%JAVA_HOME%\bin
+set PATH=%PATH%;%MAVEN_HOME%\bin
+set PATH=%PATH%;%ANT_HOME%\bin
+set PATH=%PATH%;%ANT_HOME%\bin
+echo.
+echo Checkng Java 
+java -version
+echo checking Ant
+call ant -version
+echo.
+echo checking Ant
+svn --version
+echo.
+echo checking Maven 
+mvn --version

Added: incubator/tuscany/site/src/site/resources/setenv.sh
URL: http://svn.apache.org/viewvc/incubator/tuscany/site/src/site/resources/setenv.sh?rev=409493&view=auto
==============================================================================
--- incubator/tuscany/site/src/site/resources/setenv.sh (added)
+++ incubator/tuscany/site/src/site/resources/setenv.sh Thu May 25 15:36:48 2006
@@ -0,0 +1,16 @@
+typeset -x JAVA_HOME=~/bin/jdk1.5.0_06
+typeset -x PATH=$JAVA_HOME/bin:$PATH
+#
+typeset -x ANT_HOME=~/bin/apache-ant-1.6.5
+typeset -x PATH=$ANT_HOME/bin:$PATH
+#
+typeset -x MVN_HOME=~/bin/maven-2.0.4
+typeset -x PATH=$MVN_HOME/bin:$PATH/bin
+#
+typeset -x SVN_HOME=~/bin/maven-2.0.4
+typeset -x PATH=$SVN_HOME/bin:$PATH/bin
+#
+java -version
+mvn --version
+ant -version
+svn --version

Added: incubator/tuscany/site/src/site/xdoc/maven.xml
URL: http://svn.apache.org/viewvc/incubator/tuscany/site/src/site/xdoc/maven.xml?rev=409493&view=auto
==============================================================================
--- incubator/tuscany/site/src/site/xdoc/maven.xml (added)
+++ incubator/tuscany/site/src/site/xdoc/maven.xml Thu May 25 15:36:48 2006
@@ -0,0 +1,64 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Copyright (c) 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 url="maven.xml">
+
+	<properties>
+		<author email="mike_edwards@uk.ibm.com">Mike Edwards</author>
+		<title>Apache Tuscany Maven Quick Introduction</title>
+	</properties>
+
+	<body>
+<a name="using maven"></a>
+<section name="Maven Quick Reference">
+			<p>
+				For some help getting started with Maven, look at:
+                    <script type="text/javascript">linkNewWindow('http://maven.apache.org/guides/getting-started/index.html','http://maven.apache.org/guides/getting-started/index.html');</script> 
+	    </p>
+	     <p>
+		    With Maven, there is no build "script" like the ant build.xml file. Instead you 
+				provide Maven with a description of your project and it uses that information to
+				determine how to achieve your build goal. The description is held in a pom.xml file.
+				There is a pom.xml file at the top level of your project and there are subsidiary
+				pom.xml files for modules within your project which are referenced from the top level
+				pom file. The Maven project has also established a set of best practices for
+				structuring builds and if you follow those you can get away with very little 
+				description; the Tuscany builds are set up that way.
+			</p>
+			<p>
+				The general rule for maven is that each (sub)project produces one build artifact 
+				(typically a jar file). You can see this in the java project directory where
+				there are separate projects for sca, sdo, das (etc) and within these, separate
+				folders and pom files for major components such as container.java.
+			</p>
+			<p>
+				The main Maven 2.x command is "mvn" and the default goal is "install" which will 
+				compile, unit test and package each project. This will typically output a
+				jar file that is installed locally so that other projects can depend on it.
+			</p>
+                        <p>
+                           Once you have the Java project setup up, you can build the project by issuing the following command in the tuscany root directory:<br/>
+                           <code>
+                              mvn
+                            </code>
+                            
+			</p>
+		</section>
+
+	</body>
+
+
+</document>

Modified: incubator/tuscany/site/src/site/xdoc/projectjava.xml
URL: http://svn.apache.org/viewvc/incubator/tuscany/site/src/site/xdoc/projectjava.xml?rev=409493&r1=409492&r2=409493&view=diff
==============================================================================
--- incubator/tuscany/site/src/site/xdoc/projectjava.xml (original)
+++ incubator/tuscany/site/src/site/xdoc/projectjava.xml Thu May 25 15:36:48 2006
@@ -15,344 +15,329 @@
   limitations under the License.
  -->
  <document url="projectjava">
-	 <properties>
-		<title>Apache Tuscany - Setting up Tuscany Project </title>
-	</properties>
-	<body>
-<section name="Tuscany Java Project">
+         <properties>
+                <title>Apache Tuscany - Setting up Tuscany Java Project </title>
+        </properties>
+        <body>
+<section name="Tuscany JAVA Project">
 <p>
-	<ol>
+        <ol>
 
-		<li><a href="#setup development">Setup development environment and run samples</a></li>
-		<li><a href="#checkout and build tuscany">Checkout and build Tuscany Java project</a></li>
-		<li><a href="#run samples">Run HelloWorld sample</a></li>
-	<li> <script type="text/javascript">linkNewWindow('javadocinfo.html','javadoc');</script></li>
-	<li> <script type="text/javascript">linkNewWindow('codeguidelines.html','Java Coding Guidelines');</script></li>
-	</ol>
+                <li><a href="#System requirements">System requirements</a></li>
+                <li><a href="#checkout and build tuscany">Checkout and build Tuscany Java project</a></li>
+                <li><a href="#run samples">Running  samples</a></li>
+                <li> <script type="text/javascript">linkNewWindow('patches.html','Create and submit a patch');</script></li>
+        <li> <script type="text/javascript">linkNewWindow('javadocinfo.html','javadoc');</script></li>
+        <li> <script type="text/javascript">linkNewWindow('codeguidelines.html','Java Coding Guidelines');</script></li>
+                <li><a href="#using eclipse">Using Eclipse for IDE</a></li>
+                <li><a href="#using idea">Using IDEA style templates</a></li>
+        </ol>
 </p>
 </section>
 
-<a name="setup development"></a>
-<section name="System requirement for development">
-		<p>
-			The first step to creating your java tuscany project is to <b> create 
-				<a href="#create a tuscany directory">a tuscany directory</a>.</b>
-		</p>
-		<p>		
-			Next, please download the following in order to get your machine ready for Java development.
-			Please note that the instructions mentioned in the table below is for windows environment.
-			For Linux, please follow the <script type="text/javascript">linkNewWindow('http://wiki.apache.org/ws/Tuscany/TuscanyJava/GetTuscany/Linux','Linux setup and build instruction');</script>.
-			<br></br>
-		<table style="text-align: left; width: 100%;" border="1"
-				cellpadding="2" cellspacing="2">
-				<tbody>
-					<tr> <!-- heading -->
-						<td><b>Software</b></td>
-						<td><b>Download Link</b></td>
-				<td><b>Download Instructions for windows</b></td>
-					</tr>
-					<tr>
-					<td>JDK 5.0 Update 6</td>
-					<td>
+<a name="System requirements"></a>
+<section name="System requirements">
+                <p>             
+                        Next, please download the following in order to get your machine ready for Java development.
+                        <br></br>
+                <table style="text-align: left; width: 100%;" border="1"
+                                cellpadding="2" cellspacing="2">
+                                <tbody>
+                                        <tr> <!-- heading -->
+                                                <td><b>Software</b></td>
+                                                <td><b>Download Link</b></td>
+                                <td><b>Download Instructions</b></td>
+                                        </tr>
+                                        <tr>
+                                        <td>JDK 5.0 Update 6 or later</td>
+                                        <td>
                                         <script type="text/javascript">linkNewWindow('http://java.sun.com/j2se/1.5.0/download.jsp','jdk 5.0');</script>
-				</td>
-				<td>Steps for Java setup is  <a href="#setup JDK 5.0">here</a>. </td>
-				</tr>
-				<tr> <!--mvn -->
-				        <td> Apache Maven 2.0.4  </td>
-				        <td><script type="text/javascript">linkNewWindow('http://maven.apache.org/download.html','Maven 2.04');</script> </td>
-					<td> 
-						<ul>
-						<li>
-						We are using Maven 2 to build Tuscany, plus a few Ant scripts. Steps for Maven setup is <a href="#setup maven">here</a>.
-						</li>
-						<li>
-						A quick reference on Maven is available <a href="#using maven">here</a>.
-						</li>	
-						</ul>
-					</td>
-				</tr>
-				<tr> <!--ant -->	
-		 	 		<td> Apache Ant 1.6.5  </td>
-			        	<td><script type="text/javascript">linkNewWindow('http://ant.apache.org/bindownload.cgi','Ant');</script> </td>
-					<td> Steps for Ant setup is <a href="#setup ant">here</a>. </td> 
-				</tr>
-				<tr> <!--svn -->
-					<td>Subversion 1.3.0 </td>
-					<td> <script type="text/javascript">linkNewWindow('http://subversion.tigris.org/project_packages.html','Subversion');</script></td>
-					<td> Tuscany source code is stored in a Subversion (SVN) repository, you need Subversion to download it. Steps for svn setup is <a href="#setup subversion">here</a>. 
-					</td>
-				</tr>
-				<tr><!--tomcat --> 
-				<td> Apache Tomcat 5.5.16 </td>
-				<td>
-			<script type="text/javascript">linkNewWindow('http://tomcat.apache.org/','apache tomcat 5.5');</script>
-				</td>
-				<td>
-				This is the Web container that we integrate with, to allow you to use the SCA programming 
-				model in Web applications. 
-				Steps for Tomcat setup is <a href="#setup tomcat">here</a>.
-			       	</td>
-				</tr>
-				</tbody>
-			</table>
-			<br></br>
-			Please <b>verify your setup</b>. Issue the following command to ensure you have a correct setup. 
-			<br></br>
-			<pre>
-	C:\tuscany\setenv.bat
-	java -version
-	mvn --version
-	ant -version
-	svn --version
-			</pre>	
-			<br></br>
-			You are now ready to <a href="#checkout and build tuscany"> check out and build Tuscany source code</a>. 
+                                </td>
+                                <td>Steps for Java setup is  <a href="#setup JDK 5.0">here</a>. </td>
+                                </tr>
+                                <tr> <!--mvn -->
+                                        <td> Apache Maven 2.0.4 or later</td>
+                                        <td><script type="text/javascript">linkNewWindow('http://maven.apache.org/download.html','Maven 2.04');</script> </td>
+                                        <td> 
+                                                <ul>
+                                                <li>
+                                                We are using Maven 2 to build Tuscany, plus a few Ant scripts. Steps for Maven setup is <a href="#setup maven">here</a>.
+                                                </li>
+                                                <li>
+                                                A quick reference on Maven is available <script type="text/javascript">linkNewWindow('mavan.html','here');</script>
+                                                </li>
+                                                </ul>
+                                        </td>
+                                </tr>
+                                <tr> <!--ant -->        
+                                        <td> Apache Ant 1.6.5 or later</td>
+                                        <td><script type="text/javascript">linkNewWindow('http://ant.apache.org/bindownload.cgi','Ant');</script> </td>
+                                        <td> Steps for Ant setup is <a href="#setup ant">here</a>. </td> 
+                                </tr>
+                                <tr> <!--svn -->
+                                        <td>Subversion 1.3.0 or later </td>
+                                        <td> <script type="text/javascript">linkNewWindow('http://subversion.tigris.org/project_packages.html','Subversion');</script></td>
+                                        <td> 
+                                        <ul>
+                                                <li>Tuscany source code is stored in a Subversion (SVN) repository, you need Subversion to download it. Steps for svn setup is <a href="#setup subversion">here</a>. </li>
+                                                <li> A quick reference for subversion commands is <script type="text/javascript">linkNewWindow('quicksubversion.html','here');</script></li>
+                                        </ul>
+                                        </td>
+                                </tr>
+                                <tr><!--tomcat --> 
+                                <td> Apache Tomcat 5.5.16 </td>
+                                <td>
+                        <script type="text/javascript">linkNewWindow('http://tomcat.apache.org/','apache tomcat 5.5');</script>
+                                </td>
+                                <td>
+                                This is the Web container that we integrate with, to allow you to use the SCA programming 
+                                model in Web applications. 
+                                Steps for Tomcat setup is <a href="#setup tomcat">here</a>.
+                                </td>
+                                </tr>
+                                </tbody>
+                        </table>
+                        <br></br>
+                        
 </p>
 </section><!-- system requirement for development -->
 
 
-<a name="create a tuscany directory"></a>
 <section name="Creating a tuscany directory">
-Open a Command Prompt window, then from the command prompt create a tuscany directory as follows: 
-<pre>
-	C:
-	mkdir C:\tuscany
-	cd C:\tuscany
-</pre>
-This is the directory where we're going to download the Tuscany code as well as the tools and packages required to build and run Tuscany. 
+Open a Command Prompt window, then from the command prompt create a directory named "tuscany": 
+This is the directory where we're going to check out the Tuscany code from subversion.
 </section>
-	<a name="setup JDK 5.0"></a>
+<section name="Enviroment scripts">
+<p>There is a windows <a href='setenv.bat'>setenv.bat</a> and a linux  <a href='setenv.sh'>setenv.sh</a> script that you can
+download by right clicking and "selecting save as..."  You can edit these scripts
+ with the below described environment variables to set up your environment any time by running them. On linux you invoke the shell script with
+ <pre>
+ . ./setenv.sh
+ </pre>
+</p>
+</section>
+        <a name="setup JDK 5.0"></a>
 <section name="Downloading and installing the Java JDK 5.0"> 
 <ul>
-	<li>
-	Point your Web browser to   <script type="text/javascript">linkNewWindow('http://java.sun.com/j2se/1.5.0/download.jsp','jdk 5.0');</script>.
-	</li>
-	<li>
-	Select "Download JDK 5.0 Update 6". 
-	</li>
-	<li>
-	Accept the License agreement, then select Windows Online Installation, 
-	Multi-language - jdk-1_5_0_06-windows-i586-p-iftw.exe. </li>
-	<li>
-	Download jdk-1_5_0_06-windows-i586-p-iftw.exe to the C:\tuscany directory. 
-	</li>
-	<li>
-	From the command prompt do the following: 
-	<pre>
-	jdk-1_5_0_06-windows-i586-p-iftw.exe
-	This will run the JDK 5.0 Installation Wizard. Accept the License agreement, 
-	then proceed through the pages of the wizard. Accept all the default options. 
-
-	After a few minutes the installation will complete.
-	Press Finish to close the installation wizard. 
-	</pre> 
-	</li>
-	<li>
-	Create a new .bat file C:\tuscany\setenv.bat and add the following line: 
-	<pre>
-	set JAVA_HOME=C:\Program Files\Java\jdk1.5.0_06
-	</pre>
-	</li>
+        <li>
+        Download and extract the appropriate JDK for your operating system from <script type="text/javascript">linkNewWindow('http://java.sun.com/j2se/1.5.0/download.jsp','http://java.sun.com/j2se/1.5.0/download.jsp');</script>.
+        </li>
+        <li>
+         set the JAVA_HOME environment variable to point to the root directory of where you extracted java download.
+        </li>
+        <li>
+         Add to your PATH environment variable to include the full path to the <b>bin</b> subdirectory of the JDK download package.
+        </li>
 </ul>
 </section>
 
 <a name="setup maven"></a>
-<section name ="Download and Setup Maven">
+<a name="setup maven"></a>
+<section name ="Downloading and installing Apache Maven">
 <ul>
-	<li>
-		Point your Web browser to  <script type="text/javascript">linkNewWindow('http://maven.apache.org/download.html','http://maven.apache.org/download.html');</script>.
-	</li>
-	<li>	
-		Select "Maven 2.0.4 (zip) - maven-2.0.4-bin.zip".
-	</li>
-	<li>
-	Download maven-2.0.4-bin.zip to the C:\tuscany directory. 
-	</li>
-	<li>
-	From the command prompt do the following: 
-	<pre>
-		unzip maven-2.0.4-bin.zip
-	</pre>
-	This will extract Maven 2.0.4 to the C:\tuscany\maven-2.0.4 directory. 
-	</li>
-	<li>
-	Modify C:\tuscany\setenv.bat and add the following line: 
-	<pre>
-		set PATH=%PATH%;C:\tuscany\maven-2.0.4\bin
-	</pre>
-	</li>
+        <li>
+        Download and extract Maven 2.0.4 or later from  <script type="text/javascript">linkNewWindow('http://maven.apache.org/download.html','http://maven.apache.org/download.html');</script>.
+        </li>
+        <li>
+         Add to your PATH environment variable to include the  the full path to the  <b>bin</b> subdirectory of the Maven  download package.
+        </li>
 </ul>
 </section>
 <a name="setup ant"></a>
-<section name ="Download and Setup Ant">
+<section name ="Downloading and installing Apache Ant">
 <ul>
-	<li>
-	Point your Web browser to  <script type="text/javascript">linkNewWindow('http://ant.apache.org/bindownload.cgi','http://ant.apache.org/bindownload.cgi');</script>.
-	</li>
-	<li>	
-	Select ".zip archive: apache-ant-1.6.5-bin.zip". 
-	</li>
-	<li>
-	Download apache-ant-1.6.5-bin.zip to the C:\tuscany directory. 
-	</li>
-	<li>
-	From the command prompt do the following: 
-	</li>
-	<li>
-	unzip <b> apache-ant-1.6.5-bin.zip</b>.
-	This will extract Ant 1.6.5 to the C:\tuscany\apache-ant-1.6.5 directory. 
-	</li>
-	<li>
-	Modify C:\tuscany\setenv.bat and add the following lines: 
-	<pre>
-	set PATH=%PATH%;C:\tuscany\apache-ant-1.6.5\bin
-	</pre>
-	</li>
+        <li>
+        Download and extract Ant 1.6.5  or later from  <script type="text/javascript">linkNewWindow('http://ant.apache.org/bindownload.cgi','http://ant.apache.org/bindownload.cgi');</script>.
+        </li>
+        <li>
+         Add to your PATH environment variable to include the  the full path to the <b>bin</b> subdirectory of the Ant download.
+        </li>
 </ul>
 </section>
 <a name="setup subversion"></a>
-<section name ="Download and Setup Subversion">
+<section name ="Downloading and installing Subversion">
 <ul>
-	<li>
-	Point your Web browser to  <script type="text/javascript">linkNewWindow('http://subversion.tigris.org/project_packages.html','Subversion 1.3.0');</script>.
-	</li>
-	<li>	
-	Pick a Subversion package for your system, for example for a Windows XP pick 
-	http://subversion.tigris.org/files/documents/15/29039/svn-win32-1.3.0.zip.
-	</li>
-	<li>
-	Download svn-win32-1.3.0.zip to the C:\tuscany directory.
-	</li>	
-	<li>
-	From the command prompt do the following: 
-	<pre>
-	unzip svn-win32-1.3.0.zip
-	</pre>
-	This will extract Subversion 1.3.0 to the C:\tuscany\svn-win32-1.3.0 directory. 
-	</li>
-	<li>
-	Modify C:\tuscany\setenv.bat and add the following line: 
-	<pre>
-	set PATH=%PATH%;C:\tuscany\svn-win32-1.3.0\bin
-	</pre>
-	</li>
+        <li>
+        Download and extract Subversion 1.3.1 or later from  <script type="text/javascript">linkNewWindow('http://subversion.tigris.org/project_packages.html','http://subversion.tigris.org/project_packages.html');</script>.
+        </li>
+        <li>
+        Modify your path statement to include  the full path to the subversion <b>bin</b> directory. 
+        </li>
+        <p><i>Note: For linux you may need to install subversion  as root </i></p>
 </ul>
+<p> A quick reference for subversion commands is <script type="text/javascript">linkNewWindow('quicksubversion.html','here');</script></p>
 </section>
 
 <a name="setup tomcat"></a>
 <section name ="Download and Setup Tomcat">
-	<ul>
-	<li>
-	Dowload apache-tomcat-5.5.16.zip to the C:\tuscany directory. you can dowload <script type="text/javascript">linkNewWindow('http://www.ibiblio.org/pub/mirrors/apache/tomcat/tomcat-5/v5.5.16/bin/apache-tomcat-5.5.16.zip','Tomcat Zip');</script> here. 
-	</li>
-	<li>
-	To install Tomcat, from the command prompt do the following: 
-	<code>
-	cd C:\tuscany
-	unzip apache-tomcat-5.5.16.tar.gz
-	</code> 
-        <br></br>
-	This will extract Tomcat to the C:\tuscany\apache-tomcat-5.5.16 directory.
-	</li>	
-
-	<li> 
-	From the command prompt do the following:
-	<br></br>	
-	<code>
-		ant -f java\testing\tomcat\build.xml -Dtuscany.acceptance.tc.dir=C:\tuscany\apache-tomcat-5.5.16 tuscany.tomcat.fixup
-		<br></br>
-This will configure Tomcat to use Tuscany and will install the required JARs under the Tomcat lib directory. 
-	</code>
-	</li>
-	</ul>
+        <ul>
+        <li>
+        Dowload apache-tomcat-5.5.17  <script type="text/javascript">linkNewWindow('http://www.ibiblio.org/pub/mirrors/apache/tomcat/tomcat-5/v5.5.16/bin/apache-tomcat-5.5.16.zip','Tomcat Zip');</script> here. 
+        to the <B>tuscany\java\distribution\tomcat-overlay directory</B>. Do not unpack.
+        </li>
+        </ul>
 </section>
-<a name="using maven"></a>
-<section name="Maven Quick Reference">
-			<p>
-				For some help getting started with Maven, look at:
-                    <script type="text/javascript">linkNewWindow('http://maven.apache.org/guides/getting-started/index.html','http://maven.apache.org/guides/getting-started/index.html');</script> 
-	    </p>
-	     <p>
-		    With Maven, there is no build "script" like the ant build.xml file. Instead you 
-				provide Maven with a description of your project and it uses that information to
-				determine how to achieve your build goal. The description is held in a pom.xml file.
-				There is a pom.xml file at the top level of your project and there are subsidiary
-				pom.xml files for modules within your project which are referenced from the top level
-				pom file. The Maven project has also established a set of best practices for
-				structuring builds and if you follow those you can get away with very little 
-				description; the Tuscany builds are set up that way.
-			</p>
-			<p>
-				The general rule for maven is that each (sub)project produces one build artifact 
-				(typically a jar file). You can see this in the java project directory where
-				there are separate projects for sca, sdo, das (etc) and within these, separate
-				folders and pom files for major components such as container.java.
-			</p>
-			<p>
-				The main Maven 2.x command is "mvn" and the default goal is "install" which will 
-				compile, unit test and package each project. This will typically output a
-				jar file that is installed locally so that other projects can depend on it.
-			</p>
-                        <p>
-                           Once you have the Java project setup up, you can build the project by issuing the following command in the tuscany rootd directory:<br/>
-                           <code>
-                              mvn
-                            </code>
-                            
-			</p>
-		</section>
 
 <a name="checkout and build tuscany"></a>
-<section name ="checkout and build tuscany">
-	<p>
-		<b>Check out Tuscany Java</b>
-	</p>
-        <p>	
-	From the command prompt, do the following: 
-	<br></br>
-	<code>
-	svn co http://svn.apache.org/repos/asf/incubator/tuscany/java
-	</code>
-	<br></br>
-	This should check out all the source code from the Tuscany SVN repository into the C:\tuscany\java directory. 
+<section name ="Checkout and Build Tuscany">
+        <p>
+                <b>Check out Tuscany Java</b>
+        </p>
+        <p>     
+        From the command prompt, in the <B>tuscany</B> directory do the following: 
+        <br></br>
+        <code>
+        svn co http://svn.apache.org/repos/asf/incubator/tuscany/java
+        </code>
+        <br></br>
+        This should check out all the source code from the Tuscany SVN repository into java sub directory. 
 </p>
 <p>
-	When the check out completes, do the following: 
-	<br></br>
-	<code>
-	cd java
-	dir /b
-	</code>
-	<br></br>
-	You should see the content of Java directory. 
 </p>
 <p>
-	<b> Build Tuscany Java </b>
+        <b> Build Tuscany Java </b>
 </p>
 <p>
-	From the command prompt do the following: 
-	<br></br> 
-<code>
-	cd C:\tuscany\java
-	mvn
-</code>
-<br></br>
+        When the check out completes change to the <b>java</b> subdirectory.
+        From the command prompt do the following build tuscany using maven:
+        <pre>
+        mvn 
+        </pre>
 This will build the Tuscany runtime with Maven. Maven will download all the JAR dependencies, build all the Tuscany sub-projects and run the unit tests. 
 </p>
 </section>
 <a name="run samples"></a>
-<section name ="Run Helloworld Sample">
-	<p>
-		<ol>
-			<li value="windows">
-				Information for how to run Helloworld sample in J2SE or Tomcat is <script type="text/javascript">linkNewWindow('http://wiki.apache.org/ws/Tuscany/TuscanyJava/GetTuscany/WinXP','here');</script>.
-			</li>
-			<li value="Linux">
-				Information for how to run hellowrld sample is <script type="text/javascript">linkNewWindow('http://wiki.apache.org/ws/Tuscany/TuscanyJava/GetTuscany/Linux','here');</script>.
-			</li>
-		</ol>
-	</p>
+<section name ="Running The Samples">
+        <p>Run the samples by building the distribution.</p>
+         <ul>
+         <li>
+          Change the directory to the tuscany\java\distribution
+         </li>
+         <li>
+          Issue mvn to build the distribution package.
+         </li>
+         <li>
+          Change the directory tuscany\java\distribution\target\tuscany-dist
+         </li>
+         <li>
+          Follow the directions in GettingStarted.htm
+         </li>
+         </ul>
+           
 </section>
-	</body>
+<a name="using eclipse"></a>
+<section name="Using Eclipse (optional)">
+                        <p>
+                                <span style="font-size: 10pt;">
+                                        Link to Eclipse download :
+                                        <span>
+                                                <a
+                                                        href="http://www.eclipse.org/downloads/index.php">
+                                                        http://www.eclipse.org/downloads/index.php
+                                                </a>
+                                        </span>
+                                </span>
+                        </p>
+                        <p>
+                                Getting Started documentation:
+                                                <a href="http://www.eclipse.org/downloads/index.php">
+                                                        http://www.eclipse.org/downloads/index.php
+                                                </a>
+                        </p>
+                        <p>
+                                To create the eclipse projects to use for SCA development:
+                        </p>
+                        <p>
+                                1) When checking code out from subversion, checkout the
+                                        subversion trunk to a location outside your eclipse
+                                        workspace (it has to be outside because Eclipse will
+                                        not allow you to import projects from a location
+                                        overlapping with your workspace)
+                        </p>
+                        <p style="margin-left: 0.5in; text-indent: -0.25in;"><!--[if !supportLists]-->
+                                2) Go to Import / Existing projects into workspace.
+                                        <span style="" />
+                                        Select either the runtime, spec, tools or samples
+                                        directory.
+                                        <span style="" />
+                                        The wizard proposes the list of Eclipse projects
+                                        under that directory. Importing the projects does
+                                        not copy the files; it just makes the files at that
+                                        location visible under an Eclipse project.
+                        </p>
+                        <p>
+                                3) If you need to use Eclipse to edit files outside of
+                                        these projects (for example the etc directory, or
+                                        the maven files at the root of the trunk), then
+                                        delete the Eclipse projects, with the option to not
+                                        delete the files, and import the whole trunk as a
+                                        project.
+                        </p>
+                </section>
+                <section name="Using Eclipse style templates">
+                 If you are using Eclipse, Tuscany has a preferred Java coding style. Please use the 
+                   <a href='http://svn.apache.org/repos/asf/incubator/tuscany/java/etc/tuscany-eclipse-codestyle.xml'>tuscany-eclipse-codestyle.xml</a> in Eclipse.
+                <br/>Download this file. <i>You may need to right click and save.</i> 
+                Then in Eclipse:<br/>
+                <pre>
+                Window->Preferences-&gt;Java-&gt;Code-Style-&gt;Formatter-&gt;Import...
+                <i>(Specify path and file to the tuscany-eclipse-codestyle.xml just downloaded. </i>
+                </pre>
+                </section>
+                <section name="Using Subclipse (optional)">
+                        <p>
+                                Install the Subversion Eclipse Plugin as described here:
+                                <a href="http://subclipse.tigris.org/">http://subclipse.tigris.org/
+                                </a>
+                        </p>
+                        <ol>
+                                <li>
+                                Open the SVN Repository Exploring perspective
+                                </li>
+                        
+                                <li>
+                                Right click in the SVN Repository view.
+                                
+                                </li>
+                                <li>Select "New" and "Repository Location" 
+                                
+                                </li>
+                                <li>
+                                Url:
+                                        <a href="http://svn.apache.org/repos/asf/incubator/tuscany">
+                                        http://svn.apache.org/repos/asf/incubator/tuscany
+                                </a>
+                                        <p>
+                                                Use URL https://svn.apache.org/repos/asf/incubator/tuscany if you
+                                                have committer rights and need to commit changes back to the repository.
+                                        </p>
+                                </li>
+                                <li>
+                                        Select the "Finish" button and allow Subeclipse time to access the repository and
+                                        display its contents in the SVN Repository explorer.  Once the repository is displayed
+                                        in the explorer, you will see a number of subfolders displayed.  The ones that are
+                                        relevant are "java", "cpp" and "site" - which contain the Tuscany Java runtime, the
+                                        Tuscany C++ runtime and the Tuscany website material respectively.
+                                </li>
+                                <li>
+                                        Select the folder you want to check out as a project - one of java, cpp or site for example
+                                        Right click, select "Checkout" and "Checkout using new project wizard" - select the appropriate
+                                        options for your needs and then click "Finish"
+                                </li>
+                        </ol>
+                        <p>
+                                You can check in changes using the "Commit" item in the team submenu of the Java perspective.
+                        </p>
+                </section>
+<a name="using idea"></a>
+                <section name="Using IDEA style templates">
+                 If you are using IDEA IDE, Tuscany has a preferred Java coding style. Please use the 
+                   <a href='http://svn.apache.org/repos/asf/incubator/tuscany/java/etc/tuscany-idea-codestyle.xml'>tuscany-idea-codestyle.xml</a> in IDEA 
+                <br/>Download this file. <i>You may need to right click and save.</i> 
+                        <pre>
+                        copy tuscany-idea-codestyle.xml to ~/.IntelliJIdea50/config/codestyles
+                        File->Settings, Project Code Styles, Import
+                        </pre>
+                </section>
+        </body>
 </document>

Added: incubator/tuscany/site/src/site/xdoc/quicksubversion.xml
URL: http://svn.apache.org/viewvc/incubator/tuscany/site/src/site/xdoc/quicksubversion.xml?rev=409493&view=auto
==============================================================================
--- incubator/tuscany/site/src/site/xdoc/quicksubversion.xml (added)
+++ incubator/tuscany/site/src/site/xdoc/quicksubversion.xml Thu May 25 15:36:48 2006
@@ -0,0 +1,165 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Copyright (c) 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 url="quick subversion.xml"> <!-- this is useful to both Java and C++ -->
+	<properties>
+		<author email="hmahbod@gmail.com">Haleh Mahbod</author>
+		<title>Apache Tuscany - Quick Reference for Subversion</title>
+	</properties>
+	<body>
+			
+	<a name="using subversion"></a>
+	<section name="Using Subversion (Command Line)">
+	<p>
+		You can download Subversion from 
+                <script type="text/javascript">linkNewWindow('http://subversion.tigris.org/','http://subversion.tigris.org/');</script>.
+	</p>
+	<p>
+		Subversion Reference manual ("the book") is located at 
+                <script type="text/javascript">linkNewWindow('http://svnbook.red-bean.com/','http://svnbook.red-bean.com/');</script>.
+	</p>
+	<p>
+	<span style="font-size: 10pt;">
+		If you use Eclipse as your development environment, there is a plugin available
+		which enables you to use Subversion from within Eclipse (ie it is a Subversion
+		client for Eclipse).  This plugin is called Subclipse and it is located at:
+                <script type="text/javascript">linkNewWindow('http://subclipse.tigris.org/','http://subclipse.tigris.org/');</script>
+		</span>
+		</p>
+		<p style="margin-right: -0.25in;">
+		<span style="font-size: 10pt;">
+		If you use Windows on your systems, there is also a graphical client implemented as an
+			extension to the Windows shell, called TortoiseSVN:
+					<span style="" />
+					http://tortoisesvn.tigris.org/
+				</span>
+			</p>
+			<span style="font-size: 14pt;">
+					Common Commands for Subversion
+			</span>
+			<p>Create a directory called tuscany and check out the project.
+				<p>
+				<b style="">
+					<i style="">To check out the Java project:</i>
+				</b>
+				</p>
+			</p>
+			<pre>
+Committers:                        
+svn co https://svn.apache.org/repos/asf/incubator/tuscany/java
+Non-Commiters:
+svn co http://svn.apache.org/repos/asf/incubator/tuscany/java
+			</pre>
+			<p>
+				<b style="">
+					<i style="">To check out the C++ project:</i>
+				</b>
+			</p>
+			<pre>
+Committers:                        
+svn co https://svn.apache.org/repos/asf/incubator/tuscany/cpp
+Non-Commiters:
+svn co http://svn.apache.org/repos/asf/incubator/tuscany/cpp
+			</pre>
+			<p>
+				If it worked, you will see all the files as they
+				checkout followed by a revision number - this is the
+				version of the tree that you have (useful for comparing notes)
+			</p>
+			<p>
+				<b style="">
+					<i style="">
+						To update your copy with other's people's committed changes:
+					</i>
+				</b>
+			</p>
+			<pre>
+svn update
+			</pre>
+			<p>
+				<b>
+					<i>To manipulate files in various ways:</i>
+				</b>
+			</p>
+			<pre>
+svn add
+
+svn move
+
+svn remove
+
+svn diff
+			</pre>
+			<p>
+				<b>
+					<i>To commit changes go to the root and:</i>
+				</b>
+			</p>
+			<pre>
+svn commit -m"change comment"
+			</pre>
+			<p>
+				This will commit the entire tree and display the new
+				revision number. You can also commit sub-trees and
+				individual files but this is not normal.
+			</p>
+			<p>
+				<b>
+					<i>To undo changes:</i>
+				</b>
+			</p>
+			<pre>svn revert ${file}</pre>
+			<pre>svn revert -R ${directory}
+			</pre>
+			<p>
+				<b>
+					<i>To see what has changed locally:</i>
+				</b>
+			</p>
+			<pre>svn status</pre>
+			<p style="margin-left: 0.5in;">
+				<b>
+					<i>Results:</i>
+				</b>
+			</p>
+			<p>
+				A means a file has been added locally
+			</p>
+			<p>
+				D means a file has been deleted locally
+			</p>
+			<p>
+				M means a file has been modified locally
+			</p>
+			<p>
+				? means a file exists locally that is not being managed
+				by svn.
+				<span style="" />
+				Typically this means you forgot to add it with
+				<span style="font-family: Courier;">svn add</span>
+				.
+			</p>
+			<p style="margin-left: 1in;">
+				! means a file that was being managed by svn no longer
+				exists locally.
+				<span style="" />
+				Typically this means you didn't delete it using svn
+				remove.
+			</p>
+		</section>
+
+	</body>
+</document>



---------------------------------------------------------------------
To unsubscribe, e-mail: tuscany-commits-unsubscribe@ws.apache.org
For additional commands, e-mail: tuscany-commits-help@ws.apache.org