tags:

views:

104

answers:

1
+1  Q: 

Desktop application help framework

Consider the requirements for embedding help in a Java desktop application (or applet):

  • Single source for content (such as AsciiDoc) to generate high quality PDF manuals1
  • Hooks for context-sensitive help
  • Robust, simple, and well documented API (under an hour to learn)
  • Small footprint (a sub-100K Java archive)2
  • Integrate as a docked MDI-style window, or a separate window
  • Free open source software

Google says:

Which of these, or any others, would you recommend?

1Storing the content in AsciiDoc format would be ideal, so long as conversion is trivial.
2Up to 500kb.

+1  A: 

Have a look at DocBook - last time I looked it could generate PDF, HTML and JavaHelp from files written in DocBook XML .

A crash course is available at: http://opensource.bureau-cornavin.com/crash-course/

Thorbjørn Ravn Andersen  2009-08-30 21:07:32
Am wondering more about the Java APIs -- is JavaHelp, for example, a suitable tool to use? I've taken a peek at DocBook before; thanks for the reminder.
Dave Jarvis  2009-08-30 21:20:15
JavaHelp is the tool Sun provides for help. I have not heard of any other package to do so (except for the help in Eclipse, which probably is way over your head).
Thorbjørn Ravn Andersen  2009-08-31 09:33:03

related questions

Java Time Zone is messed up
Eclipse on win64
Automate builds for Java RCP for deployment with JNLP
Why are professors or schools picking Java over C++ to teach to students?
Is there a real benefit of using J#?
Public/Popular Websites using JavaServer Faces
Why can't I use a try block around my super() call?
Accessing post variables using Java Servlets
Personal Linux web server
Is this really widening vs autoboxing?
How can I Java webstart multiple, dependent, native libraries?
Why can't I call toString() on a Java primitive?
How do I use Java to read from a file that is actively being written?
What code analysis tools do you use for your Java projects?
IllegalArgumentException or NullPointerException for a null parameter?
How do I configure and communicate with a serial port?
What is the best way to parse strings in Java
Getting started with a custom JXTA PeerGroup
Creating a custom button in Java
How to get started "writing" a code coverage tool?
Which Build-/Configuration Management Tool?
What is the difference between an int and an Integer in Java/C#?
What is the meaning of the type safety warning in certain Java generics casts?
How would you access Object properties from within an object method?
Converting CSV File to XML in Java