Commit c0a98e7b authored by Mark Doffman's avatar Mark Doffman
Browse files

2008-11-13 Mark Doffman <mark.doffman@codethink.co.uk>

        * AUTHORS
          COPYING
          INSTALL
          MAINTAINERS
          README

          Improve the project information files. Add
          new mailing list, repository and bugzilla links.
parent f8c5afee
Authors of AT-SPI D-Bus implementation.
========================================
Authors of AT-SPI D-Bus implementation
--------------------------------------
Mike Gorse <mike.gorse@novell.com>
Mark Doffman <mark.doffman@codethink.co.uk>
Authors of AT-SPI spec & implementation in CORBA
========================================
------------------------------------------------
Bill Haneman <bill.haneman@sun.com>
Marc Mulcahy <marc.mulchay@sun.com>
Michael Meeks <micheal@ximian.com>
......
GNU LIBRARY GENERAL PUBLIC LICENSE
Version 2, June 1991
GNU LIBRARY GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1991 Free Software Foundation, Inc.
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
[This is the first released version of the library GPL. It is
numbered 2 because it goes with version 2 of the ordinary GPL.]
Preamble
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
......@@ -51,7 +51,7 @@ library. If the library is modified by someone else and passed on, we
want its recipients to know that what they have is not the original
version, so that any problems introduced by others will not reflect on
the original authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that companies distributing free
software will individually obtain patent licenses, thus in effect
......@@ -98,8 +98,8 @@ works together with the library.
Note that it is possible for a library to be covered by the ordinary
General Public License rather than by this special one.
GNU LIBRARY GENERAL PUBLIC LICENSE
GNU LIBRARY GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License Agreement applies to any software library which
......@@ -133,7 +133,7 @@ such a program is covered only if its contents constitute a work based
on the Library (independent of the use of the Library in a tool for
writing it). Whether that is true depends on what the Library does
and what the program that uses the Library does.
1. You may copy and distribute verbatim copies of the Library's
complete source code as you receive it, in any medium, provided that
you conspicuously and appropriately publish on each copy an
......@@ -145,7 +145,7 @@ Library.
You may charge a fee for the physical act of transferring a copy,
and you may at your option offer warranty protection in exchange for a
fee.
2. You may modify your copy or copies of the Library or any portion
of it, thus forming a work based on the Library, and copy and
distribute such modifications or work under the terms of Section 1
......@@ -254,7 +254,7 @@ Library will still fall under Section 6.)
distribute the object code for the work under the terms of Section 6.
Any executables containing that work also fall under Section 6,
whether or not they are linked directly with the Library itself.
6. As an exception to the Sections above, you may also compile or
link a "work that uses the Library" with the Library to produce a
work containing portions of the Library, and distribute that work
......@@ -308,7 +308,7 @@ restrictions of other proprietary libraries that do not normally
accompany the operating system. Such a contradiction means you cannot
use both them and the Library together in an executable that you
distribute.
7. You may place library facilities that are a work based on the
Library side-by-side in a single library together with other library
facilities not covered by this License, and distribute such a combined
......@@ -349,7 +349,7 @@ subject to these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
11. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
......@@ -401,7 +401,7 @@ conditions either of that version or of any later version published by
the Free Software Foundation. If the Library does not specify a
license version number, you may choose any version ever published by
the Free Software Foundation.
14. If you wish to incorporate parts of the Library into other free
programs whose distribution conditions are incompatible with these,
write to the author to ask for permission. For software which is
......@@ -411,7 +411,7 @@ decision will be guided by the two goals of preserving the free status
of all derivatives of our free software and of promoting the sharing
and reuse of software generally.
NO WARRANTY
NO WARRANTY
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
......@@ -434,8 +434,8 @@ FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
END OF TERMS AND CONDITIONS
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Libraries
If you develop a new library, and you want it to be of the greatest
......
Instructions for testing
------------------------
To test AT-SPI D-Bus both a client (AT) library and server (Application)
module is required.
The ATK-Bridge application module
---------------------------------
Currently there is an implementation of the ATK-Bridge for AT-SPI D-Bus. This
is a GTK module that will expose GAIL objects as accessible objects over D-Bus.
There are a number of ways to load a GTK module into an application. A special
directory exists on a system where all modules in the directory are loaded by
GTK applications. The ATK-Bridge GTK module is called libspiatk.so. It is
installed to $(libdir)/$(GTK_MODULE_DIR) meaning that if the AT-SPI D-Bus
package were installed on a system then all GTK apps would load it at
startup.As the library is unstable this is probably not a good idea. Instead
individual GTK applications can be started with the libspiatk.so module using
the command line options. --gtk-module $(install_path)/libspiatk.so. This
should work with all GTK applications.
Once a module is loaded with the libspiatk.so module it will print out its
unique address on the D-Bus bus. You should write this down. Its currently the
only way to access the application using a client (AT).
The Python client (AT) bindings
-------------------------------
Once we have an application made accessible over the D-Bus we need an AT to
access the information. There is a python implementation of the pyatspi
bindings used by Accerciser and Orca. These bindings are installed to
$(pythondir)/pyatspi. To use these bindings set your PYTHONPATH environment
variable to the $(pythondir) directory and use "import pyatspi".
The only pyatspi based program tested so-far is Accerciser, and it can be
problematic to run using PYTHONPATH, as it modifies the search path based on
installation directory.
When running an AT using the new pyatspi bindings it is necessary to tell the
pyatspi module where to find the accessible application this is done by setting
the environment variable ATSPI_TEST_APP_NAME to the D-Bus unique name of
application.
Summary
-------
* Run a GTK application, make it accessible by either installing
libspiatk.so to the GTK modules directory or by using the --gtk-module command
line argument.
* Run an AT using the new pyatspi module. Either install AT-SPI D-Bus on a
system without the old version of pyatspi, or set the PYTHONPATH environment
variable.
* Dont forget to set the ATSPI_TEST_APP_NAME environment variable to that
of the application. The Application will print its D-Bus unique name to stdout
on connecting to the bus.
Install procedure
-----------------
% gzip -cd at-spi-1.9.0.tar.gz | tar xvf - # unpack the sources
% cd at-spi-1.9.0 # change to the toplevel directory
% ./configure # run the `configure' script
% make # build at-spi
[ Become root if necessary ]
% make install # install at-spi
Requirements
------------
GNU make
GNU autotools
pkg-config
python
glib
gtk+
gail
dbus
dbus-glib
dbus-python
X
XEVIE (Reccomended)
Mike Gorse
E-mail: mgorse@novell.com
Mark Doffman
E-mail: mark.doffman@gmail.com
Mike Gorse <mike.gorse@novell.com>
Mark Doffman <mark.doffman@codethink.co.uk>
at-spi version 1.9.0
D-Bus AT-SPI
------------
This version of at-spi requires atk 1.17.0 or later.
This version of at-spi is a MAJOR break from previous versions.
This version of at-spi is a major break from previous versions.
It has been completely rewritten to use D-Bus rather than
ORBIT / CORBA for its transport protocol.
If you have not already done so, please visit
A page including instructions for testing, project status and
TODO items is kept up to date at:
http://www.linuxfoundation.org/en/AT-SPI_on_D-Bus
The mailing list used for general questions is:
accessibility-atspi@lists.linux-foundation.org
For bug reports, feature requests, patches or enhancements please use
bugzilla. The freedesktop project name is at-spi2.
http://bugs.freedesktop.org
A git repository with the latest development code is available at:
git://anongit.freedesktop.org/git/at-spi2
More information
----------------
The project was started with a D-Bus performance review
the results of which are available on the GNOME wiki. Keep in
mind that the D-Bus AT-SPI design documents on this page
have not been kept up to date.
http://developer.gnome.org/projects/gap
http://live.gnome.org/GAP/AtSpiDbusInvestigation/
for background information on accessibility, the Gnome
Accessibility Project, mailing list info, and project status.
Other sources of relevant information about AT-SPI and Accessibility
include:
Contents of this package ==================================
http://live.gnome.org/Accessibility
http://www.sun.com/software/star/gnome/accessibility/architecture.xml
http://accessibility.kde.org/developer/atk.php
http://www.gnome.org/~billh/at-spi-idl/html/
Contents of this package
------------------------
This package includes the protocol definitions for the new D-Bus
at-spi, a gtk-module that bridges ATK to the new D-Bus based AT-SPI
as well as 'C' and Python client libraries.
Also included is the daemon neccessary for forwarding device events
and registering accessible applicaitons.
Directory structure
-------------------
The directories within this package are arranged as follows:
idl : This directory contains the interface definitions
(in Interface Definition Language) for the
accessibility support interfaces exposed by
the AT central registry, accessible applications,
and UI components.
This is possibly historic. The idl formed the basis
for the XML protocol definitions now located
in the directory "xml".
xml : This directory contains XML documents describing
the D-Bus protocol in a subset of Telepathy XML.
tools : Miscellaneous tools. Mostly for converting protocol
XML into D-Bus introspection, 'C' types and documentation.
droute : Contains a framework for registering objects
with a D-Bus connection and for routing messages to
the implementing object.
Used by the ATK adaptor.
dbind : Library to ease making D-Bus method calls, contains
marshalling code to convert function arguments
and a provided D-Bus signature into a D-Bus message.
Used by cspi.
spi-common : Contains 'C' types derived from the D-Bus
protocol specification. These types are used by
both the registry daemon and the ATK adaptor.
Structures are mainly related to events.
registryd : This directory contains code specific to the
central accessibility registry, and the registry
executable is built in this directory.
atk-adaptor : This directory contains code that bridges
the at-spi to the GTK+ toolkit, and which is
loaded at runtime by GTK+-based Gnome applications.
The 'bridge' automatically registers GTK+-2.0
applications with the accessibility registry,
and relays UI events from application to registry.
It is also responsible for servicing requests from
the registry to register handlers for specific event
types.
cspi : The client (AT) side interface - 'C' bindings.
registryd : The registry daemon code. The registry daemon
keeps a register of accessible applications and presents
this to clients (ATs).
It is also responsible for delivering device events.
idl
This directory contains the interface definitions
(in Interface Definition Language) for the
accessibility support interfaces exposed by
the AT central registry, accessible applications,
and UI components.
This is possibly historic. The idl formed the basis
for the XML protocol definitions now located
in the directory "xml".
xml
This directory contains XML documents describing
the D-Bus protocol in a subset of Telepathy XML.
tools
Miscellaneous tools. Mostly for converting protocol
XML into D-Bus introspection, 'C' types and documentation.
droute
Contains a framework for registering objects
with a D-Bus connection and for routing messages to
the implementing object.
Used by the ATK adaptor.
dbind
Library to ease making D-Bus method calls, contains
marshalling code to convert function arguments
and a provided D-Bus signature into a D-Bus message.
Used by cspi.
spi-common
Contains 'C' types derived from the D-Bus
protocol specification. These types are used by
both the registry daemon and the ATK adaptor.
Structures are mainly related to events.
registryd
This directory contains code specific to the
central accessibility registry, and the registry
executable is built in this directory.
atk-adaptor
This directory contains code that bridges
the at-spi to the GTK+ toolkit, and which is
loaded at runtime by GTK+-based Gnome applications.
The 'bridge' automatically registers GTK+-2.0
applications with the accessibility registry,
and relays UI events from application to registry.
It is also responsible for servicing requests from
the registry to register handlers for specific event
types.
cspi
The client (AT) side interface - 'C' bindings.
registryd
The registry daemon code. The registry daemon
keeps a register of accessible applications and presents
this to clients (ATs).
It is also responsible for delivering device events.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment