From dfcd61de00e472b4e137bc38259d9696c849af04 Mon Sep 17 00:00:00 2001 From: hallgren Date: Mon, 27 Aug 2012 14:56:10 +0000 Subject: [PATCH] minibar documentation updates --- src/www/minibar/about.html | 9 +++++++-- 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 @@ About 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. -
  • [Added 2012-04-02] Word-for-word replacement: when a complete and +
  • + [Added 2012-04-02] Word-for-word replacements: + 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:
    - Last modified: Thu Apr 19 14:28:52 CEST 2012 +Last modified: Mon Aug 27 16:28:25 CEST 2012
    TH 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 minibar.html. can be set to override various default options:
    OptionDefaultDescription -
    show_abstractfalseSee Translations, +
    show_abstractfalseSee Translations, not used directly by Minibar
    show_treesfalse +
    tree_img_format"png"
    show_grouped_translationstrue -
    delete_button_text"⌫"See Input, +
    show_bracketsfalse +
    delete_button_text"⌫"See Input, not used directly by Minibar
    default_source_languagenull +
    startcat_menutrue
    random_buttontrue +
    word_replacementsfalse
    try_googletrueInclude a button to try the current sentence in Google Translate
    feedback_urlnullInclude 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:
    OptionDefaultDescription -
    delete_button_text"⌫"the label for the button that deletes the last word -
    default_source_languagenullthe concrete language to +
    delete_button_text"⌫"The label for the button that deletes the last word. +
    default_source_languagenullThe 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. -
    random_buttontrueinclude a button to generate a - random sentence +
    startcat_menutrueInclude a menu to choose which start + category to use for parsing (instead of the grammar's default start + category). +
    random_buttontrueInclude a button to generate a + random sentence. +
    word_replacementsfalseEnable + word-for-word replacements. + (This is an experimental feature.)
  • translations is the object that is notified when the input @@ -179,7 +189,7 @@ and support.js, so to use it in an HTML file, you would normally include at least the following: 
    -<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>
    @@ -196,8 +206,11 @@ HTML file, you would normally include at least the following: to the concrete syntax for the translations
    • show_treesfalseadd buttons to display syntax trees next to translations. +
    tree_img_format"png"format for trees & alignment images, + can be "gif", "png" or "svg"
    show_grouped_translationstruein case there are multiple translations, group them by concrete language +
    show_bracketsfalseshow bracketed string
    @@ -232,7 +245,7 @@ should add to the user interface:
    -HTML Last modified: Mon Jun 11 17:55:10 CEST 2012 +HTML Last modified: Mon Aug 27 16:46:46 CEST 2012