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

[A11y] Add labels for different screens for Talkback reader #2743

Closed
4 of 29 tasks
rt4914 opened this issue Feb 18, 2021 · 15 comments
Closed
4 of 29 tasks

[A11y] Add labels for different screens for Talkback reader #2743

rt4914 opened this issue Feb 18, 2021 · 15 comments
Assignees
Labels
Z-ibt Temporary label for Ben to keep track of issues he's triaged.

Comments

@rt4914
Copy link
Contributor

rt4914 commented Feb 18, 2021

When Talkback is on, whenever we click on any option which leads to new screen the reader will automatically read the label associated with that screen first. If in case label in not present then it will read app name i.e. Oppia.

We need correct labels for following screens:

In general if there is a static/fixed Title for the screen, we use that as label. And if there is dynamic title then we need a static label which will not be shown on screen but will be read by the talkback.

Example

device-2021-02-24-021647.mp4

In this above video as soon as we double-tap Battery, new screen is opened.
The reader first outputs Battery followed by Navigate up, Button and finally Battery again. In this the first Battery output is the label of this new screen which indicates the learner which screen is opened. The second Battery is because we selected the title in the screen and it's just reading that text.
So we need labels for various screens general which matches the title but if the title is dynamic then we need static label.

Note: The above list can change as and when we find more such issues.

@rt4914 rt4914 self-assigned this Feb 18, 2021
@Arjupta
Copy link
Contributor

Arjupta commented Feb 20, 2021

@rt4914 the links provided in the description point to this same issue

@rt4914
Copy link
Contributor Author

rt4914 commented Feb 22, 2021

@Arjupta This issue is not finished yet. I will add more information to this soon.

@rt4914
Copy link
Contributor Author

rt4914 commented Feb 23, 2021

@mschanteltc You can directly edit the description to edit and approve things.

@mschanteltc
Copy link

I updated the original post and have questions/comments for the following:

  • Onboarding Flow: Does this need to have a label even though there is no heading or label that reads "Onboarding Flow"?
  • Admin Auth: For these pages, my concern is that if we label them to be "Admin Authorization", it might confuse the users who tapped on it with the intention of creating a new profile. I believe that we should leave the headings as is since the body text describes why a PIN is needed before moving on to creating a new profile. WDYT?
  • Topic Page, Story/Chapter List, and Revision Card should be specifically named whatever Topic/Story/Revision it is based on. Would there be any issues with this?
  • FAQs should also be read out as 'Frequently Asked Questions' for users who may not understand its abbreviated version

@rt4914
Copy link
Contributor Author

rt4914 commented Feb 23, 2021

I updated the original post and have questions/comments for the following:

  • Onboarding Flow: Does this need to have a label even though there is no heading or label that reads "Onboarding Flow"?

If we do not introduce any label it will output Oppia by default. We can mention any thing in label like Onboarding process started, etc.

  • Admin Auth: For these pages, my concern is that if we label them to be "Admin Authorization", it might confuse the users who tapped on it with the intention of creating a new profile. I believe that we should leave the headings as is since the body text describes why a PIN is needed before moving on to creating a new profile. WDYT?

Same for this too. If we do not add label it will output Oppia by default. Does this make sense: Authorize to add profiles and Authorize to access Administrator Controls ?

  • Topic Page, Story/Chapter List, and Revision Card should be specifically named whatever Topic/Story/Revision it is based on. Would there be any issues with this?

Do you mean that we should label it as Matthew Goes to Bakery or Fractions of a Group? It is doable but I will need confirmation about the technical solution from Ben.
Otherwise as per Ben suggestions in one of the PRs: we can also use Topic page, Chapter List and Subtopic page as static labels for these screens. WDYT?

  • FAQs should also be read out as 'Frequently Asked Questions' for users who may not understand its abbreviated version

So the output should be FAQs Frequently Asked Questions or just Frequently Asked Questions ?

@mschanteltc
Copy link

