Scripting - Revision history

Dan Polansky: /* Limitations */

2023-06-09T11:13:01Z

Limitations

← Older revision		Revision as of 11:13, 9 June 2023
Line 171:		Line 171:
	* Having the scripts associated with a particular node rather than the whole mind map is not necessarily ideal. It is uncustomary from the perspective of an office application.		* Having the scripts associated with a particular node rather than the whole mind map is not necessarily ideal. It is uncustomary from the perspective of an office application.
	* Storing scripts in user-defined attributes is arguably not so nice; this is not what attributes are for.		* Storing scripts in user-defined attributes is arguably not so nice; this is not what attributes are for.
	* No way to run a ''single'' script outside of the script editor. It is only within the script editor that one can run a single selected script. Outside of the script editor, there is the function to run ''all'' scripts stored in the nodes of the mind map.		* No way to run a ''single'' script outside of the script editor. It is only within the script editor that one can run a single selected script. Outside of the script editor, there is the function to run ''all'' scripts stored in the nodes of the mind map. As a result, if there are multiple scripts in the mind map, there is not way to run a ''single'' script on the ''currently selected node'', given that the currently selected node is in general distinct from the node in which the script is stored.
	* No way to rename a script in the script editor.		* No way to rename a script in the script editor.
	* No way to delete a script in the script editor.		* No way to delete a script in the script editor.

Dan Polansky: /* Limitations */

2023-06-09T10:09:53Z

Limitations

← Older revision		Revision as of 10:09, 9 June 2023
Line 170:		Line 170:
	* No way to store scripts in a script file for the whole FreeMind application; scripts can only be stored in mind maps.		* No way to store scripts in a script file for the whole FreeMind application; scripts can only be stored in mind maps.
	* Having the scripts associated with a particular node rather than the whole mind map is not necessarily ideal. It is uncustomary from the perspective of an office application.		* Having the scripts associated with a particular node rather than the whole mind map is not necessarily ideal. It is uncustomary from the perspective of an office application.
			* Storing scripts in user-defined attributes is arguably not so nice; this is not what attributes are for.
	* No way to run a ''single'' script outside of the script editor. It is only within the script editor that one can run a single selected script. Outside of the script editor, there is the function to run ''all'' scripts stored in the nodes of the mind map.		* No way to run a ''single'' script outside of the script editor. It is only within the script editor that one can run a single selected script. Outside of the script editor, there is the function to run ''all'' scripts stored in the nodes of the mind map.
	* No way to rename a script in the script editor.		* No way to rename a script in the script editor.
	* No way to delete a script in the script editor.		* No way to delete a script in the script editor.
	* No way to run a script upon mind map opening or mind map closing ("hooks"). However, from a security standpoint, this is a bonus.		* No way to run a script upon mind map opening or mind map closing ("hooks"). However, from a security standpoint, this is a bonus.
	* Storing scripts in user-defined attributes is arguably not so nice; this is not what attributes are for.
	* The built-in script editor is very simple/spartan: for instance, there is no syntax highlighting and no API exploration, let alone debugging like in Microsoft Office.		* The built-in script editor is very simple/spartan: for instance, there is no syntax highlighting and no API exploration, let alone debugging like in Microsoft Office.

Dan Polansky: /* Limitations */

2023-06-09T10:09:27Z

Limitations

← Older revision		Revision as of 10:09, 9 June 2023
Line 170:		Line 170:
	* No way to store scripts in a script file for the whole FreeMind application; scripts can only be stored in mind maps.		* No way to store scripts in a script file for the whole FreeMind application; scripts can only be stored in mind maps.
	* Having the scripts associated with a particular node rather than the whole mind map is not necessarily ideal. It is uncustomary from the perspective of an office application.		* Having the scripts associated with a particular node rather than the whole mind map is not necessarily ideal. It is uncustomary from the perspective of an office application.
	* No way to run a single script outside of the script editor. It is only within the script editor that one can run a single selected script.		* No way to run a ''single'' script outside of the script editor. It is only within the script editor that one can run a single selected script. Outside of the script editor, there is the function to run ''all'' scripts stored in the nodes of the mind map.
	* No way to rename a script in the script editor.		* No way to rename a script in the script editor.
	* No way to delete a script in the script editor.		* No way to delete a script in the script editor.

Dan Polansky: /* Examples */ +Turn currently selected nodes bold

2023-06-09T10:07:31Z

Examples: +Turn currently selected nodes bold

← Older revision		Revision as of 10:07, 9 June 2023
Line 61:		Line 61:

	Short multiline examples:		Short multiline examples:

			Turn currently selected nodes bold:
			<pre>
			selectedNodesIt = c.getSelecteds().iterator();
			while (selectedNodesIt.hasNext()) {
			selNode = selectedNodesIt.next();
			c.setBold(selNode, true);
			}
			</pre>

	Count descendants, exluding the node itself:		Count descendants, exluding the node itself:

Dan Polansky: /* API */

2023-06-09T10:03:46Z

API

← Older revision		Revision as of 10:03, 9 June 2023
Line 115:		Line 115:

	* <code>MindMapController c</code>: the controller		* <code>MindMapController c</code>: the controller
	* <code>MindMapNode node</code>: the node the script is ~~run on~~		* <code>MindMapNode node</code>: the node the script is stored in, not the currently selected one
	* <code>HashMap cookies sScriptCookies</code>: A hashmap of key-value pairs (TBD:WHAT IS THIS ANYWAY?)		* <code>HashMap cookies sScriptCookies</code>: A hashmap of key-value pairs (TBD:WHAT IS THIS ANYWAY?)

