Difference between revisions of "FreeplaneJrubyInstaller Addon"

From Freeplane - free mind mapping and knowledge management software
(→‎How to install the FreeplaneJrubyInstaller Addon in Freeplane)
 
(53 intermediate revisions by the same user not shown)
Line 2: Line 2:
  
  
−
=== This page is still a work in progress ===
+
== Introduction ==
  
−
Hi you found this page before its finished.  
+
Freeplane supports groovy (.groovy) and javascript (.js) scripts out-of-the-box.  
  
−
My idea is to finish it and **only then** make an announcement in the forum, and ask to add links to it in the addons wiki page.
+
This addon '''adds support for ruby (.rb) scripts''', enabling you to '''run ruby scripts''' (ex: <code><freeplane-user-dir>/scripts/my_ruby_script.rb</code>) alongside the out-of-the-box .groovy and .js scripts.
  
−
This is to avoid misunderstandings and be able to explain the addon and how to use it with some good explanations.
 
  
−
So, if you got here congratulations, but keep the secret! The addon is already in github, so if you cant wait anylonger knock yourself out :)
 
  
−
PS: This is progressing slow but steadly, at the rythm of my very scarce free time... dont worry though, all the coding is already finished and the addon ready, the last missing piece is to make some extense docs here in this wiki to explain how it works...
+
The addon was made with 2 purposes:
  
 +
