Sakai Help Project
This is the home page for the Sakai Help Project. (For general information on Sakai, try Documentation.)
The Help Project seeks to:
- Evolve the online Help tool
- Ensure that Help content in Sakai releases is useful, accurate and up to date
- Ensure that information about how to configure and use the Help tool is accurate and up to date
A number of Sakai production deployments have diverged from using OOTB Help in various ways - either switching it off, or modifying the supplied help. A goal of the Help project is to minimise the work which Sakai adopters need to do to present appropriate help to local users, by increasing the flexibility of the Help tool and content format.
Joining the Help Project
To join the Help Project, add your details and interests to Help Project Participants.
The Help Project is co-ordinated by Stephen Marquard from the University of Cape Town.
Project Status and Roadmap
See Help Project Roadmap. Please feel free to (a) add additional Requirements, Feature Requests or Bug Reports in JIRA, and (b) update pages in this Confluence space with additional information or ideas.
Information about the Help Tool
- Help in Sakai 2.0 and 2.1
- Help Content
- Help Configuration Examples
- Help settings in tool registration files
- Help settings in the Charon Portal
The Help Project depends on:
- The Sakai Portal (to invoke the Help tool as appropriate)
- All tool projects, as providers of Help content
- I18n and L10n DG and contributors, as translators of Help content (see I18N Confluence Space)
Current Help Issues lists details of open Requirements, Feature Requests and Bugs in the JIRA issue tracking system.