Metadata-Version: 1.1
Name: wm.help
Version: 0.1
Summary: Infrastructure to add a ReStructuredText based help system to plone sites
Home-page: https://github.com/webmeisterei/wm.help
Author: Harald Friessnegger
Author-email: harald (at) webmeisterei dot com
License: GPL
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 (2013-05-08)
        ================
        
        - Initial release
        
Keywords: plone collective help documentation docutils rest restructuredtext rst
Platform: UNKNOWN
Classifier: Framework :: Plone
Classifier: Programming Language :: Python
Classifier: Framework :: Plone
Classifier: Framework :: Plone :: 4.1
Classifier: Framework :: Plone :: 4.2
