Skip to main content

Infrastructure to add a ReStructuredText based help system to plone sites

Project description

Introduction provides infrastructure to add a help/documentation system to your plonesite that is based on restructured text files.

It registers a browser page plone/@@help that lists all packages that provide help/documentation and displays the resturctured text rendered as html. is a great way to provide up to date documentation on how to complete certain tasks (eg manage images of the carousel on the front page) to users of the portal.


In your package create a directory that contains the documentation.

One document is the index document that either contains all documentation or links to other documentation files.

See for documentation on how to write your own help plugin.


easier plugin registration

register resourceDir and docPackage automatically with the plugin

(by providing a zcml directive similar to raptus.article.core.zcml) this requires all rst files to reside directly in the package the plugin is located in and all images to reside in a folder named img)

fix regex for images to handle directives that use options too

support for placeholders in links

(eg. {{portal}}, {{index}}, {{plugin}}/

use a separate permision to access help


0.1.1 (2014-09-01)

  • Import to make sure permission View Dashboard is available.

0.1 (2013-05-08)

  • Initial release

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution (24.4 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page