View source for Talk:Add-ons (Develop)

----
'''Jokro-2011-11-20'''
A new user is helped by more structure to understand what he is doing and why he is doing it. The present description misses this. I therefore propose to replace the current text with the text below. It also might help to add the text and table which is displayed when you install the developer tools.



==Preparation: Install developer tools ==

You will need a recent version of Freeplane and a number of developer tools which are themselves supplied as an add-on:
# Update to the most recent Freeplane version
# Download and install the [http://freeplane.sourceforge.net/wiki/index.php/Add-ons#Add-on_Insert_Inline_Image Developer Tools] from the [[Add-ons]] page (follow the installation instructions there). The add-on functions provided will be available in: ''Tools > Developer tools''


==Example add-on==
The following is an example how to make your add-on. The name of the add-on is chosen to be ''myAddOn''. The add-on will put:
#a hypothetical script <tt>myCoolScript.groovy</tt> in <tt><freeplaneuserdir>/script/myCoolScript.groovy</tt>; and
#a hypothetical icon <tt>mycoolicon.png</tt> in <tt><freeplaneuserdir>/icons/mycoolicon.png</tt>.


==Steps to follow for creating the example add-on==

'''First''' prepare a directory called ''myAddOn'' with  the following structure:
* myAddOn/scripts
* myAddOn/zips/icons


'''Second''' put the above files in this structure:
# Copy <tt>myCoolScript.groovy</tt> to <tt>myAddOn/scripts/myCoolScript.groovy</tt>.
# Copy <tt>mycoolicon.png</tt> to <tt>zips/icons/mycoolicon.png</tt>.


'''Third''' create and save the map ''myAddOn'':
# Create a new mind map 
# Select ''Tools->Developer Tools->Build add-on'' to generate the template.  First a dialog for the name of the add-on displays. Fill in the name ''myAddOn''. Next a dialog displays a log of the actions which generate the template nodes.  
# The root node automatically fot the name myAddOn and has got a number of attributes. The first attribute is ''name'' with value ''myAddOn''. This is the so-called technical name of the add-on which should not be changed. The root name (core) could be changed. ??
# From the other attributes of the root node, at least the version should be filled in. E.g. fill in for version <tt>v0.1</tt> etc.
# The map ''myAddOn'' has a template node ''scripts''. Create a child node with name ''myCoolScript.groovy''.
# The map ''myAddOn'' has a template node ''zips''. Create a child node with name ''icons''. And create a child of ''icons'' with the name ''mycoolicon.png''.
# Select (again) ''Tools->Developer Tools->Build add-on''. This will add the required attributes of the script node and proposes proper ''deinstall'' rules (just accept them when you are asked for it).
# Select ''Tools > Developer Tools > Package add-on for publication''. This will create the file <tt>myAddOn-v0.1.mm</tt>


'''Fourth''', install and test:
* Select ''Tools->Scripts->Install Add-on'' (or via ''Tools->Add-ons'').
'''****End Jokro-2011-11-20'''
----