Add accessibility keys to Journal #4891 #667

iamutkarshtiwari · 2016-03-13T18:29:09Z

This PR add this feature request -> https://bugs.sugarlabs.org/ticket/4891

Now the journal can be accessed via keyboard. Following functions are implemeted ->

Entries can be scrolled with 'Up'/'Down' arrow keys.
Activity can be started/resumed by pressing 'Enter' key.
Detail View can be opened with 'Right' arrow key.
Switching b/w search entry and tree view can done with 'Tab' key.
Escape key can be use to switch back to list from detail view.
Activity can be renamed by typing anything.

Watch the below gif closely(Mouse is not used). 👯

icarito · 2016-03-13T18:52:16Z

Super! Have not tested it but it may be the nicest feature since 0.94.

Thanks Utkarsh for making it happen and Quozl for asking for it
(effectively)!
:-D

El 13/03/16 a las 13:29, Utkarsh Tiwari escibió:

This PR add this feature request -> https://bugs.sugarlabs.org/ticket/4891

Now the journal can be accessed via keyboard. Following functions are
implemeted ->

Entries can be scrolled with |'Up'/'Down'| arrow keys.

Activity can be started/resumed by pressing |'Enter'| key.

|Detail View| can be opened with |'Right'| arrow key.

Switching b/w |search entry| and |tree view| can done with |'Tab'| key.

|Escape| key can be use to switch back to list from detail view.

Activity can be |renamed| by typing anything.

Watch the below gif closely(Mouse is not used). 👯
desktop-animation2
https://cloud.githubusercontent.com/assets/6258810/13730494/05bf6196-e977-11e5-8443-9c6ddcfb640e.gif
    You can view, comment on, or merge this pull request online at:
#667
    Commit Summary
Add accessibility keys to Journal #4891
File Changes
M src/jarabe/journal/journalactivity.py
https://github.com/sugarlabs/sugar/pull/667/files#diff-0 (13)
M src/jarabe/journal/listview.py
https://github.com/sugarlabs/sugar/pull/667/files#diff-1 (43)
Patch Links:
https://github.com/sugarlabs/sugar/pull/667.patch

https://github.com/sugarlabs/sugar/pull/667.diff
—
Reply to this email directly or view it on GitHub
#667.

iamutkarshtiwari · 2016-03-13T19:05:10Z

@icarito @samdroid-apps Thanks! If the community likes it, I can work more on it to implement more accessibility features to it. :)

iamutkarshtiwari · 2016-03-13T19:06:30Z

@walterbender @quozl What are your suggestions on this feature?

samdroid-apps · 2016-03-13T21:46:59Z

Ok, this is amazing. A few comments:

When I type the letters to rename, it seems to loose the 1st charecter. It seems to go like
1. I press 1st letter
2. Enters textbox, averything selected
3. I press second letter
4. I have to go back and enter the 1st letter again :(
When you test if the keypress is a letter, you only consider latin charecters. Maybe just make it an else case?
Maybe the left arrow key would be good to use for going back to the list view from the details (in addition to the escape key)? It is very intuitive (forward to go in, backward to go out)
Maybe a sugar-artwork patch could add a focus indicator to the search bar - so that I know when it is selected?
The palettes used in the journal are GtkMenu based ones, which have great keyboard support. Maybe you could add a keyboard shortcut to show the palette? This would allow for keyboard based deletion, copying, etc.

iamutkarshtiwari · 2016-03-13T22:15:28Z

@samdroid-apps Great suggestions! I try to implement some of these and update you with a new patch ;)

quozl · 2016-03-14T02:59:33Z

Tested on OLPC XO-1 with Fedora 18.

It is very slow to respond to up and down arrow key presses. Initial delay is about one second. Subsequent delay about a fifth of a second. Perhaps the tree view is being redrawn between movements. Holding the up or down arrow keys, to force autorepeat, consumes 100% CPU, even though the selected item is already at the top or bottom of the list.

Agreed, rename first letter is lost. Space bar does not work as first letter. After renaming, two up keys are needed to get to the entry above; should only be one up key needed.

Agreed, left arrow in addition to escape for backing out of details. While in details, tab did not work for moving focus between description, tags, and comments.

