GNOME Bugzilla – Bug 475110
accessibility guide is confusingly structured
Last modified: 2007-10-02 15:11:54 UTC
Hi, I've made some very substantial changes to the Ubuntu version of the accessibility guide which I'd like to pass upstream. The relevant revisions are number 695, 696 and 697 here: http://codebrowse.launchpad.net/~ubuntu-doc/gnome-user-docs/ubuntu-changes/changes You can get patches from that link. I'll upload a screenshot of the new structure - in summary it arranges the different accessibility technologies by the different type of disability they apply to. This has the advantage that a user should be able to quickly find the sections that apply to them rather than having to read the whole guide. I've also commented out sysadmin.xml (and removed solaris-only specific material) because I think that (a) it's unlikely to be relevant to the current state of technology, where hardware is more likely to work out of the box; and (b) Gnome documentation should be distro-non-specific. I hope that those revisions don't include any Ubuntu-specific changes, they should be in separate revisions. Having said that, I don't know how cleanly the patches will apply because of the separate Ubuntu changes. There may be some manual work required to merge the changes to gnome-access-guide.xml in particular. See how it goes.
Created attachment 95211 [details] screenshot of new structure
Created attachment 95219 [details] [review] patch as per bug report Using the wonders of bzr I've managed to create a patch which contains the relevant revisions (and not the ubuntu-specific changes) which applies cleanly to the svn tree.
Incidentally that patch also includes revision 698 which corrected a typo preventing the document from validating.
Created attachment 95687 [details] [review] updated patch with orca material Here is an updated patch which does the same as the previous one, but also adds a substantial chapter on Orca screenreader and magnifier in the low vision chapter. This was taken from the wiki and tidied up by Phil Bull and a few other awesome volunteers. Please consider commit this, we are carrying it in Ubuntu.
Patch applied fine. Thanks for all the Ubuntu team's hard work! Couple of very small things to note for another time: Some indentation makes XML easier to read :) And note the standard terms for actions: "Press System → Preferences → Universal Access → Assistive Technology Preferences. Tick Enable assistive technologies and then press Close and Log Out. Log back in. The assistive technology services will be started automatically." Should say "Choose" and "Select" not "Press" and "Tick". There's a guide that explains all these kicking about somewhere. I'm making that change now. While we're at it, surely having to log out and back in again is a bug? It's certainly sucky.
Thanks! Will this go into the GNOME 2.20.1 release? I want to know so I can plan better for where we need to integrate the fix for bug 474958.
The accessibility guide is part of the GNOME user-docs module -- hang out in the #docs channel or mail the GNOME docs team and ask about a 2.20.1 release. Shaun usually does a point release if there's new stuff. (My bad for missing the 2.20 deadline btw -- I've been out of the loop for a while.) For something like Orca, it's up to the developers of that application whether to make a 2.20.1 release -- not all apps do, but if you let them know there's big changes in the documentation they probably will :)
> The accessibility guide is part of the GNOME user-docs module -- hang out in > the #docs channel or mail the GNOME docs team and ask about a 2.20.1 release. > Shaun usually does a point release if there's new stuff. (My bad for missing > the 2.20 deadline btw -- I've been out of the loop for a while.) Thanks! > For something like Orca, it's up to the developers of that application whether > to make a 2.20.1 release -- not all apps do, but if you let them know there's > big changes in the documentation they probably will :) Thanks! I'm the lead for the Orca project and we will definitely do a GNOME 2.20.1 release. The main issue I'm considering here is whether we should enable the help support in Orca for GNOME 2.20.1 or wait until GNOME 2.21.x. I think that hinges on when the docs team is going to roll in the new stuff contributed by Matthew East. I'll hang out on #docs and ask.
Here's the response on #docs: (11:10:25) shaunm: WillieWalker: we'll roll a 2.20.1 release with the new accessibility guide shaunm sm|CPU sm|test-box (11:10:40) WillieWalker: shaunm: Thanks!