summaryrefslogtreecommitdiff
path: root/src/www/syntax-editor/about.html
diff options
context:
space:
mode:
authorjohn.j.camilleri <john.j.camilleri@chalmers.se>2013-01-11 15:33:17 +0000
committerjohn.j.camilleri <john.j.camilleri@chalmers.se>2013-01-11 15:33:17 +0000
commitb8e3fe7bc099d3ee09f1c5dfe05fab1fd73afed1 (patch)
treebdea3f8224ba39bd85f6ca4c1f849113765393ef /src/www/syntax-editor/about.html
parentbe5a313372fbafa13f8f45357b9ee3a84d18b10f (diff)
Syntax editor: initial support for string literals
Also a bug fix when switching to editor, although this still messes up when using the letters grammar. Also updated readme with options, and some style improvements.
Diffstat (limited to 'src/www/syntax-editor/about.html')
-rw-r--r--src/www/syntax-editor/about.html113
1 files changed, 65 insertions, 48 deletions
diff --git a/src/www/syntax-editor/about.html b/src/www/syntax-editor/about.html
index a05d1dd20..8f9e561f1 100644
--- a/src/www/syntax-editor/about.html
+++ b/src/www/syntax-editor/about.html
@@ -6,83 +6,100 @@ About the syntax editor
</title>
<link rel=stylesheet type="text/css" href="../minibar/minibar.css"> <link rel=stylesheet type="text/css" href="editor.css"> <meta charset="UTF-8">
</head>
-<body class="syntax-editor">
+<body class="about">
<h1 id="gf-web-based-syntax-editor">GF web-based syntax editor</h1>
-<p>John J. Camilleri<br>December 2012</p>
-<p>An improved version of the <a href="http://www.grammaticalframework.org/~meza/restWiki/editor.html">old syntax editor</a>.</p>
+<p>John J. Camilleri<br />January 2013</p>
+<p>A tool for building and manipulating abstract syntax trees in GF. This is meant as improved replacement of the <a href="http://www.grammaticalframework.org/~meza/restWiki/editor.html">old syntax editor</a>.</p>
<h2 id="example-usage">Example usage</h2>
-<p>See <code>editor.html</code> and <code>editor_online.js</code>.</p>
+<p>If you want to use the tool in your own application, everything you need in the source files <code>editor.html</code> and <code>editor_online.js</code>. Contact the <a href="http://groups.google.com/group/gf-dev">GF developer mailing list</a> if you have any problems.</p>
<h2 id="available-startup-options">Available startup options</h2>
+<h3 id="grammar-manager">Grammar Manager</h3>
<table>
-<col style="width: 26%" /><col style="width: 62%" /><col style="width: 10%" /><thead>
+<thead>
<tr class="header">
-<th style="text-align: left;">Options</th>
-<th style="text-align: left;">Description</th>
-<th style="text-align: left;">Default</th>
+<th align="left">Options</th>
+<th align="left">Description</th>
+<th align="left">Default</th>
</tr>
</thead>
<tbody>
<tr class="odd">
-<td style="text-align: left;">target</td>
-<td style="text-align: left;">
-
-</td>
-<td style="text-align: left;">&quot;editor&quot;</td>
+<td align="left"><code>initial.grammar</code></td>
+<td align="left">Initial grammar URL, e.g. <code>&quot;http://localhost:41296/grammars/Foods.pgf&quot;</code></td>
+<td align="left"></td>
</tr>
<tr class="even">
-<td style="text-align: left;">initial.grammar</td>
-<td style="text-align: left;">Initial grammar URL, e.g. <code>&quot;http://localhost:41296/grammars/Foods.pgf&quot;</code></td>
-<td style="text-align: left;">
-
-</td>
+<td align="left"><code>initial.startcat</code></td>
+<td align="left">Initial startcat</td>
+<td align="left">(grammar default)</td>
+</tr>
+<tr class="odd">
+<td align="left"><code>initial.languages</code></td>
+<td align="left">Initial linearisation languages, e.g. <code>[&quot;Eng&quot;,&quot;Swe&quot;,&quot;Mlt&quot;]</code></td>
+<td align="left">(all)</td>
+</tr>
+</tbody>
+</table>
+<h3 id="editor">Editor</h3>
+<table>
+<thead>
+<tr class="header">
+<th align="left">Options</th>
+<th align="left">Description</th>
+<th align="left">Default</th>
</tr>
+</thead>
+<tbody>
<tr class="odd">
-<td style="text-align: left;">initial.startcat</td>
-<td style="text-align: left;">Initial startcat</td>
-<td style="text-align: left;">(grammar default)</td>
+<td align="left"><code>target</code></td>
+<td align="left"></td>
+<td align="left">&quot;editor&quot;</td>
</tr>
<tr class="even">
-<td style="text-align: left;">initial.languages</td>
-<td style="text-align: left;">Initial linearisation languages, e.g. <code>[&quot;Eng&quot;,&quot;Swe&quot;,&quot;Mlt&quot;]</code></td>
-<td style="text-align: left;">(all)</td>
+<td align="left"><code>initial.abstr</code></td>
+<td align="left">Initial abstract tree (as string), e.g. <code>&quot;Pred (That Fish) Expensive&quot;</code></td>
+<td align="left"></td>
</tr>
<tr class="odd">
-<td style="text-align: left;">initial.abstr</td>
-<td style="text-align: left;">Initial abstract tree (as string), e.g. <code>&quot;Pred (That Fish) Expensive&quot;</code></td>
-<td style="text-align: left;">
-
-</td>
+<td align="left"><code>lin_action</code></td>
+<td align="left">Function called when clicking on the language button beside each linearisation.</td>
+<td align="left"></td>
</tr>
<tr class="even">
-<td style="text-align: left;">show_grammar_menu</td>
-<td style="text-align: left;">Show grammar menu?</td>
-<td style="text-align: left;">True</td>
+<td align="left"><code>lin_action_tooltip</code></td>
+<td align="left">Tooltip for the button beside each linearisation.</td>
+<td align="left"></td>
</tr>
<tr class="odd">
-<td style="text-align: left;">show_startcat_menu</td>
-<td style="text-align: left;">Show startcat menu?</td>
-<td style="text-align: left;">True</td>
+<td align="left"><code>show_grammar_menu</code></td>
+<td align="left">Show grammar menu?</td>
+<td align="left">True</td>
</tr>
<tr class="even">
-<td style="text-align: left;">show_to_menu</td>
-<td style="text-align: left;">Show languages menu?</td>
-<td style="text-align: left;">True</td>
+<td align="left"><code>show_startcat_menu</code></td>
+<td align="left">Show startcat menu?</td>
+<td align="left">True</td>
</tr>
<tr class="odd">
-<td style="text-align: left;">show_random_button</td>
-<td style="text-align: left;">Show random button?</td>
-<td style="text-align: left;">True</td>
+<td align="left"><code>show_to_menu</code></td>
+<td align="left">Show languages menu?</td>
+<td align="left">True</td>
</tr>
<tr class="even">
-<td style="text-align: left;">show_import</td>
-<td style="text-align: left;">Show import button/panel?</td>
-<td style="text-align: left;">True</td>
+<td align="left"><code>show_random_button</code></td>
+<td align="left">Show random button?</td>
+<td align="left">True</td>
</tr>
<tr class="odd">
-<td style="text-align: left;">show_export</td>
-<td style="text-align: left;">Show export button?</td>
-<td style="text-align: left;">True</td>
+<td align="left"><code>show_import</code></td>
+<td align="left">Show import button/panel?</td>
+<td align="left">True</td>
+</tr>
+<tr class="even">
+<td align="left"><code>show_export</code></td>
+<td align="left">Show export button?</td>
+<td align="left">True</td>
</tr>
</tbody>
</table>
@@ -98,7 +115,7 @@ About the syntax editor
<li>Usage of printnames</li>
<li>Enter string/float/int literals</li>
<li>more prominence to Disamb-linearizations</li>
-<li>show all resulting linearizations/variants</li>
+<li>show all resulting linearization variants</li>
<li>undo/redo (or back/forward) navigation</li>
<li>structure fridge magnets more (eg newline before the magnet whose first letter is different)</li>
</ul>