Contact: Karin Weirich,   E-Mail: <100115.3527õCompuServe.COM>

Subject: Braille/2 description


I am pleased to inform you that the English Version of the Braille/2 Library V.
5.0 is now available.

Here are the highlights:

- braille setup menu for customizing most parameters.
- display of indentations and spacing for all applications.
- the possibility to route different objects like cursor, mouse, or Screen
Reader pointer.
- automatic mouse clicking on PM objects.
- positioning the braille display at a specified character for column up and
down reading.
- query mode to ask for object types.
- colour and font marking.
- colour bar tracking for DOS and OS/2 text applications.
- with SR/2 V. 2.0 the Braille/2 library provides "Tips and Keys" help files.

Currently the braille devices of the following braille vendors are supported:
Alva BV, HandyTech, Tieman, KTS.

Requirements: In order to use the Braille/2 library support for OS/2 you need a
system with OS/2 Version 2.1 or higher.
The IBM Screen Reader/2 Version 2.0 must be installed and a speech synthesizer
must be connected. The braille/2 library uses speech output for various
information. A braille only version is not available.

Braille/2 Library Overview:

Remarks:

1. IBM Screen Reader Version 2.0 must be installed in order to use the
Braille/2 Library.


2. The Braille/2 Library is built based on IBM Screen Reader Version 2.0.
For earlier versions only restricted support is available. It is
not intended to make the library generally available for earlier versions
of IBM Screen Reader.

3. Not all functions of the Braille/2 Library are available for all
supported Braille devices. For a list of the functions available
for a specific Braille device refer to supplementary documentation.

4. Some functions of this Library are only available if a suitable hardware
and in some cases additional keyboards are available.


Functions and Description

1. Switches

Start Braille Setup Menu

Use this function to start the setup menu.  The menu is displayed on
the braille device and completed by voice output. You find a
detailed description of each menu item at the end of this
document. Most settings for braille output are available from the
Braille Setup Menu. Numerous switches, settings and some query
functions can be activated using the menu. The advantage is that it is not
necessary to have specific key combinations on the braille display for
functions provided in the menu.

Using the up and down keys you can read the braille menu line by line. To
change a setting:
a) position the Braille window on the desired menu item and
b) press the cursor key on the Braille device (function: go to cursor
or selector) or press any of the touch cursor buttons above the menu item.

There are only few settings that require input from the PC keyboard or the
Screen Reader keypad.

After the Braille setup menu has been started, the line number of the
current menu item is displayed in the status field.

Leave Braille Setup Menu

Use this function to close the Braille setup menu. The settings you
selected remain active and the Braille device returns to normal mode.

Toggle cursor coupling

If cursor coupling is switched on, the Braille window follows the
cursor/selector whenever it is moved (unconditional connection). If cursor
coupling is switched off pressing the cursor/selector key positions the
braille window to the desired location, and the braille window
follows the cursor or selector when it is moved. The default setting for
cursor coupling is ON.

Toggle word wrap

If word wrap is switched on, only whole words are shown in the Braille
window. If there is not enough space left to display all characters of the
next word, the word is not displayed. No word parts are displayed. In
some cases word wrap is switched off automatically. If so, all text cells
of the braille display are used to display text. The default setting for
word wrap is OFF.

Toggle cursor emulation

If cursor emulation is switched on, pressing the up and down keys does not
move the braille window but emulates the cursor up/cursor down keys. You
can use this function only if your keyboard controler is a type one
controler.
The default setting for cursor emulation is OFF.

Direction keys for column reading

This function is used to define whether the direction keys (up and down
keys) move the braille window sequentially over the text or if they move it
vertically up and down a column.
The default setting for column reading is OFF.

Toggle between 6 and 8 dot Braille

Use this function to decide whether text is displayed using 8 or 6 dot
braille characters.
The default setting is 8 dot Braille.

Toggle blank line skip

Use this function to decide whether blank lines are displayed or not when
you move the braille window.

When reading sequentially or in columns, the default is not to display
blank lines. Instead, you hear a short beep from the PC speaker if the
braille window jumps over a blank line.

Toggle extended selector marking on and off

If extended selector marking is on, all characters in the selector are
marked using the mark symbol (dots 7 and 8 or only dot 8).

If the function is off, only the first character of the selector is marked
using the current cursor symbol.

Toggle key press notification

If key press notification is switched on, you hear a short, low beep from
the PC speaker each time you press a key on the braille device. You can use
this function, to check whether the communication between braille device
and PC works correctly or whether all keys on the braille device are
working.

The default setting for key notification is OFF.

Toggle beeps from PC speaker

If this function is ON (default), beeps for errors and other beeps come
from the PC speaker.

Toggle keypad pop-up on and off

If the braille device has an additional keypad that can be used to emulate
the Screen Reader keypad, you can use this function to activate and
deactivate the emulation. If keypad emulation is not active, you can use
the additional keypad on the braille device to perform other functions from
the Braille/2 library.

The default for keypad pop-up is ON.

Toggle mouse click

If mouse click is on (default), using mouse or selector routing a mouse
button click is performed automatically when you press a touch cursor
button. If you want to perform a single or double mouse click with the left
or right mouse button or you want to use drag and drop functions,
switch mouse click off and use the IBM Screen Reader keypad or the pop-up
keypad to perform the click.

Toggle cursor centering

If cursor centering is on (default), text lines that are longer than the
braille display are displayed with the cursor in the middle of braille
window. If cursor centering is switched off, the braille window is static
and the cursor moves over it.

Toggle 2dimensional display

If 2dimensional display is on (default), all objects that appear on the
same horizontal line on the screen are displayed in the same line on the
braille display. In addition, the distance between objects is calculated
based on their width and on the font size using specific algorithms and is
shown on the braille display. This enables you to directly get an
impression of the layout of the screen or of a document.

Toggle color bar 1 tracking on and off

Use this function to switch tracking for the first attribut cursor on or
off. The default for color bar tracking is OFF.

Toggle color bar 2 tracking on and off

Use this function to switch tracking for the second attribut cursor on
or off. The default for color bar tracking is OFF.


Toggle color bar 3 tracking on and off

Use this function to switch tracking for the third attribut cursor on or
off. The default for color bar tracking is OFF.

Toggle color marking

If you activated a color marking function, you can use this function to
switch marking off for better readability and on again. When color marking
is on, text that is displayed on screen with a specified color is marked
on the braille display using the current mark symbol, which may be dots 7
and 8 or dot 8 only.

Toggle font marking


If you activated a font marking function, you can use this function to
switch marking off for better readability and on again. When color marking
is on, text that is displayed on screen with a specified color is marked
on the braille display using the current mark symbol, which may be dots 7
and 8 or dot 8 only.

2. Movements:
-------------

Go to cursor or selector

Use this function to move the braille window

a) to the line containing the cursor.
b) If there is no cursor in the active viewport, a selector is searched
for, and if found, the braille window is moved to that position.
c) If there is no selector and no cursor, the braille window is moved to
the line with a default button, if there is one.

If none of these conditions is true, the braille window is not moved.

Go to selector

Using this function the braille window

a) is moved to the line with the selector.
b) If there is no selector in the active viewport, the braille window is
moved to the line with an attribut cursor if there is one.
c) If there is no attribut cursor either, the braille window is moved to
the line with the default button if there is one.

If none of these conditions is true, the braille window is not moved.

Cycle through selectors

If there is more than one selector in the current viewport, using this
function moves the braille window in a cycle from one selector to the next.

Go to default button

This function moves the braille window to the line that contains a default
button. If there is no default button in the current viewport the braille
window position is not changed.

Go to next default button

If there is more than one default button in the current viewport, you can
use this function to move the braille window to the next default button.

Go to Screen Reader pointer

Use this function to move the braille window to that line, that contains
the Screen Reader pointer. If your synthesizer supports indexing, pointer
coupling is actived automatically and stays in effect until you press
another key on the braille device.

Go to mouse

If the mouse pointer is positioned on a text row in the active viewport,
this function moves the braille window to that line.

Left and Backward

Use this function to move the braille window to the left or towards the
top.
If column reading with direction keys is active, the braille window
is moved up vertically. If cursor emulation is switched on, the cursor is
moved to the previous line.

Right and forward

Use this function to move the braille window to the right or toward the
bottom.
If column reading with direction keys is switched on, the braille
window is moved down vertically. If cursor emulation is switched on, the
cursor is moved to the next line.

Column up

This function moves the braille window vertically towards the top with
respect to the choosen column position.

Column down

This function moves the braille window vertically towards the bottom with
respect to the choosen column position.

Go to top

This function moves the braille window to the first line in the current
viewport.

Go to bottom

This function moves the braille window to the last line in the current
viewport.

Go to left edge

This function moves the braille window to column one of the current line.

Go to right edge

This function moves the braille window to the right, so that the last
character of the current line is displayed.

Go half line left

If the first character of the current line is not yet displayed in the
braille window, the braille window is moved left for the half of its width
(for instance 20 characters, if you have a braille display with 40 text
cells).

Go half line right

If the last character of the current line is not yet displayed in the
braille window, the braille window is moved right for the half of its
width.

Go one word left

This function moves the braille window one word to the left, if possible.

Go one word right

This function moves the braille window one word right, if possible.

Go one character left

This function moves the braille window one character to the left, if there
is one in the current line.

Go one character right

This function moves the braille window one character to the right, if
there is one in the current line.

Go to marked line (marked line 1 to 4)

This function moves the braille window to a previously marked line. You can
mark up to 4 lines and jump to each of these lines separatly if there are
enough keys or key combinations available on the braille display.

Display line 1 to 9

This function moves the braille window to the line specified
by the line number.

Display line 10 to 19

This function moves the braille window to the line specified
by the line number.

Display line 20 to 29

This function moves the braille window to the line specified
by the line number.

Display line 30 to 39

This function moves the braille window to the line specified
by the line number.

Display line 40 to 49

This function moves the braille window to the line specified
by the line number.

Display line 50 to 59

This function moves the braille window to the line specified
by the line number.

Display line 60 to 69

This function moves the braille window to the line specified
by the line number.

3. Mouse Button and Keyboard keys emulation:

Note: The following functions of the Braille/2 library are only available,
if the computer system has a type 1 keyboard controller, and if the braille
device is equipped with an additional keypad.

Emulate mouse buttons

This function emulates the mouse functions that are also available from the
Screen Reader keypad.

Tab Key

emulates pressing the tab key.

Shift Tab Key

emulates pressing the tab key with shift key down.

Page up

emulates pressing the page up key.

Alt Page up

Emulates pressing the key combination Alt + Page up.

CTRL Page up

Emulates pressing the key combination CTRL + Page up.

Page down

Emualtes pressing the page down key.

Alt Page down

Emulates pressing the key combination Alt + Page down.

CTRL Page down

Emulates pressing the key combination CTRL + Page down.

Cursor left

Emulates pressing the left arrow key.

CTRL Cursor left

Emulates pressing the key combination CTRL + left arrow key.

Cursor up

Emulates pressing the up arrow key.

Alt Cursor up

Emulates pressing the key combination ALT + up arrow key.

Cursor down

Emulates pressing the down arrow key.

Alt Cursor down

Emulates pressing the key combination Alt + down arrow key.

Cursor right

Emulates pressing the right arrow key.

STRG Cursor right

Emulates pressing the key combination STRG + right arrow key.

One more key emulates a function key

Emulates function keys 1 to 12.

One more key emulates Alt + function key

Emulates pressing the key combination Alt + function key 1 to 12.

One more key emulates Shift + function key

Emulates pressing the key combination Shift + function key 1 to 12.

One more key emulates CTRL + function key

Emulates pressing the key combination STRG + function key 1 to 12.

Escape key

Emulates pressing the Escape key.

Alt + Escape key

Emulates pressing the key combination Alt + Escape key.

CTRL + Escape key

Emulates pressing the key combination CTRL + Escape key.

Enter key

Emulates pressing the enter key.

Delete key

Emulates pressing the DEL key.

HOME key

Emulates pressing the HOME key.

END key

Emulates pressing the END key.

Move to clipboard

Emulates the key combination shift + DEL key.

Paste from clipboard

Emulates the key combination shift + insert.

Copy to clipbord

Emulates the key combination CTRL + insert.

4. Settings
-----------

Define symbol for color and fontmarking

Use this function to choose the symbol that is used for color and font
marks. You can choose either dots 7 and 8 or only dot 8. The default
is to mark the text using dots 7 and 8.

Set device mode

Use this function to select the operation mode for the touch cursor
buttons. The four modes available are:

1. Object routing (moving objects)
2. Parameter setting
3. Query
4. Setting color and font marks and defining of color bar cursors.
   Refer to document status.txt.

For each operation mode several functions are available. You find a
description for the functions in section "Set routing mode".

Set routing mode

This setting is used to set the current function for the operation mode
selected for the touch cursor buttons on the braille device. The functions
for each operation mode are listed below. Refer to document status.txt.

1. If routing mode is selected, you can choose from following functions:
   a) Cursor routing. This function enables you to move the cursor to a
      specified screen position using the touch cursor buttons.
   b) Mouse routing. This function enables you to move the mouse pointer
      to a specified screen posiiton using the touch cursor buttons. If
      mouse click is switched on, an automatic mouse click is performed at
      the target position.
   c) Screen Reader pointer routing. This function enables you to move
      the Screen Reader pointer to a specified screen position using the
      touch cursor buttons.
   d) Cursor routing with shift key down. You can use this function to mark
      text in most word processing applications.

2. If settings is active, you can choose from following functions:
   a) set braille window column. By pressing the touch cursor button
      above the desired text column the braille window is moved to
      display the choosen column at the left edge. In addition, this
      column is saved for column reading.
   b) set alerts position. By pressing the touch cursor button above the
      desired text column the alerts position is defined. To toggle margin
      alerts on or off use the standard Screen Reader function from the
      keypad.
3. If Query mode is active, you can choose from the following functions:
   a) Query object. You can determine type and state of any object by
      simply pressing a touch cursor button above it.
   b) Query position. You can determine the text column and the pixel
      coordinates in the active viewport by simply pressing a touch cursor
      button.
4. If marking is active, you can choose from the following functions:
   a) Color attribut marking. All characters that are displayed on the
      screen with the same color attribut as the choosen character are
      marked with the marking symbol by simply pressing a touch cursor
      button above a character. In addition, the color attribute is saved
      temporarily in case you want to define an attribut cursor. The color
      combination you choose is announced. This enables you to get an
      impression of the color layout used for the current application
      window.
   b) Marking of foreground color. All characters that are displayed on the
      screen with the same foreground color as the choosen character are
      marked with the marking symbol by simply pressing a touch cursor
      button above a character. In addition, the foreground color is saved
      temporarily in case you want to define an attribut cursor. The marked
      foreground color is announced. This enables you to get an
      impression of the color layout used for the current application
      window.
   b) Marking of background color. All characters that are displayed on the
      screen with the same background color as the choosen character are
      marked with the marking symbol by simply pressing a touch cursor
      button above a character. In addition, the background color is saved
      temporarily in case you want to define an attribut cursor. The marked
      background color is announced. This enables you to get an
      impression of the color layout used for the current application
      window.
   d) Font marking. All characters that are displayed on the
      screen with the same font as the choosen character are
      marked with the marking symbol by simply pressing a touch cursor
      button above a character. The marked font is announced.
      This enables you to get an impression of the font layout used for
      the current application window.
   e) Set top left corner for the search window.
      The coordinations of a character are saved for definition of a
      search window simply by pressing a touch cursor button above the
      character you want.
   f) Set bottom right corner for the search window.
      The coordinations of a character are saved for definition of a
      search window simply by pressing a touch cursor button above the
      character you want.
   g) Save settings for attribut cursor and search window. By simply
      presssing one of the first three touch cursor buttons in the
      text area of the braille device the attribut cursor and its search
      window are saved as defined with the above described functions.
      You can define up to three attribut cursors. You can use attribut
      cursors only in text windows.

