Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-7198274

RFE : Javadoc Accessibility : Use CSS styles rather than <strong> or <i> tags

    Details

    • Subcomponent:
    • Resolved In Build:
      b103
    • CPU:
      generic
    • OS:
      generic

      Description

      SYNOPSIS
      --------
      Accessibility in Javadoc: Use CSS styles rather than <strong> or <i> tags


      OPERATING SYSTEM
      ----------------
      ALL


      PATCH BASE
      ---------
      See attached webrev for code changes and jtreg testcase, based on JDK 8 (b51).


      FULL JDK VERSION
      ----------------
      JDK 7, JDK 8


      DESCRIPTION from LICENSEE
      -------------------------
      Accessibility tools rely on header elements (h1, h2, h3 etc.) to determine the structure of a page. They also interpret <strong> and <i> elements in a similar way.

      Currently, the javadoc tool generates HTML with <strong> and <i> elements which can confuse accessibility tools, which interpret these tags as headers. The code should be corrected to generate HTML that uses CSS to define text style, to retain the visual appearance without upsetting accessibility tools.

      Related guideline references:

        WCAG 2.0 checkpoint 1.3.1

      References:

        http://www.w3.org/TR/WCAG20/
        http://publib.boulder.ibm.com/infocenter/asehelp/v5r5m0/index.jsp?topic=%2Fcom.ibm.ase.cshelp.doc%2Ftopics%2Fidhi_accessibility_check_g322.html


      REPRODUCTION INSTRUCTIONS
      -------------------------
      For any packages, generate javadoc using the javadoc command

        javadoc -d e:\docs -sourcepath . java.util javax.swing java.io

      Example current HTML:
      <div class="block"><i>This method has been deprecated.</i></div>

      Example expected HTML:
      <div class="deprecatedDetail">This method has been deprecated.</div> (The deprecatedetail style is defined to be italic)


      WORKAROUND
      ----------
      NONE

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                bpatel Bhavesh Patel (Inactive)
                Reporter:
                dkorbel David Korbel (Inactive)
              • Votes:
                0 Vote for this issue
                Watchers:
                6 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:
                  Imported:
                  Indexed: