Details

    • Type: Sub-task Sub-task
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 10.7.1.1
    • Fix Version/s: 10.8.1.2
    • Component/s: Documentation
    • Labels:
      None

      Description

      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. rrefcopyright.html
        3 kB
        Kim Haase
      2. index.html
        1 kB
        Kim Haase
      3. DERBY-5136-2.diff
        0.7 kB
        Kim Haase
      4. DERBY-5135.stat
        0.1 kB
        Kim Haase
      5. DERBY-5135.diff
        167 kB
        Kim Haase

        Activity

        Kim Haase created issue -
        Kim Haase made changes -
        Field Original Value New Value
        Attachment DERBY-5135.diff [ 12473812 ]
        Attachment DERBY-5135.stat [ 12473813 ]
        Attachment index.html [ 12473814 ]
        Attachment rrefcopyright.html [ 12473815 ]
        Kim Haase made changes -
        Issue & fix info [Patch Available]
        Kim Haase made changes -
        Status Open [ 1 ] Resolved [ 5 ]
        Issue & fix info [Patch Available]
        Fix Version/s 10.8.0.0 [ 12315561 ]
        Resolution Fixed [ 1 ]
        Kim Haase made changes -
        Status Resolved [ 5 ] Reopened [ 4 ]
        Resolution Fixed [ 1 ]
        Kim Haase made changes -
        Attachment DERBY-5136-2.diff [ 12475520 ]
        Kim Haase made changes -
        Issue & fix info [Patch Available]
        Kim Haase made changes -
        Status Reopened [ 4 ] Resolved [ 5 ]
        Issue & fix info [Patch Available]
        Resolution Fixed [ 1 ]
        Rick Hillegas made changes -
        Fix Version/s 10.8.1.1 [ 12316356 ]
        Fix Version/s 10.8.1.0 [ 12315561 ]
        Rick Hillegas made changes -
        Fix Version/s 10.8.1.2 [ 12316362 ]
        Fix Version/s 10.8.1.1 [ 12316356 ]
        Kim Haase made changes -
        Status Resolved [ 5 ] Closed [ 6 ]
        Gavin made changes -
        Workflow jira [ 12607775 ] Default workflow, editable Closed status [ 12801044 ]

          People

          • Assignee:
            Kim Haase
            Reporter:
            Kim Haase
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development