Building Pas Suite

Set up Eclipse Environment

1. Install the latest version of Eclipse. Must be Eclipse version 3.3 or newer. Get the "IDE for Java developers"
2. Install an SVN client. We recommend Subversive (update site). Another option is Subclipse (update site).
3. Install Maven 2.x Plug-in for Eclipse using update site. Get the latest stable version.
   • Create a .m2 folder in your user home directory, if you don't have one. On windows this would be

     C:/Documents and Settings/[user name]/.m2
     

   • Windows Explorer may not allow you to create a folder named .m2. If this happens, open the Command Prompt, change to the desired directory, and type "mkdir .m2".
4. Install command line version of Maven
   1. Download Maven 2 from http://maven.apache.org/download.html.
   2. Unpack the downloaded distribution to a directory of your choosing (this is your Maven Home directory).  Do NOT unpack it to the .m2 folder created earlier.
   3. Define a M2_HOME system variable.
   4. Add M2_HOME/bin to the system path.
   5. Make sure that the JAVA_HOME variable is already defined and that it is set to a JDK (and not a JRE).
   6. Here is a more detailed guide to installation from the Maven 2 website: http://maven.apache.org/download.html#Installation.

Checking out the Pas Suite and dependencies

1. Open the SVN Repository Explorer perspective within Eclipse.
2. Add a subversion repository: https://tels.svn.sourceforge.net/svnroot/tels
3. Check out the Pas Learner Runtime project under trunk/Pas Suite (right-click "Pas Learner Runtime" and click "Checkout"). Before checking out the next project. Have get it to build completely.
4. Check out the pas-author-runtime project under trunk/Pas Suite (right-click "pas-author-runtime" and click "Checkout"). Before checking out the next project. Have get it to build completely.
5. Check out the pas-otrunk project under trunk/Pas Suite (right-click "pas-otrunk" and click "Checkout"). Before checking out the next project. Have get it to build completely.
6. Check out the pas-common-apps project under trunk/Pas Suite (right-click "pas-common-apps" and click "Checkout"). Before checking out the next project. Have get it to build completely.
7. Check out the pas-browsing-mozswing project under trunk/Pas Suite (right-click "pas-browsing-mozswing" and click "Checkout"). Before checking out the next project. Have get it to build completely.
8. Check out the sail-otrunk project under trunk.
9. Add a subversion repository: https://sail.svn.sourceforge.net/svnroot/sail
10. Check out the sail-data-emf project under trunk (right-click "sail-data-emf" and click "Checkout")
11. Import the OTrunk Project Set (make sure you have the Subclipse (update site) plugin for Eclipse)
    1. Download the Project Set file OTrunkProjectSet.psf and save it anywhere, such as your desktop
    2. Open Eclipse
    3. Navigate to File>Import... and the Import window will pop up
    4. Expand Team and click on "Team Project Set" and click Next
    5. The next screen will allow you to choose the path where the Project Set file is located, Browse for the file and click Finish
    6. The projects in the Project Set will now be retrieved from the repository, this may take a while

This will create the necessary projects in your eclipse workspace.

Make sure all the projects build and do not have any errors. If you encounter errors, trying cleaning the project. If there are still problems, close the project. Then, from the command line, enter the directory of the project with errors and run mvn install. Reopen the project and there should no longer be any errors. This is a common way of fixing mysterious build errors. It is also recommended that, even if no errors are encountered, that this be done occasionally.

It may also be the case that the maven tree of dependencies needs to be refreshed. If errors persist after cleaning and building at the command line, select the project and right click "properties." Go to the Java build path. Remove the Maven dependencies from the Libraries tab and then re-add them. If there is anything under the Projects tab in the Java build path, remove it. Then repeat the general clean, close, and rebuild procedure in the previous paragraph.  

FAQ for Eclipse Setup

• What is an "update site", and what do I do with it?
  An update site is a way to install new features into eclipse. The following page has a flash video that demonstrates how to use an update site URL. This particular video is for an older version of ht Maven 2 plugin, but the basic procedure is the same for all update sites:
  http://m2eclipse.codehaus.org/Installing_Maven_2.0_plugin_for_Eclipse.html
  The "update site" URL should be entered in the dialog box titled "New Update Site". This dialog apears when the "New Remote Site..." button is clicked.
  The name of the update site can be anything you want.

Running the Authoring Tool

1. In Eclipse, open Debug dialog
2. choose Authoring Tool Launcher note Otrunk
3. Click 'Debug' to start the authoring tool

Extra Stuff

You may also want to build the SAIL Framework

If you want to build SAIL Web Services you'll need and a developer account to access the TELS internal repository, svn+ssh://tels-develop.soe.berkeley.edu/var/local/svnroot. Check out SailUtils as an Eclipse project.