From 5ce14b5b6a9cbc2ee556780b5b7b415ead9d0408 Mon Sep 17 00:00:00 2001 From: Jim Procter Date: Wed, 20 Apr 2016 17:00:53 +0100 Subject: [PATCH] JAL-2074 updated URLs and removed 'how to get groovy' classpath stuff --- doc/AddingGroovySupport.html | 18 ++---------------- help/html/features/groovy.html | 27 +++++++-------------------- 2 files changed, 9 insertions(+), 36 deletions(-) diff --git a/doc/AddingGroovySupport.html b/doc/AddingGroovySupport.html index 41e34ce..63e7170 100644 --- a/doc/AddingGroovySupport.html +++ b/doc/AddingGroovySupport.html @@ -21,17 +21,10 @@

-Adding Groovy Support to Jalview +Groovy Support in Jalview

-There is currently no scripting language -extension within Jalview, in part because a -scripting API has not yet been developed. -

-

It is, however, really easy to embed scripting -engines like groovy. If groovy is detected on the -classpath, a new menu entry on the Desktop's Tools -menu will open the GroovyShell. + Groovy has been bundled with the Jalview desktop since circa 2012. The program supports interactive execution of groovy scripts via the Groovy Console, and command line execution via the '-groovy' option. The main source for documentation about Groovy in Jalview is the online help pages.

Here are some scripts to get you started:

-

Getting Groovy...

-

-You need the core groovy jars which include the GroovyShell. The easiest way of doing -this is to add the groovy-all-*.jar to the lib directory whose path is given in the java.ext.dirs property.

-

The is obtained from the embedded directory within the groovy distribution). -

TODO

Using Java class methods from Groovy is straightforward, but currently, there isn't a set of easy to use methods for the jalview objects. A Jalview Scripting API needs to be developed to make this easier.

diff --git a/help/html/features/groovy.html b/help/html/features/groovy.html index adabdf1..9aa341b 100644 --- a/help/html/features/groovy.html +++ b/help/html/features/groovy.html @@ -27,7 +27,7 @@ The Groovy Shell

- Groovy is an "agile + Groovy is an "agile and dynamic language for the Java platform". The groovy scripting language makes it extremely easy to programmatically interact with Java programs, in much the same way that Javascript is @@ -35,25 +35,12 @@ page.

- Getting Groovy...
Jalview Groovy - support is only possible if the core groovy jars which include the - GroovyShell are present on the CLASSPATH when Jalview is started. -

-

- The jars are obtained from the embedded directory within - the groovy - distribution. The easiest way of adding them to the Jalview - classpath is to download and build Jalview from its source - distribution, and then add the groovy-all-*.jar to the lib directory - whose path is given in the java.ext.dirs property. -

-

- Opening Jalview's Groovy Console
If groovy - is available, then the Tools→Groovy - Console... menu entry will be available from the Jalview Desktop's - drop-down menu. Selecting this will open the Groovy Console which allows you to interactively execute Groovy + Getting Groovy...
Jalview comes with + an embedded installation of Groovy. All you need is to select Tools→Groovy + Console... menu option from the Jalview Desktop's + drop-down menu. After a short pause, you should then see the Groovy Console appear. This allows you to interactively execute Groovy scripts within the Jalview run-time environment.

-- 1.7.10.2