I updated the original post and have questions/comments for the following:

  • Onboarding Flow: Does this need to have a label even though there is no heading or label that reads "Onboarding Flow"?

If we do not introduce any label it will output Oppia by default. We can mention any thing in label like Onboarding process started, etc.

I see, let's stick with "Onboarding Flow" then. I approved this in the original post.

  • Admin Auth: For these pages, my concern is that if we label them to be "Admin Authorization", it might confuse the users who tapped on it with the intention of creating a new profile. I believe that we should leave the headings as is since the body text describes why a PIN is needed before moving on to creating a new profile. WDYT?

Same for this too. If we do not add label it will output Oppia by default. Does this make sense: Authorize to add profiles and Authorize to access Administrator Controls ?

Yes those would work better. Would there be any issues since the heading does not match with the Talkback description?

  • Topic Page, Story/Chapter List, and Revision Card should be specifically named whatever Topic/Story/Revision it is based on. Would there be any issues with this?

Do you mean that we should label it as Matthew Goes to Bakery or Fractions of a Group? It is doable but I will need confirmation about the technical solution from Ben.
Otherwise as per Ben suggestions in one of the PRs: we can also use Topic page, Chapter List and Subtopic page as static labels for these screens. WDYT?

I'm opened to doing a combination of both. So for example, "Topic page: Decimals". This gives a description on what kind of page it is and specifics on what the page is about.

  • FAQs should also be read out as 'Frequently Asked Questions' for users who may not understand its abbreviated version

So the output should be FAQs Frequently Asked Questions or just Frequently Asked Questions ?

Let's do FAQs (Frequently Asked Questions) if possible.

@rt4914
Copy link
Contributor Author

rt4914 commented Feb 23, 2021

I updated the original post and have questions/comments for the following:

  • Onboarding Flow: Does this need to have a label even though there is no heading or label that reads "Onboarding Flow"?

If we do not introduce any label it will output Oppia by default. We can mention any thing in label like Onboarding process started, etc.

I see, let's stick with "Onboarding Flow" then. I approved this in the original post.

Thanks.

  • Admin Auth: For these pages, my concern is that if we label them to be "Admin Authorization", it might confuse the users who tapped on it with the intention of creating a new profile. I believe that we should leave the headings as is since the body text describes why a PIN is needed before moving on to creating a new profile. WDYT?

Same for this too. If we do not add label it will output Oppia by default. Does this make sense: Authorize to add profiles and Authorize to access Administrator Controls ?

Yes those would work better. Would there be any issues since the heading does not match with the Talkback description?

No. Its completely fine to have label and title different.

  • Topic Page, Story/Chapter List, and Revision Card should be specifically named whatever Topic/Story/Revision it is based on. Would there be any issues with this?

Do you mean that we should label it as Matthew Goes to Bakery or Fractions of a Group? It is doable but I will need confirmation about the technical solution from Ben.
Otherwise as per Ben suggestions in one of the PRs: we can also use Topic page, Chapter List and Subtopic page as static labels for these screens. WDYT?

I'm opened to doing a combination of both. So for example, "Topic page: Decimals". This gives a description on what kind of page it is and specifics on what the page is about.

Okay. Then in this case I will clarify one thing with Ben.
@BenHenning For dynamic title we need static labels or the labels should be ready in advances because we cannot wait for loading of data. So to do that I have one solution. When learner clicks on Topic Card on home screen we already have topic name available. We can send this topic name to TopicActivity and can set label from their programmatically. There are two issue with this: (a.) AndroidManifest.xml file will not contain label attribute as a result (b.) the Static Check that we were planning to do for labels won't work in such cases. WDYT?

  • FAQs should also be read out as 'Frequently Asked Questions' for users who may not understand its abbreviated version

So the output should be FAQs Frequently Asked Questions or just Frequently Asked Questions ?

Let's do FAQs (Frequently Asked Questions) if possible.

Sounds good. Thanks.

