In custom labels mozilla

[ManshulBelani]

Link to issue number:

#5874

Summary of the issue:

Sometimes web elements are not properly labelled for the screen reader to read. This fix helps the user to add customised labels to such web elements once and then every time the user accesses the page, this custom label will be spoken when focus is on the particular element.

Description of how this pull request fixes the issue:

This pull request implements the solution for mozilla and Chrome (Canary version). For Internet Explorer refer branch in_t5874_new
It currently supports links, images and form elements like edit boxes,combo boxes, buttons, multi line edit areas, radio buttons and check boxes.
Regarding extending the functionality to Edge we would start working on it once this gets released.

The changes made in this commit are saving the object in focus at the time of when addLabel function is called and sending this object as an argument to the function. The virtual buffer object is also sent to the function as an argument.
After adding the custom label to config file, the virtual buffer is unloaded (vBuffer.unloadBuffer()), the buffer is then reloaded again (vBuffer.loadBuffer()) so that it is in turn created again with the custom labels added to the buffer.

Testing performed:

some basic level testing performed. Working for links graphics and form fields.

Known issues with pull request:

Right now after adding the custom labels, the user has to refresh the web page once before NVDA starts reading them.

Change log entry:

The section and description of this change to use for the changes file. Valid sections are:

• New features
• Changes
• Bug fixes

For examples see the changes file in your NVDA repo: user_docs/en/changes.t2t or on github: https://github.com/nvaccess/nvda/blob/master/user_docs/en/changes.t2t

[ManshulBelani]

This pull request has code for adding custom labels to web elements in IE, mozilla and Chrome(Canary version).

[ManshulBelani]

The branch allows adding custom labels in Internet Explorer, Mozilla Firefox and Chrome Canary.
Auto refresh of buffer after adding custom label has also been handled now.

[bhavyashah]

Which web elements in IE, FX and Chrome are currently supported? Also, are there plans to extend this functionality to Edge also? This could be a hugely welcomed new feature.

…

On 11/13/17, ManshulBelani ***@***.***> wrote: The branch allows adding custom labels in Internet Explorer, Mozilla Firefox and Chrome Canary. Auto refresh of buffer after adding custom label has also been handled now. -- You are receiving this because you are subscribed to this thread. Reply to this email directly or view it on GitHub: #7194 (comment)

-- Best Regards Bhavya Shah Blogger at Hiking Across Horizons: https://bhavyashah125.wordpress.com/ Contacting Me E-mail Address: bhavya.shah125@gmail.com Follow me on Twitter @BhavyaShah125 or www.twitter.com/BhavyaShah125 Mobile Number: +91 7506221750

[ManshulBelani]

It currently supports links, images and form elements like edit boxes,combo boxes, buttons, multi line edit areas, radio buttons and check boxes.
Regarding extending the functionality to Edge we would start working on it once this gets released.

[ManshulBelani]

@michaelDCurran: I have added the auto refresh of buffer functionality after adding custom label to the code. Kindly review the code and provide feedback.
Would it be possible to add this fix in the next NVDA build?

[feerrenrut]

Please can you describe how the changes made address the problem? An explanation of how this issue fixes the problem will greatly speed up its review and increase our confidence in the change. This should include a broad level description of the design decisions made for this change.

When you are happy with this, please "request a review" by using the github reviewers menu.

[ManshulBelani]

The changes made in this commit are saving the object in focus at the time of when addLabel function is called and sending this object as an argument to the function. The virtual buffer object is also sent to the function as an argument.
After adding the custom label to config file, the virtual buffer is unloaded (vBuffer.unloadBuffer()), the buffer is then reloaded again (vBuffer.loadBuffer()) so that it is inturn created again with the custom labels added to the buffer.

[feerrenrut]

I have added this information to the description. However, at this point I don't believe this is an adequate technical description of the changes. This is a large change, that requires some non-trivial design decisions. Understanding the rationale for these decisions and the alternatives considered would make the process of reviewing the code more straightforward, and will save time in the long term maintenance of this code, as well as providing a roadmap for how the original author expects this code to be improved over time.

One example, is that the labels are persisted by storing the information in (config) files. There has been no discussion or explanation of why this is preferable over another approach. One concern here is how this scales over time? How many labels causes a degradation in performance.

While many of these questions can be answered by looking at the code, it is slower to do so. Looking at the code does not give any insight into the thought process behind the approach.

[ManshulBelani]

@feerrenrut : Please find attached the design document for the solution.
Custom Labels Design Overview.docx

[dineshkaushal]

@feerrenrut <https://github.com/feerrenrut> Any update on this?

[feerrenrut]

I think there needs to be more discussion of the overall approach taken, so that the caveats are known. Here is my interpretation of the current PR, and the concerns I have:

• Labels are saved in a folder 'webLabels' under the NVDA settings folder.
  • For each page with labels a file is created, named with the URL of the site you visit with '.ini' appended.
  • Some special characters are removed from the filename, this is not done using a library function and no indication of given the set of characters removed is safe.
  • How does this handle URL's that change as you use the page? Or URL's that are updated from time to time?
  • When will these files get cleaned up?
• There is not really a clear discussion of how keys for label are generated, and how robust this is.
• This relies on Virtual buffer support which is unlikely to be available in the future. Some discussion on how this could be implemented without virtual buffers, or will this feature have to be removed?

[Adriani90]

@ManshulBelani any update on this? Did you find some time to address @feerrenrut's comments? Thanks for your work.

[feerrenrut]

We understand this has been a desired feature. This PR requires a bit of work before we can accept it and isn't currently a priority at NV Access. Anyone who wishes to take this on may, but please consider the following:

• Conflicts and updated to Python 3 code.
• Consider new applications now available, eg Edge
• Further documentation on the PR about how it works and what cases have been considered, why certain things were done or decisions made.

For now we will close this PR.