完成插件清单

此示例是从创建我们的插件和文档文件开始的。下一步创建目录文件来描述内容的组织。剩下的一项工作是将所有内容集中到一起形成主目录,并更新 plugin.xml 以实际添加主目录。 

首先,我们创建 toc.xml 以添加起初创建的三个目录。我们使用 link 属性来引用现有的目录文件,而不是为每个主题提供一个 href

<toc label="Online Help Sample" topic="html/book.html">
	<topic label="Concepts">
		<link toc="toc_Concepts.xml" />
	</topic>
	<topic label="Tasks">
		<link toc="toc_Tasks.xml" />
	</topic>
	<topic label="Reference">
		<link toc="toc_Ref.xml" />
	</topic>
</toc>

然后我们更新 plugin.xml 以添加主目录:

   <extension point="org.eclipse.help.toc">
      <toc file="toc.xml" primary="true" />
   </extension>

注意 primary 属性的使用。将此属性设置为 true,它指示目录应该总是出现在导航中,即使没有任何其它目录引用它也是如此。这样,“主”目录将总被保证显示在主题列表中。它出现在顶级书籍列表中,因为没有其它目录引用它。 
注意
:如果有多个文件与此目录相关联,但是不出现在浏览中,只是从其它主题进行链接,则要使这些主题可用于搜索引擎,我们必须在目录中使用 extradir 属性。

最后,我们添加单独的目录文件。

   <extension point="org.eclipse.help.toc">
       <toc file="toc_Concepts.xml" />
       <toc file="toc_Tasks.xml" />
       <toc file="toc_Reference.xml" />
   </extension>

因为我们未设置 primary 属性,这些目录文件不会出现在书籍的顶级列表中。如果从主目录或主目录链接至的目录引用未指定为主目录的目录文件,则该目录文件将仅出现在文档 Web 页中。

就是这样。如果将插件目录复制到平台的 plugins 目录中,启动平台,并选择帮助 -> 帮助内容,则应该看到您的示例出现在书籍列表中。如果您单击“联机帮助样本”,您将看到目录结构:

具有样本书籍结构的联机帮助浏览器

Copyright IBM Corporation and others 2000, 2003.