Please add a key for showing the journal entry palette, and add up down key navigation of the list of actions; start, copy to, duplicate, send to, view details, erase.

Please extend this to confirmation prompts; at the prompt for whether to erase, pressing enter resumed the activity.

Please extend this to the home view activity list; key sequence f3 ctrl+2.

samdroid-apps · 2016-03-14T06:48:18Z

@quozl said:

Please extend this to the home view activity list; key sequence f3 ctrl+2.

Could we make this code into something in the toolkit? I have a list view in Bibliography activity, and I would like as well to add something that lets me keyboard functions to it. I haven't looked at the code, but could it be an api that is simple, eg.

listview = ...

thing = ListViewKeyboardControl(listview)
thing.connect_key('e', __edit_row_cb)
def __edit_row_cb(listview, row):
   # app specific logic

quozl · 2016-03-14T07:05:23Z

Worth a try.

Once upon a time Gtk+ applications were expected to have keyboard accessibility features built in, and Gtk+ provides an implementation, with the Gtk.Widget focus properties and functions. But in Sugar some of what was coded conflicted with keyboard focus control.

iamutkarshtiwari · 2016-03-14T07:27:00Z

@samdroid-apps I successfully implemented some of the enlisted features->

When I type the letters to rename, it seems to loose the 1st charecter. It seems to go like
I press 1st letter
Enters textbox, averything selected
I press second letter
I have to go back and enter the 1st letter again :(

Maybe the left arrow key would be good to use for going back to the list view from the details (in addition to the escape key)? It is very intuitive (forward to go in, backward to go out)

For the focus indicator I am thinking to change the entry-search.svg color form black to -> yellow or some other bright color. Or is there anything you would suggest?

quozl · 2016-03-14T23:47:39Z

If you must indicate focus, use a black dotted or dashed rectangle around the text are of the entry widget.

You may have noticed a very restricted set of colours used by Sugar.

This design decision originated in 2006 with the OLPC XO laptop with sunlight readable reflective display, which is colour when transmissive and monochrome when reflective. An additional justification was accessibility for children with colour vision deficiency.

The frequency of colour vision deficiency means it would be best to use black and white rather than yellow.

(Most displays and supporting software remain trichromatic. Some human populations show females with up to 50% tetrachromacy, yet our displays aren't handling them well.)

iamutkarshtiwari · 2016-03-15T06:42:12Z

@quozl Any hints on how to get those black dotted or dashed rectangle around text area?

quozl · 2016-03-15T06:52:50Z

Perhaps something to do with the CSS in sugar-artwork repository?

samdroid-apps · 2016-03-16T07:59:14Z

I ran with this patch for a while to test it more. What I found it was that it conflicted with touch-scrolling. When I could touch scroll, it would actually drag entry instead. Please try testing on a touchscreen, or turning on the "Simulate Touchscreen" option under the visual tab of the Gtk+ inspector.

quozl · 2016-03-16T19:55:14Z

Well spotted. I tested with XO-1, no touch.

davelab6 · 2016-04-04T14:17:21Z

@iamutkarshtiwari this is really awesome!! :D Any news? :)

iamutkarshtiwari · 2016-04-04T15:57:14Z

@davelab6 Thanks! :) I fixed some of the issues of this feature as suggested by the community members. As Mr. Sam Parkinson says.. it needs more work so I planning on writing an API to extend keyboard accessibility to the Sugar. I have been busy with the GSoC project so couldn't devote much time to it but will definitely bring this to existence ;)

icarito · 2016-05-23T05:13:04Z

This is a cool feature it would be great to make it happen.

quozl · 2016-11-09T03:40:05Z

Ping?

i5o · 2016-11-15T02:17:30Z

@iamutkarshtiwari can you update the code to work with the current one? If you need help let me know. (conflicts with src/jarabe/journal/journalactivity.py)

iamutkarshtiwari · 2016-11-16T10:09:46Z

@i5o I am having hard time resolving this conflict :/ Could you please help?

quozl · 2016-11-16T12:18:13Z

@iamutkarshtiwari the conflict looks quite straightforward to an expert. 😀 Do you mean help with wrangling git, or help understanding how to apply your patch again to the current master branch?

