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
Metadata
Release files for wm.help 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| wm.help-0.1.1.zip | 24.4 kB | Without provenance | Details for wm.help-0.1.1.zip |
Release files / wm.help-0.1.1.zip
| Download URL | wm.help-0.1.1.zip |
|---|---|
| Size | 24.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9bd9f38ddb5e977f5eabaf4f9377ee8ea74ba1e3fdda6cb6a3b8123b38a3ae1f
|
|
BLAKE2b-256 checksum How to use checksums |
cef926a421737b3bcedb1200a4d3b614c4f6bc06dbcdfd7a1270dd8a24e2472d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for wm.help 0.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.