From 7c00e81fb523fc7fd44d2dd6a47153929cc41562 Mon Sep 17 00:00:00 2001 From: "john.j.camilleri" Date: Mon, 5 Mar 2012 10:39:14 +0000 Subject: [PATCH] GFEP: updated readme --- eclipse/index.html | 147 +++++++++++++++++++++------------------------ 1 file changed, 67 insertions(+), 80 deletions(-) diff --git a/eclipse/index.html b/eclipse/index.html index c598d0a8f..60b4fe52c 100644 --- a/eclipse/index.html +++ b/eclipse/index.html @@ -1,9 +1,9 @@

The GF Eclipse Plugin

John J. Camilleri
-Updated: 8 Feb 2012

+Updated: 5 March 2012

-

The research leading to these results has received funding from the European Union’s Seventh Framework Programme (FP7/2007-2013) under grant agreement n° FP7-ICT-247914.

+

The research leading to these results has received funding from the European Union’s Seventh Framework Programme (FP7/2007-2013) under grant agreement no. FP7-ICT-247914.

This documentation is also available at the MOLTO Project Wiki.

@@ -27,12 +27,10 @@ Updated: 8 Feb 2012

  • Software update site URL for installing through Eclipse: http://www.grammaticalframework.org/eclipse/release/
    • -
    +

    Features

    -

    Implemented

    - - -

    Near-term

    - - -

    Long-term goals

    - - - -
    +

    Major release history

    +
    05/03/12
    +
    (1.4.0.x) Treebank manager view. Updated launch configurations. UI improvements, new icons. Inline contextual documentation. Correct resolution of qualified identifiers. Bug fixes and some refactoring.
    +
    07/02/12
    (1.3.0.x) Re-written underlying GF grammar.
    @@ -95,22 +81,15 @@ Updated: 8 Feb 2012

    Initial BETA released.
    -
    +

    Installation & updating

    System requirements

      -
    1. The plugin makes use of the newest GF features, and requires the latest developer version of GF to be installed on your system (instructions here). -Specifically, you need a version of GF which supports the “—tags” flag, added in November 2011.
      2. -
    2. Paths to GF must be set within the plugin (see below). This means: - -
        -
      • you don’t necessarily need to have GF in your PATH environment variable
        • -
      • you can use a separate GF installation for GFEP if you wish
        • -
      3. -
    3. The plugin was developed using Eclipse 3.7. It has been successfully installed on Eclipse as low as 3.6.2.
      4. +
    4. GF version 3.3.3 or above. The path to GF must be set within the plugin (see below).
      5. +
    5. Eclipse 3.6 or above.

    Installing the plugin for the first time

    @@ -153,8 +132,8 @@ Updated: 8 Feb 2012

    Deprecated stuff

    Project settings

    @@ -183,84 +162,101 @@ Updated: 8 Feb 2012

    </buildSpec> -
    +

    Getting started

    Some steps you can follow to get a feel of of the plugin’s features.

    - +

    Create a new GF Project

    New project wizard New project wizard

    - +

    Add some new modules

    + +

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

    New module wizard

    -

    If asked whether you want to add the Xtext nature to your project, you can safely say No (this prompt has been removed in newer versions).

    +

    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

    + +

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

    Syntax highlighting styles

    - +

    Workbench editor layout

    + +

    Use Eclipes’ own features to drag and drop your editor tabs to suit your needs.

    The editor and 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.

    + +

    Cross-referencing errors and warnings

    + +

    Notice how changing a cat definition for example will produce warnings and/or errors in other the modules.

    Warnings and errors in the editor

    - +

    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

    - +

    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.

    Launch configuration dialog

    - +

    Run the launch config and you will see the output from the GF compiler in the console view within Eclipse.

    Output from the GF compiler

    -

    Usage hints & issues

    +

    Run As… launch shortcut

    -

    Consoles

    +

    Using the Run → Run As → Compile with GF shortcut will take the current selection or active editor and do one of two things:

    + +
      +
    1. If a launch configuration already exists which the current file in its Source filenames field, then that config will be launch directly.
      2. +
    2. Otherwise, a new a launch configuration window is displayed where you will need to review and confirm the default settings before continuing.
      3. +
    + +

    Consoles

    The plugin provides its own console view named GFEP Log, which shows log messages based on the Log Level preference (Window → Preferences → Grammatical Framework).

    -

    Additionally, everytime a grammar is Run a new console is opened to display the output. This console may also serve as the interactive GF Shell, depending on the Interactive Mode checkbox in your Run Configuration.

    +

    Additionally, every time a grammar is Run a new console is opened to display the output. This console may also serve as the interactive GF Shell, depending on the Interactive Mode checkbox in your Run Configuration.

    Eclipse does not make it obvious when multiple console windows open; click on the Display Selected Console button to switch between open consoles:

    Display Selected Console icon

    +

    If the process associated with a console window has terminated, it will be indicated in the upper-left corner as below. Such console windows can then be closed using the gray cross button:

    + +

    Close terminated console icon

    +

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

    -

    Logs

    +

    Logs

    + +

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

    + +
      +
    1. By opening the Error Log view in Eclipse
      2. +
    2. Accessing the file directly at <workspace>/.metadata/.log
      3. +

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

    -

    Validation

    +

    Validation

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

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

    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

    @@ -290,12 +286,3 @@ files and manually add them to your Eclipse workspace to experiment with some of
  • Feature wish-list
  • Compatibilities / conflicts with other Eclipse plugins
    • - -

    Logs

    - -

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

    - -
      -
    1. By opening the Error Log view in Eclipse
      2. -
    2. Accessing the file directly at workspace/.metadata/.log
      3. -