=== Handrail ===
Contributors: mudmin
Donate link: https://makewpcompliant.com/donate/?for=handrail
Tags: accessibility, a11y, wcag, ada, accessibility statement
Requires at least: 6.5
Tested up to: 7.1
Requires PHP: 7.4
Stable tag: 1.2.1
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

Let visitors adjust your site and report barriers, and show editors which accessibility problems are theirs to fix. Not an overlay.

== Description ==

Handrail adds an Accessibility button to your site. It opens a panel with up to three parts. Choose how the panel looks: a settings sheet with a switch or a short list of choices for each tool (the default), the classic tile grid, a floating card next to the button, or a reading dock along the bottom of the screen. Everything is free; there is no paid version.

**Adjust the page (everyone).** Visitors can make text bigger, switch to a dark or high-contrast view, use a more readable font or a dyslexia font, add line and letter spacing, align text left, highlight links, show a stronger focus outline, use a large cursor, apply a color filter (grayscale, soft, strong or inverted), hide images and stop animations. Reading tools: read aloud, a reading guide that follows the pointer, and a reading mask. Quick settings (Low vision, Dyslexia friendly, Reduce motion, Keyboard, Fewer distractions) turn on several at once, and you can add your own. Choices are saved in the visitor's own browser and applied before the page draws, so there is no flash.

**Make it yours.** Set the panel's accent color (Handrail checks it reads clearly), title and button text.

**Report a problem (optional).** Visitors can tell you what got in their way. Reports arrive under Handrail › Reports and by email, with the page, what they chose, and which adjustments they had on. Spam protection is built in. You can add Cloudflare Turnstile, reCAPTCHA or hCaptcha, and if a form plugin on your site already has keys (Contact Form 7, WPForms, Gravity Forms, Forminator), Handrail can use them.

**Check this page (editors only).** People who can edit your site can run an automated accessibility check (axe-core) on any page and see each problem grouped by who can fix it:

* **Your content**: a missing image description, a light text color picked on a block.
* **Your site settings**: Site Editor styles, Additional CSS, the logo, menus.
* **Your theme** or **a named plugin**: traced from the stylesheet that set the color.

Each problem has a "Show me" button that points at it on the page. Administrators also get CSS selectors, contrast numbers, where each color came from, the nearest passing color and a Markdown export.

**Accessibility statement.** Fill in a few settings and Handrail creates a statement page that stays up to date, with your contact details and a link to the report form.

= What Handrail is not =

Handrail is not an "accessibility overlay". It does not claim to make your site compliant, does not rewrite your page, and loads almost nothing for visitors who never open it. Automated checks find about a third of accessibility problems; the checker says so. Real fixes happen in your content, theme and plugins. Handrail shows you where.

= Where the button goes =

* A floating button: a round button, a pill with the word "Accessibility", a tab on the side edge or a tab at the bottom of the screen.
* The "Accessibility button" block, for your footer or header template.
* A widget or the `[handrail]` shortcode for classic themes.
* A menu item (Appearance › Menus › Accessibility).
* An "Accessibility" icon in the Social Icons block (WordPress 6.9 and later).
* Any link to your statement page ending in `#handrail`.

== Installation ==

1. Install and activate Handrail.
2. Go to Handrail › Settings. The floating button is on by default.
3. Optional: turn on Reports under Handrail › Settings › Reports, and create your statement page under Handrail › Settings › Statement.

== Frequently Asked Questions ==

= Will this make my site ADA or WCAG compliant? =

No plugin can. Handrail helps visitors adapt your site, gives them a way to report barriers, and helps you find and fix problems. Compliance comes from fixing those problems.

= Does it slow my site down? =

Visitors who have never used it load one small script. Saved adjustments load one stylesheet. The checker (axe-core) loads only when an editor runs a check.

= Does it track visitors? =

No. Adjustments are stored in the visitor's browser. Nothing is sent anywhere unless a visitor sends a report. Read aloud uses the speech voices built into the visitor's browser; Handrail sends nothing, though some browsers' own voices are online services.

= Why is there no image captcha? =

A puzzle that blocks disabled people defeats the purpose of a barrier report form. Turnstile is usually invisible, and reCAPTCHA v3 has no puzzle at all.

== External services ==

Handrail contacts outside services only if you turn on a captcha for anonymous reports (off by default). The captcha script loads only when a visitor opens the report form, and the token is checked from your server when the report is sent.

* **Cloudflare Turnstile**: sends the visitor's browser data to Cloudflare to tell people from bots. [Terms](https://www.cloudflare.com/website-terms/), [Privacy](https://www.cloudflare.com/privacypolicy/).
* **Google reCAPTCHA**: sends the visitor's browser data to Google. [Terms](https://policies.google.com/terms), [Privacy](https://policies.google.com/privacy).
* **hCaptcha**: sends the visitor's browser data to Intuition Machines. [Terms](https://www.hcaptcha.com/terms), [Privacy](https://www.hcaptcha.com/privacy).

== Third-party code ==

* axe-core 4.14.0 by Deque Systems, Mozilla Public License 2.0, unmodified, in `core/vendor/axe-core/`.
* Atkinson Hyperlegible by the Braille Institute, SIL Open Font License 1.1, in `core/vendor/fonts/`.
* OpenDyslexic by Abbie Gonzalez, SIL Open Font License 1.1, in `pro/vendor/fonts/`.

== Screenshots ==

1. The Adjust tab with quick settings.
2. The checker grouping problems by who can fix them.
3. The report form.
4. The Reports screen.

== Changelog ==

= 1.2.1 =
* Dark and High contrast recolor every part of the page again, and leave alone only see-through overlays, like the invisible boxes ads place over a page. Pages stay readable even when a caching or script-delay plugin holds Handrail's script back, backgrounds that appear only at some screen sizes are recolored, and photos behind a gradient keep showing.
* Dark and High contrast are faster on very long pages, and text size does less work each time a page changes.
* The reading guide and reading mask keep their own colors in Dark and High contrast.
* The Accessibility button block is styled in the block editor again.
* A quick setting that is part of another one you have on now turns off when you press it, instead of doing nothing.
* Handrail switches off Handrail Pro only during a normal visit to the dashboard, so the notice is seen, and on multisite only for people who can manage network plugins.
* Deleting Handrail also removes what Handrail Pro left behind.

= 1.2.0 =
* Everything that was in Handrail Pro is now part of Handrail, free: read aloud, the reading guide and mask, the dyslexia font, left-aligned text, large cursors, color filters, hiding images, the floating card and reading dock panel styles, panel branding and your own quick settings. If Handrail Pro is installed, Handrail switches it off; your settings stay as they were.
* The Reduce motion quick setting only stops animations; it no longer also turns on Soft colors.
* Hide images leaves icons inside buttons alone, so an ad's close button stays visible.
* Dark and High contrast only recolor the parts of a page that already had a background. The see-through boxes that ads stretch over a page no longer turn into a solid panel covering half the screen.
* Dark and High contrast: buttons with a gradient (like many Submit buttons) are readable, and light decorative shapes behind menu items are recolored too.
* Text size no longer keeps growing on pages that reload ads or rebuild parts of the page.
* Turning off a quick setting no longer turns off a tool that another quick setting you still have on needs.
* On phones, the panel fits the part of the screen you can see, so its close button can't end up above the top of the screen.
* The Accessibility link's styles (block, shortcode and widget) are loaded with wp_enqueue_style instead of a style tag.

= 1.1.3 =
* The panel heading no longer shows a focus ring when the panel opens.

= 1.1.2 =
* Screen readers and the Tab key reach the floating button near the start of the page (right after a skip link) instead of after everything else. It looks the same.
* Opening the panel puts focus on its heading, so a screen reader starts at the top instead of on the first quick setting.
* The quick settings and each group of tools are lists, so screen readers say how many there are and which one you're on ("2 of 6").

= 1.1.1 =
* Choose the icon for the button, the panel heading and Accessibility links under Handrail › Settings › Look and placement: a person (the new default), a person in a circle, the handrail, sliders or an eye.
* On phones, the reading dock keeps its close button beside the title instead of below the quick settings.
* Reports: the Comments column gets more room.
* Checker: a group of problems is only marked "most likely" when every problem in it is a guess.

= 1.1.0 =
* New default panel style, the settings sheet: each tool is one row with a switch or a short list of choices. The tile grid is still available under Handrail › Settings › Look and placement.
* The floating button can be a tab on the side edge or at the bottom of the screen.
* A new Handrail icon (a handrail on two posts) and a new default color.
* Each tool has a one-line description.

= 1.0.0 =
* First release.
