Installing JavaHelp

PDF icon View this tip in PDF format

WARNING The instructions on this page apply to JavaHelp 1.1.2 only. DO NOT FOLLOW THESE INSTRUCTIONS if you are installing JavaHelp 1.1.3. Instead, for JavaHelp 1.1.3, follow the instuctions provided by Sun.

Many Help authors have reported various difficulties in getting the JavaHelp software—and other components required for successful JavaHelp authoring—successfully installed with the Java 2 SDK v 1.3. The following procedure describes how to install the latest JavaHelp software on a Windows PC.

NOTE This procedure will be useful to you if you want to install and use JavaHelp 1.1 (or 1.1.1) with the Java 2 SDK v 1.3 (aka the “JDK 1.3”). If you want to use an earlier version of the JDK, you do not need to follow the steps described here.

  1. If you have previously attempted to install the JDK and/or the JavaHelp software and your installation attempts were unsuccessful, be sure to completely remove any partial or failed installation from your system before you proceed.
  2. The exact steps for un-installing the JDK and the JavaHelp software depend on your operating system and which versions you have installed. However, you can generally use Add/Remove Programs in Control Panel to remove both components. Search your local hard disk for copies of java.exe to see if you still have any “extra” copies installed.

  3. Download the following files:
  4. Install the Java Runtime Environment v 1.2.2 as follows:
    1. Double-click the jre-1_2_2_007-win.exe file that you downloaded in step 2.
    2. Accept the license agreement and the other default settings suggested by the installer. (Optionally, you can specify an installation directory if you don’t like the default suggested by the installer.)
    3. Click Finish when the installer finishes copying files.
  5. Install the Java 2 SDK, Standard Edition, v 1.3 (aka the “JDK 1.3”) as follows:
    1. Double-click the j2sdk1_3_0-win.exe file that you downloaded in step 2.
    2. Accept the license agreement.
    3. Optionally, you can specify an installation directory if you don’t like the default suggested by the installer.
    4. In the Select Components dialog box, de-select all components except Program Files. (For JavaHelp authoring, you do not need to install the other listed components.)
    5. Select Components dialog box

    6. Click Finish when the installer finishes copying files.
  6. Modify the PATH variable on your system to ensure that the first directory listed in the PATH is the directory containing the JRE 1.2.2 that you installed in step 3.
  7. For example, if your current PATH is:

    
    %SystemRoot%\system32;%SystemRoot%
    
    

    change it to:

    
    C:\Program Files\Javasoft\JRE\1.2\bin;%SystemRoot%\system32;%SystemRoot%
    
    
    • If you are using Windows 2000, you can change your path in the System Properties control panel. Choose Start>Settings>Control Panel>System, then click the Advanced tab, and finally click the Environment Variables button.
    • If you are using Windows NT4, you can change your path in the System Properties control panel. Choose Start>Settings>Control Panel>System, and then click the Environment tab.
    • If you are using Windows 95, Windows 98 or Windows ME, you can change your path by editing the AUTOEXEC.BAT file.
  8. To confirm that you have successfully changed the path, open a command prompt window and enter the following command:
  9. 
    java -version
    
    

    Your output should look something like this:

    Output from java -version

    If the Java version is identified as “1.2.2,” you have successfully changed your PATH variable.

  10. Close the command prompt window by entering the following command:
  11. 
    exit
    
    
  12. Install JavaHelp 1.1 as follows:
    1. Launch the JavaHelp installer by double-clicking the javahelp1_1-win-no_rt.exe file that you downloaded in step 2.
    2. Click Next in each of the first three dialog boxes the installer displays.
    3. In the Choose Install Folder dialog box, click OK to accept the default, or specify an alternate directory in which to install JavaHelp.
    4. Click Next in two successive dialog boxes.
    5. In the Choose Java Virtual Machine dialog box, click to select the version of java.exe that is installed in your JDK 1.3 directory, as shown in the following illustration:
    6. Choose Java Virtual Machine dialog box

    7. Click Next.
    8. Click Install to begin the installation.
    9. Click Done when the installer finishes copying files.
  13. Reverse the change you made to the PATH environment variable in step 5.
  14. For example, if you changed your PATH to:

    
    C:\Program Files\Javasoft\JRE\1.2\bin;%SystemRoot%\system32;%SystemRoot%
    
    

    change it back to:

    
    %SystemRoot%\system32;%SystemRoot%
    
    
  15. To confirm that you have successfully changed the path, open a command prompt window and enter the following command:
  16. 
    java -version
    
    

    Your output should look something like this:

    Output from java -version command

    If the Java version is identified as “1.3.0,” you have successfully changed your PATH variable.

  17. Install the JavaHelp 1.1.1 patches, following the instructions contained in the README1.1.1.html file included with the JavaHelp software.
  18. Install any software you plan to use to author JavaHelp—for example, RoboHelp, WebWorks Publisher, or Dreamweaver.
  19. NOTE Once you have successfully installed the JavaHelp software, you may un-install JRE v 1.2.2. However, this is not recommended because you will need to have JRE v 1.2.2 installed if you ever want to un-install the JavaHelp software.