Because your changes are small, it may be easier to start a new branch, based on master, and edit in your changes;

git fetch upstream
git checkout -b feature-journalAccessiblityKeys2 upstream/master
emacs src/jarabe/journal/journalactivity.py

Then to get that branch into this pull request;

git push --force origin feature-journalAccessiblityKeys2:feature-journalAccessiblityKeys

There are many other ways of solving this; it is hard to be definitive.

iamutkarshtiwari · 2017-04-25T09:38:06Z

@quozl Conflict resolved

quozl · 2017-04-25T10:24:45Z

Thanks, I'll do another test of the changes and get back to you.

GitHub still says "branch cannot be rebased due to conflicts" when "Rebase and merge" is selected, so if you don't rebase I'll be doing it by hand. Really don't want unnecessary merge commits in history, because they make git bisect so much harder.

gitk shows the first commit is parented all the way back to 2016-03-10. 😁

iamutkarshtiwari · 2017-04-25T11:35:55Z

I resolved the merge conflicts from github directly. If there is still such issue, I'll rebase it to the latest branch.

quozl · 2017-04-25T20:51:24Z

GitHub still says "branch cannot be rebased due to conflicts" when "Rebase and merge" is selected, and further it says "Rebasing the commits of this branch on top of the base branch cannot be performed automatically due to conflicts encountered while reapplying the individual commits from the head branch."

If you're still not convinced, use gitk or another visualisation to see the ancestry of your commits, and you'll agree that the commits cannot be individually applied.

Entries can be scrolled with 'Up'/'Down' arrow keys. Entry(activity) can be started/resumed by pressing 'Enter' key. Entry can be renamed by typing anything. Detail View of an entry can be opened via 'Right' arrow key. Switching b/w search entry and tree view can done via 'Tab' key. Escape key can be use to switch back to list from detail view.

iamutkarshtiwari · 2017-04-30T21:36:21Z

@quozl Rebased

quozl · 2017-05-02T06:09:25Z

@iamutkarshtiwari, thanks. Have you tested this?

I get an error in logs;

Traceback (most recent call last):
  File "/usr/lib/python2.7/dist-packages/jarabe/main.py", line 126, in setup_journal_cb
    journalactivity.start()
  File "/usr/lib/python2.7/dist-packages/jarabe/journal/journalactivity.py", line 654, in start
    get_journal()
  File "/usr/lib/python2.7/dist-packages/jarabe/journal/journalactivity.py", line 611, in get_journal
    _journal = JournalActivity()
  File "/usr/lib/python2.7/dist-packages/jarabe/journal/journalactivity.py", line 219, in __init__
    self.connect('key-press-event', self.__key_press_event_cb)
AttributeError: 'JournalActivity' object has no attribute '_JournalActivity__key_press_event_cb'

Just a typo.

When I fix that typo, and move down the journal with down arrow, and resume an entry, then stop, then press down arrow once, I get this error;

Traceback (most recent call last):
  File "/usr/lib/python2.7/dist-packages/jarabe/journal/listview.py", line 763, in __key_detect_cb
    self.tree_view.set_cursor_on_cell(path, column, None ,  True)
TypeError: Argument 1 does not allow None as a value

Spacing on that line of code is wrong, also.

While testing, noticed a few things;

pressing left arrow in the detail view gives a sound alert and returns to the list view; while returning to the list view is good, the sound alert is not,
while on the detail view, the return key is ineffective; should it resume the entry?
pressing tab to get to the search view, then typing b works fine, but focus is stolen and subsequent typing is ignored; the search entry remains set to b only,
when renaming, the first character typed is lost, as @samdroid-apps wrote in March 2016.

Other ideas;

ticket suggestion asked for change volume; that is switching between journal, Documents, and any mounted filesystems. You might do that with ctrl+1, ctrl+2, etc.
not sure I agree with the use of tab; perhaps instead it should be ctrl+f to assign focus to the search entry, and arrow keys or escape to move focus back to the list.

rahul-bothra · 2018-03-07T13:57:49Z

@iamutkarshtiwari, Great feature
Will you be continuing this or may I work on the same, Thanks

rahul-bothra · 2018-03-13T13:12:18Z

