Fix JOGL Deployment doc

author: Sven Gothel <[email protected]> 2010-05-14 14:37:51 +0200
committer: Sven Gothel <[email protected]> 2010-05-14 14:37:51 +0200
commit: 03ce683b4e25716a0973aa6c1acb8698dbb3bb08 (patch)
tree: 167a61de48febcf195e0060a028a4e09ce4b5001
parent: 8ae3ba82b01382564525c4a7aa030bbf7d98c09a (diff)
4 files changed, 287 insertions, 160 deletions
diff --git a/doc/deployment/JOGL-DEPLOYMENT.html b/doc/deployment/JOGL-DEPLOYMENT.html
new file mode 100644
index 000000000..3c9eb7bf4
--- /dev/null
+++ b/doc/deployment/JOGL-DEPLOYMENT.html
@@ -0,0 +1,285 @@
+<!DOCTYPE html PUBliC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+    <head>
+        <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+        <link href="../../../style.css" rel="stylesheet" type="text/css"/>
+        <title>JOGL JAR Bundeling</title>
+    </head>
+    <body>
+        <div id="container">
+            <div id="header">
+                <div id="slogan">.. bundle .. deploy</div>
+                <div id="logo"><a href="http://jogamp.org/">JOGL JAR Bundeling</a></div>
+            </div>
+            <div id="menu">
+                <ul>
+                    <li><a href="http://jogamp.org/">Home</a></li>
+                    <li><a href="../../../gluegen/www/">Gluegen</a></li>
+                    <li><a href="../../../joal/www/">JOAL</a></li>
+                    <li><a href="../../../jocl/www/">JOCL</a></li>
+                    <li><a href="../../../jogl/www/">JOGL</a></li>
+                    <li><a href="../../../demos/www/">Demos</a></li>
+                    <li><a href="../../../wiki/">Wiki</a></li>
+                    <li><a href="../../../deployment/jogl-next/javadoc_public/">JavaDoc</a></li>
+                </ul>
+            </div>
+            <div id="main" class="fill">
+
+
+<h1>JNLP Deployment</h1>
+
+Supported JNLP bases are:
+<ul>
+    <li> Latest <code> http://jogamp.org/deployment/webstart/ </code></li>
+    <li> Next <code> http://jogamp.org/deployment/webstart-next/ </code></li>
+</ul>
+
+<h2>Desktop All in One</h2>
+
+<h3>With AWT and NEWT</h2>
+<p>
+<ul>
+    <li><code>newt-all-awt.jnlp</code><br>
+    <ul>
+        <li><code>jogl-all-awt.jnlp</code><br>
+        <ul>
+            <li><code>gluegen-rt.jnlp</code></li>
+            <li><code>nativewindow-all-awt.jnlp</code></li>
+        </ul></li>
+    </ul></li>
+</ul>
+</p>
+
+<h4>With AWT - Without NEWT</h4>
+<p>
+<ul>
+    <li><code>jogl-all-awt.jnlp</code><br>
+    <ul>
+        <li><code>gluegen-rt.jnlp</code></li>
+        <li><code>nativewindow-all-awt.jnlp</code></li>
+    </ul></li>
+</ul>
+</p>
+<p>
+It loads the JAR files for the <a href="#NativeLibraries">native libraries</a>,<br>
+as well as the other <a href="#AllInOneJARs">All In One JAR files</a> 
+for <a href="#AllInOneJARsAWT">AWT support</a>.
+</p>
+
+<h3>Without AWT</h2>
+
+<p>
+<ul>
+    <li><code>newt-all-noawt.jnlp</code><br>
+    <ul>
+        <li><code>jogl-all-noawt.jnlp</code><br>
+        <ul>
+            <li><code>gluegen-rt.jnlp</code></li>
+            <li><code>nativewindow.jnlp</code></li>
+        </ul></li>
+    </ul></li>
+</ul>
+</p>
+
+<p>
+It loads the JAR files for the <a href="#NativeLibraries">native libraries</a>,<br>
+as well as the other <a href="#AllInOneJARs">All In One JAR files</a> 
+for <a href="#AllInOneJARsNoAWT">Without AWT support</a>.
+</p>
+
+
+<h1>Manual Deployment</h1>
+
+<h2><a name="NativeLibraries">Native Libraries</a></h2>
+
+<p>
+Gluegen native libraries:
+<ul>
+    <li>libgluegen-rt.so</li>
+</ul>
+</p>
+
+<p>
+NativeWindow native libraries
+<ul>
+    <li>libnativewindow_awt.so</li>
+    <li>libnativewindow_jvm.so</li>
+    <li>libnativewindow_x11.so</li>
+</ul>
+</p>
+
+<p>
+JOGL native libraries
+<ul>
+    <li>libjogl_desktop.so</li>
+    <li>libjogl_gl2es12.so</li>
+    <li>libjogl_es1.so</li>
+    <li>libjogl_es2.so</li>
+    <li>libjogl_cg.so</li>
+</ul>
+</p>
+
+<p>
+NEWT native libraries
+<ul>
+    <li>libnewt.so</li>
+</ul>
+</p>
+
+<h2><a name="JavaLibraries">Java Libraries (JARs)</a></h2>
+
+<h3><a name="GluegenJAR">Gluegen JAR - Mandatory</a></h3>
+<ul>
+    <li>gluegen-rt.jar</li>
+</ul>
+</p>
+
+<h3><a name="AllInOneJARs">All In One Deployment</a></h3>
+
+<p>
+This might be the best solution
+for desktop (applets and webstart).<br>
+
+It is much faster to download
+a (maybe bigger) file once and cache 
+it for most purposes, than to download
+tens of files where its cache might not 
+be reuseable.<br>
+</p>
+
+<p>
+<a name="AllInOneJARsAWT">With AWT</a>:
+<ul>
+    <li>nativewindow.all.jar</li>
+    <li>jogl.all.jar</li>
+    <li>newt.all.jar (optional - redundant if no NEWT is used)</li>
+</ul>
+</p>
+
+<p>
+<a name="AllInOneJARsNoAWT">Without AWT</a>:
+<ul>
+    <li>nativewindow.all-noawt.jar</li>
+    <li>jogl.all-noawt.jar</li>
+    <li>newt.all-noawt.jar</li>
+</ul>
+</p>
+
+
+<h3>Atomic Deployment </h3>
+
+<p>
+This is a fine tuned solution 
+where every byte counts.<br>
+
+It is also possible to use this 
+strategy as a starting point for
+efficient manual deployment.<br>
+</p>
+
+<h4>Cores</h4>
+<ul>
+    <li>Mandatory:<br>
+    <ul>
+        <li>nativewindow.core.jar</li>
+        <li>jogl.core.jar</li>
+    </ul></li>
+
+    <li>Newt (optional):<br>
+    <ul>
+        <li>newt.core.jar</li>
+        <li>newt.ogl.jar  (to use NEWT with JOGL)</li>
+    </ul></li>
+</ul>
+
+<h4>Platform (mandatory)</h4>
+
+Chose the same platform for all picks :)
+
+<ul>
+    <li>NativeWindow [pick your platfrom, if available]:<br>
+    <ul>
+        <li>nativewindow.os.x11.jar</li>
+    </ul></li>
+
+    <li>Jogl [pick your platform]:<br>
+    <ul>
+        <li>jogl.egl.jar</li>
+        <li>jogl.os.x11.jar</li>
+        <li>jogl.os.win.jar</li>
+        <li>jogl.os.osx.jar</li>
+    </ul></li>
+
+    <li>Newt [pick your platform] (optional):<br>
+    <ul>
+        <li>newt.os.x11.jar</li>
+        <li>newt.os.win.jar</li>
+        <li>newt.os.osx.jar</li>
+    </ul></li>
+</ul>
+
+<h4>OpenGL Profile (mandatory)</h4>
+
+Pick as many as you like, at least 1:
+
+<ul>
+    <li>Embedded Device Profiles<br>
+    <ul>
+        <li>jogl.gles1.jar<br>
+        <ul>
+            <li>jogl.gles1.dbg.jar</li>
+        </ul></li>
+        <li>jogl.gles2.jar<br>
+        <ul>
+        <li>jogl.gles2.dbg.jar</li>
+        </ul></li>
+    </ul></li>
+
+    <li>Desktop Profiles<br>
+    <ul>
+        <li>jogl.gldesktop.jar<br>
+        <ul>
+            <li>jogl.gldesktop.dbg.jar</li>
+        </ul></li>
+        <li>jogl.gl2es12.jar (for desktop ES1/ES2 emulation)</li>
+    </ul></li>
+</ul>
+
+
+<h4>Jogl Toolkits/Misc (optional)</h4>
+<ul>
+    <li>jogl.util.jar</li>
+    <li>jogl.util.gl2.jar</li>
+    <li>jogl.util.fixedfuncemu.jar</li>
+</ul>
+
+
+<h4>AWT (optional) </h4>
+
+<ul>
+    <li> nativewindow.awt.jar</li>
+    <li> jogl.awt.jar</li>
+    <li> jogl.util.awt.jar (if using jogl.util)</li>
+    <li> newt.awt.jar (if using with NEWT)</li>
+</ul>
+
+<h4>GLU (optional) </h4>
+<ul>
+    <li>jogl.glutess.jar</li>
+    <li>jogl.glumipmap.jar</li>
+    <li>jogl.glugl2.jar</li>
+</ul>
+
+
+            </div>
+            <div id="footer">
+                <div id="footer_left">
+                    <span xmlns:dc="http://purl.org/dc/elements/1.1/" property="dc:title">JogAmp.org</span>
+                    by <a xmlns:cc="http://creativecommons.org/ns#" href="http://jogamp.org" property="cc:attributionName" rel="cc:attributionURL">http://jogamp.org</a>
+                    is licensed under a <br/>
+                    <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons Attribution 3.0 License</a>.
+                </div>
+            </div>
+        </div>
+    </body>
+</html>
diff --git a/doc/deployment/JOGL-JAR-BUNDELING.txt b/doc/deployment/JOGL-JAR-BUNDELING.txt
deleted file mode 100644
index cf4edd7a3..000000000
--- a/doc/deployment/JOGL-JAR-BUNDELING.txt
+++ /dev/null
@@ -1,138 +0,0 @@
-
-+++++++++++++++++++++++++++++
-+++ Native Libraries ++++++++
-+++++++++++++++++++++++++++++
-
-Gluegen native libraries
-    libgluegen-rt.so
-
-NativeWindow native libraries
-    libnativewindow_awt.so
-    libnativewindow_jvm.so
-    libnativewindow_x11.so
-
-
-JOGL native libraries
-    libjogl_desktop.so  
-    libjogl_gl2es12.so
-    libjogl_es1.so  
-    libjogl_es2.so  
-    libjogl_cg.so  
-
-NEWT native libraries
-    libnewt.so
-
-+++++++++++++++++++++++++++++
-+++ Gluegen - Mandatory +++++
-+++++++++++++++++++++++++++++
-
-Gluegen JAR - Always
-
-    Core [pick 1]
-        gluegen-rt.jar
-
-+++++++++++++++++++++++++++++
-+++ All In One Deployment +++
-+++++++++++++++++++++++++++++
-
-This might be the best solution
-for desktop (maybe webstart).
-
-It is much faster to download
-a (maybe bigger) file once and cache 
-it for most purposes, than to download
-tens of files where its cache might not 
-be reuseable.
-
-
-With AWT:
-    nativewindow.all.jar
-    jogl.all.jar
-    newt.all.jar (optional, if AWT is used only)
-
-
-Without AWT
-    nativewindow.all-noawt.jar
-    jogl.all-noawt.jar
-    newt.all-noawt.jar
-
-
-+++++++++++++++++++++++++++++
-+++ Atomic Deployment +++++++
-+++++++++++++++++++++++++++++
-
-This is a fine tuned solution 
-where every byte counts.
-
-It is also possible to use this 
-strategy as a starting point for
-efficient manual deployment.
-
-Cores:
-    nativewindow.core.jar
-    jogl.core.jar
-
-    Newt (optional):
-        newt.core.jar
-        newt.ogl.jar  (to use NEWT with JOGL)
-
-
-Platform (x11/win/osx/embedded)
-
-    Chose the same platform for all picks :)
-
-    NativeWindow [pick 0..1]:
-        nativewindow.os.x11.jar
-
-    Jogl [pick 1]:
-        jogl.egl.jar
-        jogl.os.x11.jar
-        jogl.os.win.jar
-        jogl.os.osx.jar
-
-    Newt [pick 0..1] (optional):
-        newt.os.x11.jar
-        newt.os.win.jar
-        newt.os.osx.jar
-
-
-Jogl GL [pick 1..n]
-    jogl.gles1.jar
-    jogl.gles1.dbg.jar
-    jogl.gles2.jar
-    jogl.gles2.dbg.jar
-
-    jogl.gl2es12.jar
-
-    jogl.gl2.jar
-    jogl.gl2.dbg.jar
-
-    jogl.gl3.jar
-    jogl.gl3.dbg.jar
-
-    jogl.gl4.jar
-    jogl.gl4.dbg.jar
-
-
-Jogl Toolkits/Misc [pick n] (optional):
-    jogl.util.jar
-    jogl.util.gl2.jar
-    jogl.util.fixedfuncemu.jar
-
-
-AWT [pick n] (optional):
-    nativewindow.awt.jar
-
-    jogl.awt.jar
-    jogl.util.awt.jar (if using jogl.util)
-
-    newt.awt.jar
-
-GLU [pick n] (optional):
-    jogl.glutess.jar
-    jogl.glumipmap.jar
-    jogl.glugl2.jar
-
-
-
-
diff --git a/doc/userguide/index.html b/doc/userguide/index.html
index 60c9e4323..3d693eb95 100644
--- a/doc/userguide/index.html
+++ b/doc/userguide/index.html
@@ -189,28 +189,7 @@ 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/jsr-231-2.x-webstart/jogl-all-awt.jnlp" /&gt;
-</PRE>
-
-This JNLP file points to the current JSR-231 unofficial development
-build. For reference, the extension JNLP file for the most recent
-official JSR-231 build is available at
-
-<PRE>
-  &lt;extension name="jogl" href="http://download.java.net/media/jogl/builds/archive/jsr-231-1.1.1/webstart/jogl.jnlp" /&gt;
-</PRE>
-
-Note that before JOGL transitioned to the JSR-231 APIs, there were
-releases of the library in the <code>net.java.games.jogl</code>
-namespace under version numbers "1.0", "1.1", and "1.1.1". All of
-these releases have been superseded by JSR-231. Please update your
-applications.
-
-</P>
+Please read <a href="../deployment/JOGL-DEPLOYMENT.html">JOGL Deployment</a>.
 
 <H3> Applet support </H3>
 
diff --git a/www/index.html b/www/index.html
index 00eddca4b..adde20b95 100644
--- a/www/index.html
+++ b/www/index.html
@@ -48,6 +48,7 @@
                                                         It is part of a suite of open-source technologies initiated by the Game Technology Group at Sun Microsystems.  </p>
                                                     <p>Please see the <a href="http://jogamp.org/jogl-demos/www">JOGL demos</a> for illustrations of
                                                         advanced OpenGL techniques now possible with the Java platform.  </p>
+                                                    <p>You might be interesting about <a href="../doc/deployment/JOGL-DEPLOYMENT.html">JOGL Deployment</a>.</p>
 						    <p>Please have a look at the <a href="../../wiki/">Wiki</a>, including:
                             <ul>
                                 <li><a href="../../wiki/index.php/Jogl_Overview">overview</a>,</li>
author	Sven Gothel <[email protected]>	2010-05-14 14:37:51 +0200
committer	Sven Gothel <[email protected]>	2010-05-14 14:37:51 +0200
commit	03ce683b4e25716a0973aa6c1acb8698dbb3bb08 (patch)
tree	167a61de48febcf195e0060a028a4e09ce4b5001
parent	8ae3ba82b01382564525c4a7aa030bbf7d98c09a (diff)