Software Installation

Software Packages

EarthStones' software is packaged as one of these four self-extracting files:

In some cases evaluation copies are downloaded in zip format instead.

JDoc and JSite share much of EarthStones' Java class library. The software package you received  contains the class files (along with source code and html example files) necessary to implement each product's features. The documentation supports all four packages. If you have purchased JDoc, you will find that some of the discussion does refer to features not included in this package.

Installation

By default (except for zip files), your EarthStones files are installed into a [drive]:\Program Files\EarthStones subdirectory of your default drive. This name is entirely arbitrary and you have an opportunity to change it at the beginning of the installation process. The files within this directory are in turn organized into four subdirectories:

Access to Documentation

The remainder of this document describes how to set up EarthStones' software on both your development system and your web server. All other product documentation is available in HTML format in the EarthStones\docs subdirectory. Double-clicking on the file EarthStones\contents.html will bring up a table of contents for this documentation. The shortcut EarthStones\EarthStones Documentation can also be copied to your desktop or placed in a Start menu folder to provide quick access.

Adding JDoc/JSite to your Development System

If you will be using only the ready-to-run applets supplied with your EarthStones software you may skip this and the next sections and proceed to the instructions for setting up JDoc/JSite on your web server.

To customize and extend EarthStones' class library your Java development system must be able to locate its .class files.

The next section contains additional information related to the second and third options.

Configuring your System to Run Java Applications

To run the Java console application JDocViewerApp included with JSite and JDoc packages you must have the Java Developers Kit 1.0.2 installed on your computer and configured properly.

If you do not already have Java installed you must first download it (free) from Sun's website at http://java.sun.com/products/jdk/1.0.2/ and follow the installation directions. It will typically install into a directory such as C:\Program Files\Java, which we will assume here for illustration purposes.

Next, your system's environment settings must indicate where to look for java.exe. To accomplish this, insure that the clause

;C:\Program Files\Java\bin

appears in the system's Path variable. Select Start|Settings|Control Panel and double-click the System icon. Select the Environment tab and click on the Path item in the listbox. If necessary, you can now edit the path variable to append the above code. Click Set. Make sure that you do not otherwise change the existing Path settings.

Finally, before closing this dialog, you must also set the environment's CLASSPATH variable to point to the locations of EarthStones' class files by adding the clause

;C:\Program Files\EarthStones\classes

to any code that may already be present. Click Set and Close or Apply.

If you have done all of this correctly, your system will now look for java.exe in the directory C:\Program Files\Java\bin and java.exe will look for an application class file such as JDocViewerApp.class in the directory C:\Program Files\EarthStones\classes\earthstones.

Setting up JDoc/JSite on your Web Server

Class files which are not part of Sun's core Java API are typically not available on a web server and must be supplied by the web developer. To make EarthStones' class library accessible to your web server, the contents of the EarthStones\classes subdirectory (which currently contains earthstones and symantec subdirectories) must be copied to the server directory referenced by the codebase attribute of the <applet> tag. (See Deploying JDoc/Getting Started: Rendering HTML in product documentation for discussion of <applet> tag attributes code and codebase.)

For example, if the <applet> tag includes the attribute assignment codebase="java", the contents of the EarthStones\classes subdirectory (typically subdirectories named earthstones and symantec) must be copied to the server's java subdirectory. Note that all subdirectory and file names must be copied exactly (i.e., same case) because most web servers use case-sensitive file systems.

Setup Troubleshooting

The following notes may help you fix or avoid some common (and not-so-common) problems: