root/trunk/README

Revision 150 (checked in by slee, 5 months ago)

last reorg and noswtich option

Line 
1 Jambu 0.0.7
2 ============
3
4 ================
5 * What is jambu?
6 ================
7
8 Jambu allows you to operate an application from switches or keys by
9 stepping around the UI rather than using an intermediate overlay (or OSK).
10 It uses the accessibility features of the Linux GNOME desktop.
11
12 This developer release works with Minefield (latest trunk version of Firefox 3)
13 and GTK accessibile apps (has been tested with gedit).
14
15 Find out the latest about the Jambu project and get the latest version from:
16
17   http://jambu.fullmeasure.co.uk
18
19 =====================
20 * Where to get jambu?
21 =====================
22
23 Please see:
24
25   http://jambu.fullmeasure.co.uk/download
26
27 Developers should see:
28
29   http://jambu.fullmeasure.co.uk/community/development
30
31 =======================
32 * How to Install jambu?
33 =======================
34  
35 In addition you'll want: Firefox 3
36          
37 Installing
38 ----------
39 1) Unzip the tarball (e.g tar xvf jambui-0.0.7.tar.gz)
40 2) cd (e.g. cd jambu-0.0.7)
41 3) python setup.py install (note run as root or sudo)
42
43
44 ====================
45 * How to use jambui?
46 ====================
47
48 When installed run:
49
50  jambu [--scan] [--showtree] Firefox | <other app name>
51    --scan          start auto scanning, otherwise manual
52    --showtree      show the GTKTreeView of accesible objects and other UI
53    --blink         blinking highlight, default is auto detect
54    --svg           svg highlight (requires transparency), default is auto detect
55    --noswitch      dont use switch input (doesn't require pygame)
56    -h           usage
57
58 Make sure Minefield is already open and make it the active application
59 again to be safe.
60
61 Note for developers:
62 --------------------
63 To run the local source version as apposed to the installed one run:
64   ./jambu Firefox
65
66 To make the tarball from the source run:
67   python setup.py sdist
68 and the tarball will be created in the 'dist' folder.
69
70 Operation
71 ---------
72 Use 'next' gesture to move around items and 'action' to enter a group of items or
73 perform the action for an interactive item. 'next' iterates around items in a
74 group and also the group itself to allow moving up and out of the group
75 (the highlight changes colour in this case).
76
77 See next section for gestures that invoke these actions
78
79 If you have a Window Manager that supports transparency (like Compiz on Ubuntu)
80 then SVG highlighting is auto selected. In case the detection fails you can use
81 --svg or to force the basic blinking highlight use --blink.
82
83 For now text is entered with the keyboard. Obviously a useable solution will
84 invoke an OSK like GOK or Dasher.
85
86 Ensure accerciser is not also running. In some circumstances this causes errors.
87
88 Actions and Gestures
89 --------------------
90 next item -> Left Ctrl key, USB Switch 0 or 4, middle mouse button
91 action item -> Right Ctrl key, USB switch 1 or 6, right mouse button
92
93 For the mouse gestures you need to display the UI and leave the pointer in the
94 spaces between the buttons and menus do not display properly as the mouse
95 interferes.
96
97 User Interface
98 -------------
99 A tree view is presented for developer use. It shows the model of accessibles
100 and provides buttons to (re)Generate the model, start/stop scanning and perform
101 an action.
102
103
104 ============================
105 * What known bugs are there?
106 ============================
107
108 * If highlight disappears simply do a 'next' action. The temporary use of simulated
109 mouse click for minefield menues and buttons requires that the highlight be hidden.
110 * Firefox Tabs don't work unless there are 3 of them - this is a firefox bug
111 * Need to sort multi column selections + scrolling in selections.
112 * Web document only works with visible items, need scrolling to hidden items.
113 * menus sometimes don't work - appears to be a firefox bug
114
115
116 =========================================
117 * Where can I find out more about Jambu?
118 =========================================
119
120 http://www.oatsoft.org/trac/jambu
Note: See TracBrowser for help on using the browser.