United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
Bug ID: JDK-4706779 stddoclet: Add text equivalent of ASCII art in class tree for accessibility
JDK-4706779 : stddoclet: Add text equivalent of ASCII art in class tree for accessibility

Details
Type:
Enhancement
Submit Date:
2002-06-22
Status:
Resolved
Updated Date:
2002-09-28
Project Name:
JDK
Resolved Date:
2002-09-28
Component:
docs
OS:
solaris_2.5,other
Sub-Component:
doclet
CPU:
sparc,generic
Priority:
P4
Resolution:
Fixed
Affected Versions:
1.2.0,1.4.0
Fixed Versions:
1.4.2 (mantis)

Related Reports
Duplicate:

Sub Tasks

Description
The ASCII class trees need equivalent text.

  Priority 1
  Section 508 1194.22(a)
      A text equivalent for every non-text element shall be provided 
      (e.g., via "alt", "longdesc", or in element content)
  W3C Checkpoint 1.1
       http://www.w3.org/TR/WCAG10-CORE-TECHS/#text-equivalent
       "Text equivalents mus be provided for every non-text element ... 
        This includes ASCII art..."

The ASCII art under consideration is the vertical line, horizontal line 
and plus sign:

   java.lang.Object
    |
    +--java.lang.String

                                    

Comments
EVALUATION

Important for accessibility.
###@###.### 2002-06-22

There are two ways to resolve this:

- Put a <MAP title="xxx"> element around each piece of ASCII art,
  similar to that recommended for grouping links in a navigation bar
- Replace the ASCII art with an image <IMG src="inherit.gif" alt="xxx">

The second approach would also make the appearance better, a long-needed 
enhancement.

###@###.### 2002-08-22

> What should the alt text be?
>
> The alt text should make sense when spoken by an accessibility program
> to a non-sighted user in the context of the words before and after it.
> For example, the above would be spoken as:
>
>   "java-dot-lang-dot-Object is extended by com-dot-package-dot-Class1"
>
> Unfortunately, this is the reverse of the way we normally speak it.
>
> A) "is extended by" in all cases
> B) Insert different strings for an interface "implemented by" a class
>    compared to an interface "extended by" an interface,
>    and a class "extended by" a class.
> C) Drop the word "is" in proposal A or B:  "extended by", "implemented by"
> D) Other proposals?

  I vote C.  I'd *definitely* distinguish extended and implemented.  I agree
that the "is" seems unnecessary, but I could go either way on it.

            Regards,

            ###@###.###

Conclusion for alt text:
  interface "implemented by" class
  interface "extended by" interface
  class "extended by" class

###@###.### 2002-08-27

Decided to create a resources directory in the destination directory
to hold non-HTML files that come from the source tree resources directory,
such as inherit.gif and stylesheet.css.  Equivalent to what is used in 
the MIF Doclet.

###@###.### 2002-08-29
                                     
2002-08-29
CONVERTED DATA

BugTraq+ Release Management Values

COMMIT TO FIX:
mantis

FIXED IN:
mantis

INTEGRATED IN:
mantis
mantis-b03


                                     
2004-06-14



Hardware and Software, Engineered to Work Together