Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Accessibility issues with the docs #2677

Open
makhlwf opened this issue Jan 20, 2025 · 3 comments
Open

Accessibility issues with the docs #2677

makhlwf opened this issue Jan 20, 2025 · 3 comments

Comments

@makhlwf
Copy link

makhlwf commented Jan 20, 2025

Hello, I don't know if it is the right place to report this problem, but I'm trying to learn this library, and when I try to navigate in this particular page https://wxpython.org/pages/overview/index.html to start, Specifically in the code examples, in Android, TalkBack screen reader pronounces the word index before each line of the code. On Windows Desktop, NVDA screen reader pronounces index rest_code_a9db4fab05f54d… before each line of code, which makes viewing the code not easy.

@DietmarSchwertberger
Copy link
Contributor

The better place for a report would probably have been the wxPython website repository at https://github.com/wxWidgets/wxPyWeb .

I have tried with the NVDA screen reader and I see the rest_code_ fragments in the NVDA Speech Viewer with Edge, but not with Firefox. I don't see it with the mouse, only when using the arrow keys.

Every single code line on the page looks like this:

<a id="rest_code_a9db4fab05f54d7fa2fde251e00b63c2-6" name="rest_code_a9db4fab05f54d7fa2fde251e00b63c2-6" href="index.html#rest_code_a9db4fab05f54d7fa2fde251e00b63c2-6"></a>
<span class="kn">import</span> <span class="nn">wx</span>

I don't see that these ids, names etc. add value to the page except that someone could set a link to a certain code line.

As workaround you may go to the "Source" page.

@swt2c : Do you know whether the HTML generation can be configured not to create such additional tags?
This is created by Nikola and it's not the latest Nikola version, right?

@makhlwf
I'm not a big fan of the Overview page, as I consider a menu less important than some input form elements (wxTextCtrl and wxButton).

You may want to try the wxGlade GUI builder. It should be accessible with a screen reader and it includes a tutorial to get started with wxPython.
Documentation: https://wxglade.sourceforge.net/docs/index.html
Download: https://sourceforge.net/projects/wxglade/files/wxglade/
(Go to Edit->Preferences->Accessibility after the first program start. The latest documentation is also included.)
Repository: https://github.com/wxGlade/wxGlade

@swt2c
Copy link
Collaborator

swt2c commented Jan 22, 2025

@swt2c : Do you know whether the HTML generation can be configured not to create such additional tags?
This is created by Nikola and it's not the latest Nikola version, right?

Sorry, I don't know the answer to your first question. As to the second, the current versions of Nikola are documented here:
https://github.com/wxWidgets/wxPyWeb/blob/master/requirements.txt

Unfortunately, yes, it is not the latest version of Nikola. I did briefly attempt upgrading but it was non-trivial and I wasn't interested in pursuing it further at the time (just wanted to publish the release announcement).

@DietmarSchwertberger
Copy link
Contributor

Thanks. I hope I will find time at the weekend to check whether this can be changed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants