Difference between revisions of "Files Description"
AngelHerraez (talk | contribs) (→Jmol.js) |
AngelHerraez (talk | contribs) (→A description of each file included in Jmol distribution) |
||
| Line 4: | Line 4: | ||
=== A description of each file included in Jmol distribution === | === A description of each file included in Jmol distribution === | ||
| + | (This refers to both {{File|jmol-x.x.x-binary.zip}} and | ||
| + | {{File|jmol-x.x.x-binary.tar.gz}} | ||
| + | <br> | ||
| + | {{File|jmol-x.x.x-full.tar.gz}} contains the full source code) | ||
| + | ) | ||
==== Jmol.jar ==== | ==== Jmol.jar ==== | ||
| Line 64: | Line 69: | ||
==== README.txt ==== | ==== README.txt ==== | ||
| − | A general description of Jmol package and sources of information | + | A general description of Jmol package and sources of information, including this file list documentation. |
| − | |||
=== 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 19:19, 26 October 2006
This page intends to compile some documentation to be included in Jmol distribution 
README file.
Please, add or ammend according to your knowledge.
Contents
- 1 A description of each file included in Jmol distribution
- 1.1 Jmol.jar
- 1.2 JmolApplet.jar
- 1.3 JmolApplet0.jar, JmolApplet1.jar, ... JmolApplet6.jar, JmolApplet_i18n.jar
- 1.4 JmolAppletSigned.jar
- 1.5 JmolAppletSigned0.jar, JmolAppletSigned1.jar, ... JmolAppletSigned6.jar, JmolAppletSigned_i18n.jar
- 1.6 Jmol.js
- 1.7 jmol
- 1.8 jmol.bat
- 1.9 jmol.mac
- 1.10 jmol.sh
- 1.11 COPYRIGHT.txt
- 1.12 LICENSE.txt
- 1.13 README.txt
- 2 Notes
A description of each file included in Jmol distribution
(This refers to both jmol-x.x.x-binary.zip and
jmol-x.x.x-binary.tar.gz
jmol-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 (JmolApplet0.jar etc.). In particular, Jmol.js uses the split version.
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 JmolApplet.jar. This split version is used by Jmol.js.
JmolApplet_i18n.jar is the localization module of the applet (i.e., translation of the interface into several languages).
This must accompany the JmolApplet#.jar set if you want the interface in a language different from English. (The language shown will depend on the operating system's language.)
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.
JmolAppletSigned0.jar, JmolAppletSigned1.jar, ... JmolAppletSigned6.jar, JmolAppletSigned_i18n.jar
The signed version of the split applet.
Jmol.js
The javascript library 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.sourceforge.net/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.
Notes
- Given the descriptions, you will realize that the distribution package contains 4 full copies of the applet (signed or unsigned, split or not).