Set cursor shape

Use this function to change the symbol that used to display the cursor in
the braille window. You can choose one of the following shapes for the
cursor symbol:
a) Full form. All dots are set at the cursor position.
b) No cursor. The cursor is not visible in the braille window. You can read
the character at the cursor position.
c) Underline cursor. Dots 7 and 8 are set at the cursor position.
d) Dot 8 cursor. Only dot 8 is used to indicate the cursor position.
With this cursor shape it is possible to recognize upper case letters.

Set Braille column

Use this function to adjust the braille window to a specific text column.
Refer to section "routing mode - set braille window column" for more
information.

Define symbol for areas outside the window

You can mark areas of the braille window that are not part of the current
applications window with an user-defined symbol. The default symbol is dot
8. After invoking this function you are asked to enter the dot combination
for the symbol using the Screen Reader keypad. Use keypad key 0 to make
these areas look like spaces (to erase an earlier defined symbol).

Mark current line (line 1 to 4)

Use this function to save the line number of the line currently displayed
in the braille window. After saving the number you can use the function "go
to marked line" to jump to this line directly. You can save up to 4 lines
in the active viewport, to which you can jump separatly. It is required
that there are enough keys or key combinations available on the braille
display to save all line numbers.

Set position of typewriter bell

Use this function to set the margin alerts position to the text column you
want. Refer to section "Routing mode - set alerts position" for more
information.

Query object

This function returns the type and the current state of an object. Refer to
section "Routing mode - query object" for more information.

Load Braille table

Use this function to load a new braille table. After invoking the function
you must enter the file name of a file containing a valid braille table
from the keyboard. The file braille.tab contains the default table. Braille
tables for German and for US computerbraille are available. The user may in
addition create his own braille tables using an ASCII editor.

Toggle function keys

If the braille device has one function key set on the left and another one
on the right side, you can use this function to reverse the function key
definitions for these blocks.

Toggle direction keys to reverse the definition for the up and down keys.

5. Display functions / Miscellaneous
-------------------------------------

Version and serial number

This function displays the version number and the serial number of your
Braille/2 Library license. This information is also shown in the Braille
Setup Menu.

Copiright Notice

This function shows the copyright notice for the Braille/2 library.

Announce current line number

This function is used to display and to announce the line number of the
currently displayed line.

Announce Braille column

This function is used to display and announce the column number that is
currently displayed in text cell one in the braille window.

Refresh display without cursor

This function is used to blank out the cursor symbol
temporarily in order to read the character at the cursor
position.

Stop speech

This function stops the current announcement.

Help mode on/off

Use this function to switch Screen Reader help mode on or off. As for the
keypad keys help is provided by the Braille/2 library for all keys on the
Braille display. When help mode is on and you press a keys on the braille
display, the function of the key or key combination is announced.

Test device

Use this function to raise all pins in all cells in the braille window.
Using this function you can easily determine whether all cells work
correctly.

Reset all Braille keys

If there are problems with the communication between braille device and
computer it sometimes may happen that the Braille/2 library does not get
all messages from the braille device. It may then happen that the library
shows that there are one or more keys down on the braille device, though
the user has released all keys.

In this case you can use this function to tell the Braille/2 library that
there are no keys pressed at the braille device.

Note: This function does not perform a hardware check.

