I'm trying to integrate searchable help into my Java (Swing) application. I'm using docbook right now to generate pdf help, and I know it can generate JavaHelp. I think the default viewer for JavaHelp is rather unappealing though (especially on windows, even when using the windows L&F). I couldn't find any nice looking viewers, but curious if you know of any out there, or if there are better alternatives for help within the application.
Asked
Active
Viewed 3,395 times
2 Answers
5
The default content viewer (HTML renderer) in JavaHelp is HTMLEditorKit. This component is not very impressive; it only supports HTML 3.2 and has limited CSS capabilities. It is possible to plug in alternative content viewers in JavaHelp.
You might want to try Oracle Help. It is very similar to JavaHelp, but more actively maintained. The default content viewer that comes with Oracle Help is also more capable. The DocBook-XSL JavaHelp stylesheets may require some tweaking in order to produce output that works with Oracle Help (see this page).
It is hard to find definitive information about status and future plans for these technologies. JavaHelp had its latest release in October 2007, while Oracle Help 11.1.2.1.0 was released in September 2011. There are forums (here and here), but the activity is low.
Perhaps you'd be interested in a web/browser-based help system. In that case take a look at WebHelp, one of the newer output formats for DocBook content.
mzjn
- 48,958
- 13
- 128
- 248
2
I have been using Sphinx for all my documentation needs and it has excellent HTML templates. The sphinx site itself is based on one of the templates. There is also eclipse plugin that helps you setup the base sphinx project and acts as the editor. Advantages
- You write the documentation using ReST syntax which is similar to wiki.
- Good looking html templates/
- Ability to generate other formats like epub, pdf etc.
- Versionable
Aravind Yarram
- 78,777
- 46
- 231
- 327
-
Have you been able to use this documentation from within a help viewer in your app? Or is it only in external files. – Jeff Storey Mar 29 '12 at 12:35
-
@JeffStorey It is ny external files – Aravind Yarram Mar 29 '12 at 13:41
-
We currently use docbook to pdf/html for that which works well. I'm trying to find an alternative (or at least a better viewer) for JavaHelp. – Jeff Storey Mar 29 '12 at 13:54