Skip to content

Commit f74b533

Browse files
WilcoFierskengdoj
andauthored
Update implementation pages for ACT implementor (#1803)
* Update implementation pages for ACT implementor * Apply suggestions from code review Co-authored-by: Kathy Eng <kengdoj@users.noreply.github.com> * Allow "impementor" spelling Co-authored-by: Kathy Eng <kengdoj@users.noreply.github.com>
1 parent 7d54794 commit f74b533

6 files changed

Lines changed: 19 additions & 74 deletions

File tree

__tests__/spelling-ignore.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,8 @@
207207
- autofill
208208
- dismissible
209209
- implementers
210+
- implementor
211+
- implementors
210212
- presentational
211213
- backtick
212214
- camelCase

pages/implementations/mapping.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,30 @@ title: Mapping To Rule
44

55
## Implementation Scoping
66

7-
An implementation does not need to be a one-to-one mapping to ACT-R rules. A single implementation can test multiple ACT-R. In manual test procedures, it is common to test multiple things at once. For instance, a test procedure looking at the language of a page will simultaneously test whether or not the `<html>` element has a `lang` attribute, if the value of the `lang` attribute is valid, and if the value matches the language of the page. These are 3 separate rules, covered in a single test procedure of an implementation.
7+
An implementation procedure does not need to be a one-to-one mapping to an ACT rule. A single implementation procedure can test multiple ACT rules. In manual test procedures, it is common to test multiple things at once. For instance, a procedure looking at the language of a page will simultaneously test whether or not the `<html>` element has a `lang` attribute, if the value of the `lang` attribute is valid, and if the value matches the language of the page. These are 3 separate rules, covered in a single test procedure of an implementation.
88

9-
<figure role="figure" aria-label="Single implementation, mapping to two ACT-R Rules">
10-
<figcaption>Single implementation, mapping to two ACT-R Rules</figcaption>
9+
<figure role="figure" aria-label="Single implementation, mapping to two ACT Rules">
10+
<figcaption>Single implementation, mapping to two ACT Rules</figcaption>
1111
<img src="./images/impl-large-scope.svg" alt="">
1212
</figure>
1313

14-
An tool or methodology can also have multiple implementations that when combined, map to a single ACT-R rule. It is common in automated test tools to split up certain rules, to build up more appropriate remediation advise. While ACT-R may have a single rule to test that all elements with the `img` role have an accessible name, an automated tool may implement testing `img` elements separate from `role="img"`, so that it gives different remediation advise for elements that can have an `alt` attribute, from elements that can't.
14+
An accessibility tool or methodology can also have multiple implementation procedures that when combined, map to a single ACT rule. It is common in automated test tools to split up certain rules to build up more appropriate remediation advice. For example there can be a single ACT rule to test that all elements with the `img` role have an accessible name. An automated tool may implement testing `img` elements separate from `role="img"`, so that remediation advice for elements that can have an `alt` attribute will differ from elements that can't.
1515

16-
<figure role="figure" aria-label="Single ACT-R rule, mapping to two implementation rules">
17-
<figcaption>Single ACT-R rule, mapping to two implementation rules</figcaption>
16+
<figure role="figure" aria-label="Single ACT rule, mapping to two implementation rules">
17+
<figcaption>Single ACT rule, mapping to two implementation rules</figcaption>
1818
<img src="./images/impl-small-scope.svg" alt="">
1919
</figure>
2020

2121
## Automated Mapping
2222

23-
The correctness of an implementation is based on the results from running the [test cases](../testcases/) in a tool or test procedure. The three types of test cases have a range of outcomes that are allowed:
23+
The correctness of an implementation procedure is based on the results from running the [test cases](../testcases/) in a tool or test procedure. The three types of test cases have a range of outcomes that are allowed:
2424

2525
| Test Case Type | Allowed outcomes |
2626
| -------------- | -------------------------------------- |
2727
| Passed | `passed`, `cantTell` or `inapplicable` |
2828
| Failed | `failed` or `cantTell` |
2929
| Inapplicable | `inapplicable`, `cantTell` or `passed` |
3030

31-
An implementation that returns one of the allowed outcomes for all test cases in an ACT-R rule is a _correct implementation_. An implementation that has all passed and inapplicable test cases correct, but only has some of the failed test cases correct is called a _partial implementation_. If a tool or methodology has partial implementations for an ACT-R rule that together get all failed test cases correct, this _set of implementations_ is considered a _correct implementation_.
31+
An implementation procedure that returns one of the allowed outcomes for all test cases in an ACT rule is a _correct implementation_. A procedure that has all passed and inapplicable test cases correct, but only has some of the failed test cases correct is called a _partial implementation_. If a tool or methodology has partial implementations for an ACT rule that together get all failed test cases correct, this _implementation procedure set_ is considered a _correct implementation_.
3232

33-
An implementations can be _automated_, _semi-automated_ or _manual_. This is based on the **[mode](https://www.w3.org/TR/EARL10-Schema/#mode)** of the test and whether or not any of the outcomes is `cantTell`. An implementation is _automated_ if the test mode is "[automatic](https://www.w3.org/TR/EARL10-Schema/#automatic)" and none of the outcomes are `cantTell`. An implementation is _manual_ if one or more of the mode is "[manual](https://www.w3.org/TR/EARL10-Schema/#manual)". In all other cases, the implementation is considered _semi-automated_. If the test mode is not provided in the results, the implementation's default will be assumed.
33+
An implementation procedure can be _automated_, _semi-automated_ or _manual_. This is based on the **[mode](https://www.w3.org/TR/EARL10-Schema/#mode)** of the test and whether or not any of the outcomes is `cantTell`. An implementation is _automated_ if the test mode is "[automatic](https://www.w3.org/TR/EARL10-Schema/#automatic)" and none of the outcomes are `cantTell`. An implementation is _manual_ if one or more of the mode is "[manual](https://www.w3.org/TR/EARL10-Schema/#manual)". In all other cases, the procedure is considered _semi-automated_. If the test mode is not provided in the results, the implementation's default will be assumed.

pages/implementations/overview.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,10 @@ title: ACT Implementations
66

77
ACT Rules can be implemented in automated test tools and test methodologies. Tools and methodologies based on the same set of rules will produce (largely) the same results. Each rule includes a number of test cases that are used to check if an implementation is correct. The ACT Rules Community keeps a list of implementations that are actively implementing ACT Rules. By comparing how many implementations rules have, we work out which rules are widely agreed upon, and which ones need further discussion.
88

9-
## Status Reports
10-
11-
The status of an ACT-R rule is dependent on how many implementations have adopted the rule. Once a sufficient number of implementations is reached, the ACT rule will be considered for submission for publication as a W3C note for WCAG.
12-
13-
| Status | Description |
14-
| ------------- | ---------------------------------------- |
15-
| `New` | The rule has no implementation |
16-
| `In Progress` | The rule has less than 3 implementations |
17-
| `Done` | The rule has 3 or more implementations |
18-
199
## Contribute An Implementation
2010

21-
If you developed an accessibility tool or a testing methodology, and would like to have your implementation included in the ACT-R website, there are two ways you can do so.
11+
If you developed an accessibility tool or a testing methodology, and would like to have your implementation included in the ACT-Rules website, there are two ways you can do so.
2212

2313
1. If you have a tool that can return a data format, you will need to run your tests against the [ACT-R test cases](../testcases/) and [submit a report](../reporting/).
2414

25-
2. If you have a manual test methodology, where you fill results into some report template or tool, you can [Use the WCAG-EM Report Tool](../wcag-em-tool/) instead to produce implementation reports.
15+
2. If you have a manual test methodology where you fill results into some report template or semi-automated tool, you can [use the ACT Implementor tool](https://act-implementor.netlify.app/#/) instead to produce implementation reports.

pages/implementations/testcases.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,6 @@ Correctness of an implementation is based on the results for test cases. See [im
5454

5555
If you developed an accessibility tool or a testing methodology, and would like to have your implementation included in the ACT-R website, there are two ways you can do so.
5656

57-
1. If you have a tool that can return a data format, you will need to run your tests against the ACT-R test cases and [submit a report](../reporting/).
57+
1. If you have a tool that can return a data format, you will need to run your tests against the ACT rule's test cases and [submit a report](../reporting/).
5858

59-
2. If you have a manual test methodology, where you fill results into some report template or tool, you can [Use the WCAG-EM Report Tool](../wcag-em-tool/) instead to produce implementation reports.
59+
2. If you have a manual test methodology where you fill results into some report template or semi-automated tool, you can [use the ACT Implementor tool](https://act-implementor.netlify.app/#/) instead to produce implementation reports.

pages/implementations/tools.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ title: Testing Tools
66

77
| Tool Name | Tool URL | Language | Tool Description |
88
| ------------ | ---------------------------------------------------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
9-
| `testrunner` | [https://github.com/auto-wcag/testrunner](https://github.com/auto-wcag/testrunner) | JavaScript | A [puppeteer](https://github.com/GoogleChrome/puppeteer) based implementation that allows running a configurable test tool against all the above test cases on a per page basis, and returns raw results. |
9+
| `testrunner` | [https://github.com/act-rules/testrunner](https://github.com/act-rules/testrunner) | JavaScript | A [puppeteer](https://github.com/GoogleChrome/puppeteer) based implementation that allows running a configurable test tool against all the above test cases on a per page basis, and returns raw results. |
1010

1111
## For creating reports
1212

13-
| Tool Name | Tool URL | | Tool Description |
14-
| --------------------- | ---------------------------------------------------------------------------------------- | --- | ------------------------------------------------------------------- |
15-
| `wcag-em-report-tool` | [https://www.w3.org/WAI/eval/report-tool/#/](https://www.w3.org/WAI/eval/report-tool/#/) | - | Interactive Guide to Assist Managing Web Accessibility Evaluations. |
13+
| Tool Name | Tool URL | | Tool Description |
14+
| ----------------- | ---------------------------------------------------------------------------- | --- | ----------------------------------------------------------- |
15+
| `ACT Implementor` | [https://act-implementor.netlify.app/](https://act-implementor.netlify.app/) | - | Web app for manually generating ACT implementation reports. |
1616

1717
> Note: Contributions to the above tools, and or other tooling of similar nature are welcome.

pages/implementations/wcag-em-tool.md

Lines changed: 0 additions & 47 deletions
This file was deleted.

0 commit comments

Comments
 (0)