From 09f5c2c82b65d9801be9c300f7bcb29a20685c3b Mon Sep 17 00:00:00 2001
From: hallgren <hallgren@chalmers.se>
Date: Mon, 11 Jun 2012 16:00:03 +0000
Subject: minibar-api.html: small documentation improvements

---
 src/www/minibar/minibar-api.html | 16 +++++++++++-----
 1 file changed, 11 insertions(+), 5 deletions(-)

(limited to 'src')

diff --git a/src/www/minibar/minibar-api.html b/src/www/minibar/minibar-api.html
index 2c5a8ecc0..f02837cc6 100644
--- a/src/www/minibar/minibar-api.html
+++ b/src/www/minibar/minibar-api.html
@@ -138,7 +138,7 @@ HTML file, you would normally include at least the following:
   other apps might of course use the entered text for other purposes.
   The following methods will be called:
   <ul>
-    <li><code>translations.clear()</code> is called when there no entered
+    <li><code>translations.clear()</code> is called when there is no entered
     text.
     <li><code>translations.translateFrom({from:<var>conc</var>,input:<var>string</var>})</code>
     is called when the user has entered some text. The <code>from</code>
@@ -171,7 +171,7 @@ contains two field that the caller should add to the user interface:
 
 <h2 id=Translations>The Translations object</h2>
 
-This object display translations. It is defined in
+This object displays translations. It is defined in
 <a href="minibar_translations.js">minibar_translations.js</a>.
 It also uses some auxiliary functions defined
 in <a href="minibar_support.js">minibar_support.js</a>
@@ -209,9 +209,11 @@ The <code>translations</code> object created by the
 <code>Translations</code> constructor contains two field that the caller
 should add to the user interface:
 <ul>
-  <li><code>input.main</code> is the main user interface where the current
+  <li><code>translations.main</code> is the main user interface where the current
   translations are displayed.
-  <li><code>input.menus</code> contains the menu for selecting target language.
+  <li><code>translations.menus</code> contains the menu for selecting
+  a target language. The user can select <em>All</em> or one particular
+  language.
 </ul>
 
 <h3>Methods</h3>
@@ -220,13 +222,17 @@ should add to the user interface:
   after a different grammar is selected in the <code>server</code> object. It
   will clear away old translations and update the target language menu
   with the languages available in the new grammar.
+  <li><code>translations.clear()</code> clears the main output area from old translations.
+  <li><code>translations.translateFrom({from:<var>conc</var>,input:<var>string</var>})</code>
+  displays translations of the string given in the <code>input</code>
+  property from the concrete syntax indicated by the <code>from</code>.
 </ul>
 
 
 <hr>
 <div class=modtime>
 <small class=modtime>
-HTML <!-- hhmts start --> Last modified: Sun Aug 21 19:11:35 CEST 2011 <!-- hhmts end -->
+HTML <!-- hhmts start --> Last modified: Mon Jun 11 17:55:10 CEST 2012 <!-- hhmts end -->
 </small>
 </div>
 
-- 
cgit v1.2.3