为何使用 XHTML?
帮助系统允许使用特殊标记来对 XHTML 标记添加注释,以便进行过滤、包括内容以及指定扩展锚点,从而生成动态帮助内容。在使用 HTML 时,这些功能不可用。
如何添加 XHTML
尽管 XHTML 帮助文档的添加方式与 HTML 非常相似,但还是有几项重要的差别,而这些差别是支持动态内容和搜索功能所必需的。这些必需的修改列示如下:
您必须将 XHTML 搜索参与者与文档插件绑定。
Eclipse 帮助实现使用 Lucene 来对其文档建立索引,以提高搜索速度。为了能够对文档建立索引,Lucene 必须能够读取格式。Eclipse 已提供了用于对 XHTML 文档建立索引的搜索参与者,因此您只需告知帮助系统将该参与者用于文档。请将以下扩展添加到插件清单中:
<extension point="org.eclipse.help.base.luceneSearchParticipants"> <binding participantId="org.eclipse.help.base.xhtml"/> </extension>
如果正在使用动态内容,则必须将 XHTML 动态内容生成者与文档插件绑定。
如果要使用 XML 注释来生成动态内容,则需要指示帮助系统处理文档。这是通过将 XHTML 动态内容生成者与插件绑定来实现的。
<extension point="org.eclipse.help.contentProducer"> <binding producerId="org.eclipse.help.dynamic"/> </extension>
如果您希望在 XHTML 中使用 include,则 path
属性的格式及其说明如下所示:
<plugin_id>/<path_to_xhtml_file>/<filename_xhtml>/<element_id>
其中,各个字段的含义是:
org.eclipse.help
)/my_folder/my_sub_folder/
)my_file.xhtml
)id
属性设置的(例如,my.element.id
)
例如,如果要包括插件 my.product.plugin
的文件 /copyrights/copyright.xhtml
中标识为 my_copyright
的段落(<p>
元素),请指定以下内容:
my.product.plugin/copyrights/copyright.xhtml/my_copyright