Difference between revisions of "MediaWiki/Tags for Controls"

From Jmol
Jump to navigation Jump to search
(more verbose with examples)
Line 1: Line 1:
 
= Tags in the Jmol Extension for MediaWiki that will include controls to act on models =
 
= Tags in the Jmol Extension for MediaWiki that will include controls to act on models =
 +
 +
<div style="position:fixed;right:1em;">
 +
<jmol>
 +
  <jmolApplet>
 +
    <title>A model to test action of the controls below</title>
 +
    <size>260</size>
 +
    <uploadedFileContents> Chair.cml </uploadedFileContents>
 +
    <frame> true </frame>
 +
    <color>papayaWhip</color>
 +
  </jmolApplet>
 +
</jmol>
 +
</div>
  
 
All these tags will insert controls in the page at the same time the page is being loaded.
 
All these tags will insert controls in the page at the same time the page is being loaded.
Line 5: Line 17:
  
 
These tags must be surrounded by a <code>&lt;jmol&gt; &lt;/jmol&gt;</code> tag pair and will act on a model created by a <code>jmolApplet</code> subtag.
 
These tags must be surrounded by a <code>&lt;jmol&gt; &lt;/jmol&gt;</code> tag pair and will act on a model created by a <code>jmolApplet</code> subtag.
 +
 +
Several 2nd-level subtags maybe enclosed in a single <code>&lt;jmol&gt; &lt;/jmol&gt;</code> tag pair, but no line breaks will be offered.
  
 
'''Important:''' the content of the <code>target</code> subtag must match the content of the <code>name</code> subtag of the <code>jmolApplet</code> on which the action is desired.
 
'''Important:''' the content of the <code>target</code> subtag must match the content of the <code>name</code> subtag of the <code>jmolApplet</code> on which the action is desired.
Line 38: Line 52:
 
|}
 
|}
 
Note: initial spaces are '''not''' allowed in some of the subtag contents.
 
Note: initial spaces are '''not''' allowed in some of the subtag contents.
 
<jmol>
 
  <jmolLink>
 
  <text>spacefill</text>
 
  <script>spacefill on;</script>
 
  </jmolLink>
 
</jmol>
 
  
 
== jmolCheckbox ==
 
== jmolCheckbox ==

Revision as of 18:29, 22 April 2024

Tags in the Jmol Extension for MediaWiki that will include controls to act on models

A model to test action of the controls below

All these tags will insert controls in the page at the same time the page is being loaded. The controls allow the user to apply a script, included in the tag, to the model displayed in a JSmol panel.

These tags must be surrounded by a <jmol> </jmol> tag pair and will act on a model created by a jmolApplet subtag.

Several 2nd-level subtags maybe enclosed in a single <jmol> </jmol> tag pair, but no line breaks will be offered.

Important: the content of the target subtag must match the content of the name subtag of the jmolApplet on which the action is desired.

Many of the 3rd and 4th-level subtags are optional and will take default values based on the sibling subtags (e.g. text defaults to the first characters of script).

jmolButton

Will include as 3rd-level subtags target, text, script

jmolLink

Will include as 3rd-level subtags target, text, script

Example code: Renders:
<jmol>
 <jmolLink>
  <text>spacefill</text>
  <script>spacefill on;</script> 
 </jmolLink> 
</jmol> 

Note: initial spaces are not allowed in some of the subtag contents.

jmolCheckbox

Will include as 3rd-level subtags target, text, scriptWhenChecked, scriptWhenUnchecked, checked

jmolMenu

Will include as 3rd-level subtags target, menuheight and several item's

Each item subtag will include 4th-level subtags: text, script and, only in one of them, checked

jmolRadioGroup

Will include as 3rd-level subtags target, vertical and several item's

Each item subtag will include 4th-level subtags: text, script and, only in one of them, checked


<< Back to the index page of the Extension.

Contributors

AngelHerraez