Java Solaris Communities Sun Store Join SDN My Profile Why Join?
 
Bug Database
Bug Detail
Quick Lists
Top 25 Bugs
Top 25 RFE's
Recently Closed Bugs
Printable Page Printable Page


Bug Database
Bug ID: 4905786
Votes 0
Synopsis Table headings in Javadoc output are not accessible - use <th> rather than <td>
Category doclet:tbd
Reported Against 1.4.2
Release Fixed 1.5(tiger-b30)
State 10-Fix Delivered, bug
Priority: 3-Medium
Related Bugs
Submit Date 13-AUG-2003
Description
Fixed.  Now using <TH> for headings.
 xxxxx@xxxxx  2003-11-15

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 &  xxxxx  JDKs.  It has been fixed in  xxxxx  JDKs.  Please contact  xxxxx@xxxxx  if you have questions.]
======================================================================
Work Around
N/A
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.

 xxxxx@xxxxx  2003-08-28

Fixed. Now using <TH> in headings.
 xxxxx@xxxxx  2003-11-15
Comments
  
  Include a link with my name & email   

Submitted On 13-SEP-2005
<Not sure if this is a duplicate> I am using 1.4.2 so am stuck with the <TD> (for now). According to this writeup, Sun doesn't consider this a Section 508 violation because the Javadoc tables are "layout" tables. However, what defines it as a layout table? It was my understanding that to be a layout table it had to have summary="layout" -- at least that is what the accessibility test tool that I am using uses as part of its alorithm. And the Javadoc tables have summary="". 



PLEASE NOTE: JDK6 is formerly known as Project Mustang