From 7f9e245c36bd72b2fc956381f7072d69f3a80a6d Mon Sep 17 00:00:00 2001 From: "john.j.camilleri" Date: Mon, 14 Nov 2011 11:23:17 +0000 Subject: [PATCH] Updated readme --- eclipse/index.html | 78 +++++++++++++++++++++++++--------------------- 1 file changed, 43 insertions(+), 35 deletions(-) diff --git a/eclipse/index.html b/eclipse/index.html index 9b049ad06..86078debb 100644 --- a/eclipse/index.html +++ b/eclipse/index.html @@ -2,6 +2,8 @@

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.

+

This documentation is also available at the MOLTO Project Wiki.

+

Introduction

The aim behind developing a desktop IDE for GF is to provide more powerful tools than may be possible and/or practical in a web-based environment (the GF Web IDE). In particular, the ability to resolve identifier cross-references and browse external libraries quickly during development time is one of the primary motivations for the project.

@@ -20,40 +22,17 @@ -

Update history

- -
-
16/11/11
-
Third BETA released, using new tag-based scoping for better performance.
- -
11/10/11
-
Second BETA released, with improved support for qualified names, local variable bindings, selective inheritance, module outlining, and launch configurations. Also new GF Project type.
- -
01/10/11
-
Initial BETA released.
- -
20/09/11
-
Refactoring of grammar to provide neater syntax trees, and handle cross-referencing contraints. Major work on name resolution across modules, implementing custom Scoping, Naming, ResourceDescription implementations.
- -
08/09/11
-
Successfully converted GF language grammar into ANTLR-compaticble format. Refactoring to avoid left-recursion took up the majority of this time so far.
- -
Late August 2011
-
Started investigation the use of Xtext as a basis for building the Eclipse plugin. Xtext requires a EBNF-style language grammar in order to generate development tools as a plugin for the Eclipse IDE.
-
-

Features

-

Implemented (or partially implemented)

+

Implemented

Near-term

@@ -84,19 +64,29 @@
  • Integration with ontology engineering tools
    • -

    Known issues

    +
    -
      -
    1. The in-editor validation often needs to be triggered by a keystroke.
      2. -
    +

    Update history

    -

    Other remarks

    +
    +
    16/11/11
    +
    Third BETA released, overhauled to take advantage of new compiler features. Tag-based scoping for better performance.
    -
      -
    1. Interface decisions such as icons were made reltively hastily and may not be entirely suitable or intuitive. -This will get better as the plugin gets used by more users (and provide feedback).
      2. -
    2. A wiki or bug tracker may be set up if there is enough usage feedback to justify it.
      3. -
    +
    11/10/11
    +
    Second BETA released, with improved support for qualified names, local variable bindings, selective inheritance, module outlining, and launch configurations. Also new GF Project type.
    + +
    01/10/11
    +
    Initial BETA released.
    + +
    20/09/11
    +
    Refactoring of grammar to provide neater syntax trees, and handle cross-referencing contraints. Major work on name resolution across modules, implementing custom Scoping, Naming, ResourceDescription implementations.
    + +
    08/09/11
    +
    Successfully converted GF language grammar into ANTLR-compaticble format. Refactoring to avoid left-recursion took up the majority of this time so far.
    + +
    Late August 2011
    +
    Started investigation the use of Xtext as a basis for building the Eclipse plugin. Xtext requires a EBNF-style language grammar in order to generate development tools as a plugin for the Eclipse IDE.
    +
    @@ -127,6 +117,7 @@ This will get better as the plugin gets used by more users (and provide feedback The runtime path is assumed to be ~/.cabal/bin/gf, which may be wrong depending on your system and how you installed GF.
    The library path should get automatically set from your environment’s GF_LIB_PATH variable. +
  • You can also adjust the verbosity level of the GFEP logger.

    • Updating the plugin

    @@ -191,7 +182,20 @@ files and manually add them to your Eclipse workspace. To experiment with some o
    -

    Feedback

    +

    Evaluation & feedback

    + +

    Please try to use the plugin for developing your own GF projects and report any issues you come up against. +Do not hesitate to contact me on john.j.camilleri at domain chalmers.se and let me know how you think the plugin can be improved.

    + +

    Notes

    + +
      +
    1. The in-editor validation often needs to be triggered/updated by a keystroke. So if you can still see errors which you believe should be correct, try adding a space character to ensure the validation has been re-triggered.
      2. +
    2. Validation expects to have the project’s Build Automatically option checked (turned on).
      3. +
    3. 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 behaviour will hopefully be improved in future versions.
      4. +
    + +

    Criteria

    As part of the evaluation of the GF Eclipse Plugin, feedback (both negative and positive) on the following would be appreciated:

    @@ -203,3 +207,7 @@ files and manually add them to your Eclipse workspace. To experiment with some o
  • Feature wish-list
  • Compatibilities / conflicts with other Eclipse plugins
    • + +

    Logs

    + +

    The GFEP writes a log file in your Eclipse workspace folder, self-evidently named gfep.log. When things go wrong it may be useful to consult this file, or even send it as part of any feedback you provide.