@rt4914
Copy link
Contributor Author

rt4914 commented Feb 23, 2021

@mschanteltc Can you update the description for 4 pending items Admin Auth (2), Pin Verification and Add Profile ?

@mschanteltc
Copy link

@mschanteltc Can you update the description for 4 pending items Admin Auth (2), Pin Verification and Add Profile ?

Updated.

@BenHenning
Copy link
Member

BenHenning commented Feb 24, 2021

@mschanteltc one concern I have around making the topic/story/etc. activities dynamic is we're now introducing redundancy for screenreader users. They will be hearing the topic title twice: once for the activity label, and second when they swipe through the toolbar. What benefit do we gain from having this redundancy? In general, I think we should aim to reduce the amount of information we need to convey so that it's easier to use the UI. WDYT?

Edit: well it seems that this is actually standard (e.g. to have the toolbar title & activity label in-sync). However, I'm still leaning toward having static labels for all activities even if the toolbar is dynamic, especially since dynamic titles are probably longer to read out which means the redundancy is more noticeable in those cases.

@mschanteltc
Copy link

@mschanteltc one concern I have around making the topic/story/etc. activities dynamic is we're now introducing redundancy for screenreader users. They will be hearing the topic title twice: once for the activity label, and second when they swipe through the toolbar. What benefit do we gain from having this redundancy? In general, I think we should aim to reduce the amount of information we need to convey so that it's easier to use the UI. WDYT?

Edit: well it seems that this is actually standard (e.g. to have the toolbar title & activity label in-sync). However, I'm still leaning toward having static labels for all activities even if the toolbar is dynamic, especially since dynamic titles are probably longer to read out which means the redundancy is more noticeable in those cases.

Thanks for your input Ben! I think as long as the Topic/Story/Revision names are mentioned at some point, we can use the static labels so we can eliminate the redundancies like you mentioned. Should I go ahead and edit the post to reflect this?

@rt4914
Copy link
Contributor Author

rt4914 commented Feb 24, 2021

@mschanteltc one concern I have around making the topic/story/etc. activities dynamic is we're now introducing redundancy for screenreader users. They will be hearing the topic title twice: once for the activity label, and second when they swipe through the toolbar. What benefit do we gain from having this redundancy? In general, I think we should aim to reduce the amount of information we need to convey so that it's easier to use the UI. WDYT?
Edit: well it seems that this is actually standard (e.g. to have the toolbar title & activity label in-sync). However, I'm still leaning toward having static labels for all activities even if the toolbar is dynamic, especially since dynamic titles are probably longer to read out which means the redundancy is more noticeable in those cases.

Thanks for your input Ben! I think as long as the Topic/Story/Revision names are mentioned at some point, we can use the static labels so we can eliminate the redundancies like you mentioned. Should I go ahead and edit the post to reflect this?

@mschanteltc Yes, you can edit the description and add correct labels to reflect correct labels.

@mschanteltc
Copy link

Updated. One last thing that is PENDING is the Revision Card which was originally Subtopic Page. However since "Subtopic" is not a term used in the app and is commonly replaced with "Skill", Skill Page is used instead. WDYT?

@rt4914
Copy link
Contributor Author

rt4914 commented Feb 25, 2021

Updated. One last thing that is PENDING is the Revision Card which was originally Subtopic Page. However since "Subtopic" is not a term used in the app and is commonly replaced with "Skill", Skill Page is used instead. WDYT?

@mschanteltc Makes sense. I am updating the description.

@rt4914
Copy link
Contributor Author

rt4914 commented Mar 2, 2021

Closing this issue as it has been broken down into following issues:
#2804 #2805 #2806 #2807 #2808 #2809 #2810 #2811 #2812 #2813 #2814 #2815 #2816 #2817 #2818 #2819 #2820 #2821 #2822 #2823 #2824 #2825 #2826

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Z-ibt Temporary label for Ben to keep track of issues he's triaged.
Development

No branches or pull requests

5 participants