Extension:Jmol

Jmol extension is an extension for allowing inclusion of Jmol applets inside MediaWiki articles.

Current documentation can be found on the Jmol wiki.

Usage
The Jmol extension can be used in several ways:
 * directly in the media pages of molecular files,
 * as a "custom tag" to display a molecule in 3d in-line (or in a popup window) on a wiki page.

Media pages
Not yet implemented

Tag &lt;jmolFile&gt;
The &lt;jmolFile&gt; tag can be used to display in 3d a molecule file that has been previously uploaded into Wikipedia. Some examples of its usage are available in the Jmol wiki.

A few examples:
 *  Chair.cml  will add a link named Chair.cml to the article. When this link is clicked on, a popup window is displayed containing a Jmol applet with the molecular file File:Chair.cml.
 *  Chair.cml  will add a link named Chair to the article. When this link is clicked on, a popup window is displayed containing a Jmol applet with the molecular file File:Chair.cml.

The following attributes are available for the &lt;jmolFile&gt;</tt> tag:
 * text: To configure the text used for the link. By default, the file name is used for the link.

Installing Jmol extension
Note: The latest version of the Jmol extension has been tested against MediaWiki 1.16. It probably works also with some earlier versions but this has not been tested.

To install the Jmol extension:
 * Create a Jmol</tt> folder in the extensions</tt> folder of your MediaWiki installation.
 * Download the latest stable release of Jmol (or the latest development release).
 * Extract into the Jmol</tt> folder the following files from the Jmol release :
 * all the *.txt</tt> files,
 * the Jmol.js</tt> file,
 * all the JmolApplet0*.jar</tt>,
 * all the JmolAppletSigned0*.jar</tt> files.
 * Download all the source files of the Jmol extension and place them in the Jmol</tt> folder.
 * Add the following line to your LocalSettings.php file (near the end):

Note: This description needs to be completed, especially for managing file uploads.

Configuration
There are some options you can specify in your LocalSettings.php file (after the line you've already added): Note: This list is not complete.
 * wgJmolAuthorizeJmolTag: Authorize the use of the  </tt> tag. Default is true</tt>.
 * wgJmolAuthorizeJmolFileTag: Authorize the use of the  <jmolFile/> </tt> tag. Default is true</tt>.

Options in LocalSettings.php have no effect

 * Make sure you specify the options after including the extension.

Weblinks

 * Jmol official web site
 * Jmol official Wiki
 * Browse extension source code
 * Extension documentation in Jmol Wiki