When adding a site using the 'new' button in the worksite setup tool there is the choice of creating a course or a project websites. The following steps describe how to add a site type to your sakai instance.
Edit your sakai.sitesetup.xml
sakai.sitesetup.xml describes the site types that are available in the worksite setup tool.
The location of this file depends on the version of sakai that you are working with.
If you working with the sakai source find the file here:
Sakai 2-2: site-manage/site-manage-tool/tool/src/webapp/tools/sakai.sitesetup.xml
When working with a deployed sakai the files lives here:
Sakai 2-2: webapps/sakai-site-manage-tool/tools/sakai.sitesetup.xml
Follow the instructions in that file to add a site type. After adding a site type you file may look like this:
Sample sakai.sitesetup.xml
Adding tools to your new Site Type
Each tool has an xml file that registers the tool in Sakai. It defines the id, title, description and site types (categories) that the tool belongs to.
This tables shows where to find the registration file for some of the sakai tools:
| Tool | Registry File |
|---|---|
| Announcements | announcement/announcement-tool/tool/src/webapp/tools/sakai.announcements.xml |
| Schedule | calendar/calendar-tool/tool/src/webapp/tools/sakai.schedule.xml |
| Gradebook | gradebook/app/sakai-tool/src/webapp/tools/sakai.gradebook.tool.xml |
| Email Archive | mailarchive/mailarchive-tool/tool/src/webapp/tools/sakai.mailbox.xml |
| Forms | metaobj/metaobj-tool/tool/src/webapp/tools/sakai.metaobj.xml |
| Reports | osp/reports/tool/src/webapp/tools/osp.reports.xml |
| Wizard | osp/wizard/tool/src/webapp/tools/osp.wizard.xml |
| Glossary | osp/glossary/tool/src/webapp/tools/osp.glossary.xml |
| Matrix | osp/matrix/tool/src/webapp/tools/osp.matrix.xml |
| Portfolios | osp/presentation/tool/src/webapp/tools/osp.presentation.xml |
Add a category tag to the registration element to specify you site type.
Making the site title editable
The site is not editable by default. This is to prevent instructors from renaming their course sites to something that students might not recognize, and/or keep course site titles somewhat consistent at an installation.
If you want the site title to be editable for your site type you need to add some "titleEditableSiteType" entries to the sakai.properties file like this:
titleEditableSiteType.count=2
titleEditableSiteType.1=project
titleEditableSiteType.2=portfolio
So for a Sakai installation with three editable site types this would become:
titleEditableSiteType.count=3
titleEditableSiteType.1=project
titleEditableSiteType.2=portfolio
titleEditableSiteType.2=portfolio
Specifying tool order and required tools
If specific tool order for the site type is needed, specify it inside toolOrder.xml file. Look for this file here:
component/component-api/component/src/config/org/sakaiproject/config/toolOrder.xml
or tomcat_home/sakai/toolOrder.xml
The structure toolOrder.xml file is very straightforward. Just ad a category element for your site type and add tool elements to that. By adding required="true" to a tool element the tool is automatically added to the site. By adding selected = "true" a tool is selected by default as a suggestion but may be unselected by the user.