entidi / silverstripe-gtkdoc
此包已被放弃,不再维护。没有建议的替代包。
在 SilverStripe 页面树下导入 gtk-doc 手册
1.1.0
2014-02-22 23:22 UTC
Requires
- silverstripe/framework: ~3.0
Suggests
- entidi/silverstrap: A SilverStripe theme that supports arbitrary nested menu levels
- entidi/silverstripe-autotoc: A module that automatically generates the table of contents of every page
README
silverstripe-gtkdoc 模块实现了一种新的页面类型(Gtkdoc),允许将 SilverStripe 基站点的参考手册导入页面树。gtk-doc 页面是一个典型的页面,可以包含任意文本:参考手册将以(虚拟)页面的形式显示在下面。
所需的唯一参数是要导入的 gtk-doc 参考手册的绝对路径的 .devhelp2
文件。必须在 CMS 的内容选项卡中指定。该模块期望所有 html 文件都在同一路径下,就像干净利落的 gtk-doc 安装通常所做的那样。
HTML 代码直接从文件系统获取。gtk-doc 文件通常位于 /usr/share/gtk-doc/html/
(在 GNU/Linux 平台上典型)或 /usr/local/share/gtk-doc/html/
(在基于 BSD 的系统上)。这些文件在每次特定请求时都会被检查,并在需要时更新。更新的 HTML 代码被缓存在数据库中的 GtkdocSection
表中。
为了获得更好的结果,建议使用支持任意嵌套级别的菜单的主题,例如 silverstrap 或 silverstripe-treeish。