Toggle alerts

This is a normal Screen Reader function, which you may perform from the
Screen Reader keypad or from the pop-up keypad.

Toggle speech

This function is not available.

Activate Parallel Connection

This function is not available.

Activate connection to COM2

This function is not available.

Activate connection to COM1

This function is not available.

Status display

This function is used to blank out the normal text in the braille window
and to display a status information block. This function is helpful to
query the status for braille devices that do not have separate status
cells.

Announce EPROM version

Announces the EPROM version of the braille device, if available.

6. The Braille Setup Menu
-------------------------

The Braille Setup menu is very similar to a context menu. There are two
menu levels. The first or main level has six entries to chose from. Each
item except the title line has a submenu.

The main menu:

The status area of the braille display shows the number of the current
menu item. If it has a submenu, the icon character is displayed to the
right of the item text in the braille window. The following list shows the
main menu and the five submenus:

Default values for settings in submenus are written in uppercase.

The main menu:

line 1   0,0   *****   Braille-Setup Menu   *****
line 2   1,0   Information
line 3   2,0   Settings for Cursor and Mouse
line 4   3,0   Settings for Selector and Marking
line 5   4,0   Braille Settings
line 6   5,0   Other Settings


The Submenu for Information:

line 1   1,1   :   Information about the Braille/2 Library in use
line 2   1,2   :   Copyright note
line 3   1,3   :   Version number and date of the Braille/2 Library
line 4   1,4   :   Serial number and User name
line 5   1,5   displays the line and column numbers of the currently
               displayed line. The values are related to the first text
               cell on the braille display.


The Submenu for Settings for Cursor and Mouse:

line 1   2,1   Cursor coupling  :  off/ON
line 2   2,2   Cursor emulation  :  OFF/on
line 3   2,3   Cursor symbol  :  (Braille Symbol)
                (all dots / no display / Dot 7 and 8 / only dot 8)
line 4   2,4   Cursor centering  :  off/ON
line 5   2,5   Automatic Mouse button click  :  off/ON
line 6   2,6   Move mouse with brailleWindow  :  OFF/on
line 7   2,7   Mouse click at SR/2 pointer position  :  off/ON


The Submenu for settings for selector and marking:

line 1   3,1   Extended selector marking  :  off/ON
line 2   3,2   Symbol for color and font marking  : (Braille-Symbol)
                (DOTS 7 AND 8 / only dot 8)
line 3   3,3   color marking  :  OFF/on
line 4   3,4   font marking  :  OFF/on
line 5   3,5   color bar 1 tracking  :  OFF/on
line 6   3,6   color bar 2 tracking  :  OFF/on
line 7   3,7   color bar 3 tracking  :  OFF on


The Submenu for Braille Settings:

line 1   4,1   Six dot Braille  :  OFF/on
line 2   4,2   Current Braille table  :  (Filename)
                Note: To load another braille table enter the file name
                from the PC keyboard.
line 3   4,3   Braille display at column  :  xxx
                Note: To position the Braille window to a specific column
                enter the column number from the SR/2 keypad.
line 4   4,4   Symbol for areas outside windows  : (Braille symbol)
                Note: To modify the symbol, enter the dot combination
                from the SR/2 keypad.
line 5   4,5   Word wrap  :  OFF/on
line 6   4,6   move backwards word by word  :  OFF/on
line 7   4,7   2dimensional display  :  off/ON


The Submenu for Other Settings:

line 1   5,1   Skip blank lines  :  off/ON
line 2   5,2   Alerts at position  :  xxx
                Note: To set the margin alert to a new position, just
                press the touch cursor button for that position.
line 3   5,3   Key notification  :  OFF/on
line 4   5,4   Beep on PC speakter  :  off/ON
line 5   5,5   Pop-up keypad on numeric pad  :  off/ON
line 6   5,6   Inversed function keys  :  OFF/on
line 7   5,7   Inversed direction keys  :  OFF/on