Jmol Applet

From Jmol
Revision as of 09:03, 27 July 2007 by Pimpim (talk | contribs) (added info on jmol.js)
Jump to navigation Jump to search
Running Jmol / JSmol

Jmol Applet

Java applet version of Jmol which allows Jmol to be embedded in web pages (given that viewers have a Java plugin installed). Like with the application, Scripting is available. For some demonstration pages see http://www.jmol.org/demo/. To see the HTML source use your web browser ViewPage Source.

Installing Jmol Applet

Installing Jmol / JSmol

Download Jmol package (either .zip or tar.gz format) and extract/uncompress only the neccessary files to the folder of your choice.

Which are those neccessary files? For basic use, these:

  • File icon.gifJmol.js, this contains a set of scripting commands that are helpful for interacting with Jmol via a web page (functions for buttons, checkboxes, etc. to interact with the applet). For an overview of functions see the (possibly outdated) online documentation or, for the most up-to-date info, just browse the Jmol.js sourcefile.
  • All files whose name starts with File icon.gifJmolApplet0 and ends in File icon.gif.jar
  • If you will distribute your web page files, you should also include the copyright, license and information files: File icon.gifCOPYRIGHT.txt, File icon.gifLICENSE.txt and File icon.gifREADME.txt

To use JmolApplet within local web pages, e.g. on the hard disk or on CD, see Jmol Applet Deployment Local for some precautions needed.

For some specific needs, you must use other files; read the sections below about the signed applet.

Jmol in Wikis

The applet can be embedded in HTML (or XHTML) pages (examples are listed on Websites Using Jmol), but also, with some extra technologies, in Wiki pages (see Jmol Processor).

Unsigned vs. Signed Applet & Data Access

The signed applet can load a molecular model from any http or ftp URL. However, the user will be asked to trust the signed applet. This could be problematic since the publishing authority (jmol.org) "cannot be verified", and the security certificate was issued by a group that is "not trusted" (jmol.org). This is because it would be costly and cumbersome for each version of the applet to be signed by a trusted (commercial) authority.

The unsigned applet displays the molecule without asking the user to trust it. However, it is limited (for security reasons) to loading molecular models from the same http domain (server) that downloads the applet itself. FirstGlance in Jmol uses the unsigned applet by default, but the signed applet will be used when that "Advanced Option" is checked. Thus you can easily see both applets in action. Methods for accessing data files from arbitrary servers are described in some detail at PDB Data File Access Methods.
If you are not running the applet from any server, i.e., you are using a web page residing in a local disk, further security restrictions are applied by Java: molecular models can only be located in the same folder/directory as the applet files or below it; read Jmol Applet Deployment Local.

Tools for Authoring Jmol Web Pages

If you are not comfortable writing html and javascript code or would just like to quickly put together some simple pages look at the program Jmol Web Page Maker. This is a java application that will generate simple interactive Jmol pages using a GUI interface where you can select the data files and and some basic parameters. I wrote version 1.0 of this program.--Gutow 18:13, 18 July 2006 (CEST)

Saving Files from the Applet

Although this isn't obvious, the molecule that is being shown in the applet can be saved to local disk. To do so:

  1. Open applet's menu (right-click, Ctrl+click, or click on bottom-right "Jmol" logo).
  2. Click on topmost entry (name of molecule).
  3. On the submenu that appears, click on bottommost entry (name of file).
  4. Depending on your browser's configuration, the file will be opened in the associated program ("helper application") or you will get an "Open or Save" dialog; choose Save and location in your disk.
Warning: At least in Windows, modern browsers may detect this action as opening a pop-up window, so it's likely that the pop-up blocker will prevent you from seeing the "Open or Save" dialog. Pay attention to messages and options in your browser to allow pop-ups for the current page. (Such messages often appear as yellow bars at the top of the page, warnings in a toolbar, or hints in the status line at the bottom of the browser window.)
Note for Chime users: If you have MDL Chime installed, the molecule will be opened in a browser window using Chime. You just have to use Chime's menu (File > Save molecule as) to save the file to disk.

More user-friendly ways or saving files from JmolApplet are being considered by the developers.

In Jmol v.11, a part of the molecule can be extracted and saved into MOL format. This is not so straightforward as the former, and is described in the "interactive scripting documentation" (see Jmol home page).

The ability to save the state of the molecule (rendering style, coloring, visibility, orientation, etc.) is under development, and already partially implemented in Jmol 11.0. See save state and write state in the Jmol scripting documentation. This will give similar functionality to what can be done in Chime or Rasmol, although due to Java security restrictions, saving to a file is not available for JmolApplet.