Skip to content

Commit 35313a9

Browse files
committed
Added a docs folder to build the project pages
1 parent a0fdb18 commit 35313a9

File tree

1 file changed

+83
-0
lines changed

1 file changed

+83
-0
lines changed

docs/readme.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# AxSGrease
2+
3+
- Author: James Teh <jamie@nvaccess.org> & other contributors
4+
- Copyright: 2011-2017 NV Access Limited
5+
6+
AxSGrease is a set of [GreaseMonkey](https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/) scripts to improve the accessibility of various websites.
7+
8+
## Installation
9+
Before you can install any of these scripts, you must first install [GreaseMonkey](https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/).
10+
Once that is done, simply activate the download link for the relevant script below to download and install it.
11+
12+
## Scripts
13+
Following is information about each script.
14+
15+
### Bugzilla Accessibility Fixes
16+
[Download Bugzilla Accessibility Fixes](https://github.com/nvaccess/axSGrease/raw/master/BugzillaA11yFixes.user.js)
17+
18+
This script improves the accessibility of bug pages in the [Bugzilla](http://www.bugzilla.org/) bug tracker used by many projects.
19+
It does the following:
20+
21+
- Makes the bug title, attachments heading and comment number headings accessible as headings.
22+
- Sets alternate text for user images so that screen readers don't derive an unfriendly name from the URL.
23+
24+
### GitHub Accessibility Fixes
25+
[Download GitHub Accessibility Fixes](https://github.com/nvaccess/axSGrease/raw/master/GitHubA11yFixes.user.js)
26+
27+
This script improves the accessibility of [GitHub](https://github.com/).
28+
It does the following:
29+
30+
- Makes various headings accessible as headings, including:
31+
- Comment headers in issues, pull requests and commits
32+
- Commit group headers in commit listings
33+
- The commit title for single commits
34+
- The header for each changed file in pull requests and commits
35+
- Ensures that various data tables aren't treated as layout tables, including:
36+
- The file content when viewing a single file
37+
- File listings
38+
- Diff content
39+
- Tables in Markdown content
40+
- When there are lines of code which can be commented on (e.g. a pull request or commit), puts the comment buttons after (rather than before) the code.
41+
- Makes the state of checkable menu items accessible; e.g. in the watch and labels pop-ups.
42+
- Marks "Add your reaction" buttons as having a pop-up, focuses the first reaction when the add button is pressed and makes the labels of the reaction buttons less verbose.
43+
44+
### Kill Windowless Flash
45+
[Download Kill Windowless Flash](https://github.com/nvaccess/axSGrease/raw/master/KillWindowlessFlash.user.js)
46+
47+
Adobe Flash objects can be made to be accessible.
48+
Even if they aren't and only contain unlabelled controls, it might still be possible to use these objects with some initial sighted help or by trial and error.
49+
However, it's impossible for accessibility tools to interact at all with Flash objects that are "windowless" (also known as transparent or opaque).
50+
This script makes windowless Flash objects windowed so that there may be a chance of accessing them.
51+
52+
### Monorail Accessibility Fixes
53+
[Download Monorail Accessibility Fixes](https://github.com/nvaccess/axSGrease/raw/master/MonorailA11yFixes.user.js)
54+
55+
This script improves the accessiblity of the [Monorail](https://bugs.chromium.org/) issue tracker used by Google for Chromium-related projects.
56+
It does the following:
57+
58+
- Makes issue titles and comment headings accessible as headings.
59+
- Makes the star control and status accessible.
60+
61+
### Slack Accessibility Fixes
62+
[Download Slack Accessibility Fixes](https://github.com/nvaccess/axSGrease/raw/master/SlackA11yFixes.user.js)
63+
64+
This script improves the accessibility of [Slack](https://www.slack.com/).
65+
It does the following:
66+
67+
- Reorders some elements which appear in the wrong place for accessibility. For example, using this script, the input area appears near the bottom of the page as it does visually instead of at the top.
68+
- Makes messages accessible as list items.
69+
- Makes message timestamps appear on a single line instead of crossing several lines.
70+
- Makes star controls (and their statuses) accessible.
71+
- Makes the close link for the about channel pane accessible.
72+
- Makes day separators in the message history and the about channel pane heading accessible as headings.
73+
- Reports incoming messages automatically (using a live region).
74+
- Hides an editable area which isn't shown visually.
75+
76+
### Telegram accessibility fixes
77+
[Download Telegram Accessibility Fixes](https://github.com/nvaccess/axSGrease/raw/master/TelegramA11yFixes.user.js)
78+
79+
This script improves the accessibility of the [Telegram instant messaging](https://web.telegram.org/) web interface.
80+
81+
It so far does the following:
82+
83+
- Marks the chat history as a live region so new messages are announced automatically.

0 commit comments

Comments
 (0)