构建帮助插件

在此示例中,假定文档作者已经以 HTML 文件的形式为您提供了原始文档。这些文件的粒度和结构完全取决于文档小组。一旦交付了文档,设置插件和主题就可以单独完成。

开始我们假定已经在下列树中提供了文档。

doc/
    concepts/
        concept1.html
        concept1_1.html
        concept1_2.html
    tasks/
        task1.html
        task2.html
        task3_1.html
        task3_2.html
    ref/
        ref1.html
        ref2.html

我们将假定插件名是 com.example.helpexample

第一步就是在平台 plugins 目录下创建插件目录 com.example.helpexample。应当将上面所显示的 doc\ 子树复制到该目录中。

文档插件与代码插件一样都需要清单。下列标记定义了文档插件。

<?xml version="1.0" ?>
<plugin name="Online Help Sample"
    id="com.example.helpexample"
    version="1.0"

    provider-name="MyExample" />