Difference between revisions of "Scripting API"

From Freeplane - free mind mapping and knowledge management software
m (Text replacement - "freeplane.sourceforge.net" to "www.freeplane.org")
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
This page describes Freeplane's most recent [[Scripting]] API. There have been quite a lot of changes in the current development versions that you as a script programmer should know about even if you are still working with current stable version. Differences between development and stable versions are clearly visible in the documentation.The Scripting API is in some sense extended by [[Scripting: Freeplane Utility Classes|Freeplane's utility classes]] and by the [[Scripting: Included libraries|Libraries included in Freeplane]]. There is a special page that lists [[Scripting:_API_Changes|Changes of the Scripting API]].
+
For the [[Scripting]] API see its [http://www.freeplane.org/doc/api/ Javadoc documentation].
  
−
==Entry Points==
+
The Scripting API is in some sense extended by [[Scripting: Freeplane Utility Classes|Freeplane's utility classes]] and by the [[Scripting: Included libraries|Libraries included in Freeplane]].
−
Each script is given two variables:
 
  
−
<groovy>
+
==Changes to the scripting API==
−
final Proxy.Node node;
+
The [[Scripting_API|Scripting API]] will evolve over time but Freeplane's developers will do whatever possible to keep new API versions downward compatible. On the other hand there might be changes in parts of the Freeplane code that are not part of the official API but on which some scripts might depend nevertheless. This mostly applies to the [[Scripting:_Freeplane_Utility_Classes|utility classes]].
−
final Proxy.Controller c;
 
−
</groovy>
 
  
−
For the API see its [http://freeplane.sourceforge.net/doc/api/ Javadoc documentation]. The scripting API in a narrower sense is provided as subinterfaces of interface [http://freeplane.sourceforge.net/doc/api/org/freeplane/plugin/script/proxy/Proxy.html Proxy].
+
Changes to the API are indicated per method by version numbers in the [http://www.freeplane.org/doc/api/org/freeplane/plugin/script/proxy/Proxy.html JavaDoc of the Proxy class].
  
−
[[Category:Scripting]]
+
[[Category:Script]]

Latest revision as of 19:08, 18 November 2018

For the Scripting API see its Javadoc documentation.

The Scripting API is in some sense extended by Freeplane's utility classes and by the Libraries included in Freeplane.

Changes to the scripting API

The Scripting API will evolve over time but Freeplane's developers will do whatever possible to keep new API versions downward compatible. On the other hand there might be changes in parts of the Freeplane code that are not part of the official API but on which some scripts might depend nevertheless. This mostly applies to the utility classes.

Changes to the API are indicated per method by version numbers in the JavaDoc of the Proxy class.

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