Child pages
  • Help Content
Skip to end of metadata
Go to start of metadata

The Help Tool currently presents the following types of content:

General Help

Topic ID

Topic name

sakai_accessibility

Accessibility

sakai_iframe_myworkspace

My Workspace

sakai_menubar

Menubar

sakai_course_sites

Course/Project Sites

sakai_permissions

Permissions and Roles

These special help topics are registered as part of the help collection by calling helpClasspathRegList.add() from registerStaticContent() in:

help-component/src/java/org/sakaiproject/component/app/help/HelpManagerImpl.java

Tool Help

These tools have help content. Some tool content is currently included in the Help content, and is due to be reorganized into the respective tool project area in svn in line with the Sakai 2.2. svn reorganization.

Tool help content is loaded by the Help Manager at startup for each registered tool by converting the tool registration id into a topic id by replacing "." with "_" (for example, sakai.discussion > sakai_discussion).

Topic ID

Tool

Help source

Location (SVN project)

Notes

sakai_announcements

Announcements

IU KB

announcement

(star)

sakai_assignment

Assignments

IU KB

assignment

(star)

sakai_chat

Chat

IU KB

chat

(star)

sakai_discussion

Discussion

IU KB

discussion

(star)

sakai_dropbox

Dropbox

IU KB

content

(star)

sakai_mailbox

Email Archive

IU KB

mailarchive

(star)

sakai_forums

Forums

IU KB

msgcntr

(star)

sakai_gradebook_tool

Gradebook

IU KB

gradebook

(star)

sakai_mailtool

Mailtool

SVN

mailtool

Maintained by BU

sakai_messages

Messages

IU KB

msgcntr

(star)

sakai_news

News

IU KB

web

(star)

sakai_podcasts

Podcasts

IU KB

podcast

(star)

sakai_poll

Polls

SVN

polls

Maintained by UCT

sakai_postem

Post'Em

IU KB

postem

(star)

sakai_presentation

Presentation

IU KB

presentation

 

sakai_resources

Resources

IU KB

content

(star)

sakai_site_roster

Roster

IU KB

roster

(star)

sakai_schedule

Schedule

IU KB

calendar

(star)

sakai_search

Search

SVN

search

Maintained by CARET

sakai_sections

Section Info

IU KB

sections

(star)

sakai_siteinfo

Site Info

IU KB

site-manage

(star)

sakai_sites

Sites (Admin)

IU KB

site

(star)

sakai_syllabus

Syllabus

IU KB

syllabus

(star)

sakai_samigo

T&Q (Samigo)

IU KB

sam

(star)

sakai_usermembership

User Membership

SVN

usermembership

Maintained by UFP

sakai_iframe

Web Content

IU KB

web

(star)

sakai_rwiki

Wiki

SVN

rwiki

Maintained by CARET

sakai_iframe_site

Worksite Info

IU KB

web

(star)

(star) = Help content for these tools is automatically updated in SVN whenever the KB IU source documents are updated, through a daily synchronization script.

Tools without help content

The following tools do not have Help content as yet:

  • Blogger
  • Forms (metaobj)
  • Link Tool
  • OSP tools

Unregistered content

The following collections are currently in the help project, but not registered at startup (and thus not displayed):

sakai_admin_tool (information about Admin functions)
sakai_webdav (no longer present as of 2.4.0 - included in Resources)

  • No labels