Uploaded image for project: 'Derby'
  1. Derby
  2. DERBY-5135 Derby documentation needs accessibility improvements
  3. DERBY-5136

Simple accessibility fixes to frames HTML doc output



    • Sub-task
    • Status: Closed
    • Major
    • Resolution: Fixed
    • Documentation
    • None


      The frames versions of the HTML manuals have some accessibility errors that are quite easy to fix, involving the index.html file and section heads.

      The index.html file for the frames version has several errors:

      1) The <html> element lacks a lang attribute (lang="en" in this case).

      2) The <frameset> element lacks a <noframes> element telling people with browsers that don't support frames where to find an alternative version of the documentation. We can point them to the single-file HTML manual.

      3) The <frameset> and <frame> elements require title attributes.

      It is possible to fix these issues fairly easily by providing a modified version of the DITA-OT1.1.2.1/resource/index.html file and then by making some additional edits to the init and html.dita tasks in the build.xml file.

      The documentation also violates the rule that heads must appear in order. The topics in the Derby documentation generate only two HTML head tags, <h1> for the topic title and <h4> for sections. Sections cannot be nested in DITA.

      It is possible to fix this problem by providing a modified version of the DITA-OT1.1.2.1/xsl/xslhtml/dita2htmlImpl.xsl file that specifies the use of <h2> tags instead of <h4>. Section heads are always generated with the "sectiontitle" class, which is specified in the .css files, so the output seems to look the same with either head in a browser that supports stylesheets.

      I plan to file a patch for this task tomorrow.


        1. DERBY-5136-2.diff
          0.7 kB
          Camilla Haase
        2. rrefcopyright.html
          3 kB
          Camilla Haase
        3. index.html
          1 kB
          Camilla Haase
        4. DERBY-5135.stat
          0.1 kB
          Camilla Haase
        5. DERBY-5135.diff
          167 kB
          Camilla Haase



            chaase3 Camilla Haase
            chaase3 Camilla Haase
            0 Vote for this issue
            0 Start watching this issue