制作eclipse样式的帮助系统

最新推荐文章于 2020-12-16 20:45:38 发布

kokieultra

最新推荐文章于 2020-12-16 20:45:38 发布

阅读量1.8k

点赞数

分类专栏： Java 文章标签： eclipse eclipse插件文档扩展 encoding tomcat

本文链接：https://blog.csdn.net/kokieultra/article/details/1717218

版权

本文档介绍了如何利用Eclipse构建一个类似于其内置帮助系统的联机帮助系统。通过将帮助内容转换为HTML或JSP，然后利用Eclipse插件开发环境，将这些文档打包成插件。关键步骤包括创建扩展点为TOC的插件，利用RCP runtime binary和必要的附加插件运行自定义的帮助系统。在最终产品中，通过调整配置以隐藏默认帮助并解决中文文档名的问题。

摘要由CSDN通过智能技术生成

eclipse自带的联机帮助非常强大,由Help/Help Contents打开.能全文检索,定义书签等等

最近做的项目发布的时候要做个比较友好的帮助系统,就想到了用eclipse完成,下面简单介绍一点经验

一.原理

eclipse的联机帮助其实是一个小型的B/S系统,我们点Help/Help Contents的时候,eclipse就在后台启动一个Tomcat+Lucence,而我们看到的是由eclipse自带的浏览器展示出来的网页.因此我们可以先把帮助制作成Html或者是Jsp等格式.

然后我们需要把这些网页形式的帮助文档制作成eclipse能够接受的"书".Eclipse帮助系统左边显示的一本本书其实都是Eclipse的插件,扩展点是TOC(table of contents),eclipse启动的时候会在eclipse.exe的目录下和links文件夹下的所有link指向的目录下加载插件,如果有扩展点为TOC的插件,就把它作为联机帮助系统中的一本书.因此我们就需要用eclipse的插件开发环境,把html的帮助文档包装成插件.其实这步比较简单,(网上的例子成把抓),eclipse插件开发的向导中就有Plug-in with sample help content的模板.用到的扩展点就是org.eclipse.help.toc

最后在发布系统的时候,需要一个eclipse环境,因为插件要运行在eclipse平台上.官方的帮助文档建议的minimal stand-alone help system就是RCP runtime binary 加上以下插件

org.apache.lucene org.eclipse.help org.eclipse.help.appserver org.eclipse.help.base org.eclipse.help.ui org.eclipse.help.webapp org.eclipse.tomcat org.eclipse.ui.forms 二.具体步骤