* To '''''enable Freeplane to use/run ruby scripts'''''. <br /> To run a ruby script, you first need to '''install the FreeplaneJrubyInstaller-addon'''. <br /> Once the FreeplaneJrubyInstaller-addon is installed, you can then '''use ruby scripts in Freeplane''' <br /> This wiki page shows [[FreeplaneJrubyInstaller_Addon#How_to_install_the_FreeplaneJrubyInstaller-Addon_in_Freeplane|How to install the FreeplaneJrubyInstaller-Addon in Freeplane]] and [[FreeplaneJrubyInstaller_Addon#How_to_use_ruby_scripts_in_Freeplane|How to use ruby scripts in Freeplane ]], in a step-by-step fashion. 
  
−
=== Introduction ===
+
* To '''''be helpfull for non-programmers who want to try first-steps-of-programming with Ruby and make simple Freeplane ruby scripts'''''.  <br /> Ruby is easy to learn, has many tutorials/books written for new programmers, and the RubyLiveDebugger (included in this addon) gives an instant-gratification-labtest for ruby and freeplane scripting ([https://www.youtube.com/watch?v=dy6kDGApaKw#t=08m05s demo video]) <br /> Start by installing the addon as explained in this page, and then switch to the  [[FreeplaneJrubyInstaller_-_developers|FreeplaneJrubyInstaller - developers]] wiki page. Hope you have fun :)
  
−
This addon '''adds support for .rb (ruby) scripts in Freeplane''', so that you can use .groovy .js '''and .rb''' scripts
+
  
  
  
−
Freeplane supports .groovy and .js (javascript) scripts out-of-the-box. This addon adds support for .rb (ruby) scripts, enabling you to use: <code>&lt;freeplane-user-dir&gt;/scripts/my_ruby_script.rb</code> besides .groovy and .js scripts.
 
  
−
Also, after this addon is installed, other future plugins can as well make use of ruby scripts (via the "scripts" node, just like with .groovy scripts)
 
  
 +
== How to install the FreeplaneJrubyInstaller-Addon in Freeplane ==
  
 +
To run a freeplane '''ruby''' script, you first need to '''install the FreeplaneJrubyInstaller-addon''' in Freeplane
  
−
All this is possible because Freeplane was programmed with good design (applause to the devs :) ), using JSR223 that allows external scripting engines to be added, such as the [http://jruby.org/ Jruby interpreter] that is capable of running ruby scripts with access to Java objects (Freeplane-java-objects!).
 
  
−
 
  
−
=== How to install the FreeplaneJrubyInstaller Addon in Freeplane ===
+
To install the addon follow the instructions bellow (click on any image to enlarge it):
  
 
You dont need to manually download anything, all downloads are automatic.  
 
You dont need to manually download anything, all downloads are automatic.  
−
 
−
To install the addon follow these instructions bellow (click on any image to enlarge it):
 
  
  
Line 42: Line 37:
 
[[File:img0.png|frame|400x200px|none|link={{filepath:img0.png}}]]
 
[[File:img0.png|frame|400x200px|none|link={{filepath:img0.png}}]]
  
−
* Copy to your clipboard THE-URL-TO-THE-ADDON: <code>https://raw.githubusercontent.com/zipizap/FreeplaneJrubyInstaller/master/addon_lab/FreeplaneJrubyInstaller-v1.6.addon.mm</code>
+
* Copy to your clipboard THE-URL-TO-THE-ADDON (without any leading/trailing spaces! or it fails):  
 +
 
 +
THE-URL-TO-THE-ADDON: 
 +
 
 +
'''<nowiki>https://raw.githubusercontent.com/zipizap/FreeplaneJrubyInstaller/master/addon_lab/FreeplaneJrubyInstaller-v1.7.0.addon.mm</nowiki>'''
 +
 
 +
'''<small><strike><nowiki>https://raw.githubusercontent.com/zipizap/FreeplaneJrubyInstaller/master/addon_lab/FreeplaneJrubyInstaller-v1.6.2.addon.mm</nowiki></strike></small>'''
 +
 
 +
 
 +
 
 +
 
 +
 
 
* Follow the images:
 
* Follow the images:
  
Line 54: Line 60:
  
 
* Open Freeplane for a second-time, and:
 
* Open Freeplane for a second-time, and:
 +
[[File:img6_2.png|frame|400x200px|none|link={{filepath:img6_2.png}}]]<br />
 +
[[File:img6_3.png|frame|400x200px|none|link={{filepath:img6_3.png}}]]<br />
 +
[[File:img6_4.png|frame|400x200px|none|link={{filepath:img6_4.png}}]]<br />
  
 
[[File:img7.png|frame|400x200px|none|link={{filepath:img7.png}}]]<br />
 
[[File:img7.png|frame|400x200px|none|link={{filepath:img7.png}}]]<br />
Line 66: Line 75:
  
  
−
* The following final window should appear, which indicates that Jruby is now installed in Freeplane. Hurray, the addon is installed!
+
* The following final window should appear, which indicates that the FreeplaneJrubyInstaller-addon is now installed! Hurray!
  
 
[[File:img12.png|frame|400x200px|none|link={{filepath:img12.png}}]]<br />
 
[[File:img12.png|frame|400x200px|none|link={{filepath:img12.png}}]]<br />
 +
 +
==== Youtube demo video: install FreeplaneJrubyInstaller Addon ====
 +
 +
https://youtu.be/sJUWTcPhOk0
 +
 +
 +
 +
 +
 +
==  How to use ruby scripts in Freeplane ==
 +
 +
Once the FreeplaneJrubyInstaller-addon is installed, you can then '''use ruby scripts in Freeplane'''
 +
 +
Lets take as an example, that you have a '''my_ruby_script.rb''' file, that you got from the wiki or the forum or from a friend, and you want to use it in Freeplane.
 +
 +
Do this:
 +
 +
# In Freeplane goto '''Tools/Open user directory''' to open the <code><freeplane-user-dir></code> in a new window
 +
# Inside the new window, open the subdirectory <code>scripts</code>
 +
# Copy/paste the new file into that subdirectory <br /> You should end up with: <code><freeplane-user-dir>/scripts/my_ruby_script.rb</code>
 +
# Freeplane only detects new ruby scripts after a restart. So now close Freeplane.
 +
# Open Freeplane again, and you will see that there is a new entry in the menu '''Tools/Scripts'''/'''''My_Ruby_Script''''' - click on it to run the new ruby script!
 +
 +
You now have the ruby script in freeplane: from now on whenever you want to run this script, just click again '''Tools/Scripts'''/'''''My_Ruby_Script'''''
 +
 +
==== Youtube demo video: how to use ruby scripts in Freeplane ====
 +
 +
https://youtu.be/ExqYF0SLGzI
 +
 +
 +
 +
The first time you run a ruby-script in freeplane, it takes a while to "warm-up" jruby. Since the second and third and xxx times, the script will already run much faster. This also happens (in a lesser degree) with groovy scripts.
 +
 +
NOTE: To remove a script (either ruby or groovy), just delete the script from <code><freeplane-user-dir>/scripts/my_ruby_script.rb</code> and restart Freeplane.

Latest revision as of 21:39, 9 October 2017


Introduction

Freeplane supports groovy (.groovy) and javascript (.js) scripts out-of-the-box.

This addon adds support for ruby (.rb) scripts, enabling you to run ruby scripts (ex: <freeplane-user-dir>/scripts/my_ruby_script.rb) alongside the out-of-the-box .groovy and .js scripts.


The addon was made with 2 purposes:

  • To be helpfull for non-programmers who want to try first-steps-of-programming with Ruby and make simple Freeplane ruby scripts.
    Ruby is easy to learn, has many tutorials/books written for new programmers, and the RubyLiveDebugger (included in this addon) gives an instant-gratification-labtest for ruby and freeplane scripting (demo video)
    Start by installing the addon as explained in this page, and then switch to the FreeplaneJrubyInstaller - developers wiki page. Hope you have fun :)




How to install the FreeplaneJrubyInstaller-Addon in Freeplane

To run a freeplane ruby script, you first need to install the FreeplaneJrubyInstaller-addon in Freeplane


To install the addon follow the instructions bellow (click on any image to enlarge it):

You dont need to manually download anything, all downloads are automatic.


Img0.png
  • Copy to your clipboard THE-URL-TO-THE-ADDON (without any leading/trailing spaces! or it fails):

THE-URL-TO-THE-ADDON:

https://raw.githubusercontent.com/zipizap/FreeplaneJrubyInstaller/master/addon_lab/FreeplaneJrubyInstaller-v1.7.0.addon.mm

https://raw.githubusercontent.com/zipizap/FreeplaneJrubyInstaller/master/addon_lab/FreeplaneJrubyInstaller-v1.6.2.addon.mm



  • Follow the images:
Img1.png


Img2.png


Img3.png


Img4.png


Img5.png


Img6.png



  • Open Freeplane for a second-time, and:
Img6 2.png


Img6 3.png


Img6 4.png


Img7.png


Img8.png


Img9.png


Img10.png



  • Open Freeplane for a third-time, and:
Img11.png



  • The following final window should appear, which indicates that the FreeplaneJrubyInstaller-addon is now installed! Hurray!
Img12.png


Youtube demo video: install FreeplaneJrubyInstaller Addon

https://youtu.be/sJUWTcPhOk0



How to use ruby scripts in Freeplane

Once the FreeplaneJrubyInstaller-addon is installed, you can then use ruby scripts in Freeplane

Lets take as an example, that you have a my_ruby_script.rb file, that you got from the wiki or the forum or from a friend, and you want to use it in Freeplane.

Do this:

  1. In Freeplane goto Tools/Open user directory to open the <freeplane-user-dir> in a new window
  2. Inside the new window, open the subdirectory scripts
  3. Copy/paste the new file into that subdirectory
    You should end up with: <freeplane-user-dir>/scripts/my_ruby_script.rb
  4. Freeplane only detects new ruby scripts after a restart. So now close Freeplane.
  5. Open Freeplane again, and you will see that there is a new entry in the menu Tools/Scripts/My_Ruby_Script - click on it to run the new ruby script!

You now have the ruby script in freeplane: from now on whenever you want to run this script, just click again Tools/Scripts/My_Ruby_Script

Youtube demo video: how to use ruby scripts in Freeplane

https://youtu.be/ExqYF0SLGzI


The first time you run a ruby-script in freeplane, it takes a while to "warm-up" jruby. Since the second and third and xxx times, the script will already run much faster. This also happens (in a lesser degree) with groovy scripts.

NOTE: To remove a script (either ruby or groovy), just delete the script from <freeplane-user-dir>/scripts/my_ruby_script.rb and restart Freeplane.

Retrieved from "https://www.freeplane.org/oldwiki/index.php?title=FreeplaneJrubyInstaller_Addon&oldid=6072"