我正在尝试将可搜索的帮助集成到我的Java(Swing)应用程序中。我现在正在使用docbook生成pdf帮助,我知道它可以生成JavaHelp。不过,我认为JavaHelp的默认查看器相当不吸引人(尤其是在windows上,即使使用windows L&F)。我找不到任何好看的观众,但很好奇你是否知道有,或者在应用程序中是否有更好的帮助选择。
JavaHelp中的默认内容查看器(HTML呈现器)是HTMLEditorKit。这个组成部分不是很令人印象深刻;它只支持HTML3.2,并且具有有限的CSS功能。可以在JavaHelp中插入其他内容查看器。
您可能需要尝试Oracle帮助。它与JavaHelp非常相似,但维护更积极。Oracle Help附带的默认内容查看器功能也更强。DocBook XSL JavaHelp样式表可能需要进行一些调整,以便生成可与Oracle帮助一起使用的输出(请参阅本页)。
很难找到关于这些技术的现状和未来计划的确切信息。JavaHelp最新发布于2007年10月,而Oracle Help 11.1.2.1.0发布于2011年9月。有论坛(这里和这里),但活动量很低。
也许你会对基于网络/浏览器的帮助系统感兴趣。在这种情况下,请查看WebHelp,它是DocBook内容的较新输出格式之一。
我一直在使用Sphinx来满足我的所有文档需求,它拥有出色的HTML模板。狮身人面像网站本身就是基于其中一个模板。还有eclipse插件,它可以帮助您设置基础sphinx项目并充当编辑器。优点
- 您使用类似于wiki的ReST语法编写文档
- 好看的html模板/
- 能够生成其他格式,如epub、pdf等
- 可版本控制