Running JDocViewerApp
JDocViewerApp is a Java "console application" deployed in its default configuration by typing the command
java earthstones.JDocViewerApp
at a DOS prompt (e.g., in a DOS window running under Win 95/NT). The command invokes the java console program java.exe and instructs it to open the Java class file JDocViewerApp.class and interpret its Java byte code. For this to work, your system must be configured as described in Installation and Setup.
When the program is invoked in this manner it loads the JDocViewerApp Welcome and Contents document by default.
Setting the Document Source
You are probably running this demo to test-drive JDoc on your own HTML documents. To view any document, type its path into the document source field at the bottom of the program's window and hit the ENTER key.
When specifying a path, keep the following in mind:
Using the Footer Panel's Buttons
JDocViewerApp's footer panel provides two convenient buttons:
Overriding the Default Parameters
For easy deployment, EarthStones' software sets default values for all of its parameters and then provides two methods for resetting these variables:
In either case, parameters are specified using a transparent name=value syntax. (For applets, the syntax is slightly different: <param name=name1 value=value1>.)
The following parameters are the most important in using JDocViewerApp:
Parameter | Default Value | Comments |
contents | contents.htm | The HTML document which will be display at start-up and reloaded by clicking on the footer's Contents button. |
baseDirectory | [various] | The web site's root directory. For applications using EarthStones' class libraries, this parameter is set by default; for example, JDocViewerApp sets the default base directory to C:/Progra~1/EarthStones/. Currently optional for applets (no default value). |
autoLoad | false | When set, website parameters are automatically read from the file Site.web. If autoLoad is set but no Site.web file is found in the base directory, no action is taken. By default, autoLoad is false for JDocViewerApp. |
For example, the command
java
earthstones.JDocViewerApp [cont]
baseDirectory=E:\DataFi~1\public_html [cont] contents=JavaSoftware\Contents\01\Text.htm
sets the base directory to E:\DataFi~1\public_html and loads the file JavaSoftware\Contents\01\Text.htm relative to this directory, making it the program's "contents" document.
The same result can be accomplished by setting autoLoad=true in the command line and including the baseDirectory= and contents= settings in a Site.web file.