About JavaHelp

JavaHelp, developed by Sun Microsystems, is a new compressed Help format designed to work with applications written in the Java programming language. JavaHelp and Java applications run on a variety of platforms (Windows, UNIX, Mac, Linux, etc.). JavaHelp is a delivery system, not a Help authoring tool. Currently, Sun does not provide a Help authoring tool for creating JavaHelp, but you can use RoboHELP to accomplish the task. (JavaHelp functionality is available with RoboHELP Office.)

RoboHELP provides rich support for the emerging JavaHelp format and automatically creates all the Java-based Help features such as tables of contents, full-text search, dynamic index, navigation controls, and popup windows, along with HTML-based features such as HTML content, hyperlinks, images, etc. You can now create JavaHelp systems with the same point-and-click and drag-and-drop ease as you create WinHelp, HTML Help, and WebHelp - all from the same source project. You can also leverage existing WinHelp and HTML projects to create JavaHelp systems. eHelp's solution, based on Sun's JavaHelp API, also supports file compression for smooth distribution of the JavaHelp system.

What do you need?

Help authors need a copy of the Java Development Kit (JDK) (version 1.2 or later) and the JavaHelp 1.0 or 1.1 components in order to properly generate and view JavaHelp files. The JDK can be downloaded for free from the Sun Microsystems Web site, www.sun.com.

JavaHelp is the preferred format to use with applications written in the Java programming language. If you need to create cross-platform application Help, standalone Help, intranet content, pages for Web sites, or online documentation, we recommend using WebHelp instead of JavaHelp. WebHelp is currently in its third release and is a proven, reliable tool for the uses listed above.

What do your end users need?

Your end users need the Java Runtime Environment (JRE) 1.2.1 and the JavaHelp 1.0 or 1.1 components in order to view your JavaHelp system. For more information, see Distributing JavaHelp.

What comes with JavaHelp 1.0 or 1.1?

Who should use JavaHelp?

JavaHelp provides a flexible solution for authors who design Help for applications written in the Java programming language. JavaHelp itself was developed in Java code. One of the most important features of Java is its portability across computer platforms. When you develop a Help project in JavaHelp it is cross-platform as well.

How does JavaHelp work?

Behind the scenes, JavaHelp is a compressed file (.JAR file) or a set of files used to run a Help system for a Java application. You generate JavaHelp after you finish authoring Help topics, creating a table of contents, and building the index in RoboHELP. All the files you need to distribute are copied into a single folder called "JavaHelp," or into a .JAR file if you choose to compile.

Note: Only available with RoboHELP Office.