Java swing application with simple help documentation based on eclipse (no RCP application)

Question

I developed a Java Swing application using Eclipse. I would like to integrate the existing help documentation into my GUI. Basically I want to start my help window with a typical menu item as common for most programs. So nothing fancy at all.

I spent already a lot time to find which option would be best for my case and I'm kind of stuck. I thought integrating the help would be straight forward but meanwhile I think this is not the case.

If anyone can point me in the right direction or show me a tutorial where I can get the idea how to accomplish it with eclipse help and a swing application I would be really happy. I find a lot of tutorial discussing RCP applications or writing an eclipse plugin. Somehow I tried a lot for such an easy usecase.

The following options are available as far as I can tell:

1. Eclipse like help My favorite option would be to use an eclipse like help window but after playing around a bit I have the slight feeling that this is only possible for eclipse RCP applications. Since my Swing GUI is not a RCP application I think that wont work for me.

Is it possible to integrate the Eclipse help with only my help content into my Swing application? Eclipse won't be installed on the PCs where my application is used.

Most probably those PCs are not even connected to the internet, so using the Eclipse help in info center mode is also not an option.

Using the eclipse help in standalone mode requires to specify the eclipse installation directory when launching it. That's where I'm stuck.

2. Java help or Oracle help Java Using these options is my next call also not my favorite one. I think both options are kind of outdated.

For Java help I would probably follow the Docbook approach. Even if I don't understand why this is so complicated at all...

3. Custom panel I'm almost close to design a customized panel to display my help content. Then I'm at least able to make sure that I like the way it is designed.

In the beginning I thought this might be more time consuming, but after reading what effort is necessary to get a nice looking help with Java help I think this option is not the worst choice.

Thanks Joe

Answer 1

My solution for now is to create the complete help system with HelpNDoc and then simply generate the HTML documentation.

The HTML document I will open from my swing GUI.

I also tried the CHTML but to be honest I like the look (which can be nicely configured) int the browser more.

Windows Help looks also too outdated to me. But that's just my personal opinion.

Right now this is the right solution for me and my energy will go into the help itself.

Thanks to everyone.

Joe