msyds/gf-core
1
0
Fork 0
forked from GitHub/gf-core
Code Pull Requests Activity

Updated readme

Browse Source
This commit is contained in:
john.j.camilleri
2011-11-14 11:23:17 +00:00
parent 33c6dbd8cf
commit 970d42da2b
1 changed files with 43 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
eclipse/index.html
View File

@@ -2,6 +2,8 @@
<p><em>The research leading to these results has received funding from the European Union&#8217;s Seventh Framework Programme (FP7/2007-2013) under grant agreement n° FP7-ICT-247914.</em></p>
<p><em>This documentation is also available at the <a href="http://www.molto-project.eu/node/1395">MOLTO Project Wiki</a>.</em></p>
<h2>Introduction</h2>
<p>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.</p>
@@ -20,40 +22,17 @@
<ul>
<li>This document shall contain the most up-to-date information about the plugin. The most up-to-date version of this file can always be found in the source-code repository at <a href="https://github.com/GrammaticalFramework/gf-eclipse-plugin/blob/master/README.markdown">https://github.com/GrammaticalFramework/gf-eclipse-plugin/blob/master/README.markdown</a></li>
<li>This documentation is also available at the <a href="http://www.molto-project.eu/node/1395">MOLTO Project Wiki</a>.</li>
<li>Source code repository is at <a href="https://github.com/GrammaticalFramework/gf-eclipse-plugin">https://github.com/GrammaticalFramework/gf-eclipse-plugin</a> (do not try to run the plugin from source; please only use the packaged releases).</li>
<li>Here are some <a href="http://www.grammaticalframework.org/eclipse/examples/">example GF projects</a> for testing out the plugin features.</li>
<li>Software update site URL for installing through Eclipse:
<code>http://www.grammaticalframework.org/eclipse/release/</code></li>
</ul>
<h3>Update history</h3>
<dl>
<dt><strong>16/11/11</strong></dt>
<dd>Third BETA released, using new tag-based scoping for better performance.</dd>
<dt><strong>11/10/11</strong></dt>
<dd>Second BETA released, with improved support for qualified names, local variable bindings, selective inheritance, module outlining, and launch configurations. Also new GF Project type.</dd>
<dt><strong>01/10/11</strong></dt>
<dd>Initial BETA released.</dd>
<dt><strong>20/09/11</strong></dt>
<dd>Refactoring of grammar to provide neater syntax trees, and handle cross-referencing contraints. Major work on name resolution across modules, implementing custom <code>Scoping</code>, <code>Naming</code>, <code>ResourceDescription</code> implementations.</dd>
<dt><strong>08/09/11</strong></dt>
<dd>Successfully converted GF language grammar into ANTLR-compaticble format. Refactoring to avoid left-recursion took up the majority of this time so far.</dd>
<dt><strong>Late August 2011</strong></dt>
<dd>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.</dd>
</dl>
<hr />
<h2>Features</h2>
<h3>Implemented (or partially implemented)</h3>
<h3>Implemented</h3>
<ul>
<li>Syntax highlighting and error detection</li>
@@ -62,6 +41,7 @@
<li>Warnings for problems in module dependancy hierarchy</li>
<li>Launch configurations, i.e. compilation directly from IDE</li>
<li>Auto-completion for declared identifiers</li>
<li>Background compilation (shallow) using project builder</li>
</ul>
<h3>Near-term</h3>
@@ -84,19 +64,29 @@
<li>Integration with ontology engineering tools</li>
</ul>
<h3>Known issues</h3>
<hr />
<ol>
<li>The in-editor validation often needs to be triggered by a keystroke.</li>
</ol>
<h2>Update history</h2>
<h3>Other remarks</h3>
<dl>
<dt><strong>16/11/11</strong></dt>
<dd>Third BETA released, overhauled to take advantage of new compiler features. Tag-based scoping for better performance.</dd>
<ol>
<li>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).</li>
<li>A wiki or bug tracker may be set up if there is enough usage feedback to justify it.</li>
</ol>
<dt><strong>11/10/11</strong></dt>
<dd>Second BETA released, with improved support for qualified names, local variable bindings, selective inheritance, module outlining, and launch configurations. Also new GF Project type.</dd>
<dt><strong>01/10/11</strong></dt>
<dd>Initial BETA released.</dd>
<dt><strong>20/09/11</strong></dt>
<dd>Refactoring of grammar to provide neater syntax trees, and handle cross-referencing contraints. Major work on name resolution across modules, implementing custom <code>Scoping</code>, <code>Naming</code>, <code>ResourceDescription</code> implementations.</dd>
<dt><strong>08/09/11</strong></dt>
<dd>Successfully converted GF language grammar into ANTLR-compaticble format. Refactoring to avoid left-recursion took up the majority of this time so far.</dd>
<dt><strong>Late August 2011</strong></dt>
<dd>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.</dd>
</dl>
<hr />
@@ -127,6 +117,7 @@ This will get better as the plugin gets used by more users (and provide feedback
<em>The runtime path is assumed to be <code>~/.cabal/bin/gf</code>, which may be wrong depending on your
system and how you installed GF.</em><br />
<em>The library path should get automatically set from your environment&#8217;s <code>GF_LIB_PATH</code> variable.</em></li>
<li>You can also adjust the verbosity level of the GFEP logger.</li>
</ol>
<h3>Updating the plugin</h3>
@@ -191,7 +182,20 @@ files and manually add them to your Eclipse workspace. To experiment with some o
<hr />
<h2>Feedback</h2>
<h2>Evaluation &amp; feedback</h2>
<p>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 <code>john.j.camilleri</code> at domain <code>chalmers.se</code> and let me know how you think the plugin can be improved.</p>
<h3>Notes</h3>
<ol>
<li>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.</li>
<li>Validation expects to have the project&#8217;s <strong>Build Automatically</strong> option checked (turned on).</li>
<li>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 <strong>Problems</strong> view should help you locate the cause. This behaviour will hopefully be improved in future versions.</li>
</ol>
<h3>Criteria</h3>
<p>As part of the evaluation of the GF Eclipse Plugin, feedback (both negative and positive) on the following would be appreciated:</p>
@@ -203,3 +207,7 @@ files and manually add them to your Eclipse workspace. To experiment with some o
<li>Feature wish-list</li>
<li>Compatibilities / conflicts with other Eclipse plugins</li>
</ol>
<h3>Logs</h3>
<p>The GFEP writes a log file in your Eclipse workspace folder, self-evidently named <code>gfep.log</code>. When things go wrong it may be useful to consult this file, or even send it as part of any feedback you provide.</p>