开发学院软件开发Java 使用 Eclipse 帮助系统为项目编制文档 阅读

使用 Eclipse 帮助系统为项目编制文档

 2009-12-13 00:00:00 来源:WEB开发网   
核心提示: 根据您的项目,将插件的 name 、 id 、 version 和 provider-name 修改为适当的值,使用 Eclipse 帮助系统为项目编制文档(2),扩展点 org.eclipse.help.toc 将此标识为帮助系统的一个插件,toc.xml 文件被引用进来,也为了压缩文件的大小

根据您的项目,将插件的 name 、 id 、 version 和 provider-name 修改为适当的值。扩展点 org.eclipse.help.toc 将此标识为帮助系统的一个插件。toc.xml 文件被引用进来,作为这个插件的目录;这个文件将为 Eclipse 帮助窗口左侧窗格中的分级信息提供数据。清单 2 是一个包含有类似内容的示例文件。


清单 2. 目录定义

<toc label="Sample Documentation"> 
  <topic label="My Section" href="mySection.html"> 
    <topic label="Foo" href="foo.html"/> 
    <topic label="Bar" href="bar.html"/> 
  </topic> 
</toc> 

包装插件

在最终的文档中,每一个主题元素都表现为导航列表中的一个条目。这些主题可以嵌套(它们可以包含更多的主题),每一个指向一个 HTML 或者 JSP 文件。当您完成了这一步,所有您需要做的就是包装如图 2 所示的结构中的所有内容(注意,插件目录名与在 plugin.xml 中定义的插件属性 id 和 version 相匹配)。


图 2. 插件目录结构
使用 Eclipse 帮助系统为项目编制文档

为了方便,也为了压缩文件的大小,Eclipse 允许您将实际的文件(HTML 文件)存放在一个名为 doc.zip 的 ZIP 文件中,所以您可以使用图 3 所示的目录结构。


图 3. 另一种插件目录结构
使用 Eclipse 帮助系统为项目编制文档

上一页  1 2 3 4  下一页

Tags:使用 Eclipse 帮助

编辑录入:爽爽 [复制链接] [打 印]
[]
  • 好
  • 好的评价 如果觉得好,就请您
      0%(0)
  • 差
  • 差的评价 如果觉得差,就请您
      0%(0)
赞助商链接