diff --git a/eclipse/images/eclipse-external-libraries.png b/eclipse/images/eclipse-external-libraries.png new file mode 100644 index 000000000..4298694b9 Binary files /dev/null and b/eclipse/images/eclipse-external-libraries.png differ diff --git a/eclipse/images/eclipse-treebank-manager.png b/eclipse/images/eclipse-treebank-manager.png new file mode 100644 index 000000000..eca4721be Binary files /dev/null and b/eclipse/images/eclipse-treebank-manager.png differ diff --git a/eclipse/index.html b/eclipse/index.html index 60b4fe52c..3a4fa6218 100644 --- a/eclipse/index.html +++ b/eclipse/index.html @@ -173,20 +173,23 @@ Updated: 5 March 2012

New project wizard New project wizard

-

Add some new modules

+

New module wizard

Use the GF Module wizard from File → New → Other → GF Module:

New module wizard

-

You can find some small examples at http://www.grammaticalframework.org/eclipse/examples/. Download the -files and manually add them to your Eclipse workspace to experiment with some of the plugin features.

+

You can find some small examples at http://www.grammaticalframework.org/eclipse/examples/. Download the files and manually add them to your Eclipse workspace to experiment with some of the plugin features.

-

Syntax highlighting

+

Clone module wizard

-

You can change your syntax colouring styles as you wish from Window → Preferences → Grammatical Framework → Syntax Coloring

+

If you want to clone an existing module into a new language, you can now do so via the Clone GF Module wizard. This is also available as a context menu option in the Project Explorer, via <Richt click> → Grammatical Framework → Compile for new language:

-

Syntax highlighting styles

+

Clone GF module to new language wizard

+ +

This will create and open a new module with the relevant replacements made. Note how in this case string constants are replaced by the empty string "". This wizard currently only works on concrete and instance modules.

+ +

Newly cloned file

Workbench editor layout

@@ -194,7 +197,7 @@ files and manually add them to your Eclipse workspace to experiment with some of

The editor and outline view

-

Outline view

+

Outline view

The Outline view in the bottom-right offers a quite overview of your module structure. Clicking any of the terms will make your cursor jump to that point in the file.

@@ -204,12 +207,26 @@ files and manually add them to your Eclipse workspace to experiment with some of

Warnings and errors in the editor

+

Validation

+ +

For validation to work correctly, the project’s Build Automatically option should be turned on.

+ +

The in-editor validation sometimes needs to be triggered/updated by a keystroke. If you can still see errors which you believe should be correct, try adding a space character to ensure the validation is re-triggered.

+ +

Sometimes you may get an entire file marked with errors, even though in fact there is only a single error which is causing the internal builder to fail. In such cases referring to the Problems view should help you locate the cause. This issue is particularly relevant when changes made to one module may induce errors in its descendants (e.g. renaming a parameter in a resource module). This behaviour will hopefully be improved in future versions.

+

Code formatting

Use the built-in code formatter to tidy your code automatically. Right-click in the editor and choose Format or use the keyboard shortcut Ctrl+Shift+F.

Before auto-formatting After auto-formatting

+

Syntax highlighting

+ +

You can change your syntax colouring styles as you wish from Window → Preferences → Grammatical Framework → Syntax Coloring

+ +

Syntax highlighting styles

+

Launch configurations

Set up a launch configuration from Run → Run Configurations… → Grammatical Framework. You will see the dialog below with some fields automatically filled in for you.

@@ -245,6 +262,29 @@ files and manually add them to your Eclipse workspace to experiment with some of

The Eclipse console implementation does not support command history (up arrow) or auto-completion (tab).

+

External Libraries view

+ +

This view is automatically populated with a list of all the external modules referenced by the current file. Double-clicking on any item provides a quick way of opening GF files which are imported into your grammar from outside your Eclipse project, for example the GF Resource Grammar Library.

+ +

External libraries view

+ +

Future versions of this view will contain a full tree of all identifiers available in the current scope.

+ +

Treebank Manager view

+ +

This feature works together with the launch configurations to make the process of testing treebanks against your grammars quick and easy. The general concept (independent of GFEP) is this:

+ +
    +
  1. Create a file test.trees which contains a bunch of abstract syntax trees, which you want to test
  2. +
  3. Compile your grammar and linearise the trees one by one, using some command like rf -lines -tree -file=test.trees | l -table | wf -file=test.trees.out
  4. +
  5. Manually correct the output in test.trees.out and save it as your gold standard file test.gold.
  6. +
  7. Each time you update your grammar, repeat step 2, then compare your new output against the gold standard using diff or some other comparison tool.
  8. +
+ +

The Treebank Manager view follows this same pattern but provides a convenient graphical interface for running your treebanks and also for looking at the output, just using a few clicks:

+ +

Treebank Manager view

+

Logs

The GFEP writes to the Eclipse platform log. This can be accessed in two ways:

@@ -256,14 +296,6 @@ files and manually add them to your Eclipse workspace to experiment with some of

You can set the log verbosity from Window → Preferences → Grammatical Framework.

-

Validation

- -

For validation to work correctly, the project’s Build Automatically option should be turned on.

- -

The in-editor validation sometimes needs to be triggered/updated by a keystroke. If you can still see errors which you believe should be correct, try adding a space character to ensure the validation is re-triggered.

- -

Sometimes you may get an entire file marked with errors, even though in fact there is only a single error which is causing the internal builder to fail. In such cases referring to the Problems view should help you locate the cause. This issue is particularly relevant when changes made to one module may induce errors in its descendants (e.g. renaming a parameter in a resource module). This behaviour will hopefully be improved in future versions.

-

Evaluation & feedback