{"action":"created","comment":{"url":"https://api.github.com/repos/edx/edx-documentation/pulls/comments/56363457","id":56363457,"diff_hunk":"@@ -493,17 +493,66 @@ encumber a different audience. For instance, a **Close** button that looks like\n the Accessibility API.\n \n To visibly hide content that should be read by screen readers, edX makes a CSS\n-``class=\"sr\"`` available to expose content only to screen reader users. In the\n-following example, a sighted user sees only the X, while a screen reader user\n-hears only \"Close\".\n+``class=\"sr\"`` available to expose content only to non-visual users. This is\n+achieved by displaying the content beyond the bounds of the viewport so that it \n+is not displayed visually, but still accessible in the DOM.  This is sometimes\n+referred to as displaying content \"offscreen\". In the following example, a\n+visual user sees only the X, while a screen reader user hears only \"Close\".\n \n ::\n \n   <a href=\"#\">\n-  <span aria-hidden=\"true\">X</span>\n-  <span class=\"sr\">Close</span>\n+    <span aria-hidden=\"true\">X</span>   <!-- hidden from screen reader users -->\n+    <span class=\"sr\">Close</span>       <!-- exposed only to screen reader users -->\n   </a>\n+  \n+The choice to show or hide content for a specific audience should not be taken\n+lightly. Extensive use of offscreen content often indicates poor design or \n+accessibility. The following questions should help you decide if one of the above \n+techniques is appropriate or not:\n+\n+Would all users benefit from the content displayed offscreen?\n+  If the additional content considered for display offscreen could also be useful for \n+  visual users as well, consider finding a way to make the content work visually.\n+  \n+Is important context being provided only visually?\n+  Consider a standard sidebar navigation. It is common to visually indicate the\n+  current page or section by differentiating it visually from other pages or\n+  sections in the navigation.  To a visual user, it is clear that the item in \n+  the list that looks different than all the others is the page they are currently\n+  viewing. Offscreen text is an effective way to make this visual context available \n+  to non-visual users. The following example demonstrates this.  *Note the non-breaking\n+  space in the offscreen text span.  Without it, a screen reader would read this text\n+  as \"About UsCurrent page.\"*\n+  ","path":"en_us/developers/source/conventions/accessibility.rst","position":40,"original_position":40,"commit_id":"5c7f6d979c0bd9d334b411f56233b4a7bd2ae36a","original_commit_id":"5c7f6d979c0bd9d334b411f56233b4a7bd2ae36a","user":{"login":"cptvitamin","id":444368,"avatar_url":"https://avatars.githubusercontent.com/u/444368?v=3","gravatar_id":"","url":"https://api.github.com/users/cptvitamin","html_url":"https://github.com/cptvitamin","followers_url":"https://api.github.com/users/cptvitamin/followers","following_url":"https://api.github.com/users/cptvitamin/following{/other_user}","gists_url":"https://api.github.com/users/cptvitamin/gists{/gist_id}","starred_url":"https://api.github.com/users/cptvitamin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cptvitamin/subscriptions","organizations_url":"https://api.github.com/users/cptvitamin/orgs","repos_url":"https://api.github.com/users/cptvitamin/repos","events_url":"https://api.github.com/users/cptvitamin/events{/privacy}","received_events_url":"https://api.github.com/users/cptvitamin/received_events","type":"User","site_admin":false},"body":"If you were to venn diagram that statement, you could easily have content that is \"meaningful and has purpose\" inside the circle for offscreen content (non-visual users).  How about \"Is the offscreen content generally useful for all users, not just non-visual users?\"","created_at":"2016-03-16T16:13:46Z","updated_at":"2016-03-16T16:13:46Z","html_url":"https://github.com/edx/edx-documentation/pull/925#discussion_r56363457","pull_request_url":"https://api.github.com/repos/edx/edx-documentation/pulls/925","_links":{"self":{"href":"https://api.github.com/repos/edx/edx-documentation/pulls/comments/56363457"},"html":{"href":"https://github.com/edx/edx-documentation/pull/925#discussion_r56363457"},"pull_request":{"href":"https://api.github.com/repos/edx/edx-documentation/pulls/925"}}},"pull_request":{"url":"https://api.github.com/repos/edx/edx-documentation/pulls/925","id":63085222,"html_url":"https://github.com/edx/edx-documentation/pull/925","diff_url":"https://github.com/edx/edx-documentation/pull/925.diff","patch_url":"https://github.com/edx/edx-documentation/pull/925.patch","issue_url":"https://api.github.com/repos/edx/edx-documentation/issues/925","number":925,"state":"open","locked":false,"title":"Adds more practical guidance on when it's appropriate to use offscreen text","user":{"login":"cptvitamin","id":444368,"avatar_url":"https://avatars.githubusercontent.com/u/444368?v=3","gravatar_id":"","url":"https://api.github.com/users/cptvitamin","html_url":"https://github.com/cptvitamin","followers_url":"https://api.github.com/users/cptvitamin/followers","following_url":"https://api.github.com/users/cptvitamin/following{/other_user}","gists_url":"https://api.github.com/users/cptvitamin/gists{/gist_id}","starred_url":"https://api.github.com/users/cptvitamin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cptvitamin/subscriptions","organizations_url":"https://api.github.com/users/cptvitamin/orgs","repos_url":"https://api.github.com/users/cptvitamin/repos","events_url":"https://api.github.com/users/cptvitamin/events{/privacy}","received_events_url":"https://api.github.com/users/cptvitamin/received_events","type":"User","site_admin":false},"body":"@catong can you review this for grammatical correctness and readability? \r\n@clrux do you think this guidance is helpful and complete?","created_at":"2016-03-16T15:36:18Z","updated_at":"2016-03-16T16:13:46Z","closed_at":null,"merged_at":null,"merge_commit_sha":"662d747a9bfde0c49502f2db39d5301ac4a89bcc","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/edx/edx-documentation/pulls/925/commits","review_comments_url":"https://api.github.com/repos/edx/edx-documentation/pulls/925/comments","review_comment_url":"https://api.github.com/repos/edx/edx-documentation/pulls/comments{/number}","comments_url":"https://api.github.com/repos/edx/edx-documentation/issues/925/comments","statuses_url":"https://api.github.com/repos/edx/edx-documentation/statuses/5c7f6d979c0bd9d334b411f56233b4a7bd2ae36a","head":{"label":"edx:cptvitamin/AC-326-offscreen-text","ref":"cptvitamin/AC-326-offscreen-text","sha":"5c7f6d979c0bd9d334b411f56233b4a7bd2ae36a","user":{"login":"edx","id":3179841,"avatar_url":"https://avatars.githubusercontent.com/u/3179841?v=3","gravatar_id":"","url":"https://api.github.com/users/edx","html_url":"https://github.com/edx","followers_url":"https://api.github.com/users/edx/followers","following_url":"https://api.github.com/users/edx/following{/other_user}","gists_url":"https://api.github.com/users/edx/gists{/gist_id}","starred_url":"https://api.github.com/users/edx/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/edx/subscriptions","organizations_url":"https://api.github.com/users/edx/orgs","repos_url":"https://api.github.com/users/edx/repos","events_url":"https://api.github.com/users/edx/events{/privacy}","received_events_url":"https://api.github.com/users/edx/received_events","type":"Organization","site_admin":false},"repo":{"id":23839256,"name":"edx-documentation","full_name":"edx/edx-documentation","owner":{"login":"edx","id":3179841,"avatar_url":"https://avatars.githubusercontent.com/u/3179841?v=3","gravatar_id":"","url":"https://api.github.com/users/edx","html_url":"https://github.com/edx","followers_url":"https://api.github.com/users/edx/followers","following_url":"https://api.github.com/users/edx/following{/other_user}","gists_url":"https://api.github.com/users/edx/gists{/gist_id}","starred_url":"https://api.github.com/users/edx/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/edx/subscriptions","organizations_url":"https://api.github.com/users/edx/orgs","repos_url":"https://api.github.com/users/edx/repos","events_url":"https://api.github.com/users/edx/events{/privacy}","received_events_url":"https://api.github.com/users/edx/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/edx/edx-documentation","description":"For published versions of the edX documentation, visit:","fork":false,"url":"https://api.github.com/repos/edx/edx-documentation","forks_url":"https://api.github.com/repos/edx/edx-documentation/forks","keys_url":"https://api.github.com/repos/edx/edx-documentation/keys{/key_id}","collaborators_url":"https://api.github.com/repos/edx/edx-documentation/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/edx/edx-documentation/teams","hooks_url":"https://api.github.com/repos/edx/edx-documentation/hooks","issue_events_url":"https://api.github.com/repos/edx/edx-documentation/issues/events{/number}","events_url":"https://api.github.com/repos/edx/edx-documentation/events","assignees_url":"https://api.github.com/repos/edx/edx-documentation/assignees{/user}","branches_url":"https://api.github.com/repos/edx/edx-documentation/branches{/branch}","tags_url":"https://api.github.com/repos/edx/edx-documentation/tags","blobs_url":"https://api.github.com/repos/edx/edx-documentation/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/edx/edx-documentation/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/edx/edx-documentation/git/refs{/sha}","trees_url":"https://api.github.com/repos/edx/edx-documentation/git/trees{/sha}","statuses_url":"https://api.github.com/repos/edx/edx-documentation/statuses/{sha}","languages_url":"https://api.github.com/repos/edx/edx-documentation/languages","stargazers_url":"https://api.github.com/repos/edx/edx-documentation/stargazers","contributors_url":"https://api.github.com/repos/edx/edx-documentation/contributors","subscribers_url":"https://api.github.com/repos/edx/edx-documentation/subscribers","subscription_url":"https://api.github.com/repos/edx/edx-documentation/subscription","commits_url":"https://api.github.com/repos/edx/edx-documentation/commits{/sha}","git_commits_url":"https://api.github.com/repos/edx/edx-documentation/git/commits{/sha}","comments_url":"https://api.github.com/repos/edx/edx-documentation/comments{/number}","issue_comment_url":"https://api.github.com/repos/edx/edx-documentation/issues/comments{/number}","contents_url":"https://api.github.com/repos/edx/edx-documentation/contents/{+path}","compare_url":"https://api.github.com/repos/edx/edx-documentation/compare/{base}...{head}","merges_url":"https://api.github.com/repos/edx/edx-documentation/merges","archive_url":"https://api.github.com/repos/edx/edx-documentation/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/edx/edx-documentation/downloads","issues_url":"https://api.github.com/repos/edx/edx-documentation/issues{/number}","pulls_url":"https://api.github.com/repos/edx/edx-documentation/pulls{/number}","milestones_url":"https://api.github.com/repos/edx/edx-documentation/milestones{/number}","notifications_url":"https://api.github.com/repos/edx/edx-documentation/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/edx/edx-documentation/labels{/name}","releases_url":"https://api.github.com/repos/edx/edx-documentation/releases{/id}","deployments_url":"https://api.github.com/repos/edx/edx-documentation/deployments","created_at":"2014-09-09T15:29:04Z","updated_at":"2016-03-15T18:08:23Z","pushed_at":"2016-03-16T16:04:42Z","git_url":"git://github.com/edx/edx-documentation.git","ssh_url":"git@github.com:edx/edx-documentation.git","clone_url":"https://github.com/edx/edx-documentation.git","svn_url":"https://github.com/edx/edx-documentation","homepage":" http://docs.edx.org","size":95021,"stargazers_count":34,"watchers_count":34,"language":"Makefile","has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":122,"mirror_url":null,"open_issues_count":26,"forks":122,"open_issues":26,"watchers":34,"default_branch":"master"}},"base":{"label":"edx:master","ref":"master","sha":"a0dc9ad254fe12e7ffd8870b51da15f4d051e425","user":{"login":"edx","id":3179841,"avatar_url":"https://avatars.githubusercontent.com/u/3179841?v=3","gravatar_id":"","url":"https://api.github.com/users/edx","html_url":"https://github.com/edx","followers_url":"https://api.github.com/users/edx/followers","following_url":"https://api.github.com/users/edx/following{/other_user}","gists_url":"https://api.github.com/users/edx/gists{/gist_id}","starred_url":"https://api.github.com/users/edx/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/edx/subscriptions","organizations_url":"https://api.github.com/users/edx/orgs","repos_url":"https://api.github.com/users/edx/repos","events_url":"https://api.github.com/users/edx/events{/privacy}","received_events_url":"https://api.github.com/users/edx/received_events","type":"Organization","site_admin":false},"repo":{"id":23839256,"name":"edx-documentation","full_name":"edx/edx-documentation","owner":{"login":"edx","id":3179841,"avatar_url":"https://avatars.githubusercontent.com/u/3179841?v=3","gravatar_id":"","url":"https://api.github.com/users/edx","html_url":"https://github.com/edx","followers_url":"https://api.github.com/users/edx/followers","following_url":"https://api.github.com/users/edx/following{/other_user}","gists_url":"https://api.github.com/users/edx/gists{/gist_id}","starred_url":"https://api.github.com/users/edx/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/edx/subscriptions","organizations_url":"https://api.github.com/users/edx/orgs","repos_url":"https://api.github.com/users/edx/repos","events_url":"https://api.github.com/users/edx/events{/privacy}","received_events_url":"https://api.github.com/users/edx/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/edx/edx-documentation","description":"For published versions of the edX documentation, visit:","fork":false,"url":"https://api.github.com/repos/edx/edx-documentation","forks_url":"https://api.github.com/repos/edx/edx-documentation/forks","keys_url":"https://api.github.com/repos/edx/edx-documentation/keys{/key_id}","collaborators_url":"https://api.github.com/repos/edx/edx-documentation/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/edx/edx-documentation/teams","hooks_url":"https://api.github.com/repos/edx/edx-documentation/hooks","issue_events_url":"https://api.github.com/repos/edx/edx-documentation/issues/events{/number}","events_url":"https://api.github.com/repos/edx/edx-documentation/events","assignees_url":"https://api.github.com/repos/edx/edx-documentation/assignees{/user}","branches_url":"https://api.github.com/repos/edx/edx-documentation/branches{/branch}","tags_url":"https://api.github.com/repos/edx/edx-documentation/tags","blobs_url":"https://api.github.com/repos/edx/edx-documentation/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/edx/edx-documentation/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/edx/edx-documentation/git/refs{/sha}","trees_url":"https://api.github.com/repos/edx/edx-documentation/git/trees{/sha}","statuses_url":"https://api.github.com/repos/edx/edx-documentation/statuses/{sha}","languages_url":"https://api.github.com/repos/edx/edx-documentation/languages","stargazers_url":"https://api.github.com/repos/edx/edx-documentation/stargazers","contributors_url":"https://api.github.com/repos/edx/edx-documentation/contributors","subscribers_url":"https://api.github.com/repos/edx/edx-documentation/subscribers","subscription_url":"https://api.github.com/repos/edx/edx-documentation/subscription","commits_url":"https://api.github.com/repos/edx/edx-documentation/commits{/sha}","git_commits_url":"https://api.github.com/repos/edx/edx-documentation/git/commits{/sha}","comments_url":"https://api.github.com/repos/edx/edx-documentation/comments{/number}","issue_comment_url":"https://api.github.com/repos/edx/edx-documentation/issues/comments{/number}","contents_url":"https://api.github.com/repos/edx/edx-documentation/contents/{+path}","compare_url":"https://api.github.com/repos/edx/edx-documentation/compare/{base}...{head}","merges_url":"https://api.github.com/repos/edx/edx-documentation/merges","archive_url":"https://api.github.com/repos/edx/edx-documentation/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/edx/edx-documentation/downloads","issues_url":"https://api.github.com/repos/edx/edx-documentation/issues{/number}","pulls_url":"https://api.github.com/repos/edx/edx-documentation/pulls{/number}","milestones_url":"https://api.github.com/repos/edx/edx-documentation/milestones{/number}","notifications_url":"https://api.github.com/repos/edx/edx-documentation/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/edx/edx-documentation/labels{/name}","releases_url":"https://api.github.com/repos/edx/edx-documentation/releases{/id}","deployments_url":"https://api.github.com/repos/edx/edx-documentation/deployments","created_at":"2014-09-09T15:29:04Z","updated_at":"2016-03-15T18:08:23Z","pushed_at":"2016-03-16T16:04:42Z","git_url":"git://github.com/edx/edx-documentation.git","ssh_url":"git@github.com:edx/edx-documentation.git","clone_url":"https://github.com/edx/edx-documentation.git","svn_url":"https://github.com/edx/edx-documentation","homepage":" http://docs.edx.org","size":95021,"stargazers_count":34,"watchers_count":34,"language":"Makefile","has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":122,"mirror_url":null,"open_issues_count":26,"forks":122,"open_issues":26,"watchers":34,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/edx/edx-documentation/pulls/925"},"html":{"href":"https://github.com/edx/edx-documentation/pull/925"},"issue":{"href":"https://api.github.com/repos/edx/edx-documentation/issues/925"},"comments":{"href":"https://api.github.com/repos/edx/edx-documentation/issues/925/comments"},"review_comments":{"href":"https://api.github.com/repos/edx/edx-documentation/pulls/925/comments"},"review_comment":{"href":"https://api.github.com/repos/edx/edx-documentation/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/edx/edx-documentation/pulls/925/commits"},"statuses":{"href":"https://api.github.com/repos/edx/edx-documentation/statuses/5c7f6d979c0bd9d334b411f56233b4a7bd2ae36a"}}}}