将基于重构文本的帮助系统添加到plone站点的基础结构
wm.help的Python项目详细描述
简介
help提供了一个基础设施,可以将帮助/文档系统添加到您的plonesite中 这是基于重新构造的文本文件。
它注册了一个浏览器页plone/@@help,其中列出了所有包 提供帮助/文档并显示重新采购文本的 呈现为HTML。
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)
- 初始版本