diff --git a/accessibility-checker-engine/README-RULES.md b/accessibility-checker-engine/README-RULES.md index 59e51c8f4..10db16334 100644 --- a/accessibility-checker-engine/README-RULES.md +++ b/accessibility-checker-engine/README-RULES.md @@ -76,10 +76,14 @@ Help integrates the following: * Element location * What to do * Examples -* About the requirement -* Who does this affects? +* About this requirement +* Who does this affect? -Mappings of the latest rules to the standards, the individual failure messages, and `links to the Help files` are listed in the published [Checker rule sets](https://www.ibm.com/able/requirements/checker-rule-sets). +### Rule sets and Mappings + +* Rule sets such as `IBM Accessibility v7.2`, `WCAG 2.2 (A & AA)`, etc. and mappings of the latest rules to the standards (Requirement and Rule IDs), the individual failure messages (by Reasons ID), and links to the Help files are listed in the published [Checker rule sets](https://www.ibm.com/able/requirements/checker-rule-sets) +* `npm run build:help` in the `.../accessibility-checker-engine` directory creates `dist/help/rules.html` that can be reviewed +* Each build creates the `Rules listing` artifact in **Actions** that can be reviewed prior to deployment. ## Test cases @@ -143,16 +147,16 @@ Note: Rule changes are not automatically rebuilt. You will have to kill the rule ## Summary of steps to implement/update and test a new rule -* Create a rule id for a new rule. +* Create a rule id for a new rule using the 3-word format with underscores: `type_property_test`. * Create the help file in [help-v4](help-v4). -* Create the rule implementation in [src/v4/rules](src/v4/rules). The rule implementation includes the rule context, message, help, ruleset mappings, logic and outcome. +* Create the rule implementation in [src/v4/rules](src/v4/rules). The rule implementation includes the rule context, message, help, ruleset mappings, logic, and outcome. * Create test cases for the rule in [test/v2/checker/accessibility/rules](test/v2/checker/accessibility/rules). * Test the rules with the test cases. You may run the test cases locally, or run with the local rule server. ## Feedback and reporting bugs -If you think you've found a bug, have questions or suggestions, open a [GitHub Issue](https://github.com/IBMa/equal-access/issues). If you are an IBM employee, feel free to ask questions in the IBM internal Slack channel `#accessibility-at-ibm`. +If you think you've found a bug or have questions or suggestions, open a [GitHub Issue](https://github.com/IBMa/equal-access/issues). If you are an IBM employee, feel free to ask questions in the IBM internal Slack channel `#accessibility-at-ibm`. ## License -[![IBM Equal Access Toolkit is released under the Apache-2.0 license](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](./LICENSE) \ No newline at end of file +[![IBM Equal Access Toolkit is released under the Apache-2.0 license](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](./LICENSE) diff --git a/accessibility-checker-engine/help-v4/en-US/element_mouseevent_keyboard.html b/accessibility-checker-engine/help-v4/en-US/element_mouseevent_keyboard.html index 116263a1c..104a553d3 100644 --- a/accessibility-checker-engine/help-v4/en-US/element_mouseevent_keyboard.html +++ b/accessibility-checker-engine/help-v4/en-US/element_mouseevent_keyboard.html @@ -55,13 +55,16 @@
* Using only the keyboard, make sure you can access all the functionality provided by the mouse event handlers. * **And**, if there is no equivalent keyboard access, follow the event handler table below to provide the corresponding keyboard event handlers: -| Use | with | -| :------------ | :------------ | -| onmousedown | onkeydown | -| onmouseup | onkeyup | -| onclick | onkeypress | -| onmouseover | onfocus | -| onmouseout | onblur | + + + +| Use | with | +| -------------- | ------------- | +| onmousedown | onkeydown | +| onmouseup | onkeyup | +| onclick | onkeypress | +| onmouseover | onfocus | +| onmouseout | onblur | @@ -74,12 +77,12 @@ ### About this requirement -* [IBM 2.1.1 Keyboard](https://www.ibm.com/able/requirements/requirements/#2_1_1)) -* [WCAG technique SCR20](https://www.w3.org/WAI/WCAG21/Techniques/client-side-script/SCR20) +* [IBM 2.1.1 Keyboard](https://www.ibm.com/able/requirements/requirements/#2_1_1) +* [WCAG technique SCR20: Using both keyboard and other device-specific functions](https://www.w3.org/WAI/WCAG21/Techniques/client-side-script/SCR20) ### Who does this affect? -* People using a screen reader, including blind, low vision and neurodivergent people +* People using a screen reader, including blind, low vision, and neurodivergent people * People with low vision * People with tremor or other movement disorders * People who rely on keyboard control diff --git a/accessibility-checker-engine/help-v4/en-US/target_spacing_sufficient.html b/accessibility-checker-engine/help-v4/en-US/target_spacing_sufficient.html new file mode 100644 index 000000000..cfd9071d5 --- /dev/null +++ b/accessibility-checker-engine/help-v4/en-US/target_spacing_sufficient.html @@ -0,0 +1,98 @@ + + + + + + + + + + + + + +