GitHub/gf-core
1
0
Fork 1
mirror of https://github.com/GrammaticalFramework/gf-core.git synced 2026-04-09 04:59:31 -06:00
Code Issues Packages Projects Releases Wiki Activity

GFEP: Updated readme, more screenshots

Browse Source
This commit is contained in:
john.j.camilleri
2012-03-05 15:17:15 +00:00
parent c3ef27293a
commit 2c8f4ec075
3 changed files with 47 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
eclipse/images/eclipse-external-libraries.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 17 KiB

BIN
eclipse/images/eclipse-treebank-manager.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 25 KiB

62
eclipse/index.html
View File

@@ -173,20 +173,23 @@ Updated: 5 March 2012</p>
<p><img src="http://www.grammaticalframework.org/eclipse/images/eclipse-projectwizard-1.png" alt="New project wizard" />
<img src="http://www.grammaticalframework.org/eclipse/images/eclipse-projectwizard-2.png" alt="New project wizard" /></p>
<h3>Add some new modules</h3>
<h3>New module wizard</h3>
<p>Use the <strong>GF Module</strong> wizard from <strong>File &rarr; New &rarr; Other &rarr; GF Module</strong>:</p>
<p><img src="http://www.grammaticalframework.org/eclipse/images/eclipse-modulewizard-1.png" alt="New module wizard" /></p>
<p>You can find some small examples at <a href="http://www.grammaticalframework.org/eclipse/examples/">http://www.grammaticalframework.org/eclipse/examples/</a>. Download the
files and manually add them to your Eclipse workspace to experiment with some of the plugin features.</p>
<p>You can find some small examples at <a href="http://www.grammaticalframework.org/eclipse/examples/">http://www.grammaticalframework.org/eclipse/examples/</a>. Download the files and manually add them to your Eclipse workspace to experiment with some of the plugin features.</p>
<h3>Syntax highlighting</h3>
<h3>Clone module wizard</h3>
<p>You can change your syntax colouring styles as you wish from <strong>Window &rarr; Preferences &rarr; Grammatical Framework &rarr; Syntax Coloring</strong></p>
<p>If you want to clone an existing module into a new language, you can now do so via the <strong>Clone GF Module</strong> wizard. This is also available as a context menu option in the <strong>Project Explorer</strong>, via <strong>&lt;Richt click&gt; &rarr; Grammatical Framework &rarr; Compile for new language</strong>:</p>
<p><img src="http://www.grammaticalframework.org/eclipse/images/eclipse-syntaxcoloring.png" alt="Syntax highlighting styles" /></p>
<p><img src="http://www.grammaticalframework.org/eclipse/images/eclipse-clonewizard.png" alt="Clone GF module to new language wizard" /></p>
<p>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 <code>""</code>. This wizard currently only works on <code>concrete</code> and <code>instance</code> modules.</p>
<p><img src="http://www.grammaticalframework.org/eclipse/images/eclipse-clonewizard-newfile.png" alt="Newly cloned file" /></p>
<h3>Workbench editor layout</h3>
@@ -194,7 +197,7 @@ files and manually add them to your Eclipse workspace to experiment with some of
<p><img src="http://www.grammaticalframework.org/eclipse/images/eclipse-editor-general.png" alt="The editor and outline view" /></p>
<h4>Outline view</h4>
<h3>Outline view</h3>
<p>The <strong>Outline</strong> 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.</p>
@@ -204,12 +207,26 @@ files and manually add them to your Eclipse workspace to experiment with some of
<p><img src="http://www.grammaticalframework.org/eclipse/images/eclipse-editor-cat.png" alt="Warnings and errors in the editor" /></p>
<h3>Validation</h3>
<p>For validation to work correctly, the project&#8217;s <strong>Build Automatically</strong> option should be turned on.</p>
<p>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.</p>
<p>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 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.</p>
<h3>Code formatting</h3>
<p>Use the built-in code formatter to tidy your code automatically. Right-click in the editor and choose <strong>Format</strong> or use the keyboard shortcut <strong>Ctrl+Shift+F</strong>.</p>
<p><img src="http://www.grammaticalframework.org/eclipse/images/eclipse-before-format.png" alt="Before auto-formatting" /> <img src="http://www.grammaticalframework.org/eclipse/images/eclipse-after-format.png" alt="After auto-formatting" /></p>
<h3>Syntax highlighting</h3>
<p>You can change your syntax colouring styles as you wish from <strong>Window &rarr; Preferences &rarr; Grammatical Framework &rarr; Syntax Coloring</strong></p>
<p><img src="http://www.grammaticalframework.org/eclipse/images/eclipse-syntaxcoloring.png" alt="Syntax highlighting styles" /></p>
<h3>Launch configurations</h3>
<p>Set up a launch configuration from <strong>Run &rarr; Run Configurations&#8230; &rarr; Grammatical Framework</strong>. You will see the dialog below with some fields automatically filled in for you.</p>
@@ -245,6 +262,29 @@ files and manually add them to your Eclipse workspace to experiment with some of
<p><em>The Eclipse console implementation does not support command history (up arrow) or auto-completion (tab).</em></p>
<h3><em>External Libraries</em> view</h3>
<p>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.</p>
<p><img src="http://www.grammaticalframework.org/eclipse/images/eclipse-external-libraries.png" alt="External libraries view" /></p>
<p><em>Future versions of this view will contain a full tree of all identifiers available in the current scope.</em></p>
<h3><em>Treebank Manager</em> view</h3>
<p>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:</p>
<ol>
<li>Create a file <code>test.trees</code> which contains a bunch of abstract syntax trees, which you want to test</li>
<li>Compile your grammar and linearise the trees one by one, using some command like <code>rf -lines -tree -file=test.trees | l -table | wf -file=test.trees.out</code></li>
<li>Manually correct the output in <code>test.trees.out</code> and save it as your gold standard file <code>test.gold</code>.</li>
<li>Each time you update your grammar, repeat step 2, then compare your new output against the gold standard using <code>diff</code> or some other comparison tool.</li>
</ol>
<p>The <strong>Treebank Manager</strong> 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:</p>
<p><img src="http://www.grammaticalframework.org/eclipse/images/eclipse-treebank-manager.png" alt="Treebank Manager view" /></p>
<h3>Logs</h3>
<p>The GFEP writes to the Eclipse platform log. This can be accessed in two ways:</p>
@@ -256,14 +296,6 @@ files and manually add them to your Eclipse workspace to experiment with some of
<p>You can set the log verbosity from <strong>Window &rarr; Preferences &rarr; Grammatical Framework</strong>.</p>
<h3>Validation</h3>
<p>For validation to work correctly, the project&#8217;s <strong>Build Automatically</strong> option should be turned on.</p>
<p>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.</p>
<p>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 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.</p>
<!----------------------------------------------------------------------------->
<h2>Evaluation &amp; feedback</h2>