# README: JavaHelpTM 2.0 - March 2003

CONTENTS:

- Caveat for Win32
- Target Audience
- Changes Since the 1.0 Release
- Contents of the Release
- How to Get Started
- How to Reach Us
- Limitations and Bugs
- Copyright

---------------------------------

## File Separators on the Win32 Platform

File Separators ("/" vs. "\")

All files within the JavaHelp system are specified as URLs. The separator between elements (files) in a hierarchy should be "/". In some cases "\" works on the Win32 platforms; however when the files that contain these references are added to JAR files or moved to different platforms, these references no longer work.

## Target Audiences

JavaHelp software is intended for help authors, information architects, and software developers who need a framework for delivering online help and documentation.

## Changes Since the 2.0 Release

Changes since the 1.1.3 release are described in the "Release Information" chapter of the JavaHelp System User's Guide. You can view the JavaHelp System User's Guide on by executing the UserGuide.jar file in the demos\bin folder.

To execute the jar file, open a command window and change your directory to the `demos\bin` folder, then enter the following command at the command line:

> `java -jar UserGuide.jar`

The JavaHelp System User's Guide is also included in PDF format in `doc\jhug\jhug.pdf` and can be read and printed by using the Adobe Acrobat Reader program available at http://www.adobe.com/products/acrobat/readstep2.html.

## Contents of the Release

The contents of the release are described in the "Release Information" chapter of the JavaHelp System User's Guide. You can view the JavaHelp System User's Guide by executing the UserGuide.jar file in the demos\bin folder.

To execute the jar file, open a command window and change your directory to the `demos\bin` folder, then enter the following command at the command line:

> `java -jar UserGuide.jar`

The JavaHelp System User's Guide is also included in PDF format in `doc\jhug\jhug.pdf` and can be read and printed by using the Adobe Acrobat Reader program available at http://www.adobe.com/products/acrobat/readstep2.html.

## Getting Started

You install JavaHelp software by extracting the zip file. While most installations will not require any additional installation tasks, some installations might require that the environment variable JAVAHELP_HOME be defined so that jhindexer and jhsearch will work correctly. You will know that you need to set JAVAHELP_HOME if, after installation, you see an error from jhindexer or jhsearch indicating that the environment variable needs to be set.

## Redistributable Files

The following files are redistributable. Distribution of these files is governed by the Terms and Conditions of the JavaHelp Binary Code License.

- `javahelp/lib/jh.jar`
- `javahelp/lib/jhall.jar`
- `javahelp/lib/jhbasic.jar`
- `javahelp/lib/jhsearch.jar`

## How to Reach Us

### Mailing List

We 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`

### Feedback

Comments and questions about the JavaHelp software are welcome. Please review the FAQ at our home page (http://java.sun.com/products/javahelp) before sending email to:

> javahelp-comments@eng.sun.com.

Your email message will be read. However, due to the large volume of emails, we might not able to respond personally.

### Discussion group (JAVAHELP-INTEREST)

Sun maintains a mailing list as a JavaHelp community resource where interested parties can post and exchange information and inquiries about the JavaHelp system in a public forum. Subscribers to this list can receive inquiries either as they are posted or in regular digest versions.

To subscribe, send mail to:

> listserv@javasoft.com

In the body of the message type:

> `SUBSCRIBE JAVAHELP-INTEREST`

To view archives, manage your subscription, or to unsubscribe, go to:

> http://archives.java.sun.com/archives/javahelp-interest.html

### Web Site

Other information can be obtained at our web site:

> http://java.sun.com/products/javahelp

We hope to hear from you!

---------------------------------

## Limitations and Bugs

Limitations and bugs are described in the "Release Information" chapter of the JavaHelp System User's Guide. You can view the JavaHelp System User's Guide as a JavaHelp helpset by executing the UserGuide.jar in the `demos\bin` folder.

To execute the jar file, open a command window and change your directory to the `demos\bin` folder, then enter the following command at the command line:

> `java -jar UserGuide.jar`

The JavaHelp System User's Guide is also included in PDF format in `doc\jhug\jhug.pdf` and can be read and printed by using the Adobe Acrobat Reader program available at http://www.adobe.com/products/acrobat/readstep2.html.

---------------------------------

## Copyright

Copyright 2003 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Sun, Sun Microsystems, the Sun Logo, Solaris, Java, the Java Coffee Cup Logo, JDK, Java Foundation Classes (J.F.C.), Java Plug-in and JavaHelp are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries.

DOCUMENTATION IS PROVIDED "AS IS" AND ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID.

RESTRICTED RIGHTS LEGEND: Use, duplication, or disclosure by the U.S. Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software Clause at DFARS 252.227-7013 (Oct. 1988) and FAR 52.227-19 (c) (June 1987).