{ "info": { "author": "Harald Friessnegger", "author_email": "harald (at) webmeisterei dot com", "bugtrack_url": null, "classifiers": [ "Framework :: Plone", "Framework :: Plone :: 4.1", "Framework :: Plone :: 4.2", "Framework :: Plone :: 4.3", "Programming Language :: Python" ], "description": "Introduction\n============\n\nwm.help provides infrastructure to add a help/documentation system to your plonesite\nthat is based on restructured text files.\n\nIt registers a browser page ``plone/@@help`` that lists all packages\nthat provide help/documentation and displays the resturctured text\nrendered as html.\n\n`wm.help` is a great way to provide `up to date` documentation on how to\ncomplete certain tasks (eg manage images of the carousel on the front page)\nto users of the portal.\n\n\nUsage\n=====\n\nIn your package create a directory that contains the documentation.\n\nOne document is the index document that either contains all documentation or links to other documentation files.\n\nSee wm.help.example for documentation on how to write your own help plugin.\n\n\nTODOS\n=====\n\neasier plugin registration\n register resourceDir and docPackage automatically with the plugin\n\n (by providing a zcml directive similar to raptus.article.core.zcml)\n this requires all rst files to reside directly in the package\n the plugin is located in and all images to reside in a folder named img)\n\n\nfix regex for images to handle directives that use options too\n\nsupport for placeholders in links\n (eg. ``{{portal}}``, ``{{index}}``, ``{{plugin}}/my.plugin.name``)\n\nuse a separate permision to access help\n\nChangelog\n=========\n\n\n0.1.1 (2014-09-01)\n------------------\n\n- Import plone.app.portlets to make sure permission `View Dashboard` is\n available.\n\n0.1 (2013-05-08)\n----------------\n\n- Initial release", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/webmeisterei/wm.help", "keywords": "plone collective help documentation docutils rest restructuredtext rst", "license": "GPL", "maintainer": null, "maintainer_email": null, "name": "wm.help", "package_url": "https://pypi.org/project/wm.help/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/wm.help/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/webmeisterei/wm.help" }, "release_url": "https://pypi.org/project/wm.help/0.1.1/", "requires_dist": null, "requires_python": null, "summary": "Infrastructure to add a ReStructuredText based help system to plone sites", "version": "0.1.1" }, "last_serial": 1209328, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "967d9f1987f66bdb3a7b7f7f2921a408", "sha256": "1c28b9c59deb373974442dcbc5281bb2967454e7e2a03713dcbb06453b5ff767" }, "downloads": -1, "filename": "wm.help-0.1.zip", "has_sig": false, "md5_digest": "967d9f1987f66bdb3a7b7f7f2921a408", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 24054, "upload_time": "2013-05-08T13:38:51", "url": "https://files.pythonhosted.org/packages/d0/71/128a774a0cc4f393645effa58caaf50fbdcba6e67363492571a0ca90fcd1/wm.help-0.1.zip" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "355869ff4d7bf3f322ce58ac9c4f25e2", "sha256": "9bd9f38ddb5e977f5eabaf4f9377ee8ea74ba1e3fdda6cb6a3b8123b38a3ae1f" }, "downloads": -1, "filename": "wm.help-0.1.1.zip", "has_sig": false, "md5_digest": "355869ff4d7bf3f322ce58ac9c4f25e2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 24382, "upload_time": "2014-09-01T15:25:15", "url": "https://files.pythonhosted.org/packages/ce/f9/26a421737b3bcedb1200a4d3b614c4f6bc06dbcdfd7a1270dd8a24e2472d/wm.help-0.1.1.zip" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "355869ff4d7bf3f322ce58ac9c4f25e2", "sha256": "9bd9f38ddb5e977f5eabaf4f9377ee8ea74ba1e3fdda6cb6a3b8123b38a3ae1f" }, "downloads": -1, "filename": "wm.help-0.1.1.zip", "has_sig": false, "md5_digest": "355869ff4d7bf3f322ce58ac9c4f25e2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 24382, "upload_time": "2014-09-01T15:25:15", "url": "https://files.pythonhosted.org/packages/ce/f9/26a421737b3bcedb1200a4d3b614c4f6bc06dbcdfd7a1270dd8a24e2472d/wm.help-0.1.1.zip" } ] }