Dan Polansky: /* Limitations */

2023-06-09T09:56:48Z

Limitations

← Older revision		Revision as of 09:56, 9 June 2023
Line 159:		Line 159:

	==Limitations==		==Limitations==
	* ~~There is no~~ way to store scripts in a script file for the whole application; scripts can only be stored in mind maps~~[verify]~~.		* No way to store scripts in a script file for the whole FreeMind application; scripts can only be stored in mind maps.
	* The built-in script editor is very simple/spartan: for instance, there is no syntax highlighting.		* Having the scripts associated with a particular node rather than the whole mind map is not necessarily ideal. It is uncustomary from the perspective of an office application.
			* No way to run a single script outside of the script editor. It is only within the script editor that one can run a single selected script.
			* No way to rename a script in the script editor.
			* No way to delete a script in the script editor.
			* No way to run a script upon mind map opening or mind map closing ("hooks"). However, from a security standpoint, this is a bonus.
			* Storing scripts in user-defined attributes is arguably not so nice; this is not what attributes are for.
			* The built-in script editor is very simple/spartan: for instance, there is no syntax highlighting and no API exploration, let alone debugging like in Microsoft Office.

	==Freeplane==		==Freeplane==

Dan Polansky: /* Examples */

2023-06-09T09:49:17Z

Examples

← Older revision		Revision as of 09:49, 9 June 2023
Line 39:		Line 39:

	==Examples==		==Examples==
	Some example scripts follow. They take advantage of 1) = for assignment of the result of a calculation, 2) c for controller, and 3) node for the ~~current~~ node.		Some example scripts follow. They take advantage of 1) = for assignment of the result of a calculation, 2) c for controller, and 3) node for the script node.

	One-liner examples:		One-liner examples:
Line 58:		Line 58:
	* Make node bold if folded: <code>c.setBold(node, node.isFolded())</code> If not folded, make it non-bold.		* Make node bold if folded: <code>c.setBold(node, node.isFolded())</code> If not folded, make it non-bold.
	* Set hyperlink: <code>c.setLink(node, "http://www.google.com/");</code>		* Set hyperlink: <code>c.setLink(node, "http://www.google.com/");</code>
			* Make the currently selected node bold (not the script node): <code>c.setBold(c.getSelected(), true);</code>

	Short multiline examples:		Short multiline examples:

Dan Polansky: +set hyperlink

2023-06-09T09:23:48Z

+set hyperlink

← Older revision		Revision as of 09:23, 9 June 2023
Line 57:		Line 57:
	* Remove last icon: <code>c.removeLastIcon(node);</code>		* Remove last icon: <code>c.removeLastIcon(node);</code>
	* Make node bold if folded: <code>c.setBold(node, node.isFolded())</code> If not folded, make it non-bold.		* Make node bold if folded: <code>c.setBold(node, node.isFolded())</code> If not folded, make it non-bold.
			* Set hyperlink: <code>c.setLink(node, "http://www.google.com/");</code>

	Short multiline examples:		Short multiline examples:

Dan Polansky: /* Implementation */

2023-06-09T09:05:07Z

Implementation

← Older revision		Revision as of 09:05, 9 June 2023
Line 141:		Line 141:

	==Implementation==		==Implementation==
	Scripts are stored in attributes whose names starts with "script", meaning in the attribute of the attribute function, not in the attribute of XML. Thus, the script attribute can be called "script1", "script_A", or "script_sum_calculation". Attributes created via Actions > New Script menu in the script editor are of the form "script''N''", where N is an integer.		Scripts are stored in attributes whose names starts with "script", meaning in the attribute of the attribute function, not in the attribute of XML. Thus, the script attribute can be called "script1", "script_A", or "script_sum_calculation". Attributes created via Actions > New Script menu in the script editor are of the form "script''N''", where N is a positive integer (1, 2, ...).

	The script attributes are probably distinguished from non-script attributes by their starting with "script".		The script attributes are probably distinguished from non-script attributes by their starting with "script".

Dan Polansky at 09:04, 9 June 2023

2023-06-09T09:04:27Z

← Older revision		Revision as of 09:04, 9 June 2023
Line 1:		Line 1:
	Since [[Release 0.9.0]], FreeMind has a scripting facility using Groovy programming language, an imperative language syntactically resembling Java but with some syntactic sugar added such as optional declaration of types. The best way to get started is perhaps by reading [[Scripting/Mind map documentation]], the wiki version of the mind map documentation originally written by Christian Foltin. What follows here is less informative and consolidated than the mind map documentation. Another source is the dedicated page [[~~Example~~ scripts]] for scripts supplied by FreeMind users.		Since [[Release 0.9.0]], FreeMind has a scripting facility using Groovy programming language, an imperative language syntactically resembling Java but with some syntactic sugar added such as optional declaration of types. The best way to get started is perhaps by reading [[Scripting/Mind map documentation]], the wiki version of the mind map documentation originally written by Christian Foltin. What follows here is less informative and consolidated than the mind map documentation. Another source is the dedicated page [[User-contributed example scripts]] for scripts supplied by FreeMind users.

	==Using==		==Using==
Line 169:		Line 169:
	==See also==		==See also==
	* [[Scripting/Mind map documentation]]		* [[Scripting/Mind map documentation]]
	* [[~~Example~~ scripts]]		* [[User-contributed example scripts]]
	* [[FreeMind 0.9.0: The New Features]]		* [[FreeMind 0.9.0: The New Features]]

	[[Category:Development]]		[[Category:Development]]