+
+
+
+
+
+
+
+ An add-on may contain multiple scripts. The node text defines the script name (e.g. insertInlineImage.groovy). The name must have a suffix of a supported script language like .groovy or .js and may only consist of letters and digits. The script properties have to be configured via attributes:
+
+
+
+
+
+ * menuLocation: <locationkey>
+
+
+ - Defines the menu location, defaults a sub menu 'main_menu_scripting/addons.${name}'.
+
+
+ - Use developer tool menuItemInfo to inspect menu location keys.
+
+
+ - This attribute is mandatory
+
+
+
+
+
+ * menuTitleKey: <key>
+
+
+ - The menu item title will be looked up under the translation key <key> - don't forget to define its translation.
+
+
+ - This attribute is mandatory
+
+
+
+
+
+ * executionMode: <mode>
+
+
+ - The execution mode as described in the Freeplane wiki (http://freeplane.sourceforge.net/wiki/index.php/Scripting)
+
+
+ - ON_SINGLE_NODE: Execute the script once. The node variable is set to the selected node.
+
+
+ - ON_SELECTED_NODE: Execute the script n times for n selected nodes, once for each node.
+
+
+ - ON_SELECTED_NODE_RECURSIVELY: Execute the script on every selected node and recursively on all of its children.
+
+
+ - In doubt use ON_SINGLE_NODE.
+
+
+ - This attribute is mandatory
+
+
+
+
+
+ * keyboardShortcut: <shortcut>
+
+
+ - Optional: keyboard combination / accelerator for this script, e.g. control alt I
+
+
+ - Use lowercase letters for modifiers and uppercase for letters. Use no + signs.
+
+
+ - The available key names are listed at http://download.oracle.com/javase/1.4.2/docs/api/java/awt/event/KeyEvent.html#VK_0
+
+
+ In the list only entries with a 'VK_' prefix count. Omit the prefix in the shortcut definition.
+
+
+
+
+
+ * Permissions that the script(s) require, each either false or true:
+
+
+ - execute_scripts_without_asking
+
+
+ - execute_scripts_without_file_restriction: permission to read files
+
+
+ - execute_scripts_without_write_restriction: permission to create/change/delete files
+
+
+ - execute_scripts_without_exec_restriction: permission to execute other programs
+
+
+ - execute_scripts_without_network_restriction: permission to access the network
+
+
+ Notes:
+
+
+ - The set of permissions is fixed.
+
+
+ - Don't change the attribute names, don't omit one.
+
+
+ - Set the values either to true or to false
+
+
+ - In any case set execute_scripts_without_asking to true unless you want to annoy users.
+
+
+
+
+