View source for MediaWiki

{{Running_Jmol_Sections}}
= Description =

[http://www.mediawiki.org/ MediaWiki] is an open source wiki engine licensed under the [http://www.gnu.org/copyleft/gpl.html GNU General Public License]. It is used by [[metawikipedia:Sites_using_MediaWiki|many websites]], including this one.

The Jmol Mediawiki Extension enables the use of the Jmol applet inside of Mediawiki pages.

'''Current version: 4.2_2.0''', compatible with JSmol
(You can check which version a Wiki is using by going to the <code>[[Special:Version]]</code> page in that Wiki.

:Note that documentation in this page is obsolete; while it gets updated, you can check documentation for the 4.x version at this [http://proteopedia.org/w/User:Jaime_Prilusky/JSmolExtension Proteopedia page]

'''Current status:''' 
* The Jmol Mediawiki Extension is now using JSmol (in HTML5 modality by default, but also compatible with Java modality)
* Security is hopefully correct now. The delay effect can be obtained by using [[MediaWiki#Jmol_applet_in_a_popup_window | Jmol applet in a popup window]].
* The Jmol Mediawiki Extension is fully functional and stabilized. It currently needs to be modified for a few things: better security, ability to delay loading the applet.

= Wikis using the Jmol Extension =

If you know a Wiki using the Jmol MediaWiki Extension, please add it to the list of [[Wikis_Using_Jmol |Wikis using Jmol]].

= How to use the Jmol Extension =

Once the Jmol Extension is installed in the Wiki, you can start adding Jmol applets and controls.

How to know if the Extension is installed, and which version it is? Visit the <code>Special:Version</code> page in your wiki; the extension should be listed there.

[[MediaWiki/ExtensionV3|How to use version 3 of the Jmol Extension]]

[[MediaWiki/ExtensionV4|How to use version 4 of the Jmol Extension]]

= Installation =
(''This must be done by the wiki administrator.'')

The files forming the Jmol Extension are part of the Jmol source code and may hence be retrieved from [{{SVN Trunk}}Jmol-extensions/wiki/MediaWiki/ the SVN system].

Installation of the Jmol extension is now described on [[:mw:Extension:Jmol#Installing Jmol Extension|the Jmol extension page on MediaWiki]].

You can configure the Jmol extension with several settings added after the above line (default value in '''bold'''):
* <tt>$wgJmolAuthorizeChoosingSignedApplet</tt> (<tt>true</tt>, '''<tt>false</tt>''') : Authorize users to choose between the unsigned and the signed Jmol applet.
* <tt>$wgJmolAuthorizeUploadedFile</tt> ('''<tt>true</tt>''', <tt>false</tt>) : Authorize the use of {{Tag|uploadedFileContents}}.
* <tt>$wgJmolAuthorizeUrl</tt> (<tt>true</tt>, '''<tt>false</tt>''') : Authorize the use of {{Tag|urlContents}}.
* <tt>$wgJmolDefaultAppletSize</tt> ('''<tt>400</tt>''') : Size in pixels of the Jmol applet.
* <tt>$wgJmolDefaultScript</tt> : Default script.
* <tt>$wgJmolExtensionPath ('''extensions/Jmol''')</tt> : Path to the directory where the Jmol extension is installed. This must be an absolute path, therefore if you customize it, make sure it is prepended with <tt>$wgScriptPath</tt> (see example in Jmol.php).
* <tt>$wgJmolForceNameSpace</tt> : Force the NameSpace where the applet will go looking for wiki pages containing molecular data (using {{Tag|wikiPageContents}}).
* <tt>$wgJmolShowWarnings</tt> ('''<tt>true</tt>''', <tt>false</tt>) : Display warnings when users try to use disabled features.
* <tt>$wgJmolUsingSignedAppletByDefault</tt> (<tt>true</tt>, '''<tt>false</tt>''') : Choose if the signed Jmol applet will be used by default. ''Note: the signed Jmol applet is signed with a default certificate. If you want to use the signed Jmol applet in your wiki, I suggest resigning the Jmol applet with your own certificate.''


'''Note:''' If you want to authorize users to upload files containing molecular data (for using the {{Tag|uploadedFileContents}} tag), you need to do the following:
* By default, MediaWiki authorizes the uploading of files whose name ends with a limited number of extensions. For example, if you want to authorize uploading {{File|*.cml}} files, add <tt>$wgFileExtensions[] = 'cml';</tt> in {{File|LocalSettings.php}}.
* You can add an icon in the {{Directory|skins/common/images/icons/}} directory for each extension (for example, {{File|fileicon-cml.png}}). In this wiki, we are using [[:Image:Fileicon_Chemical.png|this image]], which leads to the [[:Category:Molecular_Data|following result]].

== Installation of older versions ==

The Jmol Extension below v. 3.3 uses another extension, [[mw:Extension:StubManager|Stub Manager]], so you first need to install it.

= Problems yet to be solved =

* Having problems with Jmol applets that are placed below the flow of a link, button, or other user interface element in markup. I get what appears to be a Java error when loading an uploaded file. --[[User:Mevans86|Mevans86]] 18:58, 13 October 2010 (UTC)

* Does not work with Media wiki 1.17 (and probably 1.15,1.16).  I think there was a rewrite of mediawiki code and I get:
: Warning: Parameter 1 to Jmol::tag_jmol() expected to be a reference, value given in /var/www/mediawiki/extensions/StubManager/StubManager.php on line 783
: --[[User:Jacksmind|Jacksmind]] 01:00, 10 October 2010 (UTC)
:: Hopefully this is solved with version 3.3 of the Extension, since it no longer depends on StubManager. (Still to be confirmed, but it is working fine with MW 1.16 in this site.) --[[User:AngelHerraez|AngelHerraez]] 12:32, 22 November 2010 (CET)

* The developers at WikiMedia / WikiMedia Commons / Wikipedia apparently advocate the use of a simpler way of inserting Jmol applets, by just linking to the (previously uploaded) model file (as it is done e.g. with images) and having the server decide upon the way to handle it, with something simpler than the current Extension (see [https://bugzilla.wikimedia.org/show_bug.cgi?id=16491 a discussion] about this).
: However, in my opinion rendering of a 3D molecular model clearly calls for something more flexible than a simple, barebone viewer with default settings. Maybe we would have to resort to a simpler extension for Wikipedia and a full one for other wikis?
:: New tags are available since version 3.3 of the extension, which are much more simple to use ({{Tag|jmolFile}}, {{tag|jmolPdb}}, {{tag|jmolSmiles}}), but are currently not flexible. A solution to explore may be the use of HTML templates to give the opporunity to choose between differently configured viewers (with different controls and informations). --[[User:NicolasVervelle|NicolasVervelle]] 22:44, 28 November 2010 (CET)

* An interesting feature would be the server-side automation of the snapshot ability of the Jmol application, so that images are generated into the wiki page as a thumbnail that will link to --or be replaced by-- the applet when the user clicks on the image, or on a link below it (see an [[User:Bduke#How_should_molecules_be_shown_on_Wikipedia | example]] of this idea, though not server-generated).

* I have just upgraded to MediaWiki 1.18.1 and I now have:
:Warning: Parameter 3 to Jmol::jmolPdbTag() expected to be a reference, value given in /var/www/SklogWiki/includesparser/Parser.php  on line 3580
:Any advice? --[[User:SklogWiki|SklogWiki]] 19:31, 31 January 2012 (CET)
 

== Already solved ==
These are left here for reference, as you may still have these problems depending on your version of MediaWiki or your version of the Jmol MediaWiki Extension.

* The installation does not work when the wiki is installed in a non-root folder of the server (e.g.  <nowiki>http://www.myserver.com/mywiki/index.php</nowiki> instead of <nowiki>http://mywiki.myserver.com/index.php</nowiki>). 
: '''Fixed''' (2008-Nov-29) in [http://jmol.svn.sourceforge.net/viewvc/jmol/trunk/Jmol-extensions/wiki/MediaWiki/ revision 10393].

* Using {{Tag|jmolAppletButton}} or {{Tag|jmolAppletlink}} throws an error in Internet Explorer: "Invalid argument", and prevents the pop-up. 
: '''Partially fixed''' (2008-Dec-2) in [http://jmol.svn.sourceforge.net/viewvc/jmol/trunk/Jmol-extensions/wiki/MediaWiki/ revision 10411].
: '''Completely fixed''' (2008-Dec-8) in [http://jmol.svn.sourceforge.net/viewvc/jmol/trunk/Jmol-extensions/wiki/MediaWiki/ revision 10467].

* The scripts associated to checkboxes rendered by {{tag|jmolCheckbox}} have no effect on the applet. 
: '''Fixed''' (2008-Dec-8) in [http://jmol.svn.sourceforge.net/viewvc/jmol/trunk/Jmol-extensions/wiki/MediaWiki/ revision 10467].
:: This was the discussion of the problem:
<div style="border:1px dashed #000099; margin-left:6ex;">
(Bob)  something in {{file|/skins/common/wikibits.js?97}} is disabling checkboxes.<br />
(Nico)  Yes, good catch, thanks a lot. Now, I need to find a way to overcome the behaviour of <code>setupCheckboxShiftClick()</code>. I am going to ask on mediawiki list.<br />
(Bugzilla) [https://bugzilla.wikimedia.org/show_bug.cgi?id=10642 discussion]
</div>
:: The problem was due to a conflict in the <code>onClick</code> event for checkboxes correctly written by the Jmol Extension and a javascript library ({{file|wikibits.js}}) included in MediaWiki. The offending js function is now overwritten by the extension.

* Since Jmol scripting can include a call to javascript commands, the Jmol applet inserted by the Jmol MediaWiki Extension can execute arbitrary javascript added by any user editing the page (see [[User:Ilmari_Karonen/JS_injection_demo | demo]]). This is an unacceptable security hole for some systems such as Wikipedia, and will prevent Jmol from being used there. There is hence a need to implement a "scripting-without-javascript" mode of the applet, i.e. a way to completely disable the <code>javascript</code> command in Jmol scripts run from the MediaWiki Extension. 
: '''Fixed''' (2008-Dec-8) in [http://jmol.svn.sourceforge.net/viewvc/jmol/trunk/Jmol-extensions/wiki/MediaWiki/ revision 10467].
:: No javascript will be executed by Jmol applets inserted by the Extension.

* The signed applet was not being used even when explicitly authorized in the wiki configuration (<code>$wgJmolAuthorizeChoosingSignedApplet=true</code>) and requested for the applet (<code><signed>true</signed></code>). 
: '''Fixed''' (2008-Dec-8) in [http://jmol.svn.sourceforge.net/viewvc/jmol/trunk/Jmol-extensions/wiki/MediaWiki/ revision 10467].
:: Now you can also have both signed and unsigned applets in the same page.

* Inserting applets with models read from php pages fails. The applet is using the {{tag|urlContents}} tag and the url contains the '&' character. 
: '''Fixed''' (2009-Nov-13) in [http://jmol.svn.sourceforge.net/viewvc/jmol/trunk/Jmol-extensions/wiki/MediaWiki/ revision 11738], version 3.2 of the Extension.
:: The '&' is not tolerated by the wikicode. The solution is to use %26 (the wikicode for &) instead of the ampersand(s) in the url, content of the {{tag|urlContents}} tag. The Extension will later filter those %26 codes and convert them to & so that the server correctly provides the model.

= External links =

* Wikipedia: [[wikipedia:Wikipedia:Using Jmol to display molecular models|Using Jmol to display molecular models]]
* Wikipedia: [[wikipedia:Wikipedia:WikiProject Chemistry|WikiProject Chemistry]]
* MediaWiki: [http://www.mediawiki.org/wiki/Extension:Jmol Jmol Extension for MediaWiki]