From 7d34f76375218dfb600381f933fbfccd0d0c3695 Mon Sep 17 00:00:00 2001 From: "john.j.camilleri" Date: Mon, 19 Mar 2012 12:48:30 +0000 Subject: [PATCH] GFEP: Added video tutorial --- eclipse/index.html | 64 ++++++++++++++++++++++++++++++++++------------ 1 file changed, 47 insertions(+), 17 deletions(-) diff --git a/eclipse/index.html b/eclipse/index.html index 6dcfd33a7..731d1684b 100644 --- a/eclipse/index.html +++ b/eclipse/index.html @@ -1,7 +1,7 @@

The GF Eclipse Plugin

John J. Camilleri
-Updated: 6 March 2012

+Updated: 19 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 no. FP7-ICT-247914.

@@ -20,15 +20,13 @@ Updated: 6 March 2012

Links

- -

Features

- - -

Major release history

+

Release history

+
14/03/13
+
(1.4.1.x) GF source files can now be anywhere in project, not necessarily at top level.
+
06/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.
@@ -99,15 +98,15 @@ Updated: 6 March 2012

In order for dependencies to be satisfied, you need to ensure that your Eclipse has the following update site URLs set:

Steps for installation

  1. Inside Eclipse, go to Help → Install New Software.
    2. -
  2. Add new software site using the URL: http://www.grammaticalframework.org/eclipse/release/
    3. +
  3. Add new software site using the URL: http://www.grammaticalframework.org/eclipse/release/
  4. Select the GF Eclipse Plugin, and make sure the Contact all update sites during install to find required software option is checked.
  5. Click Next, accept the license agreement and install.
  6. Accept the prompt warning that the software is unsigned.
    7. @@ -118,7 +117,8 @@ Updated: 6 March 2012

    1. Add the GF perspective by clicking Open Perspective → Other and choosing GF.
      2. -
    2. The plugin will try to determine the path to your GF executable automatically. You can always check/overwrite it by going to Window → Preferences → Grammatical Framework.
      3. +
    3. The plugin will try to determine the path to your GF executable automatically. You can always check/overwrite it by going to Window → Preferences → Grammatical Framework. +This path should include the name of the GF binary itself, e.g. /home/john/.cabal/bin/gf or C:\Users\John\GF\gf.exe.
    4. You can also adjust the verbosity level of the GFEP console log in the preferences window.
    @@ -168,6 +168,33 @@ Updated: 6 March 2012

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

    +

    Video tutorial

    + +

    A quick run through of the major features available in the GF Eclipse Plugin.

    + + + +

    If the video doesn’t appear above, you can view it at https://vimeo.com/38768382

    + +

    The Eclipse workspace and project concepts

    + +

    When you run Eclipse, it asks you to create or specify a workspace on your system. Any projects you wish to work +on inside Eclipse must reside in this workspace; generally each folder under the top-level workspace directory is +considered an individual project, i.e.:

    + +
    workspace/
+    Project1/
+        file1.gf
+        file2.gf
+    Project2/
+        file3.gf
+        file4.gf
+
    + +

    If you open an existing folder as your workspace in Eclipse, then your folders in that workspace do not automatically +become Eclipse projects. You must follow the “Create new GF Project” wizards below, and give your project the exact +name of the existing folder (e.g. Project1 or Project2 in the example above.)

    +

    Create a new GF Project

    New project wizard @@ -179,7 +206,7 @@ Updated: 6 March 2012

    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 grammaticalframework.org/eclipse/examples. Download the files and manually add them to your Eclipse workspace to experiment with some of the plugin features.

    Clone module wizard

    @@ -209,12 +236,15 @@ Updated: 6 March 2012

    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.

    +

    Builder

    + +

    For validation to work correctly, the project’s Build Automatically option should be turned on. +Each time you save a file (or some other change occurs in your project), the builder should get triggered which recompiles any GF files which have changed. If the builder does not seem to get triggered, try to run a clean via Project → Clean…

    +

    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.

    @@ -315,7 +345,7 @@ Updated: 6 March 2012

    Please try to use the plugin for developing your own GF projects and report any issues you come up against.

    -

    For all bug reports and feature requests please use the GitHub Issue Tracker at https://github.com/GrammaticalFramework/gf-eclipse-plugin/issues.

    +

    For all bug reports and feature requests please use the GitHub Issue Tracker.

    Do not hesitate to let us know how you think the plugin can be improved!