PloneContextHelp

Allows product authors and administators to provide in-portal help pages. A portlet shows the user pages relevant to the current context through an efficient search based on criteria set by the help page creator.

Project Description

A tool and framework for managing context-linked and browsable help pages.

The tool contains bundles of help pages (typicall one bundle per product which provides help), organised in folders. A help page contains a set of criteria to determine where it is matched, in addition to the help text. Links to matched help pages will be presented to users as appropriate.

Help pages are portal content, indexed in a special catalog found in the portal_contexthelp tool. As such, they can be managed TTW in Plone. However, you are recommended to use the management API in interfaces/IContextHelpManager.py to add, remove, find and modify pages in code, as this is cleaner and better encapsulates the help page management functionality.

Requirements and installation

• Requires Archetypes 1.3 and Plone 2.x
• Requires AddRemoveWidget from the archetypes svn repository on svn.plone.org
• Requires PloneContextActions from collective svn (does not need to be installed in Plone, but must be present in the Products directory)

Install using the QuickInstaller in the usual way.

Developer documentation

Please see interfaces/IContextHelp.py, interfaces/IContextHelpTool.py and interfaces/IContextHelpManager.py for the most important elemenets of the API.

Current Release

No stable release available yet.