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 |  |
| sakai_assignment | Assignments | IU KB | assignment | |
| sakai_chat | Chat | IU KB | chat | |
| sakai_discussion | Discussion | IU KB | discussion | |
| sakai_dropbox | Dropbox | IU KB | content | |
| sakai_mailbox | Email Archive | IU KB | mailarchive | |
| sakai_forums | Forums | IU KB | msgcntr | |
| sakai_gradebook_tool | Gradebook | IU KB | gradebook | |
| sakai_mailtool | Mailtool | SVN | mailtool | Maintained by BU |
| sakai_messages | Messages | IU KB | msgcntr | |
| sakai_news | News | IU KB | web | |
| sakai_podcasts | Podcasts | IU KB | podcast | |
| sakai_poll | Polls | SVN | polls | Maintained by UCT |
| sakai_postem | Post'Em | IU KB | postem | |
| sakai_presentation | Presentation | IU KB | presentation | |
| sakai_resources | Resources | IU KB | content | |
| sakai_site_roster | Roster | IU KB | roster | |
| sakai_schedule | Schedule | IU KB | calendar | |
| sakai_search | Search | SVN | search | Maintained by CARET |
| sakai_sections | Section Info | IU KB | sections | |
| sakai_siteinfo | Site Info | IU KB | site-manage | |
| sakai_sites | Sites (Admin) | IU KB | site | |
| sakai_syllabus | Syllabus | IU KB | syllabus | |
| sakai_samigo | T&Q (Samigo) | IU KB | sam | |
| sakai_usermembership | User Membership | SVN | usermembership | Maintained by UFP |
| sakai_iframe | Web Content | IU KB | web | |
| sakai_rwiki | Wiki | SVN | rwiki | Maintained by CARET |
| sakai_iframe_site | Worksite Info | IU KB | web | |
= 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)