This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Infrastructure to add a ReStructuredText based help system to plone sites

Project Description

Introduction

wm.help 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.

wm.help 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.

Usage

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 wm.help.example for documentation on how to write your own help plugin.

TODOS

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}}/my.plugin.name)

use a separate permision to access help

Changelog

0.1.1 (2014-09-01)

  • Import plone.app.portlets to make sure permission View Dashboard is available.

0.1 (2013-05-08)

  • Initial release
Release History

Release History

This version
History Node

0.1.1

History Node

0.1

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
wm.help-0.1.1.zip (24.4 kB) Copy SHA256 Checksum SHA256 Source Sep 1, 2014

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting