diff options
Diffstat (limited to 'src/www/syntax-editor/README.md')
| -rw-r--r-- | src/www/syntax-editor/README.md | 78 |
1 files changed, 57 insertions, 21 deletions
diff --git a/src/www/syntax-editor/README.md b/src/www/syntax-editor/README.md index 50f911f13..1a029f9b5 100644 --- a/src/www/syntax-editor/README.md +++ b/src/www/syntax-editor/README.md @@ -1,3 +1,13 @@ +<!DOCTYPE html> +<html> +<head> +<title>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"> + # GF web-based syntax editor John J. Camilleri @@ -7,35 +17,55 @@ An improved version of the [old syntax editor][1]. [1]:http://www.grammaticalframework.org/~meza/restWiki/editor.html -## Notes +## Example usage -- Tested with latest Chrome and Firefox (only). +See `editor.html` and `editor_online.js`. ## Available startup options -|Options|Description|Default| -|-------|-----------|-------| -|target | |"editor"| -|initial.grammar|Initial grammar URL, e.g. `"http://localhost:41296/grammars/Foods.pgf"`|-| -|initial.startcat|Initial startcat|-| -|initial.languages|Initial linearisation languages, e.g. `["Eng","Swe","Mlt"]`|-| -|initial.abstr|Initial abstract tree (as string), e.g. `"Pred (That Fish) Expensive"`|-| -|show.grammar_menu|Show grammar menu?|true| -|show.startcat_menu|Show start category menu?|true| -|show.to_menu|Show languages menu?|true| -|show.random_button|Show random button?|true| - -## Example usage ++---------------------+--------------------------------------------------+--------+ +|Options |Description |Default | ++=====================+==================================================+========+ +|target | |"editor"| +| | | | ++---------------------+--------------------------------------------------+--------+ +|initial.grammar |Initial grammar URL, | | +| |e.g. `"http://localhost:41296/grammars/Foods.pgf"`| | ++---------------------+--------------------------------------------------+--------+ +|initial.startcat |Initial startcat |(grammar| +| | |default)| ++---------------------+--------------------------------------------------+--------+ +|initial.languages |Initial linearisation languages, |(all) | +| |e.g. `["Eng","Swe","Mlt"]` | | ++---------------------+--------------------------------------------------+--------+ +|initial.abstr |Initial abstract tree (as string), e.g. `"Pred | | +| |(That Fish) Expensive"` | | ++---------------------+--------------------------------------------------+--------+ +|show_grammar_menu |Show grammar menu? |True | +| | | | ++---------------------+--------------------------------------------------+--------+ +|show_startcat_menu |Show startcat menu? |True | +| | | | ++---------------------+--------------------------------------------------+--------+ +|show_to_menu |Show languages menu? |True | +| | | | ++---------------------+--------------------------------------------------+--------+ +|show_random_button |Show random button? |True | +| | | | ++---------------------+--------------------------------------------------+--------+ +|show_import |Show import button/panel? |True | +| | | | ++---------------------+--------------------------------------------------+--------+ +|show_export |Show export button? |True | +| | | | ++---------------------+--------------------------------------------------+--------+ -See `editor.html` and `editor_online.js`. - -## Bugs +## Notes -- Change startcat doesn't work when given an initial startcat +- Tested with latest Chrome and Firefox (only). -## TODO +## To do/feature requests -- Import AST from text field - Compatibility with grammars with dependent category types - Clicking on tokens to select tree node - Clipboard of trees @@ -46,3 +76,9 @@ See `editor.html` and `editor_online.js`. - undo/redo (or back/forward) navigation - structure fridge magnets more (eg newline before the magnet whose first letter is different) +## Known bugs + +- Change startcat doesn't work when given an initial startcat + +</body> +</html> |