United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
Bug ID: JDK-4636667 stddoclet: Use <H1>, <H2>, <H3> in proper sequence for accessibility
JDK-4636667 : stddoclet: Use

,

,

in proper sequence for accessibility


Details
Type:
Enhancement
Submit Date:
2002-02-12
Status:
Resolved
Updated Date:
2002-09-28
Project Name:
JDK
Resolved Date:
2002-09-28
Component:
docs
OS:
generic
Sub-Component:
doclet
CPU:
generic
Priority:
P4
Resolution:
Fixed
Affected Versions:
1.4.0
Fixed Versions:
1.4.2 (mantis)

Related Reports

Sub Tasks

Description
Sections should be introduced with the HTML heading elements (H1-H6). 

  Priority 2
  NOT a Section 508 requirement, but is a W3C recommendation
  W3C Checkpoint 3.5
     http://www.w3.org/TR/WCAG10-HTML-TECHS/#document-headers
     "Sections should be introduced with the HTML heading elements (H1-H6)"
      H2 elements should follow H1 elements, H3 elements should follow H2 
      elements, etc. Content developers should not "skip" levels 
      (e.g., H1 directly to H3)."

Change the header elements so they appear in sequence <H1>, <H2>, <H3>.  
As of 1.4.0, <H2> appears on the Overview page, each package page
contains <H2>, and each class page contains <H2> and <H3>.

This can be fixed by changing the overview page to <H1>, as that
contains the title of the entire document.

Because doing this will increase the size of the overview title font, 
it is important to also add a style definition to set its font sizes 
to be similar in size to the existing Javadoc output.

                                    

Comments
EVALUATION

Important and easy to do for accessibility. I only affects
the overview-summary page, which has <H2> but should have <H1>.
###@###.### 2002-02-12

If we replace <H2> with <H1> on the overview page, the title
will be larger than it was, and some title will not fit on 
the line as they had previously.  The default <H1> is too large
of a font for the title.  

To get the same size font on Mozilla 1.0 and Internet Explorer 6 
requires setting the font size of H1 to 145% of the body font.
The font size is ignored by Netscape 4.x, so will just have to
stay larger in that browser.  So use this:

<H1 style="font-size: 140%">
Document Title
</H1>

Or, better yet, set the size in stylesheet.css, since there will
be only one occurrence of <H1>:

/* Headings */
h1 { font-size: 145% }

###@###.### 2002-09-04
                                     
2002-09-04
PUBLIC COMMENTS

Fixed by changing overview-summary.html page to:

<H1>
Document Title
</H1>

and adding this to stylesheet.css 

/* Headings */
h1 { font-size: 145% }

Regression test at <ws>/test/com/sun/javadoc/AccessH1/AccessH1.java

###@###.### 2002-09-05
                                     
2002-09-05
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