Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0
Note
titleSakai Version compatibility

The build instructions for the SCORM Tool differ slightly according to the version of Sakai you are building. The main distinction occurs between versions prior to Sakai Version 2.2 and those afterward. If you already have the SCORM Tool source, check the project.properties file in the root of the tool's source tree for the property 'scorm.runtime.version' ... this version will roughly correspond to the Sakai version that is required.

The last version of the SCORM Tool that works with Sakai v2.1.2 is, understandably, version 2.1.2. Make sure you have this version by checking for a tag '2-1-2_MAINT' here: https://source.sakaiproject.org/contrib/scorm/runtime_tool/tags (if there is no such tag there, then its not there yet...just use trunk...move up one level: https://source.sakaiproject.org/contrib/scorm/runtime_tool/trunk)

Note

All examples are Linux command line examples

Sakai source

  • Check out the Sakai source from the subversion repository. Refer to the documentation for the Sakai release. The lastest Sakai release docs are here http://www.sakaiproject.org/release
    Code Block
    titleSakai subversion checkout
    svn co https://source.sakaiproject.org/svn/tags/sakai_2-1-2_MAINT/
    

SCORM Tool source

  • Check out the SCORM Tool source from the subversion repository.
    Code Block
    titleSCORM TOOL subversion checkout
    svn co https://source.sakaiproject.org/contrib/scorm/runtime_tool/branches/2-1-2_MAINT/ scormrte
    
    Note

    trunk will hold the migration for 2.2. So, if your brave....

    Code Block
    svn co https://source.sakaiproject.org/contrib/scorm/runtime_tool/trunk scormrte

SVN:EXTERNALS property

*Modify the svn:externals property for the Sakai source root to include the SCORM Tool source

Note

You may need to set your SVNEDITOR or EDITOR shell variable to the text editor of your choosing

Code Block
titleedit svn property svn:eternals
setenv EDITOR vi
cd scormte
svn propedit svn:externals .
Note

The dot (".") in the last line must be included

  • Add the following line (subsituting the appropriate svn repository path):
    Code Block
    scormrte     https://source.sakaiproject.org/contrib/scorm/runtime_tool/branches/2-1-2_MAINT
    
  • ... save and quite the editor

[SCORM:Optional] The Eclipse externals file

  • If you are using Eclipse , you may want to add the same line above to the file .externals in the same directory

Update

  • Update the local subversion repository
    Code Block
    titleupdate the local svn repo
    svn update
    
  • ... you should see subversion checking for the scormrte external, then checking out a bunch of files.

Add alternate Maven remote repository

  • Some special dependencies for the SCORM Tool are stored in a Maven 'Remote Repository' at UC Davis. The repository URL below should be included in your build.properties file. There is a sample copy of a build.properties file inlcuded in root directory of the SCORM Tool source called 'build.properties.sample'
    Code Block
    titleAdditional Maven '*remote repository*'
    http://svn.ucdavis.edu/maven/
    
    Note

    The trailing slash ('/') is critical. This is true in all cases with Maven: not just the SCORM Tool

Maven Build

  • You can run the standard Sakai plugin goals in the SCORM Tool source root, but you should have built Sakai froom source at least once. Otherwise, the tool's build will fail note finding any depenencies in your local Maven repository.
    Code Block
    titlebuild
    maven sakai
    
    Note

    First builds of Sakai go much smoother with the bld and dpl goals instead of the sakai goal

    Code Block
    maven bld dpl
    

    .... That is because sakai = cln + bld + dpl and the cln part tries to look for dependencies that are only available in the maven repo (local) after the dpl part