Sun Java Solaris Communities My SDN Account Join SDN
 
JavaHelp

JavaHelp Software FAQ

JavaHelp

General

Technology

 


What is the JavaHelp software?

The JavaHelp software is both an API and a platform-independent, extensible system for application help and online documentation. Written entirely in the Java programming language, the JavaHelp help system provides capabilities for navigating, searching, and displaying information.

Back to top.


Is JavaHelp software a Help Authoring Tool?

No, JavaHelp software is not a Help Authoring Tool. For information about Help Authoring Tools for JavaHelp software, please see the Industry Support page at java.sun.com/javase/technologies/desktop/javahelp/industry.html.

Back to top.


Who can use the JavaHelp software?

The JavaHelp software enables information designers, help authors, and software developers to provide a single, cross-platform, cross-browser solution for all online documentation needs, including online help for components, applets, and applications, and online documentation (i.e. books and employee handbooks) for the Web or corporate intranet.

Back to top.


What are the key advantages of the JavaHelp software?

There are many advantages in using the JavaHelp software, including the following:

  • JavaHelp software is written 100% in the Java programming language, which means that it can run on any platform and browser that supports the Java runtime environment (JRE).
  • JavaHelp software is ideally suited for the network and can be dynamically extended with additional functionality over the web or Intranet.
  • Because the JavaHelp software is being developed by the creators of the Java technologies, developers are ensured that it is designed to work well with the Java Platform and that it has widespread support from the industry and help authoring tool vendors.

Back to top.


Why create a help system standard for the Java Platform?

Most applications require a help system; Java applications are no exception. Software developers and authors have expressed a strong desire for a help system standard designed to integrate well with the Java Platform. The JavaHelp software fills this void by providing a high quality, user-centric help system that will eliminate the need to develop a costly proprietary help system.

Back to top.


Who is involved in developing the JavaHelp software?

JavaHelp software is being developed using an open, industry-participative process. Information designers, software developers and licensees are encouraged to participate in the development and evolution of JavaHelp by reviewing and submitting comments via our feedback form. For more information about the Sun's open development process, see java.sun.com/aboutJava/standardization/.

Back to top.


How does the JavaHelp software differ from other Java-based help formats?

JavaHelp software is an industrial strength, industry-supported help system designed for the Java Platform. JavaHelp software offers a rich feature set, including context sensitive help, extensibility, merging and many other features. Hence, developers are ensured that the JavaHelp system is easily integrated into their Java applications and that it has widespread industry support, including tool vendors.

Sun's Java Workshop help and JMAPI help are customized Java-based help system designed specifically for use within their respective products. Both Java Workshop and JMAPI plan to migrate to the JavaHelp system in future releases.

Oracle Help for Java is a proprietary help format that is designed for Oracle applications.

CreativeSoft's Jelp is a tool that translates WinHelp to a proprietary Java-based help system. CreativeSoft has announced plans to support JavaHelp in a future release.

Back to top.


Is the JavaHelp software 100% Pure Java?

The 100% Pure Java is a certification program that acts as a quality assurance seal of approval that an application is completely written in the Java language and can run on any JRE-supported platform.

The JavaHelp implementation is written entirely in the Java language using JFC components and architecture, and is 100% Pure Java certified.

Back to top.


Can the JavaHelp software run in a non-Java application, such as a C++ application?

Yes, the JavaHelp software can provide help for applications written in languages other than the Java language. This is possible by through the use of a help server.

Back to top.


What areas of the JavaHelp specification would be of interest to authors?

The JavaHelp specification is written primarily from the developer's perspective. However, the following sections may be of particular interest to authors:

  • Overview: This section provides a general overview of the JavaHelp software.
  • Scenarios: This section uses a number of concrete examples to illustrate ways that the JavaHelp software can be used in products in a variety of environments.
  • File Formats: This section describes the formats of the files used in the help viewer. The HelpSet file and map files descriptions are of particular interest.

Back to top.


What does it mean for JavaHelp software to be a Standard Extension?

As a standard extension, the JavaHelp software will be delivered separately from the JDK to enable faster upgrades that incorporate new features and bug fixes while maintaining ease in integrating with JDK 1.1 and 1.2.

Standard Extensions are packages of Java classes that application developers can use to extend the functionality of the core platform. JDK 1.2 provides an extension mechanism that allows the Java virtual machine* (VM) to use the extension classes in much the same way as the VM uses the (core) system classes.

Back to top.


What versions of the JDK will the JavaHelp software support?

The JavaHelp software now supports both JDK 1.1 and JDK 1.2. Support for JDK 1.1 has been added in response to feedback from many customers needing online help for JDK 1.1 applications.

Although JDK 1.1 is in wider use, JDK 1.2 is fundamentally a better platform offering many advantageous features for the JavaHelp software, including:

  • jar:protocol - Provides a general and consistent way to refer to files within a JAR file.
  • Temporary files - Provides improved full-text search performance.
  • More flexible ClassLoader (including standard URLClassLoader) - Enables the easy creation of new ClassLoaders.
  • Improved security model.
  • Access to the SystemEventQueue from an applet - Enables some context-sensitive help features in applets.
  • Improved I18N support, including input methods.
  • Printing support.
  • 2D graphics support.

Back to top.


What version of Swing does the JavaHelp software support?

The JavaHelp software supports Swing 1.1.

Back to top.


Is there a licensing fee for the JavaHelp software?

No. The shipping release of JavaHelp software will be distributable royalty free with your product.

Back to top.


What are the user requirements for running the JavaHelp software?

The Java Runtime Environment (JRE) is needed to run the JavaHelp system. For applications, this should not be an issue for users, as the developer will provide the classes along with the proper JRE in the application. For browser-based applications, if the browser does not already support the proper JRE, Sun's Project Java Activator (see java.sun.com/products/plugin/) can be used for Internet Explorer 3.02 or later and Netscape Navigator 3.0 or later to provide the latest JRE.

Back to top.


In what way can I customize and extend the JavaHelp system?

The JavaHelp system is designed to be flexible and extensible. It allows custom or third-party navigational controls, search engines, and content viewers to be added. Additional functionality can be added using JComponents.

Back to top.


Does the JavaHelp viewer support JavaScript or other web technologies?

The JavaHelp HTML-based viewer will support Swing JComponents for adding additional functionality to the content pane. At this point, the JavaHelp HTML viewer does not support JavaScript. However, a more sophisticated viewer may be substituted to support these technologies.

Back to top.


Does JavaHelp software support pop-ups?

Pop-ups will be provided as a feature in the JavaHelp system.

Back to top.


Will the JavaHelp software support internationalization?

Yes. JavaHelp software can take advantage of the JDK 1.2 internationalization support to provide full I18N support. Localization of help content, indexes, and table of contents is supported and are loaded in a locale specific way.

Back to top.


Will the JavaHelp system run in Netscape Navigator and Internet Explorer browsers?

The JavaHelp system can run on any browser that supports JRE 1.1 or 1.2. If the JRE is not available on Netscape Navigator and Internet Explorer, Sun's Java Plug-in can be used to specify the latest JDK software rather than the default Java Virtual Machine provided by the browser. For more information on how the Java Plug-in works, see java.sun.com/products/plugin/.

Back to top.


The Mac installation files don't work on my Mac.

The Mac installers built with InstallAnywhere are created in MacBinary format so they can be easily transported to different operating systems. However, this means that the installers cannot be run directly by double-clicking on them; they need to be "de-MacBinaried" first via a tool like StuffitExpander 4.5.

Back to top.


*As used on this web site, the terms "Java virtual machine" or "JVM" mean a virtual machine for the Java platform.