Bug ID: JDK-8184223 Fix accessibility of JavaFX docs

Type: Bug
Component: javafx
Sub-Component: accessibility
Affected Version: 9

Priority: P3
Status: Resolved
Resolution: Fixed

Submitted: 2017-07-12
Updated: 2019-02-20
Resolved: 2017-10-24

JDK 10
10Fixed

All our docs, including API docs, need to be accessible.

Although many checks are subjective and hence manual, some are more easily automated.

Two issues for JavaFX.

All files should declare a default language, in the <html> tag, like this:
  <html lang="en">
One standalone HTML file does not do so.

All tables should should arrange to have row headers and column headers that can be used by screen readers to identify data cells. Generally speaking, each row and each column should have at least one header cell (<th>) wth the scope attribute set to "row" or "col" as appropriate. This may mean changing a data cell (<td>) in each row  to a header cell. Use CSS to compensate, if you don't want to change the appearance.
Accessibility Report

  1778 files checked
     1 files did not specify a default language
       All files specified a title

Accessibility: Tables Report

Checked 5192 tables in 1778 files.

<unset>              41     0   0%
csspropertytable    104     0   0%
html4colortable       1     0   0%
memberSummary      1815  1815 100%
overviewSummary       4     0   0%
package              10     0   0%
packagesSummary      13    13 100%
requiresSummary       7     7 100%
typeSummary          80    80 100%
useSummary         3117  3117 100%
TOTAL              5192  5032  96%

Changeset: 6c40427a4237 Author: jgiles Date: 2017-10-24 14:33 -0700 URL: http://hg.openjdk.java.net/openjfx/10-dev/rt/rev/6c40427a4237 8184223: Fix accessibility of JavaFX docs Reviewed-by: jjg, kcr
24-10-2017
While reviewing the look of all of the tables, I found a few unwanted differences. There were two main problems: 1. The use of <th scope="row"> caused the first column of most of the tables to appear in the same style as the table header 2. A small number of tables had missing or misplaced thead versus tbody tags. 3. The cellspacing and cellpadding removed in JDK-8184220 caused the tables to look cramped. Here is a webrev with the delta from the v1 version: http://cr.openjdk.java.net/~kcr/8184223/delta.01.02/ Here is the patched cssref.html file for browsing: http://cr.openjdk.java.net/~kcr/8184223/webrev.02/raw_files/new/modules/javafx.graphics/src/main/docs/javafx/scene/doc-files/cssref.html For completeness, here is the full v2 webrev: http://cr.openjdk.java.net/~kcr/8184223/webrev.02/
24-10-2017
The delta webrev looks good.
17-10-2017
Updated webrev with a few items fixed up: http://cr.openjdk.java.net/~kcr/8184223/webrev.01/ Here is the delta from the original version: http://cr.openjdk.java.net/~kcr/8184223/delta.00.01/ This includes a fix by Jon Gibbons to redo the color table in cssref.html so it flows nicely, as well as addressing various other feedback. I also reverted the spurious whitespace changes from the original version.
12-10-2017
Webrev for review: http://cr.openjdk.java.net/~jgiles/8184223/index.html This removes all a11y issues reported.
26-09-2017
I have a fix locally that resolves the identified issues (as best as I can tell). Once JDK-8184220 is merged, I will put a webrev up for this issue.
03-09-2017
See http://cr.openjdk.java.net/~jjg/doc-report/javafx-combined/accessibility.log for a horribly verbose list of issues. In general, for each file listed, scan for the use of "<table", then visually inspect for use of either "scope=row\|col" attributes (for most tables) or "<th id="/"<td headers=" for really complex/irregular tables.
23-08-2017
Updated report: I'm sorry I cant use monospace font here. Accessibility Report Details 1777 files checked All files specified a default language All files specified a title Accessibility: Tables Report Details Checked 5192 tables in 1777 files. <unset> 41 0 0% <<<<<====== 41 tables, with no declared style class, have some accessibility issues csspropertytable 104 13 12% <<<<<====== of 104 tables, class=csspropertytable, 13 are OK, the rest have some accessibility issues html4colortable 1 0 0% <<<===== 1 table needs attention memberSummary 1815 1815 100% overviewSummary 4 0 0% <<<===== 4 table need attention package 10 0 0% <<<===== 10 table need attention packagesSummary 13 13 100% requiresSummary 7 7 100% typeSummary 80 80 100% useSummary 3117 3117 100% TOTAL 5192 5045 97%
23-08-2017

Blocks :	JDK-8180066 - Convert package.html files to package-info.java
Relates :	JDK-8184220 - Fix tidy issues in JavaFX docs
Relates :	JDK-8184221 - Update remaining JavaFX docs to HTML 5