Skip to content

Commit

Permalink
chore(website): replaced aXe with axe (case-sensitive branding) and u…
Browse files Browse the repository at this point in the history
…pdated references to Ace 1.2 beta ('next' release tag) which is now the latest official published NPM package.
  • Loading branch information
danielweck committed Apr 8, 2021
1 parent a54e934 commit b904626
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion website/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ theme = "daisy"
publishDir = "site"

[params]
description = "**[Ace](/ace)**, an accessibility checker for EPUB! A **[DAISY Consortium](http://daisy.org)** project. Latest version: v1.1.1 (and v1.2.0 'beta')"
description = "**[Ace](/ace)**, an accessibility checker for EPUB! A **[DAISY Consortium](http://daisy.org)** project. Latest version: v1.2"
2 changes: 1 addition & 1 deletion website/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ Ace, the Accessibility Checker for EPUB, is a tool developed by the [DAISY Conso

Read more about the Ace project on [Inclusive Publishing](http://inclusivepublishing.org/ace).

Latest version: v1.1.1 (and v1.2.0 'beta').
Latest version: v1.2

_Note: the Ace by DAISY "desktop application" (as known as the Ace App) is a software project based on the Ace core components. For more information, please [visit this page]({{<relref "getting-started/ace-app.md">}})._
2 changes: 1 addition & 1 deletion website/content/docs/report-html.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This table details each violation and provides information about:

* `Impact`: the severity of the violation
* `Ruleset`: the category that this rule is in
* `Rule`: identifier for the rule, as well as the underlying engine that checks for it (e.g. _aXe_ or _Ace_)
* `Rule`: identifier for the rule, as well as the underlying engine that checks for it (e.g. _axe_ or _Ace_)
* `Location`: where in the book the violation occurred, as well as an HTML code snippet of the relevant portion.
* `Details`: suggestions on how to fix the problem, as well as a link to the relevant topic page in our online knowledge base.

Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/report-json.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ An example of an assertion for an individual test is shown below. Note that it i
```
{
"@type": "earl:assertion",
"earl:assertedBy": "aXe",
"earl:assertedBy": "axe",
"earl:mode": "automatic",
"earl:test": {
"earl:impact": "critical",
Expand Down
2 changes: 1 addition & 1 deletion website/content/getting-started/why-ace.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Specifically, Ace:
- extracts other various content features to facilitate human-driven accessibility audits
- can be run as a command line tool, or integrated as a Javascript node module, or driven by an HTTP API

Under the hood, Ace currently runs [aXe](https://github.com/dequelabs/axe-core), an engine for automated testing of HTML developed by the good folks at Deque Systems.
Under the hood, Ace currently runs [axe](https://github.com/dequelabs/axe-core), an engine for automated testing of HTML developed by the good folks at Deque Systems.


## What Ace doesn’t do?
Expand Down
12 changes: 6 additions & 6 deletions website/content/rules/html.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ title = "HTML Rules"
weight = 1
+++

Under the hood, most of the accessibility checks ran by Ace are powered by [aXe](https://github.com/dequelabs/axe-core), an engine for automated testing of HTML. Ace uses aXe's rules, with some modifications (described [here](#modifications)).
Under the hood, most of the accessibility checks ran by Ace are powered by [Deque axe](https://github.com/dequelabs/axe-core), an engine for automated testing of HTML. Ace uses axe's rules, with some modifications (described [here](#modifications)).

## Rules

Here is a list of aXe's rules used by Ace, taken from [their documentation](https://github.com/dequelabs/axe-core/blob/v4.1.1/doc/rule-descriptions.md):
Here is a list of axe's rules used by Ace (see the full up to date documentation [in GitHub](https://github.com/daisy/axe-core/blob/v4.1.4_DAISY/doc/rule-descriptions.md) ):

| Rule ID | Description |
| :------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------ |
Expand Down Expand Up @@ -99,8 +99,8 @@ Developer note: regular expression replace all: `(\| .+? \| .+? \|) .+? \| .+? \

## Modifications

Certain aspects of HTML accessibility checking don't apply to EPUBs, so Ace has modified aXe's default ruleset slightly.
Certain aspects of HTML accessibility checking don't apply to EPUBs, so Ace has modified axe's default ruleset slightly.

* Ace disables aXe's `bypass`, `region`, `page-has-heading-one`, and `landmark-complementary-is-top-level` rules.
* Ace changes aXe's `landmark-one-main` rule to add the `page-no-duplicate-main` check (was `has-no-more-than-one-main`, see https://github.com/dequelabs/axe-core/blob/develop/CHANGELOG.md#300-2018-03-19 ).
* DAISY Axe fork: https://github.com/daisy/axe-core/pull/3
* Ace disables axe's `bypass`, `region`, `page-has-heading-one`, and `landmark-complementary-is-top-level` rules.
* Ace changes axe's `landmark-one-main` rule to add the `page-no-duplicate-main` check (was `has-no-more-than-one-main`, see https://github.com/dequelabs/axe-core/blob/develop/CHANGELOG.md#300-2018-03-19 ).
* DAISY Axe fork: https://github.com/daisy/axe-core/pull/4

0 comments on commit b904626

Please sign in to comment.