From b2512234ddcb6b1fa196c21ae1aba1397ff35ffd Mon Sep 17 00:00:00 2001 From: hallgren Date: Thu, 11 Aug 2011 16:28:49 +0000 Subject: minibar: documentation and API work --- src/runtime/javascript/minibar/minibar-api.html | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) (limited to 'src/runtime/javascript/minibar/minibar-api.html') diff --git a/src/runtime/javascript/minibar/minibar-api.html b/src/runtime/javascript/minibar/minibar-api.html index 758080815..8899117e2 100644 --- a/src/runtime/javascript/minibar/minibar-api.html +++ b/src/runtime/javascript/minibar/minibar-api.html @@ -29,7 +29,7 @@ div.modtime { float: right; }

Minibar API

-The minibar is structured as three object: +The Minibar web app consists of the following objects:

Minibar @@ -42,10 +42,10 @@ They are described below.
The Minibar object

-This is the complete Minibar web app. It is defined in +This object implements the complete Minibar web app. It is defined in minibar.js. It also uses the Input -and Translations objects, and some auxiliary functions defined -in minibar_support.js +and Translations objects described below, and some auxiliary +functions defined in minibar_support.js and support.js, so to use it in an HTML file, you would normally include at least the following: @@ -116,7 +116,7 @@ HTML file, you would normally include at least the following:
Constructor
-var input=new Input(server,options,translations) +var input=new Input(server,translations,options)
- server is the PGF service object @@ -134,17 +134,22 @@ HTML file, you would normally include at least the following:
- translations is the object that is notified when the input - has changed. In the minibar, this is the object that display translations. + has changed. In the minibar, this is the object that display translations, but + other apps might of course use the entered text for other purposes. The following methods will be called:
  - translations.clear() +
  - translations.clear() is called when there no entered + text.
  - translations.translateFrom({from:conc,input:string}) + is called when the user has entered some text. The from + property is the name of the concrete syntax and the input + property is the entered text.
Properties and user interface
-The input object created by the Inputconstructor +The input object created by the Input constructor contains two field that the caller should add to the user interface:
- input.main is the main user interface where the current @@ -221,7 +226,7 @@ should add to the user interface:
  
  -HTML Last modified: Tue Aug 9 17:55:19 CEST 2011 +HTML Last modified: Thu Aug 11 17:14:37 CEST 2011
  -- cgit v1.2.3

Minibar API

The Minibar object

Constructor

Properties and user interface