User:AngelHerraez/Sandbox MW Extension

From Jmol
Jump to navigation Jump to search

Template:Extension

The Jmol extension allows for displaying molecular models in interactive 3D inside wiki pages using JSmol HTML5 objects.

Documentation on its installation and use can be found at the Jmol project pages, as well as at Jmol Wiki, with full details and demonstration examples.

Usage

The Jmol extension can be used as a "custom tag" to display a 3D interactive view of a molecule or structure in a wiki page, either:

  • in a popup window, upon user action
  • in-line, inserted in the page as the page is loaded
  • in-line, inserted in the page upon user action

<jmolFile>

The <jmolFile> tag can be used to display in 3D a molecule or structure file that has been previously uploaded into a Wiki.

This tag may be disabled by administrators in the configuration file of the wiki, using $wgJmolAuthorizeJmolFileTag = false

A few examples:

  • <source lang=html inline>Chair.cml</source> will put in the article a Chair.cml link. When users click on it, a popup window will display the 3D structure specified in File:Chair.cml.
  • <source lang=html inline>chair conformation</source> will put in the article a chair conformation link. When this link is clicked on, a popup window will display the 3D structure specified in File:Chair.cml.

<jmolSmiles>

The <jmolSmiles> tag can be used to display in 3D a molecule file using its SMILES notation.

This tag may be disabled by administrators in the configuration file of the wiki, using $wgJmolAuthorizeJmolSmilesTag = false

A few examples:

  • <source lang=html inline>CCCNC</source> will put in the article a CCCNC link. When users click on it, a popup window will display the 3D structure that matches the SMILES string CCCNC.
  • <source lang=html inline>smiles notation</source> will put in the article a smiles notation link. When this link is clicked on, a popup window will display the 3D structure that matches the SMILES string CCCNC.

<jmolPdb>

The <jmolPdb> tag can be used to display in 3D a molecule file using its PDB code.

This tag may be disabled by administrators in the configuration file of the wiki, using $wgJmolAuthorizeJmolPdbTag = false

A few examples:

  • <source lang=html inline>1ALE</source> will put in the article a 1ALE link. When users click on it, a popup window will display the 3D structure matching the PDB code 1ALE.
  • <source lang=html inline>Partial structure of Apo-C-I</source> will put in the article a Partial structure of Apo-C-I link. When this link is clicked on, a popup window will display the 3D structure matching the PDB code 1ALE.

<jmol>

The <jmol> tag can be used to display in 3D a molecule or structure file in several situations. Its use is more complex than the other tags, but also more flexible. It takes embedded sub-tags (2nd and 3rd level). Documentation is available in the Jmol project pages or in the Extension page at the Jmol Wiki.

This tag may be disabled by administrators in the configuration file of the wiki, using $wgJmolAuthorizeJmolTag = false


Installing Jmol extension

Note: Version 6 of the Jmol Extension has been tested against MediaWiki 1.39-1.43. For older installations of MediaWiki you may use previous versions of the Extension.

To install the Jmol extension in your wiki, follow instructions at the Jmol project pages

Wikis using the Jmol extension

If you know a wiki using the Jmol extension, please add it to the list of Wikis using Jmol or report it at the Jmol-users e-mail list.

Troubleshooting

Please address any queries to the Jmol-developers e-mail list


Weblinks

[[Category:3D extensions{{#translation:}}]]

Contributors

AngelHerraez

Retrieved from "https://wiki.jmol.org/index.php?title=User:AngelHerraez/Sandbox_MW_Extension&oldid=10356"