{"action":"created","issue":{"url":"https://api.github.com/repos/projecthydra/sufia/issues/2003","repository_url":"https://api.github.com/repos/projecthydra/sufia","labels_url":"https://api.github.com/repos/projecthydra/sufia/issues/2003/labels{/name}","comments_url":"https://api.github.com/repos/projecthydra/sufia/issues/2003/comments","events_url":"https://api.github.com/repos/projecthydra/sufia/issues/2003/events","html_url":"https://github.com/projecthydra/sufia/issues/2003","id":153859727,"number":2003,"title":"Improve accessibility of help text","user":{"login":"justcolin","id":11234702,"avatar_url":"https://avatars.githubusercontent.com/u/11234702?v=3","gravatar_id":"","url":"https://api.github.com/users/justcolin","html_url":"https://github.com/justcolin","followers_url":"https://api.github.com/users/justcolin/followers","following_url":"https://api.github.com/users/justcolin/following{/other_user}","gists_url":"https://api.github.com/users/justcolin/gists{/gist_id}","starred_url":"https://api.github.com/users/justcolin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/justcolin/subscriptions","organizations_url":"https://api.github.com/users/justcolin/orgs","repos_url":"https://api.github.com/users/justcolin/repos","events_url":"https://api.github.com/users/justcolin/events{/privacy}","received_events_url":"https://api.github.com/users/justcolin/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/projecthydra/sufia/labels/accessibility","name":"accessibility","color":"207de5"},{"url":"https://api.github.com/repos/projecthydra/sufia/labels/user%20interface","name":"user interface","color":"02e10c"}],"state":"open","locked":false,"assignee":{"login":"justcolin","id":11234702,"avatar_url":"https://avatars.githubusercontent.com/u/11234702?v=3","gravatar_id":"","url":"https://api.github.com/users/justcolin","html_url":"https://github.com/justcolin","followers_url":"https://api.github.com/users/justcolin/followers","following_url":"https://api.github.com/users/justcolin/following{/other_user}","gists_url":"https://api.github.com/users/justcolin/gists{/gist_id}","starred_url":"https://api.github.com/users/justcolin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/justcolin/subscriptions","organizations_url":"https://api.github.com/users/justcolin/orgs","repos_url":"https://api.github.com/users/justcolin/repos","events_url":"https://api.github.com/users/justcolin/events{/privacy}","received_events_url":"https://api.github.com/users/justcolin/received_events","type":"User","site_admin":false},"milestone":null,"comments":4,"created_at":"2016-05-09T20:15:27Z","updated_at":"2016-05-10T14:17:11Z","closed_at":null,"body":"### Descriptive summary\r\n\r\nIn our user and accessibility testing we found that the default presentation of help text on Sufia forms is making some things difficult for users. Issues include (in loose order of importance):\r\n\r\n- The help buttons to show/hide the help text do not have visible text and they are very small, making it very difficult for users using voice control software to select them.\r\n    - Here is an example of the annoying process someone using voice control software has to go through to move the mouse: https://youtu.be/G4zUOwP3F_k?t=57s\r\n    - The rule of thumb is to avoid making users go through that process whenever possible.\r\n    - When buttons have visible text users of voice control software can often just tell the computer to click the button by name, but in this case I think that would clutter the screen with repeated link/button names, which is an accessibility problem for other users.\r\n- The help buttons are so small they are a bit tricky for most users to select with a mouse, and would be very difficult for users with motor disabilities to select.\r\n    - Some users with motor disabilities use touch screens, another reason why even desktops applications should prefer larger buttons.\r\n- Many users have been confused about how to close the help boxes.\r\n- It is not obvious to users who are less computer literate that there is help text available.\r\n    - As a university with many older faculty, we can't assume that every user is going to be great using fancier interfaces.\r\n- The modals/pop-ups cover up parts of the interface that we are trying to help people with.\r\n    - This is especially problematic for people who are not as computer literate.\r\n\r\n### Suggested fix\r\n\r\nPut the help text bellow the label, visible to everyone. It solves all the accessibility problems, is a lot simpler to maintain, and is standard across most websites so users shouldn't find the added text jarring.\r\n\r\nWhen people need to add a lot of help text, we recommend that they write a short 1–2 sentence summary of what the first does and include a link to a static help page in that description for a longer explanation about that field.\r\n\r\nHere is an example of how things can look (screenshot taken from U-M's research data repository, so some things are different from the Sufia defaults):\r\n\r\n![screen shot 2016-05-09 at 3 59 35 pm copy](https://cloud.githubusercontent.com/assets/11234702/15126562/89a2f09e-1600-11e6-88c3-056e0323c6f4.png)\r\n\r\n### Questions\r\n\r\n1. Are people interested in a \"Hide Help Text\" button at the top of each form or as an option in a user's profile page?\r\n\r\n2. Is anyone in the community interested in a configuration option to bring back the less accessible help text buttons for institutions who prefer it? If so I am more than happy to add that feature to the PR.\r\n\r\n3. If people are interested in the the option mentioned in question 2, would they be okay with some accessibility improvements to the help button interface? This will probably consist of a little visible text saying to make it easier for people using voice control software, as well as a dedicated button to close the popup.\r\n\r\n### Related work\r\n\r\n#1612"},"comment":{"url":"https://api.github.com/repos/projecthydra/sufia/issues/comments/218171189","html_url":"https://github.com/projecthydra/sufia/issues/2003#issuecomment-218171189","issue_url":"https://api.github.com/repos/projecthydra/sufia/issues/2003","id":218171189,"user":{"login":"mtribone","id":4163828,"avatar_url":"https://avatars.githubusercontent.com/u/4163828?v=3","gravatar_id":"","url":"https://api.github.com/users/mtribone","html_url":"https://github.com/mtribone","followers_url":"https://api.github.com/users/mtribone/followers","following_url":"https://api.github.com/users/mtribone/following{/other_user}","gists_url":"https://api.github.com/users/mtribone/gists{/gist_id}","starred_url":"https://api.github.com/users/mtribone/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mtribone/subscriptions","organizations_url":"https://api.github.com/users/mtribone/orgs","repos_url":"https://api.github.com/users/mtribone/repos","events_url":"https://api.github.com/users/mtribone/events{/privacy}","received_events_url":"https://api.github.com/users/mtribone/received_events","type":"User","site_admin":false},"created_at":"2016-05-10T14:17:11Z","updated_at":"2016-05-10T14:17:11Z","body":"@justcolin I really like the context of +Add and the label on the button (+Add Contributor). I've always seen the help icon all over the page as a problem, so adding minimal help text is a good solution. I worry that others will get too wordy, but I guess that is the responsibility of the adopter if they want to override the text.\r\n\r\nI'm curious on how to approach the tome that is the rights metadata. If we link to another page does the user lose anything by moving back and forth? By using a modal, we keep the context of  filling out the form. Similar feeling about the keywords in the facets and using a modal, so looking forward to seeing your approach.\r\n\r\nI agree with @sfbetz that hiding help text is unnecessary as a configuration option. "}}