United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
Bug ID: JDK-4905786 Table headings in Javadoc output are not accessible - use <th> rather than <td>
JDK-4905786 : Table headings in Javadoc output are not accessible - use
rather than

Details
Type:
Bug
Submit Date:
2003-08-13
Status:
Resolved
Updated Date:
2003-11-23
Project Name:
JDK
Resolved Date:
2003-11-23
Component:
docs
OS:
generic
Sub-Component:
doclet
CPU:
generic
Priority:
P3
Resolution:
Fixed
Affected Versions:
1.4.2
Fixed Versions:
5.0 (b30)

Related Reports

Sub Tasks

Description
Name: dk106046			Date: 08/13/2003

NOTE: This request is based on a liberal interpretation of the U.S. Federal 
Government 508 Standard.

Documentation generated by javadoc has an accessbility problem because table headings are 
represented as <td> instead of <th>.
This has an accessbility problem because table headings are represented as <td> instead of <th>, 
and as such assistive technologies cannot distinguish headings from other table data.

Recreation Steps::

For any packages, generate javadoc using the javadoc command
For example, from D:\cn131-20020821\src\classes\sov directory run the following command:
javadoc -d e:\docs -sourcepath . java.util javax.swing java.io

Cause of  the problem::
<TH> tag is never used in the javadoc. <TD> tag was used instead of <TH> tag.

[This bug is being submitted as a courtesy, in order to maintain uniformity between Sun & IBM JDKs.  It has been fixed in IBM JDKs.  Please contact ###@###.### if you have questions.]
======================================================================

                                    

Comments
EVALUATION

This would be a variant of section 508(g) "Row and column headers shall be
identified for data tables" (these are not data tables -- they are
layout tables with headers).

Using <th> would apply to all tables that have headings:

Overview Page (overview-summary.html)
   "Java 2 Platform Packages" table (lists all package names)

Package Page (package-summary.html)
    "Interface Summary" table
    "Class Summary" table
    "Exception Summary" table
    "Error Summary" table
    etc. 

Class/Interface Page
    "Nested Class Summary" table
    "Nested classes inherited from class XXX" table
    "Field Summary" table
    "Fields inherited from class XXX" table
    etc.

Use Page
    "Packages that use XXX"
    "Uses of XXX in java.xxx"
    etc.

Deprecated Page
    "Deprecated Classes" table
    "Deprecated Interfaces" table
    etc.

Constant Values Page
    "java.xxx.*"
    "java.xxx.XXX"
    etc.
      NOTE: All data on this page is in tables with no borders.
      <th> should be applied to the header of each of these tables

Serialized Form Page
    "Package xxx"
    "Class XXX extends XXX implements Serializable"
    "Serialization Methods"
    "Serialized Fields"
    etc.
       NOTE: All tables on this page are single cell and act as headings.
       Table characteristics for single-cell tables are typically
       ignored by screen readers.
       Could change <td> to <th> if easy to do so, as they are all headings.

Overview Frame (upper-left frame, overview-frame.html)
    "Java 2 Platform Std. Ed. 1.4.2" 
       NOTE: The above heading is in a single-cell table.
       The <th> could be applied to it.
       The rest of the content ("All Classes" link and "Packages" AND list of 
       package names) are all in a single-cell table, so should *not* get the 
       <th> tag.

All Classes Frame (lower-left frame, all-classes.html)
     "All Clases"
       NOTE: The heading "All Classes" is not in a table.
       The rest of the frame (the list of classes) is in a single-cell table,
       so should *not* get the <th> tag.

Package Frame (lower-left frame, package-frame.html)
    "java.xxx"
       NOTE: The "java.applet" heading is not in a table.
       Each subsequent heading ("Interfaces", "Classes")
       AND its content is in a single-cell table, so should *not* get 
       the <th> tag.

###@###.### 2003-08-28

Fixed. Now using <TH> in headings.
###@###.### 2003-11-15
                                     
2003-08-28
PUBLIC COMMENTS

Fixed.  Now using <TH> for headings.
###@###.### 2003-11-15
                                     
2003-11-15
CONVERTED DATA

BugTraq+ Release Management Values

COMMIT TO FIX:
tiger
tiger-beta

FIXED IN:
tiger-beta

INTEGRATED IN:
tiger-b30
tiger-beta


                                     
2004-06-14



Hardware and Software, Engineered to Work Together