Menu Content/Inhalt
Instructions - Installing TransformAble in Sakai

Building TransformAble and Installing in Sakai

These instructions outline the process of downloading, building and installing TransformAble for Sakai.


These instructions assume that you have a working version of Sakai set up, along with a suitable development environment. The PreferAble tool can be used in the mercury portal however you will require the new Velocity portal to see the styling effects of TransformAble. To use the PreferAble tool inside the portal, you will require the worksite setup tool.

It is important to note that the TransfromAble code does not work with some of the earlier versions of Sakai.  It works with the 2.4 QA branch of Sakai, as well as the trunk version.

If you have not already done so, you will have to update your file and set the source version to 1.5:

maven.compile.source = 1.5 = 1.5

1. Obtain TransformAble for Sakai

The source code for TransformAble is part of contrib, and can be downloaded from:
The TransformAble source code should be checked out to a directory named "transformable" as if it were a sub-project of Sakai. For example, "access" and "alias" are Sakai projects.  "transformable" should be located in your local file system as a sibling of "access":
      + access/
      + alias/
      + ...
      + transformable/
      + ...

The svn checkout command to place "transformable" in the correct location is as follows.  This assumes the current working directory is your "sakai" development folder:

svn co transformable

2. Add the TransformAble Maven repository to your

The TransformAble code that is in the Sakai SVN repository contains the source code for integrating TransformAble into Sakai. The core TransformAble components are available in JAR files from our public Maven repository. Please add our public Maven repository to your


3. Shutdown Sakai

If you are running Sakai please shut it down.

4. Build TransformAble

If you use Maven 1

Build and install TransformAble:

change directory to transformable and run maven sakai

If you use Maven 2

Build and install TransformAble:

change directory to transformable and run:
mvn -Dmaven.test.skip=true -Dmaven.tomcat.home=$CATALINA_HOME clean install sakai:deploy

Note that you can build all of Sakai and include TransformAble as part of the build by issuing either maven command from the root "sakai" folder if you checked out the TransformAble code as outlined above.

5. Enable PreferAble and StyleAble


PreferAble is currently "stealthed" in the Sakai distribution. To unstealth all stealthed tools, set the following property in

  This e-mail address is being protected from spambots. You need JavaScript enabled to view it


To enable StyleAble in the portal, set the following property in


To enable PreferAble's "Content Navigation" pane, and StyleAble's on-the-fly generation of a table of contents and list of links, set the following in


6. Restart Sakai


PreferAble and StyleAble should now be installed into your Sakai.

Last Updated on Friday, 13 April 2007 14:58