Scripting

From FreeMind

(Difference between revisions)
Jump to: navigation, search
(expand a bit)
(+security; +some examples)
Line 14: Line 14:
To run a script, use the menu Tools > Evaluate or press Alt + F8. Alternatively, you can run a script from the script editor, using its menu Actions > Run. The Run function of the script editor shows the results of the execution in the pane at the bottom, and it shows error messages there, if any.
To run a script, use the menu Tools > Evaluate or press Alt + F8. Alternatively, you can run a script from the script editor, using its menu Actions > Run. The Run function of the script editor shows the results of the execution in the pane at the bottom, and it shows error messages there, if any.
 +
 +
==Examples==
 +
Some example scripts:
 +
 +
* Set a new text of a node: <code>=12 * 14</code> (A little trick: scripts starting with "=" replace the text of a node with their results.)
 +
* Change the text of a node: <code>c.setNodeText(node, node.getText() + " - appended text")</code>
 +
 +
See also [[Example scripts]].
 +
 +
For another set of examples, see the FreeMind documentation available from the menu Help > Documentation, in particular the section "New features in version 0.9.0" and the subsection "Scripting support".
 +
 +
==Security==
 +
By default, FreeMind scripts are restricted in what they can do on the local computer. The restrictions include those of file operations, network operations and execution of applications. These restrictions can be lifted is user preferences, from the menu Tools > Preferences..., and the section "Scripting".
 +
 +
The available security options for scripting, in the section "Scripting" and subsection "Permissions":
 +
* Permit File Operations
 +
* Permit Network Operations
 +
* Permit to Execute Other Applications
 +
* Trust Signed Scripts
 +
* Optional User Key Alias for Signing
==Implementation==
==Implementation==

Revision as of 09:35, 23 August 2010

FreeMind 0.9.0 beta series has a scripting facility using Groovy.

To find out about it, see FreeMind 0.9.0: The New Features.

Contents

Menu

  • Tools > Evaluate
  • Tools > Script Editor

Keyboard

  • Alt + F8: run a script

Using

New scripts can be created using the script editor, available from the menu Tools > Script Editor. Alternatively, you can plainly create an attribute whose name starts with "script" such as "script2"; such an attribute is understood by FreeMind to be a script.

To run a script, use the menu Tools > Evaluate or press Alt + F8. Alternatively, you can run a script from the script editor, using its menu Actions > Run. The Run function of the script editor shows the results of the execution in the pane at the bottom, and it shows error messages there, if any.

Examples

Some example scripts:

  • Set a new text of a node: =12 * 14 (A little trick: scripts starting with "=" replace the text of a node with their results.)
  • Change the text of a node: c.setNodeText(node, node.getText() + " - appended text")

See also Example scripts.

For another set of examples, see the FreeMind documentation available from the menu Help > Documentation, in particular the section "New features in version 0.9.0" and the subsection "Scripting support".

Security

By default, FreeMind scripts are restricted in what they can do on the local computer. The restrictions include those of file operations, network operations and execution of applications. These restrictions can be lifted is user preferences, from the menu Tools > Preferences..., and the section "Scripting".

The available security options for scripting, in the section "Scripting" and subsection "Permissions":

  • Permit File Operations
  • Permit Network Operations
  • Permit to Execute Other Applications
  • Trust Signed Scripts
  • Optional User Key Alias for Signing

Implementation

Scripts are stored in an attribute whose name reads "script" followed with a numeral, meaning in the attribute of the attribute function, not in the attribute of XML.

The script attributes are probably distinguished from non-script attributes by their starting with "script".

An example of storage in XML:

<node TEXT="hello">
<attribute NAME="script1" VALUE="=node.getNodeLevel() + &quot; &quot; + node.getText()"/>
</node>

See also

Personal tools