diff options
| author | hallgren <hallgren@chalmers.se> | 2012-08-27 14:56:10 +0000 |
|---|---|---|
| committer | hallgren <hallgren@chalmers.se> | 2012-08-27 14:56:10 +0000 |
| commit | dfcd61de00e472b4e137bc38259d9696c849af04 (patch) | |
| tree | b85631f9166135c310fc2dec3223cd49c2149f59 /src/www | |
| parent | a15e907e8031047c3da21ee84cf465c02d88fda8 (diff) | |
minibar documentation updates
Diffstat (limited to 'src/www')
| -rw-r--r-- | src/www/minibar/about.html | 9 | ||||
| -rw-r--r-- | src/www/minibar/minibar-api.html | 29 |
2 files changed, 28 insertions, 10 deletions
diff --git a/src/www/minibar/about.html b/src/www/minibar/about.html index 8b902051e..82ac96f8d 100644 --- a/src/www/minibar/about.html +++ b/src/www/minibar/about.html @@ -3,6 +3,9 @@ <title>About Minibar</title> <link rel=stylesheet type="text/css" href="minibar.css"> <meta charset="UTF-8"> +<style> +:target .summary { font-weight: bold; background: white; } +</style> </head> <body class=minibar> @@ -185,7 +188,9 @@ Some implementation details: the grammar menu. You can also add grammars from several directories on the same server of course. The included minibar configuration file adds the user's own grammars from the grammar editor. - <li>[Added 2012-04-02] Word-for-word replacement: when a complete and + <li id=wordforword> + [Added 2012-04-02] <span class=summary>Word-for-word replacements</span>: + when a complete and unambiguous sentence has been entered, the words glow blue and when you click on one, possible replacements appear. (Replacements are shown as names of functions in the abstract syntax for now. They should be shown as words @@ -212,7 +217,7 @@ Some implementation details: <hr> <div class=modtime><small> -<!-- hhmts start --> Last modified: Thu Apr 19 14:28:52 CEST 2012 <!-- hhmts end --> +<!-- hhmts start -->Last modified: Mon Aug 27 16:28:25 CEST 2012 <!-- hhmts end --> </small></div> <address> <a href="http://www.cse.chalmers.se/~hallgren/">TH</a> diff --git a/src/www/minibar/minibar-api.html b/src/www/minibar/minibar-api.html index f02837cc6..0ac1203d1 100644 --- a/src/www/minibar/minibar-api.html +++ b/src/www/minibar/minibar-api.html @@ -70,14 +70,18 @@ For an example, see <a href="minibar.html">minibar.html</a>. can be set to override various default options: <table class=border> <tr><th>Option<th>Default<th>Description - <tr><td>show_abstract<td>false<td rowspan=3>See Translations, + <tr><td>show_abstract<td>false<td rowspan=5>See Translations, not used directly by Minibar <tr><td>show_trees<td>false + <tr><td>tree_img_format<td>"png" <tr><td>show_grouped_translations<td>true - <tr><td>delete_button_text<td>"⌫"<td rowspan=3>See Input, + <tr><td>show_brackets<td>false + <tr><td>delete_button_text<td>"⌫"<td rowspan=5>See Input, not used directly by Minibar <tr><td>default_source_language<td>null + <tr><td>startcat_menu<td>true <tr><td>random_button<td>true + <tr><td>word_replacements<td>false <tr><td>try_google<td>true<td>Include a button to try the current sentence in Google Translate <tr><td>feedback_url<td>null<td>Include a button to open a feedback @@ -124,13 +128,19 @@ HTML file, you would normally include at least the following: can be set to override various default options: <table class=border> <tr><th>Option<th>Default<th>Description - <tr><td>delete_button_text<td>"⌫"<td>the label for the button that deletes the last word - <tr><td>default_source_language<td>null<td>the concrete language to + <tr><td>delete_button_text<td>"⌫"<td>The label for the button that deletes the last word. + <tr><td>default_source_language<td>null<td>The concrete language to use for input in case the user's browers doesn't supply a suitable default. If none is provided the first language in alphabetical order will be used. - <tr><td>random_button<td>true<td>include a button to generate a - random sentence + <tr><td>startcat_menu<td>true<td>Include a menu to choose which start + category to use for parsing (instead of the grammar's default start + category). + <tr><td>random_button<td>true<td>Include a button to generate a + random sentence. + <tr><td>word_replacements<td>false<td>Enable + <a href="about#wordforword">word-for-word replacements</a>. + (This is an experimental feature.) </table> <li><code>translations</code> is the object that is notified when the input @@ -179,7 +189,7 @@ and <a href="support.js">support.js</a>, so to use it in an HTML file, you would normally include at least the following: <blockquote><pre> -<script type="text/JavaScript" src="minibar_input.js"></script> +<script type="text/JavaScript" src="minibar_translations.js"></script> <script type="text/JavaScript" src="minibar_support.js"></script> <script type="text/JavaScript" src="support.js"></script> </pre></blockquote> @@ -196,8 +206,11 @@ HTML file, you would normally include at least the following: to the concrete syntax for the translations <tr><td>show_trees<td>false<td>add buttons to display syntax trees next to translations. + <tr><td>tree_img_format<td>"png"<td>format for trees & alignment images, + can be "gif", "png" or "svg" <tr><td>show_grouped_translations<td>true<td>in case there are multiple translations, group them by concrete language + <tr><td>show_brackets<td>false<td>show bracketed string </table> </ul> @@ -232,7 +245,7 @@ should add to the user interface: <hr> <div class=modtime> <small class=modtime> -HTML <!-- hhmts start --> Last modified: Mon Jun 11 17:55:10 CEST 2012 <!-- hhmts end --> +HTML <!-- hhmts start -->Last modified: Mon Aug 27 16:46:46 CEST 2012 <!-- hhmts end --> </small> </div> |