Can be closed in favor of #791

quozl · 2018-03-14T10:57:56Z

Thanks. Did you use any of this work? If so, please see if you can split your patches and use "git commit --amend --author" to properly credit @iamutkarshtiwari.

quozl · 2018-03-15T01:47:33Z

I see 2670767 has co-authorship.

iamutkarshtiwari force-pushed the feature-journalAccessiblityKeys branch from 4051599 to 4d04280 Compare March 13, 2016 18:36

iamutkarshtiwari force-pushed the feature-journalAccessiblityKeys branch from 4d04280 to 8e121c0 Compare March 15, 2016 10:19

samdroid-apps added the feature label Mar 16, 2016

samdroid-apps added the needs work label Mar 26, 2016

iamutkarshtiwari force-pushed the feature-journalAccessiblityKeys branch from fac4234 to 4542cbd Compare April 30, 2017 21:35

rahul-bothra mentioned this pull request Mar 13, 2018

[Feature]: Add accessibility keys to Journal #791

Closed

8 tasks

quozl closed this Mar 15, 2018

Add accessibility keys to Journal #4891 #667

Add accessibility keys to Journal #4891 #667

iamutkarshtiwari commented Mar 13, 2016

icarito commented Mar 13, 2016

iamutkarshtiwari commented Mar 13, 2016

iamutkarshtiwari commented Mar 13, 2016

samdroid-apps commented Mar 13, 2016

iamutkarshtiwari commented Mar 13, 2016

quozl commented Mar 14, 2016

samdroid-apps commented Mar 14, 2016

quozl commented Mar 14, 2016

iamutkarshtiwari commented Mar 14, 2016

quozl commented Mar 14, 2016

iamutkarshtiwari commented Mar 15, 2016

quozl commented Mar 15, 2016

samdroid-apps commented Mar 16, 2016

quozl commented Mar 16, 2016

davelab6 commented Apr 4, 2016

iamutkarshtiwari commented Apr 4, 2016

icarito commented May 23, 2016

quozl commented Nov 9, 2016

i5o commented Nov 15, 2016

iamutkarshtiwari commented Nov 16, 2016

quozl commented Nov 16, 2016

iamutkarshtiwari commented Apr 25, 2017

quozl commented Apr 25, 2017

iamutkarshtiwari commented Apr 25, 2017

quozl commented Apr 25, 2017

iamutkarshtiwari commented Apr 30, 2017

quozl commented May 2, 2017

rahul-bothra commented Mar 7, 2018

rahul-bothra commented Mar 13, 2018

quozl commented Mar 14, 2018

quozl commented Mar 15, 2018

Add accessibility keys to Journal #4891 #667

Add accessibility keys to Journal #4891 #667

Conversation

iamutkarshtiwari commented Mar 13, 2016

icarito commented Mar 13, 2016

iamutkarshtiwari commented Mar 13, 2016

iamutkarshtiwari commented Mar 13, 2016

samdroid-apps commented Mar 13, 2016

iamutkarshtiwari commented Mar 13, 2016

quozl commented Mar 14, 2016

samdroid-apps commented Mar 14, 2016

quozl commented Mar 14, 2016

iamutkarshtiwari commented Mar 14, 2016

quozl commented Mar 14, 2016

iamutkarshtiwari commented Mar 15, 2016

quozl commented Mar 15, 2016

samdroid-apps commented Mar 16, 2016

quozl commented Mar 16, 2016

davelab6 commented Apr 4, 2016

iamutkarshtiwari commented Apr 4, 2016

icarito commented May 23, 2016

quozl commented Nov 9, 2016

i5o commented Nov 15, 2016

iamutkarshtiwari commented Nov 16, 2016

quozl commented Nov 16, 2016

iamutkarshtiwari commented Apr 25, 2017

quozl commented Apr 25, 2017

iamutkarshtiwari commented Apr 25, 2017

quozl commented Apr 25, 2017

iamutkarshtiwari commented Apr 30, 2017

quozl commented May 2, 2017

rahul-bothra commented Mar 7, 2018

rahul-bothra commented Mar 13, 2018

quozl commented Mar 14, 2018

quozl commented Mar 15, 2018