README 2.98 KB
Newer Older
Javier Hernández's avatar
Javier Hernández committed
1
Accerciser 3.22.0
2 3 4 5 6 7
Just 15 minutes a day for better accessibility!

Description
===========

  Accerciser is an interactive Python accessibility explorer for the GNOME
Javier Jardón's avatar
Javier Jardón committed
8
  desktop. It uses AT-SPI2 to inspect and control widgets, allowing you to check
9 10 11 12 13 14
  if an application is providing correct information to assistive technologies
  and automated test frameworks. Accerciser has a simple plugin framework which
  you can use to create custom views of accessibility information.

  In essence, Accerciser is a next generation at-poke tool.

15 16 17
Features
========

Javier Jardón's avatar
Javier Jardón committed
18
* Based in at-spi2
19

Javier Jardón's avatar
Javier Jardón committed
20
Accerciser uses the new dbus-based accessiblity framework.
21 22 23 24

* Plugin architecture

Create a Python module, drop it in a folder, and have it load as a plugin pane
Javier Jardón's avatar
Javier Jardón committed
25
with full access to AT-SPI2 and the selected element in the accessibility tree
26 27 28 29 30 31 32 33 34
view.

* Interface browser and event monitor plugins

All the features you've come to expect from a poke tool, and then some.

* IPython console plugin

A full, interactive Python shell with access to the accessible object selected
Javier Jardón's avatar
Javier Jardón committed
35
in the tree view; all AT-SPI2 interfaces, methods and attributes; and any other
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
Python modules. Supports autocompletion and a million other niceties thanks to
IPython.

* API browser plugin
  
Shows the interfaces, methods, and attributes available on the selected
accessible object.

* Global hotkeys

Move the tree view quickly to the last focused accessible or the one under the
mouse pointer. Insert a marker into the event monitor log for easy
identification at a later time.

* Customizable UI layout

Move plugin tabs to different panels or even separate windows to view them
concurrently.

* Accessibility!

Accerciser does not disable its own accessibility.

* Yelp documentation
  
Included in the package.

* Python powered

Brits, not serpents.


68 69 70
Requirements
============

Javier Hernández's avatar
Javier Hernández committed
71 72 73 74 75 76
As Accerciser uses pygobject, you'll need to have the following libraries:

    gobject-introspection
    python-gobject >= 2.90.3
    gtk+3 >= 3.1.13

77 78
  On a Red Hat based distro:

Javier Hernández's avatar
Javier Hernández committed
79
    python >= 3.2
Javier Hernández's avatar
Javier Hernández committed
80
    pyatspi >= 1.9.0
Javier Hernández's avatar
Javier Hernández committed
81
    at-spi2-core >= 2.5.2
82
    glib2 >= 2.10
83
    GConf2-devel
Javier Hernández's avatar
Javier Hernández committed
84
    pygobject
85 86 87 88

  On a Debian based distro:

    python >= 2.4
Javier Hernández's avatar
Javier Hernández committed
89 90
    python-pyatspi >= 1.9.0
    at-spi2 >= 2.1.5
91
    libgconf2-dev
Javier Hernández's avatar
Javier Hernández committed
92
    python-gobject
93
    
94
  To use the Python console plugin, you must hve IPython installed.
95 96 97

  Make sure accessibility is enabled for your GNOME desktop:

Javier Hernández's avatar
Javier Hernández committed
98 99
    gsettings get org.gnome.desktop.interface toolkit-accessibility

100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
  
Installing
==========

  autogen.sh
  make
  sudo make install

Running
=======

  Type 'accerciser' at the prompt or choose the Accerciser item from the 
  Programming menu in GNOME.
  
Help
=====

  See the Help menu in the program GUI.

Legal
=====
  
  Copyright (c) 2006, 2007 IBM Corporation

  All rights reserved. This program and the accompanying materials are made
  available under the terms of the BSD License which accompanies this
  distribution, and is available at
  http://www.opensource.org/licenses/bsd-license.php.
  
  See COPYING and NOTICE for details.