|
What's in this Release?
The Milestone 1 release represents a first step on the way to a full realization of the Sakai 3 vision. The focus for this release is on some of the initial UX work, including the re-thinking of core pages (e.g., My Workspace, site Home page), inter-user communication and social networking, page authoring and organization, and the distinction between and meaning of tools, sites, groups, and users in Sakai 3. The functionality inside existing tools in this milestone release is mostly still at the level of Sakai 2.6.
My Dashboard
|
My Dashboard represents a re-conceptualization of the MyWorkspace page. It focuses on aggregating and navigating relevant content across your sites and groups, and communication with your fellow collaborators. Many of these capabilities are presented via widgets (e.g., Sites, My Profile, My Connections, Poll Tracker), or via ever-present links in page footers (e.g., My People, My Inbox, Online Connections). Widgets can be added to your My Dashboard (or other appropriate pages) via the "Add Widgets" button, and removed by clicking on the close "X" in the widget's top-right corner. They can be easily reorganized on the screen via drag-and-drop, and you can also select a general layout for widgets on the dashboard via the Edit Layout button. The configuration of each widget is controlled by its "Settings" button near its top-right corner. There are a variety of example widgets included in this release: Personal Tools, Sites, My Profile, Google Docs, Hello World, My Connections, and Poll Tracker. |
Social Networking (Profiles and Connections)
|
The concept of social networking is explored in this release though the notions of "Profiles" and "Connections". Much like Friends in Facebook, Connections are other Sakai users with whom you've mutually agreed to communicate and share your Profile information. Your Profile information is displayed in the "My Profile" widget on your My Dashboard. You can directly edit it from there – and example of in-line editing – or from the "My Profile" link in the footer of every page. The "My Connections" widget on your My Dashboard presents a synoptic view of your Connections' profiles, including their online status (see also "Online Connections" in the page footer). You can get a more complete view of your Connections' profiles from the "My People" link in the footer of every page, which takes you to the "People" widget. From there you can browse your entire list of connections, search the community of users and send requests to people for permission to connect, or respond to connection requests from others. |
Messaging (Instant Messaging and Internal Email)
|
Universal access to instant messaging and email-like messaging between fellow collaborators is being explored in Sakai 3. In this release the footer of each page has a "My Inbox" link that takes you to an internal messaging system. From there you can send and receive messages to and from your Sakai "connections". For instance, if someone requests that you become a "connection", then you would find a message containing the request (and a link to accept) in your Inbox. When you have new, unread messages, the number of messages is presented in parentheses next to the "My Inbox" text in the footer. You can also instant message with your connections via the "Online connections" link in the footer of each page. It provides both a count of how many of your connections are currently on-line (the number in parentheses next to the text), and a pop-up list of their names. You can initiate an instant messaging conversation with any connection simply by clicking on their name. When you send your message, they will see your name appear in their page's footer, next to their "Online Connections" link, and they can click on your name to pop-up a window with your conversation. |
Page Authoring
|
The ability to author pages using a rich-text editor, and to be able to embed content from or links to other Sakai capabilities in such pages is one of the key capabilities being explored for Sakai 3. For example, embedding the contents of a file you've uploaded (i.e, a picture or graph) in the middle of the text you're composing, a forum thread at the bottom or on the side of a page of discussion materials, a set of self-study questions and the end of a reading, a Poll in the middle of your lecture materials, etc. In this milestone release the options for what can be embedded in a page are limited: YouTube Video, Tangler Forum, Single File Reference (i.e., Resources), Comments, Poll, Navigation, and Form. More options will follow in future releases. Navigation between authored pages has not yet been addressed, so this release includes only very rudimentary page navigation functionality. This will be improved upon in future designs and releases. Basically you have the ability to designate an authored page as a "Top page", which means it will be listed in the page menu on the right-hand side of a site's pages. Otherwise, it is presumed that the page is only reachable by clicking on a link in another page that leads to it; the authoring environment includes an "Insert Sakai Link" capability that lets you easily browse a site's set of pages and embed a link to one. |
General Notes
- This milestone release still uses Kernel 1 as its basis, so it still exhibits the same performance characteristics and limitations that are familiar in Sakai 2. Over the coming weeks the Sakai 3 code base will shift to using Kernel 2, which will help realize many of the features and capabilities envisioned for Sakai 3, such as social networking, everything is content, relaxing of site/tool/group boundaries, etc.
- Accessibility is a key goal of the UX work in Sakai 3. Note that the reorganization of widgets on the Dashboard can be done via the keyboard, and the WYSIWYG editor (TinyMCE) used for page authoring is more accessible then previous options in Sakai. There are also efforts to make Sakai pages more screen-reader friendly in general.
Getting Started
The instructions below will guide you through obtaining the code, building and deploying it, configuring it, and getting up and running with it. If you have problems getting Sakai 3 up and running, please search the sakai-dev email archive for suggestions; if you can't find what you need there, then post your question on the sakai-dev email list ([joining the list]).
Get the Code (OBSOLETE)
In order to run the milestone release the following prerequisites are required: Java JRE 5.0 (i.e., Java 1.5), Subversion 1.4+, Maven 2.0.6+ and Tomcat 5.5.26+. You will also need to use MySQL or Oracle as your database; this release is not fully compatible with the default HSQL in-memory database.
If you are unfamiliar with setting up a local environment congenial for working with Sakai see
Development Environment Setup Walkthrough
Once you have installed and configured Java, Subversion, Maven and Tomcat, download the source code artifact:
Mac/Linux
sakai-src-3.0.0-milestone01.tgz md5
Windows
sakai-src-3.0.0-milestone01.zip md5
Or you can check out the sakai-3.0.0-milestone01 tag:
svn co https://source.sakaiproject.org/svn/sakai/tags/sakai-3.0.0-milestone01/ sakai-src
Javadocs and Taglibdoc
You can also view and/or download the 3.0.0-milestone01 Javadocs and Taglibdocs.
Taglibdocs (download zip)
Build and Deploy
Install the Sakai artifacts in your local Maven (.m2) repository. Install the master project first (e.g., sakai-src/master) before installing the rest of Sakai. Note that -Dmaven.tomcat.home is specified as /opt/tomcat. Adjust the path accordingly so that Maven can find your Tomcat home folder ($CATALINA_HOME).
cd sakai-src/master mvn clean install cd .. mvn clean install -Dmaven.test.skip=true -Dmaven.tomcat.home=/opt/tomcat sakai:deploy
Add the UX Portal and Widget webapps
Two UX webapps need to be added to Tomcat's $CATALINA_HOME/webapps folder. You can either download the attached *.zip and explode it in /webapps or check out the experimental UX portal and widget modules from our SVN repository. The uxportal project must be named "dev" and uxwidgets must be named "devwidgets."
sakai-3.0.0-milestone01-ux-webapps.zip md5
or
cd $CATALINA_HOME/webapps svn co https://source.sakaiproject.org/svn/ux/branches/sakai-3.0.0-milestone01/uxportal/src/main/webapp dev svn co https://source.sakaiproject.org/svn/ux/branches/sakai-3.0.0-milestone01/uxwidgets/src/main/webapp devwidgets
Enable JCR and Search and set logged out URL in sakai.properties
Sakai uses a standard key=value properties file for basic configuration settings. For the 3.0.0-milestone01 release you must enable both the JCR and Search modules as well as set the logged out URL to /dev by adding the following setting to your sakai.properties file.
jcr.experimental=true search.enable=true loggedOutUrl=/dev
If you are unfamiliar with sakai.properties a sample file configured for MySQL is attached. (Note this release will not work with the default HSQL database, you need to use MySQL or Oracle.) Name your database "sakai", add the correct database username and password and locate the file in $CATALINA_HOME/sakai and Sakai will read the property settings on start up. See the /config project for other sakai.properties examples.
JVM settings
Sakai running in Tomcat requires more heap space than is provided by a minimally configured JVM. We recommend that you include in $CATALINA_HOME/bin a SETENV file to provide Sakai with a bit more breathing space. Make sure that you have added $CATALINA_HOME/bin to PATH and then create the SETENV file with the following recommended settings:
Mac/Linux: Create a file called setenv.sh with the following:
export JAVA_OPTS="-server -XX:+UseParallelGC -Xmx768m -XX:MaxPermSize=160m -Djava.awt.headless=true"
Windows: Create a file called setenv.bat with the following:
set JAVA_OPTS=-server -XX:+UseParallelGC -Xmx768m -XX:MaxPermSize=160m -Djava.awt.headless=true
Start Tomcat
Start Tomcat and navigate to the UX portal http://localhost:8080/dev.
*nix: $CATALINA_HOME/bin/startup.sh Win: $CATALINA_HOME/bin/startup.bat
Login as the administrator (user: admin, password: admin) and you will be directed to the dashboard page.

Reporting Issues
If you have problems getting Sakai 3 up and running, please search the sakai-dev email archive for suggestions; if you can't find what you need there, then post your question on the sakai-dev email list (Join email lists).
If you find any bugs with the new UX and social networking capabilities of Sakai 3, then please report them in Sakai's Jira. (Note that the Affects Version for this release is 3.0.0-miletone01.) If you experience difficulty with the existing Sakai 2.x tools in this release, that is beyond the scope of this demo, and we ask that you only report such issues if you can also reproduce them in a Sakai 2.x instance (and then you should report them as affecting that version.)
Suggestions for adding or enhancing functionality are also welcome via Jira Feature Requests. Please keep in mind, however, that this release represents the early stages of a significant work-in-progress, so your comments may not receive an immediate response.
Documentation
Anthony Whyte has written an article examining the new emphasis on RESTful interfaces and client-side JavaScript consumers that mark Sakai 3. See A. Whyte, "RESTful Sakai: Entities, SData and Widgets."