为plone网站添加基于ReStructuredText的帮助系统的基础设施
项目描述
介绍
wm.help提供将帮助/文档系统添加到您的plone网站的基础设施,该系统基于restructured text文件。
它注册了一个浏览器页面plone/@@help,列出所有提供帮助/文档的软件包,并显示作为HTML渲染的reStructuredText。
wm.help是向门户用户提供关于如何完成特定任务(例如管理主页上的轮播图片)的最新文档的好方法。
使用方法
在您的软件包中创建一个包含文档的目录。
其中一个文档是索引文档,它包含所有文档或链接到其他文档文件。
请参阅wm.help.example以了解如何编写您自己的帮助插件的文档。
待办事项
- 更简单的插件注册
自动将resourceDir和docPackage与插件注册
(通过提供一个类似于raptus.article.core.zcml的zcml指令)这要求所有rst文件直接位于插件所在的包中,所有图像位于名为img的文件夹中)
修复图像的正则表达式以处理使用选项的指令
- 支持链接中的占位符
(例如:{{portal}},{{index}},{{plugin}}/my.plugin.name)
使用单独的权限访问帮助
变更日志
0.1.1 (2014-09-01)
导入plone.app.portlets以确保权限“查看仪表板”可用。
0.1 (2013-05-08)
初始发布
项目详情
关闭
wm.help-0.1.1.zip的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 9bd9f38ddb5e977f5eabaf4f9377ee8ea74ba1e3fdda6cb6a3b8123b38a3ae1f |
|
MD5 | 355869ff4d7bf3f322ce58ac9c4f25e2 |
|
BLAKE2b-256 | cef926a421737b3bcedb1200a4d3b614c4f6bc06dbcdfd7a1270dd8a24e2472d |