Scripting: Other languages
Installation of other languages
To install a new language you only have to install all required JAR (.jar) files in <freeplane-user-dir>/lib. Alternatively include JARs from other local folders by extending Freeplane's script classpath. Which JARs you need should be mentioned in the documentation of the language or in documentation of the JSR 223 adapter if is not part of the standard language distribution. Depending on the implementation/quality of the existing JSR 223 adpters problems might occur. If you get another language working please add a section here with a description what you had to do.
Here a step-by-step instruction to install Jython, the Python implementation that runs on the JVM:
- Download the all-in-one Jython-JAR, e.g. from maven central. It contains not only the language and all necessary libraries but also the JSR 223 adapter.
- Add this
libdirectory to the script class path, so the .jar will be found. You may simply add
lib, as relative paths are considered relative to the Freeplane user directory.
- Create the following test script as
<freeplane-user-dir>/scripts/testJython.py(suffix ".py" is mandatory)
- Restart Freeplane, so the script appears in the menu.
c.statusInfo = "Jython's here: Node's text is " + node.text
Hints for scripting Freeplane in Python/Jython can be found on page Scripting: Jython.
Groovy is the distinguished scripting language for Freeplane and will be most probably always be better supported than other languages. Here are the differences:
- Since most Freeplane scripting happens in Groovy, you will more likely find one to help you with problems in the Freeplane forum.
- Groovy is (so far) the only language to write formulas and filters with.
- The Groovy scripting API is extended by some methods and tweaks (see a separate page):
- Shortcut methods - Simple references to other nodes like ID_1723255651.text
- The script editor only supports Groovy scripts.
A part of this drawbacks could be worked around in the future. It could be made possible for instance to change the language for formulas per map. (If you would like to implement that show up in the Developers forum.)