Follow the instructions below to download and build:

1. Get the Source

2. Database Information

3. Dependency on etudes-util

4. Sakai.properties Configurations

5. Build and Deploy Etudes JForum

6. Update Sakai Roles

7. Mask FCK Editor Image Icon

8. Add Jforum Icon to Sakai Left Menu

1. Get the Source

Get the JForum 2.8.1 source and place it at sakai source folder. To get JForum from Sakai Contrib SVN, issue the below SVN commands from your Sakai source folder:

svn co https://source.sakaiproject.org/contrib/etudes/sakai-jforum/tags/2.8.1 etudes-jforum

2. Database Information

Etudes Jforum 2.8.1 works with MySQL 4.1+,  MySQL 5.0+ and Oracle databases.

3. Dependency on etudes-util

Build etudes-util before building Etudes Jforum.

Get etudes-util from https://source.sakaiproject.org/contrib/etudes/etudes-util/tags/1.0.8

Notes:

a) Add etudes-util version to master/pom.xml to "properties" element as below

<!--Etudes-->
<etudes.util.version>1.0.8</etudes.util.version>

b) Add etudes-util dependencies to "dependencies" element under "dependencyManagement" element
 

<!--Etudes-->
<dependency>
<groupId>org.etudes</groupId>
<artifactId>etudes-util-api</artifactId>
<version>${etudes.util.version}</version>
<scope>provided</scope>
</dependency>

<dependency>
<groupId>org.etudes</groupId>
<artifactId>etudes-util-util</artifactId>
<version>${etudes.util.version}</version>
</dependency>

Install etudes-util using : mvn clean install

4. Sakai.properties Configurations

Add the jforum configurations to sakai.properties and customize.

Refer to readme/jforum_config_properties.txt for the properties or the Jforum properties.

5. Build and Deploy Etudes JForum

a. Add Etudes Jforum version to master/pom.xml to "properties" element as below

<!--Etudes-->
<etudes.jforum.version>2.8.1</etudes.jforum.version>

Add etudes-JForum dependency to "dependencies" element under "dependencyManagement" element
<!--Etudes-->
<dependency>
<groupId>org.etudes</groupId>
<artifactId>etudes-jforum-api</artifactId>
<version>${etudes.jforum.version}</version>
<scope>provided</scope>
</dependency>

b. Add lines to the Sakai root pom.xml build profile section that you are using (the default is the "full" profile). These instruct Maven to include the Jforum sources in the build.

<module>etudes-util</module>
<module>jforum</module>

c. Run Maven Commands

The sample maven goals are

mvn clean - remove any prior build

mvn install - compile and package Etudes jforum

mvn sakai:deploy - install the needed files to the local Servlet container

Note : Make sure under tomcat(components, shared/lib, webapps) there are no other versions of jforum files than 2.8.1

6. Update Sakai Roles

Update Sakai Roles (under realms) to include JForum permissions

a. Check appropriate JForum permissions under the roles in !site.template.course.

• Check jforum.manage for teacher, instructor, faculty types of roles (maintain).
• Check jforum.member for student types of custom roles that you have (access).

b. If you have project sites and related roles in !site.template.project), appropriate permissions (jforum.manage or jforum.member) need to be checked as defined above.

7. Mask FCK Editor Image Icon

This is a necessary step for masking the image icon in the toolbar of the

editor (JForum handles embedded images through the 'Attach files' process).

If you omit this step, you will get a toolbar error!!!

Under sakai source/reference/library/src/webapp/editor/FCKeditor/config.js

file, include this statement

FCKConfig.ToolbarSets["JforumDefault"] = [

['Source','-','Preview'],

['Cut','Copy','Paste','PasteText','PasteWord','-','SpellCheck'],

['Undo','Redo','-','Find','Replace','-','SelectAll','RemoveFormat'],

['Bold','Italic','Underline','StrikeThrough','-','Subscript','Superscript'],

['OrderedList','UnorderedList','-','Outdent','Indent'],

['JustifyLeft','JustifyCenter','JustifyRight','JustifyFull'],

['Link','Unlink','Anchor'],

['Smiley'],

['SpecialChar'], ['Style'],

'/',

['FontFormat','FontName','FontSize'],

['TextColor','BGColor'],

['About']

] ;

and compile and deploy sakai again.

NOTE: If you have already deployed sakai and don't want to redeploy then in tomcat/webapps/library/editor/FCKeditor/config.js you can add the above statement.

8. Add Jforum Icon to Sakai Left Menu

If you are using sakai's default cascading style sheet create the icons folder under tomcat/webapps/library/skin/default/

or download it from here.

and copy the image jforum-menu.png from jforum-tool/src/webapp/images/sakai-menu to

tomcat/webapps/library/skin/default/icons.

Add the below line to tomcat/webapps/library/skin/default/portal.css

.icon-sakai-jforum-tool{

background-image: url(icons/jforum-menu.png);

}

Questions?

Contact sakai-dev@collab.sakaiproject.org or dev@etudes.org

Up | Install Guide | Upgrade Guide

Back to top