-
+
Ace, an accessibility checker for EPUB! A DAISY Consortium project. Latest version: v1.3.2
diff --git a/categories/index.html b/categories/index.html index 5926a856..6025c523 100644 --- a/categories/index.html +++ b/categories/index.html @@ -13,12 +13,54 @@ gtag('js', new Date()); gtag('config', 'UA-327448-5'); + - + skip to content @@ -115,7 +157,7 @@
-
+
Categories on Ace, by DAISY
https://daisy.github.io/ace/categories/
Recent content in Categories on Ace, by DAISY
- Hugo -- gohugo.io
- en-us Hugo
+ en-us
+
Ace, an accessibility checker for EPUB! A DAISY Consortium project. Latest version: v1.3.2
diff --git a/categories/index.xml b/categories/index.xml index 845c489f..8277c15b 100644 --- a/categories/index.xml +++ b/categories/index.xml @@ -4,7 +4,8 @@
-
+
Ace, an accessibility checker for EPUB! A DAISY Consortium project. Latest version: v1.3.2
diff --git a/contributing/contributing/index.html b/contributing/contributing/index.html index 88883a0f..75dbfeb8 100644 --- a/contributing/contributing/index.html +++ b/contributing/contributing/index.html @@ -13,12 +13,54 @@ gtag('js', new Date()); gtag('config', 'UA-327448-5'); + - + skip to content @@ -115,7 +157,7 @@
-
+
Ace, an accessibility checker for EPUB! A DAISY Consortium project. Latest version: v1.3.2
diff --git a/contributing/index.html b/contributing/index.html index f649c2ef..7d29dffc 100644 --- a/contributing/index.html +++ b/contributing/index.html @@ -13,12 +13,54 @@ gtag('js', new Date()); gtag('config', 'UA-327448-5'); + - + skip to content @@ -115,7 +157,7 @@
-
+
Contributing on Ace, by DAISY
https://daisy.github.io/ace/contributing/
Recent content in Contributing on Ace, by DAISY
- Hugo -- gohugo.io
- en-us Hugo
+ en-us
+ -
How to contribute?
https://daisy.github.io/ace/contributing/contributing/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/contributing/contributing/
- First, welcome to Ace and thank you so much for being willing to contribute!
-Submitting an issue You can first check the issue tracker to see if someone already reported the issue. Don’t forget to included the closed issues in your search in case we fixed it already!
-If you can’t find any mention of your issue in our tracker, please file a new issue!
-When filing an issue, please provide the following details:
+ <p>First, welcome to Ace and thank you so much for being willing to contribute!</p>
<h2 id="submitting-an-issue">Submitting an issue</h2>
<p>You can first check the <a href="https://github.com/daisy/ace/issues">issue tracker</a> to see if someone already reported the issue. Don’t forget to included the closed issues in your search in case we fixed it already!</p>
<p>If you can’t find any mention of your issue in our tracker, please <a href="https://github.com/daisy/ace/issues/new">file a new issue</a>!</p>
<p>When filing an issue, please provide the following details:</p>
-
-
Code base overview
https://daisy.github.io/ace/contributing/code/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/contributing/code/
- Ace consists of the following packages:
- ace-cli: the command line interface ace-config: unifies the per-package configuration files into a global config file ace-core: the core checker’s logic, and the code responsible for running the underlying Web checker ace-core/scripts: the Javascript files injected in the headless browser to run Ace’s checks ace-http: the Http API ace-logger: logging ace-report and ace-report-axe: utils for building Ace’s reports epub-utils: utils for parsing EPUBs jest-env-puppeteer, jest-puppeteer, and puppeteer-utils: for working with the headless browser
+ <p>Ace consists of the following packages:</p>
<ul>
<li><strong>ace-cli</strong>: the command line interface</li>
<li><strong>ace-config</strong>: unifies the per-package configuration files into a global config file</li>
<li><strong>ace-core</strong>: the core checker’s logic, and the code responsible for running the underlying Web checker</li>
<li><strong>ace-core/scripts</strong>: the Javascript files injected in the headless browser to run Ace’s checks</li>
<li><strong>ace-http</strong>: the Http API</li>
<li><strong>ace-logger</strong>: logging</li>
<li><strong>ace-report</strong> and <strong>ace-report-axe</strong>: utils for building Ace’s reports</li>
<li><strong>epub-utils</strong>: utils for parsing EPUBs</li>
<li><strong>jest-env-puppeteer</strong>, <strong>jest-puppeteer</strong>, and <strong>puppeteer-utils</strong>: for working with the headless browser</li>
</ul>
-
-
Implementation notes
https://daisy.github.io/ace/contributing/notes/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/contributing/notes/
- HTML checker Under the hood, most of the HTML checks are powered by axe, an engine for automated testing of HTML from Deque Systems.
-Headless browser During the evaluation of an EPUB, Ace loads each HTML content document in a “headless” web browser window (i.e. invisible from the point of view of the user of the command line tool, but nonetheless using a real rendering engine). Ace was originally based on Puppeteer but it is now using Electron by default.
+ <h2 id="html-checker">HTML checker</h2>
<p>Under the hood, most of the HTML checks are powered by <a href="https://github.com/dequelabs/axe-core">axe</a>, an engine for automated testing of HTML from <a href="https://www.deque.com/">Deque Systems</a>.</p>
<h2 id="headless-browser">Headless browser</h2>
<p>During the evaluation of an EPUB, Ace loads each HTML content document in a “headless” web browser window (i.e. invisible from the point of view of the user of the command line tool, but nonetheless using a real rendering engine). Ace was originally based on <a href="https://github.com/GoogleChrome/puppeteer">Puppeteer</a> but it is now using <a href="https://github.com/electron/electron">Electron</a> by default. Electron and Puppeteer both use Chromium which is the open source component that powers various web browsers (including Google Chrome and Microsoft Edge). Both Ace (command line) and Ace App (Graphical User Interface) now rely on this Electron runtime to perform the accessibility checks, but the legacy Puppeteer method remains available via the command <code>ace-puppeteer</code> (similarly, the default Electron variant can also be explicitly invoked with <code>ace-electron</code> instead of <code>ace</code>).</p>
-
diff --git a/contributing/notes/index.html b/contributing/notes/index.html
index 230b5e2d..cde55693 100644
--- a/contributing/notes/index.html
+++ b/contributing/notes/index.html
@@ -13,12 +13,54 @@
gtag('js', new Date());
gtag('config', 'UA-327448-5');
+
-
+
skip to content
@@ -115,7 +157,7 @@
Ace, an accessibility checker for EPUB! A DAISY Consortium project. Latest version: v1.3.2
diff --git a/contributing/index.xml b/contributing/index.xml index 5380dcb4..bd4a1410 100644 --- a/contributing/index.xml +++ b/contributing/index.xml @@ -4,39 +4,29 @@
-
+
Ace, an accessibility checker for EPUB! A DAISY Consortium project. Latest version: v1.3.2
diff --git a/docs/cli/index.html b/docs/cli/index.html index 70573a3a..c517ff79 100644 --- a/docs/cli/index.html +++ b/docs/cli/index.html @@ -13,12 +13,54 @@ gtag('js', new Date()); gtag('config', 'UA-327448-5'); + - + skip to content @@ -115,7 +157,7 @@
-
+
Ace, an accessibility checker for EPUB! A DAISY Consortium project. Latest version: v1.3.2
@@ -454,9 +496,9 @@Overview
info: - xhtml/out-of-spine-content.xhtml: 2 issues found info: Consolidating results... { - "@type": "earl:report", - "@context": "http://daisy.github.io/ace/ace-report-1.0.jsonld", - "dct:title": "Ace Report", + "@type": "earl:report", + "@context": "http://daisy.github.io/ace/ace-report-1.0.jsonld", + "dct:title": "Ace Report", ... } info: Done @@ -486,9 +528,12 @@help
-V, --verbose display verbose output -s, --silent do not display any output - -l, --lang <language> language code for localized messages (e.g. "fr"), default is "en" + -l, --lang <language> language code for localized messages (e.g. "fr"), default is "en" Examples $ ace -o out ~/Documents/book.epub + +If you find DAISY Ace useful, please help us by donating to support its ongoing maintenance. +Support our work https://daisy.org/AceCLSponsorversion
Displays the version of Ace and exits.
Syntax: --version or -v
verbose
info: Processing ../epub-a11y-checker/samples/build/epub-a11y-tests-001.epub verbose: Extracting EPUB info: Parsing EPUB -verbose: at location '/var/folders/x0/tvbr6tz54js_7q7gvg9s2g240000gn/T/tmp-55388YEqs0mEKHq3x' +verbose: at location '/var/folders/x0/tvbr6tz54js_7q7gvg9s2g240000gn/T/tmp-55388YEqs0mEKHq3x' info: Analyzing accessibility metadataNote that running Ace with --verbose enabled also creates verbose output in the log file.
silent
diff --git a/docs/config/index.html b/docs/config/index.html index 241c76dc..b588214e 100644 --- a/docs/config/index.html +++ b/docs/config/index.html @@ -13,12 +13,54 @@ gtag('js', new Date()); gtag('config', 'UA-327448-5'); + - + skip to content @@ -115,7 +157,7 @@
-
+
Ace, an accessibility checker for EPUB! A DAISY Consortium project. Latest version: v1.3.2
@@ -428,26 +470,26 @@Overview
Defaults
The defaults for Ace configuration are:
-{
- "cli": {
- "return-2-on-validation-error": false
- },
- "logging": {
- "fileName": "ace.log",
- "level": "info"
- },
- "output": {
- "force": false,
- "subdir": false
- },
- "report": {
- "use-relative-paths": true
- },
- "runtime": {
- "concurrencyLevel": 4
- }
-}
-Reference
+{
+ "cli": {
+ "return-2-on-validation-error": false
+ },
+ "logging": {
+ "fileName": "ace.log",
+ "level": "info"
+ },
+ "output": {
+ "force": false,
+ "subdir": false
+ },
+ "report": {
+ "use-relative-paths": true
+ },
+ "runtime": {
+ "concurrencyLevel": 4
+ }
+}
+Reference
cli.return-2-on-validation-error
Default: “false”
Indicates whether the CLI should return with the error code 2 if any violations were found in the input publication.
-
+
Ace, an accessibility checker for EPUB! A DAISY Consortium project. Latest version: v1.3.2
@@ -437,13 +479,13 @@Starting the server
-h, --help output usage information -v, --version output the version number - -H, --host set the server's hostname (default: localhost) - -p, --port set the server's port (default: 8000) + -H, --host set the server's hostname (default: localhost) + -p, --port set the server's port (default: 8000) -V, --verbose display verbose output -s, --silent do not display any output - -l, --lang <language> language code for localized messages (e.g. "fr"), default is "en" + -l, --lang <language> language code for localized messages (e.g. "fr"), default is "en" Examples $ ace-http -p 3000API
@@ -463,25 +505,25 @@Job status codes
Job information
This is returned by calling GET /job/:jobid/ with the ID of a job.
{
- job: URL for the job information
- status: A job status code
- report: {
- zip: URL for the zipped report,
- json: URL for the json report
- }
- }
-Examples
+ {
+ job: URL for the job information
+ status: A job status code
+ report: {
+ zip: URL for the zipped report,
+ json: URL for the json report
+ }
+ }
+Examples
Submit a job
-~ ❯❯❯ curl --form "epub=@/Users/marisa/dev/epub-a11y-checker/samples/build/epub-a11y-tests-001.epub" http://localhost:8000/jobs/
+~ ❯❯❯ curl --form "epub=@/Users/marisa/dev/epub-a11y-checker/samples/build/epub-a11y-tests-001.epub" http://localhost:8000/jobs/
-{"job":"http://localhost:8000/jobs/38fb458a-37a2-4e5c-874c-5cf387bf86c1","status":1,"report":{}}%
+{"job":"http://localhost:8000/jobs/38fb458a-37a2-4e5c-874c-5cf387bf86c1","status":1,"report":{}}%
Check job status
~ ❯❯❯ curl http://localhost:8000/jobs/38fb458a-37a2-4e5c-874c-5cf387bf86c1
-{"job":"http://localhost:8000/jobs/38fb458a-37a2-4e5c-874c-5cf387bf86c1","status":0,"report":{"zip":"http://localhost:8000/jobs/38fb458a-37a2-4e5c-874c-5cf387bf86c1/report/?type=zip","json":"http://localhost:8000/jobs/38fb458a-37a2-4e5c-874c-5cf387bf86c1/report/?type=json"}}%
+{"job":"http://localhost:8000/jobs/38fb458a-37a2-4e5c-874c-5cf387bf86c1","status":0,"report":{"zip":"http://localhost:8000/jobs/38fb458a-37a2-4e5c-874c-5cf387bf86c1/report/?type=zip","json":"http://localhost:8000/jobs/38fb458a-37a2-4e5c-874c-5cf387bf86c1/report/?type=json"}}%
Get the report
-~ ❯❯❯ curl 'http://localhost:8000/jobs/38fb458a-37a2-4e5c-874c-5cf387bf86c1/report/?type=zip' -o ~/out.zip
+~ ❯❯❯ curl 'http://localhost:8000/jobs/38fb458a-37a2-4e5c-874c-5cf387bf86c1/report/?type=zip' -o ~/out.zip
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
@@ -493,17 +535,17 @@ Submit a job
inflating: ace-report-38fb458a-37a2-4e5c-874c-5cf387bf86c1/report.html
inflating: ace-report-38fb458a-37a2-4e5c-874c-5cf387bf86c1/report.json
Get only the JSON report
-~ ❯❯❯ curl 'http://localhost:8000/jobs/38fb458a-37a2-4e5c-874c-5cf387bf86c1/report/?type=json' -o ~/out.json
+~ ❯❯❯ curl 'http://localhost:8000/jobs/38fb458a-37a2-4e5c-874c-5cf387bf86c1/report/?type=json' -o ~/out.json
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 24972 100 24972 0 0 3482k 0 --:--:-- --:--:-- --:--:-- 4064k
~ ❯❯❯ tail ~/out.json
-{"@type":"earl:report","@context":"http://daisy.github.io/ace/ace-report-1.0.jsonld","dct:title":"Ace Report",
+{"@type":"earl:report","@context":"http://daisy.github.io/ace/ace-report-1.0.jsonld","dct:title":"Ace Report",
...
List all the jobs
(after having added several jobs)
~ ❯❯❯ curl http://localhost:8000/jobs/
-[{"job":"http://localhost:8000/jobs/8198e049-2e81-4be8-b889-ace01978dabc","status":-1,"report":{}},{"job":"http://localhost:8000/jobs/38fb458a-37a2-4e5c-874c-5cf387bf86c1","status":0,"report":{"zip":"http://localhost:8000/jobs/38fb458a-37a2-4e5c-874c-5cf387bf86c1/report/?type=zip","json":"http://localhost:8000/jobs/38fb458a-37a2-4e5c-874c-5cf387bf86c1/report/?type=json"}},{"job":"http://localhost:8000/jobs/107df1e7-deff-436f-811e-2a8473b20237","status":0,"report":{"zip":"http://localhost:8000/jobs/107df1e7-deff-436f-811e-2a8473b20237/report/?type=zip","json":"http://localhost:8000/jobs/107df1e7-deff-436f-811e-2a8473b20237/report/?type=json"}},{"job":"http://localhost:8000/jobs/d62bb7c7-4eea-4f0b-bd73-b45f28630ebe","status":0,"report":{"zip":"http://localhost:8000/jobs/d62bb7c7-4eea-4f0b-bd73-b45f28630ebe/report/?type=zip","json":"http://localhost:8000/jobs/d62bb7c7-4eea-4f0b-bd73-b45f28630ebe/report/?type=json"}},{"job":"http://localhost:8000/jobs/4363a917-c422-486f-98c0-bd98cc423fc0","status":0,"report":{"zip":"http://localhost:8000/jobs/4363a917-c422-486f-98c0-bd98cc423fc0/report/?type=zip","json":"http://localhost:8000/jobs/4363a917-c422-486f-98c0-bd98cc423fc0/report/?type=json"}}]%
+[{"job":"http://localhost:8000/jobs/8198e049-2e81-4be8-b889-ace01978dabc","status":-1,"report":{}},{"job":"http://localhost:8000/jobs/38fb458a-37a2-4e5c-874c-5cf387bf86c1","status":0,"report":{"zip":"http://localhost:8000/jobs/38fb458a-37a2-4e5c-874c-5cf387bf86c1/report/?type=zip","json":"http://localhost:8000/jobs/38fb458a-37a2-4e5c-874c-5cf387bf86c1/report/?type=json"}},{"job":"http://localhost:8000/jobs/107df1e7-deff-436f-811e-2a8473b20237","status":0,"report":{"zip":"http://localhost:8000/jobs/107df1e7-deff-436f-811e-2a8473b20237/report/?type=zip","json":"http://localhost:8000/jobs/107df1e7-deff-436f-811e-2a8473b20237/report/?type=json"}},{"job":"http://localhost:8000/jobs/d62bb7c7-4eea-4f0b-bd73-b45f28630ebe","status":0,"report":{"zip":"http://localhost:8000/jobs/d62bb7c7-4eea-4f0b-bd73-b45f28630ebe/report/?type=zip","json":"http://localhost:8000/jobs/d62bb7c7-4eea-4f0b-bd73-b45f28630ebe/report/?type=json"}},{"job":"http://localhost:8000/jobs/4363a917-c422-486f-98c0-bd98cc423fc0","status":0,"report":{"zip":"http://localhost:8000/jobs/4363a917-c422-486f-98c0-bd98cc423fc0/report/?type=zip","json":"http://localhost:8000/jobs/4363a917-c422-486f-98c0-bd98cc423fc0/report/?type=json"}}]%
diff --git a/docs/index.html b/docs/index.html
index 548ae3f2..8de50998 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -13,12 +13,54 @@
gtag('js', new Date());
gtag('config', 'UA-327448-5');
+
-
+
skip to content
@@ -115,7 +157,7 @@
-
+
Ace, an accessibility checker for EPUB! A DAISY Consortium project. Latest version: v1.3.2
diff --git a/docs/index.xml b/docs/index.xml
index 01ec0754..1f3e64cb 100644
--- a/docs/index.xml
+++ b/docs/index.xml
@@ -4,74 +4,50 @@
Reference on Ace, by DAISY
https://daisy.github.io/ace/docs/
Recent content in Reference on Ace, by DAISY
- Hugo -- gohugo.io
- en-us Hugo
+ en-us
+ -
Command line interface
https://daisy.github.io/ace/docs/cli/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/docs/cli/
- Overview The easiest way to run Ace is to type this on the command line:
-$ ace ~/Documents/book.epub You’ll then see a description of Ace’s actions as it runs tests on the book. The JSON report is printed to the command line at the end (nothing is saved to disk; you need to specify --outdir for that).
-Example:
-info: Processing ../epub-a11y-checker/samples/build/epub-a11y-tests-001.epub info: Parsing EPUB info: Analyzing accessibility metadata info: Checking package.
+ <h2 id="overview">Overview</h2>
<p>The easiest way to run Ace is to type this on the command line:</p>
<pre tabindex="0"><code>$ ace ~/Documents/book.epub
</code></pre><p>You’ll then see a description of Ace’s actions as it runs tests on the book. The JSON report is printed to the command line at the end (nothing is saved to disk; you need to specify <a href="#outdir"><code>--outdir</code></a> for that).</p>
<p>Example:</p>
<pre tabindex="0"><code>info: Processing ../epub-a11y-checker/samples/build/epub-a11y-tests-001.epub
info: Parsing EPUB
info: Analyzing accessibility metadata
info: Checking package...
info: - EPUB/package.opf: 4 issues found
info: Checking documents...
info: - xhtml/front.xhtml: No issues found
info: - xhtml/nav.xhtml: 2 issues found
info: - xhtml/table-structure.xhtml: 2 issues found
info: - xhtml/image-desc.xhtml: 4 issues found
info: - xhtml/heading-order-01.xhtml: No issues found
info: - xhtml/heading-order-02.xhtml: No issues found
info: - xhtml/heading-order-03.xhtml: No issues found
info: - xhtml/color-contrast.xhtml: 2 issues found
info: - xhtml/epub-type-and-aria.xhtml: 5 issues found
info: - xhtml/out-of-spine-content.xhtml: 2 issues found
info: Consolidating results...
{
"@type": "earl:report",
"@context": "http://daisy.github.io/ace/ace-report-1.0.jsonld",
"dct:title": "Ace Report",
...
}
info: Done
</code></pre><p>Ace will exit with a return code of <code>0</code> when complete, or <code>1</code> if there was an error that prevented Ace from successfully executing. Note that these return codes do not indicate whether there were violations in the publication; for that, you need to first edit Ace’s <a href="https://daisy.github.io/ace/docs/config/">configuration</a>.</p>
-
-
HTML Report
https://daisy.github.io/ace/docs/report-html/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/docs/report-html/
- Ace outputs a human-readable report in HTML format, containing information about which automated tests failed, as well as extracted data visualizations, to highlight potential problem areas and to assist in manual checking.
-Note that the report looks best with javascript enabled, though it’s not required.
-After the header, which contains the Ace version, report date, and publication title, there are four sections, detailed below.
-Violations Summary of Violations This table lists statistics for the violations, in terms of severity: Critical, Serious, Moderate, or Minor; and by ruleset category: WCAG 2.
+ <p>Ace outputs a human-readable report in HTML format, containing information about which automated tests failed, as well as extracted data visualizations, to highlight potential problem areas and to assist in manual checking.</p>
<p>Note that the report looks best with javascript enabled, though it’s not required.</p>
<p>After the header, which contains the Ace version, report date, and publication title, there are four sections, detailed below.</p>
<h2 id="violations">Violations</h2>
<h3 id="summary-of-violations">Summary of Violations</h3>
<p>This table lists statistics for the violations, in terms of severity: Critical, Serious, Moderate, or Minor; and by ruleset category: WCAG 2.0 A, WCAG 2.0 AA, EPUB, Best Practice, or Other. It’s useful for getting a quick overview of the violations.</p>
-
-
JSON Report
https://daisy.github.io/ace/docs/report-json/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/docs/report-json/
- Ace’s outputs a machine-readable report in JSON format, detailing the automated tests. The vocabulary of this report is a mix of EARL (Evaluation and Reporting Language), Dublin Core, and custom terms.
-Document structure Each example piece of the report shown below appears in order, in one JSON file.
- Header information Outlines Data Properties earl:testSubject for this EPUB file Accessibility metadata summary Assertions Header information This gives basic information about Ace and when the report was created.
+ <p>Ace’s outputs a machine-readable report in JSON format, detailing the automated tests. The vocabulary of this report is a mix of <a href="https://www.w3.org/TR/EARL10-Schema/">EARL</a> (Evaluation and Reporting Language), Dublin Core, and custom terms.</p>
<h2 id="document-structure">Document structure</h2>
<p>Each example piece of the report shown below appears in order, in one JSON file.</p>
<ul>
<li><a href="#header-information">Header information</a></li>
<li><a href="#outlines">Outlines</a></li>
<li><a href="#data">Data</a></li>
<li><a href="#properties">Properties</a></li>
<li><a href="#earltestsubject-for-this-epub-file">earl:testSubject for this EPUB file</a></li>
<li><a href="#accessibility-metadata-summary">Accessibility metadata summary</a></li>
<li><a href="#assertions">Assertions</a></li>
</ul>
<h3 id="header-information">Header information</h3>
<p>This gives basic information about Ace and when the report was created.</p>
-
-
Configuration
https://daisy.github.io/ace/docs/config/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/docs/config/
- Overview Ace can be configured through a config.json file located in an OS-specific directory:
- on Windows in "%HOME%\AppData\Local\DAISY Ace\Config\" on macOS in "~/Library/Preferences/DAISY\ Ace/" on Linux in "~/.config/DAISY Ace/" Defaults The defaults for Ace configuration are:
-{ "cli": { "return-2-on-validation-error": false }, "logging": { "fileName": "ace.log", "level": "info" }, "output": { "force": false, "subdir": false }, "report": { "use-relative-paths": true }, "runtime": { "concurrencyLevel": 4 } } Reference cli.
+ <h2 id="overview">Overview</h2>
<p>Ace can be configured through a <code>config.json</code> file located in an OS-specific directory:</p>
<ul>
<li>on Windows in <code>"%HOME%\AppData\Local\DAISY Ace\Config\"</code></li>
<li>on macOS in <code>"~/Library/Preferences/DAISY\ Ace/"</code></li>
<li>on Linux in <code>"~/.config/DAISY Ace/"</code></li>
</ul>
<h2 id="defaults">Defaults</h2>
<p>The defaults for Ace configuration are:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span> <span style="color:#f92672">"cli"</span>: {
</span></span><span style="display:flex;"><span> <span style="color:#f92672">"return-2-on-validation-error"</span>: <span style="color:#66d9ef">false</span>
</span></span><span style="display:flex;"><span> },
</span></span><span style="display:flex;"><span> <span style="color:#f92672">"logging"</span>: {
</span></span><span style="display:flex;"><span> <span style="color:#f92672">"fileName"</span>: <span style="color:#e6db74">"ace.log"</span>,
</span></span><span style="display:flex;"><span> <span style="color:#f92672">"level"</span>: <span style="color:#e6db74">"info"</span>
</span></span><span style="display:flex;"><span> },
</span></span><span style="display:flex;"><span> <span style="color:#f92672">"output"</span>: {
</span></span><span style="display:flex;"><span> <span style="color:#f92672">"force"</span>: <span style="color:#66d9ef">false</span>,
</span></span><span style="display:flex;"><span> <span style="color:#f92672">"subdir"</span>: <span style="color:#66d9ef">false</span>
</span></span><span style="display:flex;"><span> },
</span></span><span style="display:flex;"><span> <span style="color:#f92672">"report"</span>: {
</span></span><span style="display:flex;"><span> <span style="color:#f92672">"use-relative-paths"</span>: <span style="color:#66d9ef">true</span>
</span></span><span style="display:flex;"><span> },
</span></span><span style="display:flex;"><span> <span style="color:#f92672">"runtime"</span>: {
</span></span><span style="display:flex;"><span> <span style="color:#f92672">"concurrencyLevel"</span>: <span style="color:#ae81ff">4</span>
</span></span><span style="display:flex;"><span> }
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><h2 id="reference">Reference</h2>
<h3 id="clireturn-2-on-validation-error"><code>cli.return-2-on-validation-error</code></h3>
<p>Default: “<code>false</code>”</p>
<p>Indicates whether the CLI should return with the error code <code>2</code> if any violations were found in the input publication.</p>
-
-
Logging
https://daisy.github.io/ace/docs/logging/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/docs/logging/
- Overview Ace prints a log of messages in a ace.log file located in an OS-specific directory:
- on Windows in "%HOME%\AppData\Local\DAISY Ace\Log\" on macOS in "~/Library/Logs/DAISY\ Ace/" on Linux in "~/.local/state/DAISY Ace/" Configuration The logging level and the name of the log file can be configured through Ace’s config file. Read more on Ace configuration to know more.
+ <h2 id="overview">Overview</h2>
<p>Ace prints a log of messages in a <code>ace.log</code> file located in an OS-specific directory:</p>
<ul>
<li>on Windows in <code>"%HOME%\AppData\Local\DAISY Ace\Log\"</code></li>
<li>on macOS in <code>"~/Library/Logs/DAISY\ Ace/"</code></li>
<li>on Linux in <code>"~/.local/state/DAISY Ace/"</code></li>
</ul>
<h2 id="configuration">Configuration</h2>
<p>The logging level and the name of the log file can be configured through Ace’s config file. Read more on <a href="https://daisy.github.io/ace/docs/config/">Ace configuration</a> to know more.</p>
-
-
Http API
https://daisy.github.io/ace/docs/http-api/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/docs/http-api/
- Starting the server After installing Ace, run the ace-http command from the terminal:
-$ ace-http info: [ace-http] server listening on http://localhost:8000 The command line options are printed when you run ace-http --help:
-Ace by DAISY, an Accessibility Checker for EPUB Usage: ace-http [options] Options: -h, --help output usage information -v, --version output the version number -H, --host set the server's hostname (default: localhost) -p, --port set the server's port (default: 8000) -V, --verbose display verbose output -s, --silent do not display any output -l, --lang <language> language code for localized messages (e.
+ <h2 id="starting-the-server">Starting the server</h2>
<p>After <a href="https://daisy.github.io/ace/ace/getting-started/installation/">installing Ace</a>, run the <code>ace-http</code> command from the terminal:</p>
<pre tabindex="0"><code>$ ace-http
info: [ace-http] server listening on http://localhost:8000
</code></pre><p>The command line options are printed when you run <code>ace-http --help</code>:</p>
<pre tabindex="0"><code>Ace by DAISY, an Accessibility Checker for EPUB
Usage: ace-http [options]
Options:
-h, --help output usage information
-v, --version output the version number
-H, --host set the server's hostname (default: localhost)
-p, --port set the server's port (default: 8000)
-V, --verbose display verbose output
-s, --silent do not display any output
-l, --lang <language> language code for localized messages (e.g. "fr"), default is "en"
Examples
$ ace-http -p 3000
</code></pre><h2 id="api">API</h2>
<p>This API is available to client applications.</p>
-
diff --git a/docs/logging/index.html b/docs/logging/index.html
index b67a28e1..bdf5de5c 100644
--- a/docs/logging/index.html
+++ b/docs/logging/index.html
@@ -13,12 +13,54 @@
gtag('js', new Date());
gtag('config', 'UA-327448-5');
+
-
+
skip to content
@@ -115,7 +157,7 @@
-
+
Ace, an accessibility checker for EPUB! A DAISY Consortium project. Latest version: v1.3.2
diff --git a/docs/report-html/index.html b/docs/report-html/index.html
index 958f9eb4..841b9da5 100644
--- a/docs/report-html/index.html
+++ b/docs/report-html/index.html
@@ -13,12 +13,54 @@
gtag('js', new Date());
gtag('config', 'UA-327448-5');
+
-
+
skip to content
@@ -115,7 +157,7 @@
-
+
Ace, an accessibility checker for EPUB! A DAISY Consortium project. Latest version: v1.3.2
diff --git a/docs/report-json/index.html b/docs/report-json/index.html
index b93f382a..cda5f092 100644
--- a/docs/report-json/index.html
+++ b/docs/report-json/index.html
@@ -13,12 +13,54 @@
gtag('js', new Date());
gtag('config', 'UA-327448-5');
+
-
+
skip to content
@@ -115,7 +157,7 @@
-
+
Ace, an accessibility checker for EPUB! A DAISY Consortium project. Latest version: v1.3.2
@@ -450,93 +492,93 @@ Document structure
Header information
This gives basic information about Ace and when the report was created.
{
- "@type": "earl:report",
- "@context": "http://daisy.github.io/ace/ace-report-1.0.jsonld",
- "dct:title": "Ace Report",
- "dct:description": "Report on automated accessibility checks for EPUB",
- "dct:date": "1/26/2018, 4:29:25 PM",
- "earl:assertedBy": {
- "@type": "earl:software",
- "doap:name": "DAISY Ace",
- "doap:description": "DAISY Accessibility Checker for EPUB",
- "doap:homepage": "http://ace.daisy.org",
- "doap:created": "2017-07-01",
- "doap:release": {
- "doap:revision": "1.0.0"
+ "@type": "earl:report",
+ "@context": "http://daisy.github.io/ace/ace-report-1.0.jsonld",
+ "dct:title": "Ace Report",
+ "dct:description": "Report on automated accessibility checks for EPUB",
+ "dct:date": "1/26/2018, 4:29:25 PM",
+ "earl:assertedBy": {
+ "@type": "earl:software",
+ "doap:name": "DAISY Ace",
+ "doap:description": "DAISY Accessibility Checker for EPUB",
+ "doap:homepage": "http://ace.daisy.org",
+ "doap:created": "2017-07-01",
+ "doap:release": {
+ "doap:revision": "1.0.0"
}
},
Outlines
This is the structural data that Ace extracts.
- "outlines": {
- "toc": // HTML fragment representing an extracted view of the table of contents
+ "outlines": {
+ "toc": // HTML fragment representing an extracted view of the table of contents
,
- "headings": // HTML fragment representing an extracted view of the headings
+ "headings": // HTML fragment representing an extracted view of the headings
,
- "html": // outline view of heading and sectioning content
+ "html": // outline view of heading and sectioning content
},
Data
The fields under data contain extracted images, audios, canvases, embeds, epub-triggers, epub-switches, iframes, maps, scripts, and videos. The example here shows information about the publication’s images and iframes:
- "data": {
- "images": [
+ "data": {
+ "images": [
{
- "src": "EPUB/images/daisy.png",
- "alt": "DAISY Consortium",
- "role": "presentation",
- "html": "<img xmlns=\"http://www.w3.org/1999/xhtml\" src=\"../images/daisy.png\" alt=\"DAISY Consortium\" role=\"presentation\" />",
- "location": "xhtml/image-desc.xhtml#epubcfi(/4/18/4/2)"
+ "src": "EPUB/images/daisy.png",
+ "alt": "DAISY Consortium",
+ "role": "presentation",
+ "html": "<img xmlns=\"http://www.w3.org/1999/xhtml\" src=\"../images/daisy.png\" alt=\"DAISY Consortium\" role=\"presentation\" />",
+ "location": "xhtml/image-desc.xhtml#epubcfi(/4/18/4/2)"
},
...
],
- "iframes": [
+ "iframes": [
{
- "src": "EPUB/xhtml/out-of-spine-content-embed-01.xhtml",
- "location": "xhtml/out-of-spine-content.xhtml#epubcfi(/4/6/6)"
+ "src": "EPUB/xhtml/out-of-spine-content-embed-01.xhtml",
+ "location": "xhtml/out-of-spine-content.xhtml#epubcfi(/4/6/6)"
},
...
]
},
Properties
These publication-wide properties describe different aspects of the EPUB as being present or absent.
- "properties": {
- "hasManifestFallbacks": false,
- "hasBindings": false,
- "hasSVGContentDocuments": false,
- "hasFormElements": false,
- "hasMathML": false,
- "hasPageBreaks": false
+ "properties": {
+ "hasManifestFallbacks": false,
+ "hasBindings": false,
+ "hasSVGContentDocuments": false,
+ "hasFormElements": false,
+ "hasMathML": false,
+ "hasPageBreaks": false
},
earl:testSubject for this EPUB file
This formally states that the test subject of this report is the given publication, and includes some basic metadata.
-"earl:testSubject": {
- "url": "../epub-a11y-checker/samples/build/epub-a11y-tests-001.epub",
- "metadata": {
- "dc:identifier": "com.github.epub-a11y-checker.epub-a11y-tests-001",
- "dc:description": "Samples for EPUB Accessibility Testing",
- "dc:title": "EPUB-A11Y-TESTS-001",
- "dc:creator": [
- "Marisa DeMeglio",
- "Romain Deltour"
+"earl:testSubject": {
+ "url": "../epub-a11y-checker/samples/build/epub-a11y-tests-001.epub",
+ "metadata": {
+ "dc:identifier": "com.github.epub-a11y-checker.epub-a11y-tests-001",
+ "dc:description": "Samples for EPUB Accessibility Testing",
+ "dc:title": "EPUB-A11Y-TESTS-001",
+ "dc:creator": [
+ "Marisa DeMeglio",
+ "Romain Deltour"
],
- "dc:language": "en",
- "dcterms:modified": "2017-02-21T13:00:00Z"
+ "dc:language": "en",
+ "dcterms:modified": "2017-02-21T13:00:00Z"
},
- "links": {}
+ "links": {}
},
Accessibility metadata summary
The accessibility metadata properties are organized by whether they are missing, empty (blank), or present in the publication.
- "a11y-metadata": {
- "missing": [
- "schema:accessMode",
- "schema:accessibilityFeature",
- "schema:accessibilityHazard",
- "schema:accessibilitySummary",
- "schema:accessModeSufficient",
- "a11y:certifiedBy"
+ "a11y-metadata": {
+ "missing": [
+ "schema:accessMode",
+ "schema:accessibilityFeature",
+ "schema:accessibilityHazard",
+ "schema:accessibilitySummary",
+ "schema:accessModeSufficient",
+ "a11y:certifiedBy"
],
- "empty": [],
- "present": [
- "schema:accessibilityAPI",
- "schema:accessibilityControl"
+ "empty": [],
+ "present": [
+ "schema:accessibilityAPI",
+ "schema:accessibilityControl"
]
},
Assertions
@@ -544,45 +586,45 @@ Header information
Document-level assertions
An assertion for a document looks like this. A document may be a package document, content document, or the whole EPUB itself. Note that in this example, earl:testSubject points to the package document, and earl:result does not include a pointer to a location within the document (as individual test assertions do), because this assertion is for the entire document.
{
- "@type": "earl:assertion",
- "assertions": [
+ "@type": "earl:assertion",
+ "assertions": [
// list of assertions for tests
...
],
- "earl:testSubject": {
- "url": "EPUB/package.opf",
- "dct:title": "EPUB-A11Y-TESTS-001"
+ "earl:testSubject": {
+ "url": "EPUB/package.opf",
+ "dct:title": "EPUB-A11Y-TESTS-001"
},
- "earl:result": {
- "earl:outcome": "fail"
+ "earl:result": {
+ "earl:outcome": "fail"
}
}
Where earl:outcome is based on the results for the individual tests. If any test failed, then the document is given a fail outcome. The earl:result property belongs to its parent earl:assertion and is relevant to that assertion’s earl:testSubject.
Test-level assertions
An example of an assertion for an individual test is shown below. Note that it includes a location reference, a test description, and suggestions for remedying the issue (including a link to the relevant section of the Accessible Publishing Knowledge Base).
{
- "@type": "earl:assertion",
- "earl:assertedBy": "axe",
- "earl:mode": "automatic",
- "earl:test": {
- "earl:impact": "critical",
- "dct:title": "aria-roles",
- "dct:description": "Ensures all elements with a role attribute use a valid value",
- "help": {
- "url": "http://kb.daisy.org/publishing/docs/script/aria.html",
- "dct:title": "ARIA",
- "dct:description": "ARIA roles used must conform to valid values"
+ "@type": "earl:assertion",
+ "earl:assertedBy": "axe",
+ "earl:mode": "automatic",
+ "earl:test": {
+ "earl:impact": "critical",
+ "dct:title": "aria-roles",
+ "dct:description": "Ensures all elements with a role attribute use a valid value",
+ "help": {
+ "url": "http://kb.daisy.org/publishing/docs/script/aria.html",
+ "dct:title": "ARIA",
+ "dct:description": "ARIA roles used must conform to valid values"
}
},
- "earl:result": {
- "earl:outcome": "fail",
- "dct:description": "Role must be one of the valid ARIA roles",
- "earl:pointer": {
- "cfi": [
- "/4/16/4/2"
+ "earl:result": {
+ "earl:outcome": "fail",
+ "dct:description": "Role must be one of the valid ARIA roles",
+ "earl:pointer": {
+ "cfi": [
+ "/4/16/4/2"
],
- "css": [
- "p > img[role=\"none\\ presentation\"]"
+ "css": [
+ "p > img[role=\"none\\ presentation\"]"
]
}
}
diff --git a/getting-started/ace-app/index.html b/getting-started/ace-app/index.html
index a7d77524..f7b5989e 100644
--- a/getting-started/ace-app/index.html
+++ b/getting-started/ace-app/index.html
@@ -13,12 +13,54 @@
gtag('js', new Date());
gtag('config', 'UA-327448-5');
+
-
+
skip to content
@@ -115,7 +157,7 @@
-
+
Ace, an accessibility checker for EPUB! A DAISY Consortium project. Latest version: v1.3.2
diff --git a/getting-started/index.html b/getting-started/index.html
index 09318a93..c1d9dcff 100644
--- a/getting-started/index.html
+++ b/getting-started/index.html
@@ -13,12 +13,54 @@
gtag('js', new Date());
gtag('config', 'UA-327448-5');
+
-
+
skip to content
@@ -115,7 +157,7 @@
-
+
Ace, an accessibility checker for EPUB! A DAISY Consortium project. Latest version: v1.3.2
diff --git a/getting-started/index.xml b/getting-started/index.xml
index 5c74b5e8..c709f095 100644
--- a/getting-started/index.xml
+++ b/getting-started/index.xml
@@ -4,50 +4,36 @@
Getting started on Ace, by DAISY
https://daisy.github.io/ace/getting-started/
Recent content in Getting started on Ace, by DAISY
- Hugo -- gohugo.io
- en-us Hugo
+ en-us
+ -
Why Ace?
https://daisy.github.io/ace/getting-started/why-ace/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/getting-started/why-ace/
- What is Ace? Ace is a tool to run automated accessibility checks for EPUB Publications, in order to assist in the evaluation of conformance to the EPUB Accessibility specification.
-What does Ace do? Specifically, Ace:
- runs automated accessibility tests on EPUB content documents extracts the publication metadata, and checks accessibility-related metadata extracts various document outlines (the ToC, headings, and HTML structure) for side-by-side comparison extracts all the EPUBs images and graphics and their associated accessibility descriptions in a consolidated table, for easier review 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, an engine for automated testing of HTML developed by the good folks at Deque Systems.
+ <h2 id="what-is-ace">What is Ace?</h2>
<p>Ace is a tool to run automated accessibility checks for EPUB Publications, in order to assist in the evaluation of conformance to the <a href="http://www.idpf.org/epub/latest/accessibility">EPUB Accessibility</a> specification.</p>
<h2 id="what-does-ace-do">What does Ace do?</h2>
<p>Specifically, Ace:</p>
<ul>
<li>runs automated accessibility tests on EPUB content documents</li>
<li>extracts the publication metadata, and checks accessibility-related metadata</li>
<li>extracts various document outlines (the ToC, headings, and HTML structure) for side-by-side comparison</li>
<li>extracts all the EPUBs images and graphics and their associated accessibility descriptions in a consolidated table, for easier review</li>
<li>extracts other various content features to facilitate human-driven accessibility audits</li>
<li>can be run as a command line tool, or integrated as a Javascript node module, or driven by an HTTP API</li>
</ul>
<p>Under the hood, Ace currently runs <a href="https://github.com/dequelabs/axe-core">axe</a>, an engine for automated testing of HTML developed by the good folks at Deque Systems.</p>
-
-
Installation
https://daisy.github.io/ace/getting-started/installation/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/getting-started/installation/
- Note: this documentation applies to the Ace by DAISY command line tool. For more information about the Ace by DAISY “desktop application” (as known as the Ace App), please visit this page.
-Minimum System Requirements Operating systems: Microsoft Windows 10+, Apple MacOS High Sierra 10.13+, Linux 64-bit Ubuntu 14.04+, Debian 8+, openSUSE 13.3+, or Fedora Linux 24+
-Ace is a NodeJS / Javascript program that launches either Electron or Puppeteer to execute the accessibility tests in headless Chromium webviews, see implementation notes.
+ <p><em>Note: this documentation applies to the Ace by DAISY command line tool. For more information about the Ace by DAISY “desktop application” (as known as the Ace App), please <a href="https://daisy.github.io/ace/ace/getting-started/ace-app/">visit this page</a>.</em></p>
<h2 id="minimum-system-requirements">Minimum System Requirements</h2>
<p>Operating systems: Microsoft Windows 10+, Apple MacOS High Sierra 10.13+, Linux 64-bit Ubuntu 14.04+, Debian 8+, openSUSE 13.3+, or Fedora Linux 24+</p>
<p>Ace is a NodeJS / Javascript program that launches either Electron or Puppeteer to execute the accessibility tests in headless Chromium webviews, see
<a href="https://daisy.github.io/ace/ace/contributing/notes/">implementation notes</a>. Ace has other software dependencies that require a modern NodeJS runtime, for security and performance reasons. NodeJS version 20 is required, and NodeJS 22 is recommended.</p>
-
-
Running Ace
https://daisy.github.io/ace/getting-started/running/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/getting-started/running/
- Note: this documentation applies to the Ace by DAISY command line tool. For more information about the Ace by DAISY “desktop application” (as known as the Ace App), please visit this page.
-Checking an EPUB You can check an EPUB by running the ace command followed by the path to the EPUB document (if the file name includes spaces, place it inside " marks). For example:
-$ ace ~/Documents/moby-dick.epub The above command will run the automated accessibility tests on the EPUB document and output the results.
+ <p><em>Note: this documentation applies to the Ace by DAISY command line tool. For more information about the Ace by DAISY “desktop application” (as known as the Ace App), please <a href="https://daisy.github.io/ace/ace/getting-started/ace-app/">visit this page</a>.</em></p>
<h2 id="checking-an-epub">Checking an EPUB</h2>
<p>You can check an EPUB by running the <code>ace</code> command followed by the path to the EPUB document (if the file name includes spaces, place it inside <code>"</code> marks). For example:</p>
<pre tabindex="0"><code>$ ace ~/Documents/moby-dick.epub
</code></pre><p>The above command will run the automated accessibility tests on the EPUB document and output the results.</p>
-
-
The Ace App
https://daisy.github.io/ace/getting-started/ace-app/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/getting-started/ace-app/
- What is the Ace by DAISY App? Ace by DAISY App is the official graphical user interface for the EPUB accessibility checker developed by the DAISY Consortium. The Ace App is available for the Windows, MacOS and Linux desktop operating systems.
-Where can I download the Ace App? The latest version of the Ace App is 1.3.2. The application installers are distributed via the GitHub development website. Here are convenient download links:
+ <h2 id="what-is-the-ace-by-daisy-app">What is the Ace by DAISY App?</h2>
<p>Ace by DAISY App is the official graphical user interface for the EPUB accessibility checker developed by the <a href="http://daisy.org">DAISY Consortium</a>. The Ace App is available for the Windows, MacOS and Linux desktop operating systems.</p>
<h2 id="where-can-i-download-the-ace-app">Where can I download the Ace App?</h2>
<p>The latest version of the Ace App is 1.3.2. The application installers are distributed via the GitHub development website. Here are convenient download links:</p>
-
diff --git a/getting-started/installation/index.html b/getting-started/installation/index.html
index a4ed16f6..6188c239 100644
--- a/getting-started/installation/index.html
+++ b/getting-started/installation/index.html
@@ -13,12 +13,54 @@
gtag('js', new Date());
gtag('config', 'UA-327448-5');
+
-
+
skip to content
@@ -115,7 +157,7 @@
-
+
Ace, an accessibility checker for EPUB! A DAISY Consortium project. Latest version: v1.3.2
@@ -337,7 +379,7 @@ Table of contents
Minimum System Requirements
Operating systems: Microsoft Windows 10+, Apple MacOS High Sierra 10.13+, Linux 64-bit Ubuntu 14.04+, Debian 8+, openSUSE 13.3+, or Fedora Linux 24+
Ace is a NodeJS / Javascript program that launches either Electron or Puppeteer to execute the accessibility tests in headless Chromium webviews, see
-implementation notes. Ace has other software dependencies that require a modern NodeJS runtime, for security and performance reasons. NodeJS version 16+ is required, and NodeJS 18+ is recommended as v16 is scheduled to exit maintenance phase by the end of 2023.
+implementation notes. Ace has other software dependencies that require a modern NodeJS runtime, for security and performance reasons. NodeJS version 20 is required, and NodeJS 22 is recommended.
Further information:
- https://github.com/nodejs/release#release-schedule
diff --git a/getting-started/running/index.html b/getting-started/running/index.html
index 2bf02e25..2c938ca4 100644
--- a/getting-started/running/index.html
+++ b/getting-started/running/index.html
@@ -13,12 +13,54 @@
gtag('js', new Date());
gtag('config', 'UA-327448-5');
+
-
+
skip to content
@@ -115,7 +157,7 @@
-
+
Ace, an accessibility checker for EPUB! A DAISY Consortium project. Latest version: v1.3.2
diff --git a/getting-started/why-ace/index.html b/getting-started/why-ace/index.html
index b515f47e..63f0f842 100644
--- a/getting-started/why-ace/index.html
+++ b/getting-started/why-ace/index.html
@@ -13,12 +13,54 @@
gtag('js', new Date());
gtag('config', 'UA-327448-5');
+
-
+
skip to content
@@ -115,7 +157,7 @@
-
+
Ace, an accessibility checker for EPUB! A DAISY Consortium project. Latest version: v1.3.2
diff --git a/help/contact/index.html b/help/contact/index.html
index 6dd7f85b..a1e3af8b 100644
--- a/help/contact/index.html
+++ b/help/contact/index.html
@@ -13,12 +13,54 @@
gtag('js', new Date());
gtag('config', 'UA-327448-5');
+
-
+
skip to content
@@ -115,7 +157,7 @@
-
+
Ace, an accessibility checker for EPUB! A DAISY Consortium project. Latest version: v1.3.2
diff --git a/help/index.html b/help/index.html
index c018ef2a..500938d4 100644
--- a/help/index.html
+++ b/help/index.html
@@ -13,12 +13,54 @@
gtag('js', new Date());
gtag('config', 'UA-327448-5');
+
-
+
skip to content
@@ -115,7 +157,7 @@
-
+
Ace, an accessibility checker for EPUB! A DAISY Consortium project. Latest version: v1.3.2
diff --git a/help/index.xml b/help/index.xml
index 41b2b8d0..1e00890c 100644
--- a/help/index.xml
+++ b/help/index.xml
@@ -4,27 +4,22 @@
Need Help? on Ace, by DAISY
https://daisy.github.io/ace/help/
Recent content in Need Help? on Ace, by DAISY
- Hugo -- gohugo.io
- en-us Hugo
+ en-us
+ -
Troubleshooting
https://daisy.github.io/ace/help/troubleshooting/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/help/troubleshooting/
- Ace fails with “Unexpected error” Erm… you probably just hit a bug in Ace. Follow the guidelines for submitting an issue. You may also contact us.
-I receive an EACCESS error when trying to install Ace You may receive an EACCESS error when you try to install Ace, for instance when installing the puppeteer dependency. This indicates the you do not have write permissions to the npm installation directories. You can fix this by following the instructions in the npm documentation.
+ <h2 id="ace-fails-with-unexpected-error">Ace fails with “Unexpected error”</h2>
<p>Erm… you probably just hit a bug in Ace. Follow the <a href="https://daisy.github.io/ace/ace/contributing/contributing/#submitting-an-issue">guidelines for submitting an issue</a>. You may also <a href="https://daisy.github.io/ace/help/contact/">contact us</a>.</p>
<h2 id="i-receive-an-eaccess-error-when-trying-to-install-ace">I receive an <code>EACCESS</code> error when trying to install Ace</h2>
<p>You may receive an <code>EACCESS</code> error when you try to install Ace, for instance when installing the <code>puppeteer</code> dependency. This indicates the you do not have write permissions to the <code>npm</code> installation directories. You can fix this by following the <a href="https://docs.npmjs.com/getting-started/fixing-npm-permissions">instructions in the <code>npm</code> documentation</a>.</p>
-
-
Contact us
https://daisy.github.io/ace/help/contact/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/help/contact/
- You can reach us:
- via the contact form on InclusivePublishing.org on GitHub, we’re @daisy on Twitter, we’re @InclusivePub
+ <p>You can reach us:</p>
<ul>
<li>via the <a href="https://inclusivepublishing.org/contact/">contact form on InclusivePublishing.org</a></li>
<li>on GitHub, we’re <a href="https://github.com/daisy/ace">@daisy</a></li>
<li>on Twitter, we’re <a href="http://twitter.com/InclusivePub">@InclusivePub</a></li>
</ul>
-
diff --git a/help/troubleshooting/index.html b/help/troubleshooting/index.html
index 12373c6b..91dbd10c 100644
--- a/help/troubleshooting/index.html
+++ b/help/troubleshooting/index.html
@@ -13,12 +13,54 @@
gtag('js', new Date());
gtag('config', 'UA-327448-5');
+
-
+
skip to content
@@ -115,7 +157,7 @@
-
+
Ace, an accessibility checker for EPUB! A DAISY Consortium project. Latest version: v1.3.2
@@ -358,7 +400,7 @@
-
+
skip to content
@@ -115,7 +157,7 @@
-
+
Ace, an accessibility checker for EPUB! A DAISY Consortium project. Latest version: v1.3.2
@@ -284,6 +326,21 @@ Ace, by DAISY
Latest version: v1.3.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.
+
+ If you find DAISY Ace useful, please help us by donating to support its ongoing maintenance.
+ Support our work
+
+
+
-
diff --git a/index.xml b/index.xml
index 4bce7114..6eed789a 100644
--- a/index.xml
+++ b/index.xml
@@ -4,190 +4,127 @@
Ace, by DAISY
https://daisy.github.io/ace/
Recent content on Ace, by DAISY
- Hugo -- gohugo.io
- en-us Hugo
+ en-us
+ -
Command line interface
https://daisy.github.io/ace/docs/cli/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/docs/cli/
- Overview The easiest way to run Ace is to type this on the command line:
-$ ace ~/Documents/book.epub You’ll then see a description of Ace’s actions as it runs tests on the book. The JSON report is printed to the command line at the end (nothing is saved to disk; you need to specify --outdir for that).
-Example:
-info: Processing ../epub-a11y-checker/samples/build/epub-a11y-tests-001.epub info: Parsing EPUB info: Analyzing accessibility metadata info: Checking package.
+ <h2 id="overview">Overview</h2>
<p>The easiest way to run Ace is to type this on the command line:</p>
<pre tabindex="0"><code>$ ace ~/Documents/book.epub
</code></pre><p>You’ll then see a description of Ace’s actions as it runs tests on the book. The JSON report is printed to the command line at the end (nothing is saved to disk; you need to specify <a href="#outdir"><code>--outdir</code></a> for that).</p>
<p>Example:</p>
<pre tabindex="0"><code>info: Processing ../epub-a11y-checker/samples/build/epub-a11y-tests-001.epub
info: Parsing EPUB
info: Analyzing accessibility metadata
info: Checking package...
info: - EPUB/package.opf: 4 issues found
info: Checking documents...
info: - xhtml/front.xhtml: No issues found
info: - xhtml/nav.xhtml: 2 issues found
info: - xhtml/table-structure.xhtml: 2 issues found
info: - xhtml/image-desc.xhtml: 4 issues found
info: - xhtml/heading-order-01.xhtml: No issues found
info: - xhtml/heading-order-02.xhtml: No issues found
info: - xhtml/heading-order-03.xhtml: No issues found
info: - xhtml/color-contrast.xhtml: 2 issues found
info: - xhtml/epub-type-and-aria.xhtml: 5 issues found
info: - xhtml/out-of-spine-content.xhtml: 2 issues found
info: Consolidating results...
{
"@type": "earl:report",
"@context": "http://daisy.github.io/ace/ace-report-1.0.jsonld",
"dct:title": "Ace Report",
...
}
info: Done
</code></pre><p>Ace will exit with a return code of <code>0</code> when complete, or <code>1</code> if there was an error that prevented Ace from successfully executing. Note that these return codes do not indicate whether there were violations in the publication; for that, you need to first edit Ace’s <a href="https://daisy.github.io/ace/docs/config/">configuration</a>.</p>
-
-
How to contribute?
https://daisy.github.io/ace/contributing/contributing/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/contributing/contributing/
- First, welcome to Ace and thank you so much for being willing to contribute!
-Submitting an issue You can first check the issue tracker to see if someone already reported the issue. Don’t forget to included the closed issues in your search in case we fixed it already!
-If you can’t find any mention of your issue in our tracker, please file a new issue!
-When filing an issue, please provide the following details:
+ <p>First, welcome to Ace and thank you so much for being willing to contribute!</p>
<h2 id="submitting-an-issue">Submitting an issue</h2>
<p>You can first check the <a href="https://github.com/daisy/ace/issues">issue tracker</a> to see if someone already reported the issue. Don’t forget to included the closed issues in your search in case we fixed it already!</p>
<p>If you can’t find any mention of your issue in our tracker, please <a href="https://github.com/daisy/ace/issues/new">file a new issue</a>!</p>
<p>When filing an issue, please provide the following details:</p>
-
-
HTML Rules
https://daisy.github.io/ace/rules/html/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/rules/html/
- Under the hood, most of the accessibility checks ran by Ace are powered by Deque axe, an engine for automated testing of HTML.
-Deque axe defines over 100 rules (including a few experimental and deprecated ones): https://github.com/daisy/axe-core/blob/v4.7.2_DAISY/doc/rule-descriptions.md
-Note that the link above references the DAISY fork of Axe which adds a few EPUB-specific rules not present in Deque’s original ruleset (epub-type-has-matching-role and pagebreak-label). Also note that Ace defines additional EPUB rules related to publication package metadata, etc.
+ <p>Under the hood, most of the accessibility checks ran by Ace are powered by <a href="https://github.com/dequelabs/axe-core">Deque axe</a>, an engine for automated testing of HTML.</p>
<p>Deque axe defines over 100 rules (including a few experimental and deprecated ones): <a href="https://github.com/daisy/axe-core/blob/v4.7.2_DAISY/doc/rule-descriptions.md">https://github.com/daisy/axe-core/blob/v4.7.2_DAISY/doc/rule-descriptions.md</a></p>
<p>Note that the link above references the DAISY fork of Axe which adds a few EPUB-specific rules not present in Deque’s original ruleset (<code>epub-type-has-matching-role</code> and <code>pagebreak-label</code>). Also note that Ace defines additional <a href="https://daisy.github.io/ace/rules/epub/">EPUB rules</a> related to publication package metadata, etc. (in other words, accessibility checks that require analysing other files than the publication’s HTML documents)</p>
-
-
Troubleshooting
https://daisy.github.io/ace/help/troubleshooting/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/help/troubleshooting/
- Ace fails with “Unexpected error” Erm… you probably just hit a bug in Ace. Follow the guidelines for submitting an issue. You may also contact us.
-I receive an EACCESS error when trying to install Ace You may receive an EACCESS error when you try to install Ace, for instance when installing the puppeteer dependency. This indicates the you do not have write permissions to the npm installation directories. You can fix this by following the instructions in the npm documentation.
+ <h2 id="ace-fails-with-unexpected-error">Ace fails with “Unexpected error”</h2>
<p>Erm… you probably just hit a bug in Ace. Follow the <a href="https://daisy.github.io/ace/ace/contributing/contributing/#submitting-an-issue">guidelines for submitting an issue</a>. You may also <a href="https://daisy.github.io/ace/help/contact/">contact us</a>.</p>
<h2 id="i-receive-an-eaccess-error-when-trying-to-install-ace">I receive an <code>EACCESS</code> error when trying to install Ace</h2>
<p>You may receive an <code>EACCESS</code> error when you try to install Ace, for instance when installing the <code>puppeteer</code> dependency. This indicates the you do not have write permissions to the <code>npm</code> installation directories. You can fix this by following the <a href="https://docs.npmjs.com/getting-started/fixing-npm-permissions">instructions in the <code>npm</code> documentation</a>.</p>
-
-
Why Ace?
https://daisy.github.io/ace/getting-started/why-ace/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/getting-started/why-ace/
- What is Ace? Ace is a tool to run automated accessibility checks for EPUB Publications, in order to assist in the evaluation of conformance to the EPUB Accessibility specification.
-What does Ace do? Specifically, Ace:
- runs automated accessibility tests on EPUB content documents extracts the publication metadata, and checks accessibility-related metadata extracts various document outlines (the ToC, headings, and HTML structure) for side-by-side comparison extracts all the EPUBs images and graphics and their associated accessibility descriptions in a consolidated table, for easier review 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, an engine for automated testing of HTML developed by the good folks at Deque Systems.
+ <h2 id="what-is-ace">What is Ace?</h2>
<p>Ace is a tool to run automated accessibility checks for EPUB Publications, in order to assist in the evaluation of conformance to the <a href="http://www.idpf.org/epub/latest/accessibility">EPUB Accessibility</a> specification.</p>
<h2 id="what-does-ace-do">What does Ace do?</h2>
<p>Specifically, Ace:</p>
<ul>
<li>runs automated accessibility tests on EPUB content documents</li>
<li>extracts the publication metadata, and checks accessibility-related metadata</li>
<li>extracts various document outlines (the ToC, headings, and HTML structure) for side-by-side comparison</li>
<li>extracts all the EPUBs images and graphics and their associated accessibility descriptions in a consolidated table, for easier review</li>
<li>extracts other various content features to facilitate human-driven accessibility audits</li>
<li>can be run as a command line tool, or integrated as a Javascript node module, or driven by an HTTP API</li>
</ul>
<p>Under the hood, Ace currently runs <a href="https://github.com/dequelabs/axe-core">axe</a>, an engine for automated testing of HTML developed by the good folks at Deque Systems.</p>
-
-
Code base overview
https://daisy.github.io/ace/contributing/code/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/contributing/code/
- Ace consists of the following packages:
- ace-cli: the command line interface ace-config: unifies the per-package configuration files into a global config file ace-core: the core checker’s logic, and the code responsible for running the underlying Web checker ace-core/scripts: the Javascript files injected in the headless browser to run Ace’s checks ace-http: the Http API ace-logger: logging ace-report and ace-report-axe: utils for building Ace’s reports epub-utils: utils for parsing EPUBs jest-env-puppeteer, jest-puppeteer, and puppeteer-utils: for working with the headless browser
+ <p>Ace consists of the following packages:</p>
<ul>
<li><strong>ace-cli</strong>: the command line interface</li>
<li><strong>ace-config</strong>: unifies the per-package configuration files into a global config file</li>
<li><strong>ace-core</strong>: the core checker’s logic, and the code responsible for running the underlying Web checker</li>
<li><strong>ace-core/scripts</strong>: the Javascript files injected in the headless browser to run Ace’s checks</li>
<li><strong>ace-http</strong>: the Http API</li>
<li><strong>ace-logger</strong>: logging</li>
<li><strong>ace-report</strong> and <strong>ace-report-axe</strong>: utils for building Ace’s reports</li>
<li><strong>epub-utils</strong>: utils for parsing EPUBs</li>
<li><strong>jest-env-puppeteer</strong>, <strong>jest-puppeteer</strong>, and <strong>puppeteer-utils</strong>: for working with the headless browser</li>
</ul>
-
-
Contact us
https://daisy.github.io/ace/help/contact/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/help/contact/
- You can reach us:
- via the contact form on InclusivePublishing.org on GitHub, we’re @daisy on Twitter, we’re @InclusivePub
+ <p>You can reach us:</p>
<ul>
<li>via the <a href="https://inclusivepublishing.org/contact/">contact form on InclusivePublishing.org</a></li>
<li>on GitHub, we’re <a href="https://github.com/daisy/ace">@daisy</a></li>
<li>on Twitter, we’re <a href="http://twitter.com/InclusivePub">@InclusivePub</a></li>
</ul>
-
-
EPUB Rules
https://daisy.github.io/ace/rules/epub/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/rules/epub/
- In addition to the HTML rules, Ace implements EPUB-specific checks. The “impact” property indicates the severity of each violation (“minor”, “moderate”, “serious”, or “critical”), as per Deque axe’s definition described in their documentation ( https://github.com/daisy/axe-core/blob/v4.7.2_DAISY/doc/issue_impact.md ).
- Missing metadata (impact = “serious”): metadata-accessmode, metadata-accessibilityfeature, metadata-accessibilityhazard Missing metadata (impact = “moderate”): metadata-accessibilitysummary, metadata-accessModesufficient Incorrect metadata values (impact = “moderate”): metadata-accessibilityfeature-invalid, metadata-accessibilityhazard-invalid (mixed positive and negative terms (e.g. noFlashingHazard and flashing), unknown mixed with none or other vocabulary values, or usage of terms not defined by the specification) Incorrect metadata values (impact = “minor”): metadata-accessmode-invalid, metadata-accessmodesufficient-invalid (usage of terms not defined by the specification) Missing authored page list when metadata printPageNumbers/pageBreakMarkers is present (impact = “moderate”): metadata-accessibilityFeature-printPageNumbers-nopagelist Mismatched page breaks in SMIL and in HTML documents (impact = “serious”): epub-pagelist-mediaoverlays Authored page list references elements in HTML documents that are not page breaks or do not exist (impact = “serious”): epub-pagelist-broken Authored page list does not reference all elements that are page breaks in HTML documents (impact = serious): epub-pagelist-missing-pagebreak Mismatched authored table of contents and reading order of elements inside HTML documents (impact = “serious”): epub-toc-order Missing publication title metadata (impact = “serious”): epub-title Missing OPF lang attribute (impact = “serious”): epub-lang Missing dc:source publication metadata when reflowable EPUB has authored page list (impact = “serious”): epub-pagesource
+ <p>In addition to the <a href="https://daisy.github.io/ace/rules/html/">HTML rules</a>, Ace implements EPUB-specific checks. The “impact” property indicates the severity of each violation (“minor”, “moderate”, “serious”, or “critical”), as per Deque axe’s definition described in their documentation ( <a href="https://github.com/daisy/axe-core/blob/v4.7.2_DAISY/doc/issue_impact.md">https://github.com/daisy/axe-core/blob/v4.7.2_DAISY/doc/issue_impact.md</a> ).</p>
<ul>
<li>Missing metadata (impact = “serious”): <code>metadata-accessmode</code>, <code>metadata-accessibilityfeature</code>, <code>metadata-accessibilityhazard</code></li>
<li>Missing metadata (impact = “moderate”): <code>metadata-accessibilitysummary</code>, <code>metadata-accessModesufficient</code></li>
<li>Incorrect metadata values (impact = “moderate”): <code>metadata-accessibilityfeature-invalid</code>, <code>metadata-accessibilityhazard-invalid</code> (mixed positive and negative terms (e.g. <code>noFlashingHazard</code> and <code>flashing</code>), <code>unknown</code> mixed with <code>none</code> or other vocabulary values, or usage of terms not defined by the specification)</li>
<li>Incorrect metadata values (impact = “minor”): <code>metadata-accessmode-invalid</code>, <code>metadata-accessmodesufficient-invalid</code> (usage of terms not defined by the specification)</li>
<li>Missing authored page list when metadata <code>printPageNumbers</code>/<code>pageBreakMarkers</code> is present (impact = “moderate”): <code>metadata-accessibilityFeature-printPageNumbers-nopagelist</code></li>
<li>Mismatched page breaks in SMIL and in HTML documents (impact = “serious”): <code>epub-pagelist-mediaoverlays</code></li>
<li>Authored page list references elements in HTML documents that are not page breaks (impact = “minor”) or do not exist (impact = “serious”): <code>epub-pagelist-broken</code></li>
<li>Authored page list does not reference all elements that are page breaks in HTML documents (impact = serious): <code>epub-pagelist-missing-pagebreak</code></li>
<li>Mismatched authored table of contents and reading order of elements inside HTML documents (impact = “serious”): <code>epub-toc-order</code></li>
<li>Missing publication title metadata (impact = “serious”): <code>epub-title</code></li>
<li>Missing OPF lang attribute (impact = “serious”): <code>epub-lang</code></li>
<li>Missing <code>dc:source</code> / <code>pageBreakSource</code> publication metadata when reflowable EPUB has authored page list (impact = “serious”): <code>epub-pagesource</code></li>
</ul>
-
-
HTML Report
https://daisy.github.io/ace/docs/report-html/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/docs/report-html/
- Ace outputs a human-readable report in HTML format, containing information about which automated tests failed, as well as extracted data visualizations, to highlight potential problem areas and to assist in manual checking.
-Note that the report looks best with javascript enabled, though it’s not required.
-After the header, which contains the Ace version, report date, and publication title, there are four sections, detailed below.
-Violations Summary of Violations This table lists statistics for the violations, in terms of severity: Critical, Serious, Moderate, or Minor; and by ruleset category: WCAG 2.
+ <p>Ace outputs a human-readable report in HTML format, containing information about which automated tests failed, as well as extracted data visualizations, to highlight potential problem areas and to assist in manual checking.</p>
<p>Note that the report looks best with javascript enabled, though it’s not required.</p>
<p>After the header, which contains the Ace version, report date, and publication title, there are four sections, detailed below.</p>
<h2 id="violations">Violations</h2>
<h3 id="summary-of-violations">Summary of Violations</h3>
<p>This table lists statistics for the violations, in terms of severity: Critical, Serious, Moderate, or Minor; and by ruleset category: WCAG 2.0 A, WCAG 2.0 AA, EPUB, Best Practice, or Other. It’s useful for getting a quick overview of the violations.</p>
-
-
Installation
https://daisy.github.io/ace/getting-started/installation/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/getting-started/installation/
- Note: this documentation applies to the Ace by DAISY command line tool. For more information about the Ace by DAISY “desktop application” (as known as the Ace App), please visit this page.
-Minimum System Requirements Operating systems: Microsoft Windows 10+, Apple MacOS High Sierra 10.13+, Linux 64-bit Ubuntu 14.04+, Debian 8+, openSUSE 13.3+, or Fedora Linux 24+
-Ace is a NodeJS / Javascript program that launches either Electron or Puppeteer to execute the accessibility tests in headless Chromium webviews, see implementation notes.
+ <p><em>Note: this documentation applies to the Ace by DAISY command line tool. For more information about the Ace by DAISY “desktop application” (as known as the Ace App), please <a href="https://daisy.github.io/ace/ace/getting-started/ace-app/">visit this page</a>.</em></p>
<h2 id="minimum-system-requirements">Minimum System Requirements</h2>
<p>Operating systems: Microsoft Windows 10+, Apple MacOS High Sierra 10.13+, Linux 64-bit Ubuntu 14.04+, Debian 8+, openSUSE 13.3+, or Fedora Linux 24+</p>
<p>Ace is a NodeJS / Javascript program that launches either Electron or Puppeteer to execute the accessibility tests in headless Chromium webviews, see
<a href="https://daisy.github.io/ace/ace/contributing/notes/">implementation notes</a>. Ace has other software dependencies that require a modern NodeJS runtime, for security and performance reasons. NodeJS version 20 is required, and NodeJS 22 is recommended.</p>
-
-
Implementation notes
https://daisy.github.io/ace/contributing/notes/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/contributing/notes/
- HTML checker Under the hood, most of the HTML checks are powered by axe, an engine for automated testing of HTML from Deque Systems.
-Headless browser During the evaluation of an EPUB, Ace loads each HTML content document in a “headless” web browser window (i.e. invisible from the point of view of the user of the command line tool, but nonetheless using a real rendering engine). Ace was originally based on Puppeteer but it is now using Electron by default.
+ <h2 id="html-checker">HTML checker</h2>
<p>Under the hood, most of the HTML checks are powered by <a href="https://github.com/dequelabs/axe-core">axe</a>, an engine for automated testing of HTML from <a href="https://www.deque.com/">Deque Systems</a>.</p>
<h2 id="headless-browser">Headless browser</h2>
<p>During the evaluation of an EPUB, Ace loads each HTML content document in a “headless” web browser window (i.e. invisible from the point of view of the user of the command line tool, but nonetheless using a real rendering engine). Ace was originally based on <a href="https://github.com/GoogleChrome/puppeteer">Puppeteer</a> but it is now using <a href="https://github.com/electron/electron">Electron</a> by default. Electron and Puppeteer both use Chromium which is the open source component that powers various web browsers (including Google Chrome and Microsoft Edge). Both Ace (command line) and Ace App (Graphical User Interface) now rely on this Electron runtime to perform the accessibility checks, but the legacy Puppeteer method remains available via the command <code>ace-puppeteer</code> (similarly, the default Electron variant can also be explicitly invoked with <code>ace-electron</code> instead of <code>ace</code>).</p>
-
-
JSON Report
https://daisy.github.io/ace/docs/report-json/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/docs/report-json/
- Ace’s outputs a machine-readable report in JSON format, detailing the automated tests. The vocabulary of this report is a mix of EARL (Evaluation and Reporting Language), Dublin Core, and custom terms.
-Document structure Each example piece of the report shown below appears in order, in one JSON file.
- Header information Outlines Data Properties earl:testSubject for this EPUB file Accessibility metadata summary Assertions Header information This gives basic information about Ace and when the report was created.
+ <p>Ace’s outputs a machine-readable report in JSON format, detailing the automated tests. The vocabulary of this report is a mix of <a href="https://www.w3.org/TR/EARL10-Schema/">EARL</a> (Evaluation and Reporting Language), Dublin Core, and custom terms.</p>
<h2 id="document-structure">Document structure</h2>
<p>Each example piece of the report shown below appears in order, in one JSON file.</p>
<ul>
<li><a href="#header-information">Header information</a></li>
<li><a href="#outlines">Outlines</a></li>
<li><a href="#data">Data</a></li>
<li><a href="#properties">Properties</a></li>
<li><a href="#earltestsubject-for-this-epub-file">earl:testSubject for this EPUB file</a></li>
<li><a href="#accessibility-metadata-summary">Accessibility metadata summary</a></li>
<li><a href="#assertions">Assertions</a></li>
</ul>
<h3 id="header-information">Header information</h3>
<p>This gives basic information about Ace and when the report was created.</p>
-
-
Running Ace
https://daisy.github.io/ace/getting-started/running/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/getting-started/running/
- Note: this documentation applies to the Ace by DAISY command line tool. For more information about the Ace by DAISY “desktop application” (as known as the Ace App), please visit this page.
-Checking an EPUB You can check an EPUB by running the ace command followed by the path to the EPUB document (if the file name includes spaces, place it inside " marks). For example:
-$ ace ~/Documents/moby-dick.epub The above command will run the automated accessibility tests on the EPUB document and output the results.
+ <p><em>Note: this documentation applies to the Ace by DAISY command line tool. For more information about the Ace by DAISY “desktop application” (as known as the Ace App), please <a href="https://daisy.github.io/ace/ace/getting-started/ace-app/">visit this page</a>.</em></p>
<h2 id="checking-an-epub">Checking an EPUB</h2>
<p>You can check an EPUB by running the <code>ace</code> command followed by the path to the EPUB document (if the file name includes spaces, place it inside <code>"</code> marks). For example:</p>
<pre tabindex="0"><code>$ ace ~/Documents/moby-dick.epub
</code></pre><p>The above command will run the automated accessibility tests on the EPUB document and output the results.</p>
-
-
Configuration
https://daisy.github.io/ace/docs/config/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/docs/config/
- Overview Ace can be configured through a config.json file located in an OS-specific directory:
- on Windows in "%HOME%\AppData\Local\DAISY Ace\Config\" on macOS in "~/Library/Preferences/DAISY\ Ace/" on Linux in "~/.config/DAISY Ace/" Defaults The defaults for Ace configuration are:
-{ "cli": { "return-2-on-validation-error": false }, "logging": { "fileName": "ace.log", "level": "info" }, "output": { "force": false, "subdir": false }, "report": { "use-relative-paths": true }, "runtime": { "concurrencyLevel": 4 } } Reference cli.
+ <h2 id="overview">Overview</h2>
<p>Ace can be configured through a <code>config.json</code> file located in an OS-specific directory:</p>
<ul>
<li>on Windows in <code>"%HOME%\AppData\Local\DAISY Ace\Config\"</code></li>
<li>on macOS in <code>"~/Library/Preferences/DAISY\ Ace/"</code></li>
<li>on Linux in <code>"~/.config/DAISY Ace/"</code></li>
</ul>
<h2 id="defaults">Defaults</h2>
<p>The defaults for Ace configuration are:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span>{
</span></span><span style="display:flex;"><span> <span style="color:#f92672">"cli"</span>: {
</span></span><span style="display:flex;"><span> <span style="color:#f92672">"return-2-on-validation-error"</span>: <span style="color:#66d9ef">false</span>
</span></span><span style="display:flex;"><span> },
</span></span><span style="display:flex;"><span> <span style="color:#f92672">"logging"</span>: {
</span></span><span style="display:flex;"><span> <span style="color:#f92672">"fileName"</span>: <span style="color:#e6db74">"ace.log"</span>,
</span></span><span style="display:flex;"><span> <span style="color:#f92672">"level"</span>: <span style="color:#e6db74">"info"</span>
</span></span><span style="display:flex;"><span> },
</span></span><span style="display:flex;"><span> <span style="color:#f92672">"output"</span>: {
</span></span><span style="display:flex;"><span> <span style="color:#f92672">"force"</span>: <span style="color:#66d9ef">false</span>,
</span></span><span style="display:flex;"><span> <span style="color:#f92672">"subdir"</span>: <span style="color:#66d9ef">false</span>
</span></span><span style="display:flex;"><span> },
</span></span><span style="display:flex;"><span> <span style="color:#f92672">"report"</span>: {
</span></span><span style="display:flex;"><span> <span style="color:#f92672">"use-relative-paths"</span>: <span style="color:#66d9ef">true</span>
</span></span><span style="display:flex;"><span> },
</span></span><span style="display:flex;"><span> <span style="color:#f92672">"runtime"</span>: {
</span></span><span style="display:flex;"><span> <span style="color:#f92672">"concurrencyLevel"</span>: <span style="color:#ae81ff">4</span>
</span></span><span style="display:flex;"><span> }
</span></span><span style="display:flex;"><span>}
</span></span></code></pre></div><h2 id="reference">Reference</h2>
<h3 id="clireturn-2-on-validation-error"><code>cli.return-2-on-validation-error</code></h3>
<p>Default: “<code>false</code>”</p>
<p>Indicates whether the CLI should return with the error code <code>2</code> if any violations were found in the input publication.</p>
-
-
The Ace App
https://daisy.github.io/ace/getting-started/ace-app/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/getting-started/ace-app/
- What is the Ace by DAISY App? Ace by DAISY App is the official graphical user interface for the EPUB accessibility checker developed by the DAISY Consortium. The Ace App is available for the Windows, MacOS and Linux desktop operating systems.
-Where can I download the Ace App? The latest version of the Ace App is 1.3.2. The application installers are distributed via the GitHub development website. Here are convenient download links:
+ <h2 id="what-is-the-ace-by-daisy-app">What is the Ace by DAISY App?</h2>
<p>Ace by DAISY App is the official graphical user interface for the EPUB accessibility checker developed by the <a href="http://daisy.org">DAISY Consortium</a>. The Ace App is available for the Windows, MacOS and Linux desktop operating systems.</p>
<h2 id="where-can-i-download-the-ace-app">Where can I download the Ace App?</h2>
<p>The latest version of the Ace App is 1.3.2. The application installers are distributed via the GitHub development website. Here are convenient download links:</p>
-
-
Logging
https://daisy.github.io/ace/docs/logging/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/docs/logging/
- Overview Ace prints a log of messages in a ace.log file located in an OS-specific directory:
- on Windows in "%HOME%\AppData\Local\DAISY Ace\Log\" on macOS in "~/Library/Logs/DAISY\ Ace/" on Linux in "~/.local/state/DAISY Ace/" Configuration The logging level and the name of the log file can be configured through Ace’s config file. Read more on Ace configuration to know more.
+ <h2 id="overview">Overview</h2>
<p>Ace prints a log of messages in a <code>ace.log</code> file located in an OS-specific directory:</p>
<ul>
<li>on Windows in <code>"%HOME%\AppData\Local\DAISY Ace\Log\"</code></li>
<li>on macOS in <code>"~/Library/Logs/DAISY\ Ace/"</code></li>
<li>on Linux in <code>"~/.local/state/DAISY Ace/"</code></li>
</ul>
<h2 id="configuration">Configuration</h2>
<p>The logging level and the name of the log file can be configured through Ace’s config file. Read more on <a href="https://daisy.github.io/ace/docs/config/">Ace configuration</a> to know more.</p>
-
-
Http API
https://daisy.github.io/ace/docs/http-api/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/docs/http-api/
- Starting the server After installing Ace, run the ace-http command from the terminal:
-$ ace-http info: [ace-http] server listening on http://localhost:8000 The command line options are printed when you run ace-http --help:
-Ace by DAISY, an Accessibility Checker for EPUB Usage: ace-http [options] Options: -h, --help output usage information -v, --version output the version number -H, --host set the server's hostname (default: localhost) -p, --port set the server's port (default: 8000) -V, --verbose display verbose output -s, --silent do not display any output -l, --lang <language> language code for localized messages (e.
+ <h2 id="starting-the-server">Starting the server</h2>
<p>After <a href="https://daisy.github.io/ace/ace/getting-started/installation/">installing Ace</a>, run the <code>ace-http</code> command from the terminal:</p>
<pre tabindex="0"><code>$ ace-http
info: [ace-http] server listening on http://localhost:8000
</code></pre><p>The command line options are printed when you run <code>ace-http --help</code>:</p>
<pre tabindex="0"><code>Ace by DAISY, an Accessibility Checker for EPUB
Usage: ace-http [options]
Options:
-h, --help output usage information
-v, --version output the version number
-H, --host set the server's hostname (default: localhost)
-p, --port set the server's port (default: 8000)
-V, --verbose display verbose output
-s, --silent do not display any output
-l, --lang <language> language code for localized messages (e.g. "fr"), default is "en"
Examples
$ ace-http -p 3000
</code></pre><h2 id="api">API</h2>
<p>This API is available to client applications.</p>
-
diff --git a/rules/epub/index.html b/rules/epub/index.html
index 1474d236..a68333bf 100644
--- a/rules/epub/index.html
+++ b/rules/epub/index.html
@@ -13,12 +13,54 @@
gtag('js', new Date());
gtag('config', 'UA-327448-5');
+
-
+
skip to content
@@ -115,7 +157,7 @@
-
+
Ace, an accessibility checker for EPUB! A DAISY Consortium project. Latest version: v1.3.2
@@ -293,12 +335,12 @@ EPUB Rules
- Incorrect metadata values (impact = “minor”):
metadata-accessmode-invalid, metadata-accessmodesufficient-invalid (usage of terms not defined by the specification)
- Missing authored page list when metadata
printPageNumbers/pageBreakMarkers is present (impact = “moderate”): metadata-accessibilityFeature-printPageNumbers-nopagelist
- Mismatched page breaks in SMIL and in HTML documents (impact = “serious”):
epub-pagelist-mediaoverlays
-- Authored page list references elements in HTML documents that are not page breaks or do not exist (impact = “serious”):
epub-pagelist-broken
+- Authored page list references elements in HTML documents that are not page breaks (impact = “minor”) or do not exist (impact = “serious”):
epub-pagelist-broken
- Authored page list does not reference all elements that are page breaks in HTML documents (impact = serious):
epub-pagelist-missing-pagebreak
- Mismatched authored table of contents and reading order of elements inside HTML documents (impact = “serious”):
epub-toc-order
- Missing publication title metadata (impact = “serious”):
epub-title
- Missing OPF lang attribute (impact = “serious”):
epub-lang
-- Missing
dc:source publication metadata when reflowable EPUB has authored page list (impact = “serious”): epub-pagesource
+- Missing
dc:source / pageBreakSource publication metadata when reflowable EPUB has authored page list (impact = “serious”): epub-pagesource
diff --git a/rules/html/index.html b/rules/html/index.html
index e9311175..3ee76496 100644
--- a/rules/html/index.html
+++ b/rules/html/index.html
@@ -13,12 +13,54 @@
gtag('js', new Date());
gtag('config', 'UA-327448-5');
+
-
+
skip to content
@@ -115,7 +157,7 @@
-
+
Ace, an accessibility checker for EPUB! A DAISY Consortium project. Latest version: v1.3.2
diff --git a/rules/index.html b/rules/index.html
index 602ff1af..53979d2d 100644
--- a/rules/index.html
+++ b/rules/index.html
@@ -13,12 +13,54 @@
gtag('js', new Date());
gtag('config', 'UA-327448-5');
+
-
+
skip to content
@@ -115,7 +157,7 @@
-
+
Ace, an accessibility checker for EPUB! A DAISY Consortium project. Latest version: v1.3.2
diff --git a/rules/index.xml b/rules/index.xml
index fe05747a..0fa2f78c 100644
--- a/rules/index.xml
+++ b/rules/index.xml
@@ -4,28 +4,22 @@
Rules on Ace, by DAISY
https://daisy.github.io/ace/rules/
Recent content in Rules on Ace, by DAISY
- Hugo -- gohugo.io
- en-us Hugo
+ en-us
+ -
HTML Rules
https://daisy.github.io/ace/rules/html/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/rules/html/
- Under the hood, most of the accessibility checks ran by Ace are powered by Deque axe, an engine for automated testing of HTML.
-Deque axe defines over 100 rules (including a few experimental and deprecated ones): https://github.com/daisy/axe-core/blob/v4.7.2_DAISY/doc/rule-descriptions.md
-Note that the link above references the DAISY fork of Axe which adds a few EPUB-specific rules not present in Deque’s original ruleset (epub-type-has-matching-role and pagebreak-label). Also note that Ace defines additional EPUB rules related to publication package metadata, etc.
+ <p>Under the hood, most of the accessibility checks ran by Ace are powered by <a href="https://github.com/dequelabs/axe-core">Deque axe</a>, an engine for automated testing of HTML.</p>
<p>Deque axe defines over 100 rules (including a few experimental and deprecated ones): <a href="https://github.com/daisy/axe-core/blob/v4.7.2_DAISY/doc/rule-descriptions.md">https://github.com/daisy/axe-core/blob/v4.7.2_DAISY/doc/rule-descriptions.md</a></p>
<p>Note that the link above references the DAISY fork of Axe which adds a few EPUB-specific rules not present in Deque’s original ruleset (<code>epub-type-has-matching-role</code> and <code>pagebreak-label</code>). Also note that Ace defines additional <a href="https://daisy.github.io/ace/rules/epub/">EPUB rules</a> related to publication package metadata, etc. (in other words, accessibility checks that require analysing other files than the publication’s HTML documents)</p>
-
-
EPUB Rules
https://daisy.github.io/ace/rules/epub/
Mon, 01 Jan 0001 00:00:00 +0000
-
https://daisy.github.io/ace/rules/epub/
- In addition to the HTML rules, Ace implements EPUB-specific checks. The “impact” property indicates the severity of each violation (“minor”, “moderate”, “serious”, or “critical”), as per Deque axe’s definition described in their documentation ( https://github.com/daisy/axe-core/blob/v4.7.2_DAISY/doc/issue_impact.md ).
- Missing metadata (impact = “serious”): metadata-accessmode, metadata-accessibilityfeature, metadata-accessibilityhazard Missing metadata (impact = “moderate”): metadata-accessibilitysummary, metadata-accessModesufficient Incorrect metadata values (impact = “moderate”): metadata-accessibilityfeature-invalid, metadata-accessibilityhazard-invalid (mixed positive and negative terms (e.g. noFlashingHazard and flashing), unknown mixed with none or other vocabulary values, or usage of terms not defined by the specification) Incorrect metadata values (impact = “minor”): metadata-accessmode-invalid, metadata-accessmodesufficient-invalid (usage of terms not defined by the specification) Missing authored page list when metadata printPageNumbers/pageBreakMarkers is present (impact = “moderate”): metadata-accessibilityFeature-printPageNumbers-nopagelist Mismatched page breaks in SMIL and in HTML documents (impact = “serious”): epub-pagelist-mediaoverlays Authored page list references elements in HTML documents that are not page breaks or do not exist (impact = “serious”): epub-pagelist-broken Authored page list does not reference all elements that are page breaks in HTML documents (impact = serious): epub-pagelist-missing-pagebreak Mismatched authored table of contents and reading order of elements inside HTML documents (impact = “serious”): epub-toc-order Missing publication title metadata (impact = “serious”): epub-title Missing OPF lang attribute (impact = “serious”): epub-lang Missing dc:source publication metadata when reflowable EPUB has authored page list (impact = “serious”): epub-pagesource
+ <p>In addition to the <a href="https://daisy.github.io/ace/rules/html/">HTML rules</a>, Ace implements EPUB-specific checks. The “impact” property indicates the severity of each violation (“minor”, “moderate”, “serious”, or “critical”), as per Deque axe’s definition described in their documentation ( <a href="https://github.com/daisy/axe-core/blob/v4.7.2_DAISY/doc/issue_impact.md">https://github.com/daisy/axe-core/blob/v4.7.2_DAISY/doc/issue_impact.md</a> ).</p>
<ul>
<li>Missing metadata (impact = “serious”): <code>metadata-accessmode</code>, <code>metadata-accessibilityfeature</code>, <code>metadata-accessibilityhazard</code></li>
<li>Missing metadata (impact = “moderate”): <code>metadata-accessibilitysummary</code>, <code>metadata-accessModesufficient</code></li>
<li>Incorrect metadata values (impact = “moderate”): <code>metadata-accessibilityfeature-invalid</code>, <code>metadata-accessibilityhazard-invalid</code> (mixed positive and negative terms (e.g. <code>noFlashingHazard</code> and <code>flashing</code>), <code>unknown</code> mixed with <code>none</code> or other vocabulary values, or usage of terms not defined by the specification)</li>
<li>Incorrect metadata values (impact = “minor”): <code>metadata-accessmode-invalid</code>, <code>metadata-accessmodesufficient-invalid</code> (usage of terms not defined by the specification)</li>
<li>Missing authored page list when metadata <code>printPageNumbers</code>/<code>pageBreakMarkers</code> is present (impact = “moderate”): <code>metadata-accessibilityFeature-printPageNumbers-nopagelist</code></li>
<li>Mismatched page breaks in SMIL and in HTML documents (impact = “serious”): <code>epub-pagelist-mediaoverlays</code></li>
<li>Authored page list references elements in HTML documents that are not page breaks (impact = “minor”) or do not exist (impact = “serious”): <code>epub-pagelist-broken</code></li>
<li>Authored page list does not reference all elements that are page breaks in HTML documents (impact = serious): <code>epub-pagelist-missing-pagebreak</code></li>
<li>Mismatched authored table of contents and reading order of elements inside HTML documents (impact = “serious”): <code>epub-toc-order</code></li>
<li>Missing publication title metadata (impact = “serious”): <code>epub-title</code></li>
<li>Missing OPF lang attribute (impact = “serious”): <code>epub-lang</code></li>
<li>Missing <code>dc:source</code> / <code>pageBreakSource</code> publication metadata when reflowable EPUB has authored page list (impact = “serious”): <code>epub-pagesource</code></li>
</ul>
-
diff --git a/tags/index.html b/tags/index.html
index 96ca96df..ef383b49 100644
--- a/tags/index.html
+++ b/tags/index.html
@@ -13,12 +13,54 @@
gtag('js', new Date());
gtag('config', 'UA-327448-5');
+
-
+
skip to content
@@ -115,7 +157,7 @@
-
+
Ace, an accessibility checker for EPUB! A DAISY Consortium project. Latest version: v1.3.2
diff --git a/tags/index.xml b/tags/index.xml
index c442ebd1..9ad72a51 100644
--- a/tags/index.xml
+++ b/tags/index.xml
@@ -4,7 +4,8 @@
Tags on Ace, by DAISY
https://daisy.github.io/ace/tags/
Recent content in Tags on Ace, by DAISY
- Hugo -- gohugo.io
- en-us Hugo
+ en-us
+