添加 XHTML 帮助文档

为何使用 XHTML?

帮助系统允许使用特殊标记来对 XHTML 标记添加注释,以便进行过滤包括内容以及指定扩展锚点,从而生成动态帮助内容。在使用 HTML 时,这些功能不可用。

如何添加 XHTML

尽管 XHTML 帮助文档的添加方式与 HTML 非常相似,但还是有几项重要的差别,而这些差别是支持动态内容和搜索功能所必需的。这些必需的修改列示如下:

XHTML include 格式

如果您希望在 XHTML 中使用 include,则 path 属性的格式及其说明如下所示:

   <plugin_id>/<path_to_xhtml_file>/<filename_xhtml>/<element_id>

其中,各个字段的含义是:

例如,如果要包括插件 my.product.plugin 的文件 /copyrights/copyright.xhtml 中标识为 my_copyright 的段落(<p> 元素),请指定以下内容:

   my.product.plugin/copyrights/copyright.xhtml/my_copyright