blob: 6aded020a09903b0ec5f45f20cc0abc478f61aab [file] [log] [blame]
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Modules Explorer View</title>
</head>
<body>
<h2>Modules Explorer View</h2>
<p>EASE provides modules, script libraries that simplify the use of several Java APIs. To browse available libraries and their functionality, the <i>Modules Explorer</i> view lists available functions.</p>
<img src="../../images/modules_explorer.png" />
<p>Modules are organized in categories, displayed in a tree structure. Once loaded it provides the functions and members that are listed.
Function parameters are listed, the optional ones in grey, italic text. The return type is denoted after the colon. Modules, functions and members are drag &amp; drop enabled.
The shell will automatically load the defining module if required, but cannot automatically set the mandatory parameters. Drop will result in an error, but then the command can easily be re-executed with the correct parameters.</p>
<p>All items do provide hover help to show details on the module or the function. The same information is also available in the help system and can be accessed from the context menu of each item.</p>
<p>The search box at the top allows to search for modules and/or methods that contain a dedicated string. Do not forget to clear the input to see all available methods again.</p>
<h3>Preferences</h3>
<p>Module preferences are available in <i>Preferences/Scripting/Modules</i>. Modules may be switched from visbile to hidden state and vice versa via drag &amp; drop. Categories cannot be changed that way, so it does not matter on which folder you drop a module.
</p>
<p><a href="../concepts/script_modules.html">Read more about modules</a> to understand how they integrate with the script engine.</p>
</body>
</html>