Difference between revisions of "Files Description/Jmol 14"

From Jmol
Jump to navigation Jump to search
(Jmol.js)
(Split applet files after 11.1.36)
Line 76: Line 76:
 
=== Files specific to Jmol versions after 11.1.36 ===
 
=== Files specific to Jmol versions after 11.1.36 ===
  
==== JmolApplet0.jar, JmolApplet0(severalNamesHere).jar ====
+
==== JmolApplet0.jar, JmolApplet0''(severalNamesHere)''.jar ====
  
...
+
The applet is divided up into several pieces according to their
 +
function, so that if a page does not require a component, that
 +
component is not downloaded from the server.  
 +
It is still recommended that you put all JmolApplet0*.jar
 +
files on your server even if your page does not use the capabilities
 +
provided by some of the files, because the pop-up menu and Jmol console
 +
both allow users to access parts of Jmol you might not have considered.
  
==== JmolAppletSigned0.jar, JmolAppletSigned0(severalNamesHere).jar ====
+
The set of these files is equivalent to {{File|JmolApplet.jar}}.
  
...
+
This split version is the one that will be used if you use {{File|Jmol.js}}.
 +
To use JmolApplet0*.jar, use the simplest form of jmolInitialize(), just
 +
indicating the directory containing the set of jar files:
 +
jmolInitialize("directory-containing-jar-files")
 +
for example,
 +
jmolInitialize(".")  // jar files are in the same folder as the web page
 +
jmolInitialize("../jmol") // jar files are in a parallel folder, named 'jmol'.
  
 +
==== JmolAppletSigned0.jar, JmolAppletSigned0''(severalNamesHere)''.jar ====
 +
 +
The signed version of the new split applet.
 +
This version allows the user to access files anywhere on a hard drive and from any location on the web.
 +
Typically users get a message asking if they want to accept the
 +
certificate for '''each''' of the 16 loadable files. For this reason,
 +
JmolAppletSigned0*.jar may not be of general use.
 +
 +
To use JmolAppletSigned0*.jar with Jmol.js, use the form:
 +
jmolInitialize("directory-containing-jar-files", true)
 +
or
 +
jmolInitialize("directory-containing-jar-files", "JmolAppletSigned0.jar")
  
 
=== Notes ===
 
=== Notes ===
  
 
# Given the descriptions, you will realize that the distribution package contains 4 full copies of the applet (signed or unsigned, split or not).
 
# Given the descriptions, you will realize that the distribution package contains 4 full copies of the applet (signed or unsigned, split or not).

Revision as of 15:09, 12 May 2007

This information is also included in Jmol distribution File icon.gifREADME file.


Common files in Jmol distributions

(This refers to both File icon.gifjmol-x.x.x-binary.zip and File icon.gifjmol-x.x.x-binary.tar.gz
File icon.gifjmol-x.x.x-full.tar.gz contains the full source code) )

Jmol.jar

The application executable file (a program written in Java). This can be run as any other program: opens in its own window, can be resized or minimized, admits drag-and-drop, has a top menu, can open and save files, etc.

JmolApplet.jar

The applet, i.e. a version of the program that will only run when embedded in a web page.

This is an all-in-one file, kept mainly for compatibility with old pages that call it explicitly. Current recommended procedure is to use the split version (File icon.gifJmolApplet0.jar etc.). In particular, File icon.gifJmol.js uses the split version.

JmolAppletSigned.jar

An equivalent version of the applet, but this is a "signed" applet (a term in Java security language). This means it must be authorized by the web page visitor for it to run, but then it will have less security restrictions for file access. For example, it can access files on any part of the user's hard disk or from any other web server.

Jmol.js

The library, written in javascript language, that assists in the programming of web pages that use Jmol applet, without the need to know and write detailed JmolApplet code.

This library uses the split version of the applet (unsigned or signed).

Fully documented at http://jmol.org/jslibrary/

jmol

????

jmol.bat

A batch file to start Jmol application under Windows.

jmol.mac

???

jmol.sh

A shell script to start Jmol application under Unix-like systems, like Linux/BSD/Solaris and Cygwin for Windows.

COPYRIGHT.txt

The copyright explanations.

LICENSE.txt

The GNU Lesser General Public License, under which Jmol is released.

README.txt

A general description of Jmol package and sources of information, including this file list documentation.


Files specific to Jmol versions up to 11.1.29

JmolApplet0.jar, JmolApplet1.jar, ... JmolApplet6.jar, JmolApplet_i18n.jar

The applet divided up into several pieces, for faster loading. The set of these files is equivalent to File icon.gifJmolApplet.jar. This split version is used by File icon.gifJmol.js.

File icon.gifJmolApplet_i18n.jar is the localization module of the applet (i.e., translation of the interface into several languages). This must accompany the File icon.gifJmolApplet#.jar set if you want the interface in a language different from English. (The language shown will depend on the operating system's language.)

JmolAppletSigned0.jar, JmolAppletSigned1.jar, ... JmolAppletSigned6.jar, JmolAppletSigned_i18n.jar

The signed version of the split applet.


Files specific to Jmol versions after 11.1.36

JmolApplet0.jar, JmolApplet0(severalNamesHere).jar

The applet is divided up into several pieces according to their function, so that if a page does not require a component, that component is not downloaded from the server. It is still recommended that you put all JmolApplet0*.jar files on your server even if your page does not use the capabilities provided by some of the files, because the pop-up menu and Jmol console both allow users to access parts of Jmol you might not have considered.

The set of these files is equivalent to File icon.gifJmolApplet.jar.

This split version is the one that will be used if you use File icon.gifJmol.js. To use JmolApplet0*.jar, use the simplest form of jmolInitialize(), just indicating the directory containing the set of jar files:

jmolInitialize("directory-containing-jar-files")

for example,

jmolInitialize(".")  // jar files are in the same folder as the web page 
jmolInitialize("../jmol") // jar files are in a parallel folder, named 'jmol'.

JmolAppletSigned0.jar, JmolAppletSigned0(severalNamesHere).jar

The signed version of the new split applet. This version allows the user to access files anywhere on a hard drive and from any location on the web. Typically users get a message asking if they want to accept the certificate for each of the 16 loadable files. For this reason, JmolAppletSigned0*.jar may not be of general use.

To use JmolAppletSigned0*.jar with Jmol.js, use the form:

jmolInitialize("directory-containing-jar-files", true)

or

jmolInitialize("directory-containing-jar-files", "JmolAppletSigned0.jar")

Notes

  1. Given the descriptions, you will realize that the distribution package contains 4 full copies of the applet (signed or unsigned, split or not).