# JavaHelpTM 1.0 Specification

Sun Microsystems, Inc.

Copyright 1998 Sun Microsystems, Inc.
901 San Antonio Road, Palo Alto, California 94303 U.S.A.

All rights reserved. Copyright in this document is owned by Sun Microsystems, Inc.

Sun Microsystems, Inc. (SUN) hereby grants to you at no charge a nonexclusive, nontransferable, worldwide, limited license (without the right to sublicense) under SUN's intellectual property rights that are essential to practice the JavaHelp 1.0 Specification "Specification") to use the Specification for internal evaluation purposes only. Other than this limited license, you acquire no right, title or interest in or to the Specification and you shall have no right to use the Specification for productive or commercial use.

### RESTRICTED RIGHTS LEGEND

Use, duplication, or disclosure by the U.S. Government is subject to restrictions of FAR 52.227-14(g)(2)(6/87) and FAR 52.227-19(6/87), or DFAR 252.227-7015(b)(6/95) and DFAR 227.7202-1(a).

SUN MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. SUN SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES.

### TRADEMARKS

Sun, the Sun logo, Sun Microsystems, JavaSoft, JavaBeans, JavaHelp, JDK, Java, HotJava, HotJava Views, Visual Java, Solaris, NEO, Joe, Netra, NFS, ONC, ONC+, OpenWindows, PC-NFS, EmbeddedJava, PersonalJava, SNM, SunNet Manager, Solaris sunburst design, Solstice, SunCore, SolarNet, SunWeb, Sun Workstation, The Network Is The Computer, ToolTalk, Ultra, Ultracomputing, Ultraserver, Where The Network Is Going, Sun WorkShop, XView, Java WorkShop, the Java Coffee Cup logo, and Visual Java are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries.

> THIS PUBLICATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

> THIS PUBLICATION COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THE PUBLICATION. SUN MICROSYSTEMS, INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS PUBLICATION AT ANY TIME.

| # JavaHelp 1.0 - Introduction

## Status of this Specification

JavaHelpTM is the Help system for the JavaTM Platform. These documents describe the JavaHelp 1.0 specification. As of the publication of this document, the closest released implementation is the JavaHelp 1.0 release which follows this specification.

We followed Sun's Open Development Process for the Java Platform, an open and inclusive process that produces high-quality specifications in "Internet-time". Through this process the critical feedback from all reviewers helped us transform early specifications into a high quality final specifications that satisfied the needs of the user community. The release of this specification is part of this process.

We expect the specification to continue to be extended in future updates. Please send us your feedback to guarantee that future specifications best suites your needs.

## How to read this Specification

Two sets of documents are included. The first set is the actual specification that describes the JavaHelp API and its use. Also included are several related documents that, while not technically part of the specification, help in understanding it. These documents describe aspects of Sun's reference implementation.

We suggest that you begin by reading the specification Overview. In order to make the JavaHelp system features more concrete and easy to understand, a number of usage scenarios are explained in a companion document. These scenarios describe some of the different ways the JavaHelp system can be used in Java applications.

You may want to complement your reading of this specification by exploring the JavaHelp 1.0 release which corresponds to this specification. This reference implementation also supports some features that are useful for online documentation systems but that we have judged to not be appropriate for inclusion in the specification at this time. The release also includes examples of documentation and applications that use this specification.

## Table of Contents of Specification

| Introduction to the JavaHelp API (this document)
| Overview of the JavaHelp API
| Formats of JavaHelp Data Files
| Localizing JavaHelp
| Customizing JavaHelp
| JavaBeans Help Data
| Context-Sensitive Help
| Search API
| Merging Help Information
| Specification Change History
| The JavaHelp Classes
| JavaHelp Class Architecture
| Package javax.javahelp

## Related Documents

| JavaHelp Scenarios
| The JavaHelp 1.0 Reference Implementation
| Java Components
| `jar:` Protocol Specification

## Further Reading

Up-to-date public information on JavaHelp technology, including our latest presentations at public forums, is available at our home page at http://java.sun.com/products/javahelp . We also maintain a mailing list for regular information about JavaHelp updates and events. To subscribe, send mail to listserv@javasoft.com. In the body of the message type SUBSCRIBE JAVAHELP-INFO

Further information on Java technology can be found at Sun's Java web site at http://java.sun.com . Of special interest is the description of the next version of the Java Development Kit JDKTM1.2 , and within it the information on Swing, standard extensions and the jar: protocol. Slightly more up-to-date information on Swing can be obtained at The Swing Connection's home page.

## Your Feedback

We encourage your feedback at javahelp-comments@eng.sun.com.

We thank you for your help in making this, and future specifications, meet your needs!

JavaHelpTM 1.0
Send your comments to javahelp-comments@eng.sun.com
Last modified: Mon Apr 12 19:13:58 MDT 1999