Difference between revisions of "Scripting environment setup"
From Freeplane - free mind mapping and knowledge management software
| Line 2: | Line 2: | ||
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: | 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: | ||
| + | |||
| + | ==Installations== | ||
* 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 [http://www.eclipse.org/downloads/packages Eclipse download page]. | * 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 [http://www.eclipse.org/downloads/packages Eclipse download page]. | ||
| Line 8: | Line 10: | ||
* [http://groovy.codehaus.org/Eclipse+Plugin Install the Groovy-Eclipse plugin]. | * [http://groovy.codehaus.org/Eclipse+Plugin Install the Groovy-Eclipse plugin]. | ||
* Close Eclipse | * Close Eclipse | ||
| + | |||
| + | ==Setup workspace== | ||
* Copy existing Freeplane scripts to workspace (if you have some): | * Copy existing Freeplane scripts to workspace (if you have some): | ||
cp -R ~/.freeplane/1.2.x/scripts/ ~/freeplanescripts | cp -R ~/.freeplane/1.2.x/scripts/ ~/freeplanescripts | ||
| Line 18: | Line 22: | ||
tar -xzvf freeplane_src-1.2.13.tar.gz | tar -xzvf freeplane_src-1.2.13.tar.gz | ||
mv freeplane-1.2.13 freeplane_src | mv freeplane-1.2.13 freeplane_src | ||
| + | |||
| + | ==Create projects== | ||
* Create a Java Project for the Freeplane binaries: | * Create a Java Project for the Freeplane binaries: | ||
[[File:Eclipse-create-project-freeplane_bin-0.png]] | [[File:Eclipse-create-project-freeplane_bin-0.png]] | ||
| Line 27: | Line 33: | ||
[[File:Eclipse-create-project-scripts-2.png]] | [[File:Eclipse-create-project-scripts-2.png]] | ||
[[File:Eclipse-create-project-scripts-3.png]] | [[File:Eclipse-create-project-scripts-3.png]] | ||
| + | |||
| + | ==Using Eclipse== | ||
* Edit scripts | * Edit scripts | ||
[[File:Eclipse-edit-script.png]] | [[File:Eclipse-edit-script.png]] | ||
| − | + | ===Magic keys=== | |
| + | * ALT+Space | ||
| + | ** Initiates content assist, completes typed texts. | ||
| + | ** Import declarations for completed types are automatically added. | ||
| + | ** Example: type "str" (without the quotes) and hit ALT space. | ||
| + | * F3 | ||
| + | ** Navigates to the definition of the variable/class under the cursor. | ||
| + | ** This also works for Java and Freeplane classes - allowes to lookup details of the class. | ||
| + | * ALT+Cursor_Left | ||
| + | ** Navigates to the last remembered location. | ||
| + | * Shift+Ctrl+T | ||
| + | ** Open a type (e.g. a class or interface). | ||
| + | ** Try entering "proxy" and select the Proxy from org.freeplane.plugin.script.proxy | ||
| + | ** Proxy is the API definition. | ||
| + | * Shift+Ctrl+R | ||
| + | ** Use this to open a script. | ||
[[Category:Script]] | [[Category:Script]] | ||
Revision as of 07:30, 29 March 2012
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:
Installations
- 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
- Install the Groovy-Eclipse plugin.
- Close Eclipse
Setup workspace
- Copy existing Freeplane scripts to workspace (if you have some):
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 projects
- Create a Java Project for the Freeplane binaries:
- Create a Groovy Project for the scripts (even if you have none):
Using Eclipse
- Edit scripts
Magic keys
- ALT+Space
- Initiates content assist, completes typed texts.
- Import declarations for completed types are automatically added.
- Example: type "str" (without the quotes) and hit ALT space.
- F3
- Navigates to the definition of the variable/class under the cursor.
- This also works for Java and Freeplane classes - allowes to lookup details of the class.
- ALT+Cursor_Left
- Navigates to the last remembered location.
- Shift+Ctrl+T
- Open a type (e.g. a class or interface).
- Try entering "proxy" and select the Proxy from org.freeplane.plugin.script.proxy
- Proxy is the API definition.
- Shift+Ctrl+R
- Use this to open a script.
