From 128613c77d99c1eecd3a33a3d644096224f368c2 Mon Sep 17 00:00:00 2001
From: Kenneth Russel <kbrussel@alum.mit.edu>
Date: Mon, 24 Oct 2005 21:46:36 +0000
Subject: Updated JOGL demos to point to new JSR-231 beta web-startable
 binaries on download.java.net. Added XTrans demo to jogl-demos web page.
 Updated text on web pages and added text to Users' Guide on how to perform a
 developers' installation and how to use JOGL from Java Web Start.

git-svn-id: file:///usr/local/projects/SUN/JOGL/git-svn/svn-server-sync/jogl/trunk@403 232f8b59-042b-4e1e-8c03-345bb8c30851
---
 doc/userguide/index.html | 84 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 84 insertions(+)

(limited to 'doc/userguide/index.html')

diff --git a/doc/userguide/index.html b/doc/userguide/index.html
index 6a3e08c75..10136bc0f 100644
--- a/doc/userguide/index.html
+++ b/doc/userguide/index.html
@@ -12,6 +12,11 @@
 <UL>
 
   <LI> Overview
+  <LI> Developing with JOGL
+  <UL>
+    <LI> Local installation for development
+    <LI> Java Web Start integration
+  </UL>
   <LI> Creating a GLDrawable
   <LI> Writing a GLEventListener
   <LI> Using the Composable Pipeline
@@ -75,6 +80,85 @@ GlueGen is forthcoming.
 
 </P>
 
+<H2> Developing with JOGL </H2>
+
+<H3> Local installation for development </H3>
+
+<P>
+
+The JOGL distribution for developers contains two parts: a
+platform-independent JAR file containing the Java classes of the
+library (jogl.jar) and a platform-dependent native library containing
+the associated JNI code which calls OpenGL. 
+
+</P>
+<P>
+
+If you are developing a new application which uses JOGL, download both
+jogl.jar and the appropriate native library jar file (for example,
+jogl-natives-win32.jar). It is recommended to place both of these jar
+files in the same directory. Modify your CLASSPATH environment
+variable to include the full path to jogl.jar; for example,
+".;C:\Some\Other\Package\foo.jar;C:\Users\myhome\jogl\jogl.jar". (If
+you did not previously set the CLASSPATH environment variable, you may
+want to make sure that ".", the current directory, is on your new
+CLASSPATH.) Use the jar command which ships with the JDK to extract
+the native library jar; e.g., "jar xvf jogl-natives-win32.jar". Modify
+your PATH environment variable (Windows), LD_LIBRARY_PATH environment
+variable (Solaris and Linux), or DYLD_LIBRARY_PATH environment
+variable (Mac OS X) to contain the directory holding the new .dll, .so
+or .jnilib files. At this point your Java installation should be able
+to see the JOGL class files. Users of IDEs such as NetBeans and
+Eclipse should consult the IDE's documentation to see how to add jar
+files and native libraries to their current project.
+
+</P>
+<P>
+
+Dropping the JOGL jar and native library into the extension directory
+of the JRE is strongly discouraged. Doing so can cause conflicts with
+third-party applications launched via Java Web Start, and causes
+confusion later when upgrading the distribution.
+
+</P>
+
+<H3> Java Web Start integration </H3>
+
+<P>
+
+The recommended distribution vehicle for applications using JOGL is
+Java Web Start. JOGL-based applications do not even need to be signed;
+all that is necessary is to reference the JOGL extension JNLP file.
+Because the JOGL jar files are signed, an unsigned application can
+reference the signed JOGL library and continue to run inside the
+sandbox.
+
+</P>
+<P>
+
+To reference JOGL within your application's JNLP file, simply place
+the following line in the <code>&lt;resources&gt;</code> section:
+
+<PRE>
+  &lt;extension name="jogl" href="http://download.java.net/media/jogl/builds/archive/jsr-231-current/jogl.jnlp" /&gt;
+</PRE>
+
+This JNLP file points to the current JSR-231 unofficial development
+build; the JNLP file's location will change once the reference
+implementation is complete. The APIs in this release differ
+significantly from the 1.1.1 release of JOGL, which was the last
+pre-JSR release of the JOGL project. It is strongly recommended that
+applications transition to the new APIs, as the implementation is
+generally more robust than the 1.1.1 release and provides new and
+useful functionality. For reference, the stable JOGL 1.1.1 extension
+JNLP file is
+
+<PRE>
+  &lt;extension name="jogl" href="https://jogl.dev.java.net/webstart/jogl-1-1.jnlp" /&gt;
+</PRE>
+
+</P>
+
 <H2> Creating a GLDrawable </H2>
 
 <P>
-- 
cgit v1.2.3