Scripting environment setup

From Freeplane - free mind mapping and knowledge management software
Revision as of 23:36, 28 March 2012 by Boercher (talk | contribs)

Modern Integrated Development Environments like Eclipse or Idea make it much easier to edit Groovy scripts for Freeplane as in a normal text editor. Syntax highlighting, code completion, error detection, debugging and source navigation are extremely useful especially if you are not that experienced.

But it's more or less difficult for beginners to setup an IDE properly for Groovy scripting, so here's a step-by-step guide:

  • Download and install a "Eclipse IDE for Java Developers" or "Eclipse for RCP and RAP Developers" (the latter is more useful for regular Freeplane developers) from Eclipse download page.
  • Launch Eclipse for the first time and select some directory as your workspace root

Eclipse-select-workspace.png

   cp -R ~/.freeplane/1.2.x/scripts/ ~/freeplanescripts
  • Download current Freeplane binary distribution and unpack it into the workspace, and rename directory:
   cd ~/freeplanescripts
   unzip freeplane_bin-1.2.13.zip
   mv freeplane-1.2.13 freeplane_bin
  • Download matching Freeplane source distribution and unpack it into the workspace and rename directory:
   cd ~/freeplanescripts
   tar -xzvf freeplane_src-1.2.13.tar.gz
   mv freeplane-1.2.13 freeplane_src
  • Create a Java Project for the Freeplane binaries:

Eclipse-create-project-freeplane bin-0.png Eclipse-create-project-freeplane bin-1.png Eclipse-create-project-freeplane bin-2.png

  • Create a Groovy Project for the scripts (even if you have none):

Eclipse-create-project-scripts-0.png Eclipse-create-project-scripts-1.png Eclipse-create-project-scripts-2.png Eclipse-create-project-scripts-3.png

  • Edit scripts

Eclipse-edit-script.png

FIXME: add tutorials for using Eclipse!