Documenting Accerciser – first impressions
junho 11, 2011 § 4 Comentários
In the first days of my internship, I dedicated time for writing a demo that explored accessibility issues. You can read more about it here.
After some time, I realized that the demo would be almost 100% accessible – or 100% accessible – since I was only using default GTK+ methods. Basically, I discovered that a lib called GAIL would take care of most of my accessibility issues, turning my demo into something really boring – i.e., I almost wouldn’t use ATK. I even used it once to fix an accessibility error found via Accerciser, but it was something really simple involving comboboxes. There’s even a GTK+ patch for solving it without the need of using ATK.
To do something interesting that massively depends on ATK, the best way is to write a custom widget. Basically, you have to extend a GTK+ widget in a way that GAIL won’t find it by default – and that’s where you’ll find space to write tons of ATK code.
Since I didn’t find an interesting way of extending GtkEntry (or any other default widget) yet, and given that maybe I can do another more useful programming tasks, I skipped to my second scheduled task: documenting Accerciser in a topic-based, Mallard way. If you want to learn how something works, try writing a documentation for it. 😉 Today, I finished a beta version for preliminary reviews and what I have to say is that I read a lot about AT-SPI, pyatspi, libatspi, and accessibility. Also, I read most of Accerciser’s code and even wrote a simple patch for it. Now, I also have a good notion about how to write plugins for Accerciser. Besides learning a lot about this tool – what’s going to be useful if my programming tasks become related to it – I feel I’m doing something useful for the GNOME community.
I’ll keep on writing that little demo in my free time – just for the pleasure of it. Besides, I may use more GTK+ in the future (including this internship), so it’ll be good for exercising. After finishing the Accerciser docs, I’m thinking of helping the tool with new plugins, bug fixes and migration to GNOME 3.
If you read the docs and have any critics/tips/notes about it, please let me know.
😀
If you write a demo, it would be cool if you could follow the style at http://developer.gnome.org/gnome-devel-demos/unstable/ and include it in the gnome-devel-docs module it git.
Clicked a bit through the documentation in git and I really like it – nice work!
Very small issues:
The picture in interface_viewer_plugin.page looks a bit stretched.
And maybe “or cloned from gnome.org GIT repository” on
howto_setting_up_accerciser.page could get an info note with a link to https://live.gnome.org/Git/Developers for those that have not used Git before?
Thanks a lot for the tips, Andre! And good to know that, Johannes. 🙂
[…] Aline Duarte Bessa wrote new topic-based help for Accerciser, an interactive tool that allows GNOME applications to check what accessibility information they are providing. She wrote documentation for the Assistive Technology Service Provider Interface (AT-SPI), which is used to provide a description of an application to accessibility tools. She examined the entire Accerciser bug list, provided feedback on all the bugs, and created patches for many of them. She also wrote a demo widget that explored accessibility issues. [1, 2, 3, 4] […]