Custom Menus - Revision history

AngelHerraez: ammend link to new location

2025-08-10T18:35:58Z

ammend link to new location

2014-11-12T19:58:40Z

updating popup menu features to 14.3

2014-07-06T11:39:18Z

‎How to load a custom menu

2014-01-29T19:12:15Z

‎How to load a custom menu

2010-10-28T19:04:00Z

fix improper uppercase in Jmol.js functions

2009-01-11T16:26:51Z

‎How to write your own custom menu

2009-01-11T15:41:51Z

‎Part III: Word Translations

2009-01-11T01:35:10Z

‎Special identifiers in this section

2009-01-11T01:25:00Z

‎A note about language translation

2009-01-11T01:16:34Z

update - caveat about bug in previous versions

← Older revision		Revision as of 18:35, 10 August 2025
Line 180:		Line 180:
	An example of custom menu: [[test.mnu]]		An example of custom menu: [[test.mnu]]

−	If you design a new menu, please share it in the [[Recycling_Corner~~#Custom_pop-up_menus~~\|Custom pop-up menus section]] within [[Recycling Corner]].	+	If you design a new menu, please share it in the [[Recycling_Corner/Menus\|Custom pop-up menus section]] within [[Recycling Corner]].

@@ Line 176: / Line 176: @@
 == Examples of menus ==
-Default menu is built using [http://jmol.svn.sourceforge.net/viewvc/jmol/trunk/Jmol/jmol.mnu this file].
+Default menu is built using [{{SVN Trunk}}Jmol/jmol.mnu this file].
 An example of custom menu: [[test.mnu]]
 If you design a new menu, please share it in the [[Recycling_Corner#Custom_pop-up_menus|Custom pop-up menus section]] within [[Recycling Corner]].

@@ Line 13: / Line 13: @@
 as a command-line parameter.
-* To switch to your own menu on the '''applet''' via scripting, use
+* To switch to your own menu in the '''Jmol Object''' via scripting, use
   load menu "myMenu.mnu"
 : To get back the default menu, use an empty string:
   load menu ""
-* To insert the '''applet''' with your own menu:
+* To insert the '''Jmol Object''' with your own menu into a webpage:
-** If you are using Jmol.js to insert the applet, use
+** If you are using [[Jmol JavaScript Object]], the currently recommended method to insert the Jmol Object, include this when [[Jmol_JavaScript_Object/Info|defining the <code>Info</code> variable]]:
   jmolSetCallback("menuFile","myMenu.mnu")
 :: after <code>jmolInitialize()</code> and prior to <code>jmolApplet()</code>.

@@ Line 12: / Line 12: @@
   -m myMenu.mnu
 as a command-line parameter.
 * To insert the '''applet''' with your own menu:
-** If you are using Jmol.js (recommended) to insert the applet, use
+** If you are using Jmol.js to insert the applet, use
   jmolSetCallback("menuFile","myMenu.mnu")
 :: after <code>jmolInitialize()</code> and prior to <code>jmolApplet()</code>.
@@ Line 20: / Line 25: @@
   param=menuFile value="myMenu.mnu"
 :: as one of the parameters of the tag.
 == How to check the current menu ==

@@ Line 15: / Line 15: @@
 * To insert the '''applet''' with your own menu:
 ** If you are using Jmol.js (recommended) to insert the applet, use
-  JmolSetCallback("menuFile","myMenu.mnu")
+  jmolSetCallback("menuFile","myMenu.mnu")
-:: after <code>JmolInitialize()</code> and prior to <code>JmolApplet()</code>.
+:: after <code>jmolInitialize()</code> and prior to <code>jmolApplet()</code>.
-:* If you are directly inserting the <code>applet</code> or <code>object</code>  tag, use
+:* If you are directly inserting the <code>applet</code> or <code>object</code> tag (''not a recommended method''), use
   param=menuFile value="myMenu.mnu"
 :: as one of the parameters of the tag.

@@ Line 38: / Line 38: @@
 == How to write your own custom menu ==
-''(Updated as of Jmol version 11.7.21)''
+''(Updated as of Jmol version 11.6.13 and 11.7.21)''
 The menu file (a plain-text file) contains three parts:
@@ Line 45: / Line 45: @@
 # Part II contains all the Jmol scripts that correspond to a menu click.
 # Part III contains additional words that will be translated.
 === Part I: Menu Structure ===

@@ Line 167: / Line 167: @@
 Each definition consists of
   key | label
 == Examples of menus ==

@@ Line 108: / Line 108: @@
 The following options exist as of Jmol 11.3.15:
-* CHARGE    data set includes partial charge information
+* CHARGE    - data set includes partial charge information
-* FRAMES    data set includes multiple frames
+* FRAMES    - data set includes multiple frames
-* PDB       data set is PDB file format information (HETERO, etc.)
+* PDB       - data set is PDB file format information (HETERO, etc.)
-* SYMMETRY  data set includes symmetry information
+* SYMMETRY  - data set includes symmetry information
-* UNITCELL  data set contains a unit cell
+* UNITCELL  - data set contains a unit cell
-* VIBRATION data set includes vibration data
+* VIBRATION - data set includes vibration data
 A key may contain multiple option identifiers.
-In addition, APPLET indicates that this item should
+In addition, APPLET indicates that the item should
-show up only in the Jmol applet menu, not the Jmol application menu
+show up only in the Jmol applet menu, not the Jmol application menu.
 If a key includes a phrase in square brackets, as in
    [color_atoms]Menu | Atoms = schemeMenu - @COLOR - opaque translucent
 then for all menu and submenu items under this menu
 the script given in Part II is '''prepended''' with that phrase, with
-underscore replaced with space. For example,
+underscore replaced with space. For example, the last two menu entries in the previous example will invoke these commands:
 === Part II: Key Definitions ===

@@ Line 81: / Line 81: @@
 The way translation works is that a code preprocessor identifies text that
-in the CODE is written as GT._("...."). This is called *internationalization*,
+in the code is written as <code>GT._("....")</code>. This is called ''internationalization'',
 and it occurs when the Jmol distribution is built.
@@ Line 87: / Line 87: @@
 the selected language is looked up. If that phrase has been translated into
 that particular language by a human volunteer, then the translated phrase is
-returned. This is called *localization*.
+returned. This is called ''localization''.
 All menu labels will be sent through the GT._() method. If you change a menu label to

@@ Line 2: / Line 2: @@
 : ''NOTE:''
+:
-: If you find trouble trying to use this feature, make sure to update to Jmol version 11.7.21 or later; there are bugs in the localization of custom pop-up menus in previous versions.
+: If you find trouble trying to use this feature, make sure to update Jmol version to at least 11.6.13 or 11.7.21; there are bugs in the localization of custom pop-up menus in previous versions.
 Starting on v. 11.3.15, Jmol (both application and applet) allows a customized pop-up menu instead of the standard default menu.