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

        Activity

        Gavin made changes -
        Workflow jira [ 12607775 ] Default workflow, editable Closed status [ 12801044 ]
        Kim Haase made changes -
        Status Resolved [ 5 ] Closed [ 6 ]
        Hide
        Kim Haase added a comment -

        Changes have appeared in 10.8 and alpha docs.

        Show
        Kim Haase added a comment - Changes have appeared in 10.8 and alpha docs.
        Rick Hillegas made changes -
        Fix Version/s 10.8.1.2 [ 12316362 ]
        Fix Version/s 10.8.1.1 [ 12316356 ]
        Rick Hillegas made changes -
        Fix Version/s 10.8.1.1 [ 12316356 ]
        Fix Version/s 10.8.1.0 [ 12315561 ]
        Kim Haase made changes -
        Status Reopened [ 4 ] Resolved [ 5 ]
        Issue & fix info [Patch Available]
        Resolution Fixed [ 1 ]
        Hide
        Kim Haase added a comment -

        Committed patch DERBY-5136-2.diff to documentation trunk at revision 1089207.
        Merged to 10.8 doc branch at revision 1089210.

        Show
        Kim Haase added a comment - Committed patch DERBY-5136 -2.diff to documentation trunk at revision 1089207. Merged to 10.8 doc branch at revision 1089210.
        Kim Haase made changes -
        Issue & fix info [Patch Available]
        Kim Haase made changes -
        Attachment DERBY-5136-2.diff [ 12475520 ]
        Hide
        Kim Haase added a comment -

        Attaching DERBY-5136-2.diff, with the change to the line in build.xml.

        I plan to commit this patch shortly.

        Show
        Kim Haase added a comment - Attaching DERBY-5136 -2.diff, with the change to the line in build.xml. I plan to commit this patch shortly.
        Kim Haase made changes -
        Status Resolved [ 5 ] Reopened [ 4 ]
        Resolution Fixed [ 1 ]
        Hide
        Kim Haase added a comment -

        Part of the build.xml init task, the dita.regex target, makes a change to the DITA-OT1.1.2.1/xsl/xslhtml/dita2htmlImpl.xsl file before the copy task copies the fixed version from lib. This means that by default, in a freshly checked out workspace, the copy is not done because the version in DITA-OT1.1.2.1/xsl/xslhtml is newer than the one in lib.

        To fix this, the copy task needs to have the overwrite parameter set:

        <copy file="$

        {dita.lib.dir}

        /dita2htmlImpl.xsl" todir="$

        {dita.dir}

        /xsl/xslhtml" overwrite="true"/>

        Show
        Kim Haase added a comment - Part of the build.xml init task, the dita.regex target, makes a change to the DITA-OT1.1.2.1/xsl/xslhtml/dita2htmlImpl.xsl file before the copy task copies the fixed version from lib. This means that by default, in a freshly checked out workspace, the copy is not done because the version in DITA-OT1.1.2.1/xsl/xslhtml is newer than the one in lib. To fix this, the copy task needs to have the overwrite parameter set: <copy file="$ {dita.lib.dir} /dita2htmlImpl.xsl" todir="$ {dita.dir} /xsl/xslhtml" overwrite="true"/>
        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 ]
        Hide
        Kim Haase added a comment -

        Committed patch DERBY-5135.diff (wrong name) to documentation trunk at revision 1082984.

        Show
        Kim Haase added a comment - Committed patch DERBY-5135 .diff (wrong name) to documentation trunk at revision 1082984.
        Kim Haase made changes -
        Issue & fix info [Patch Available]
        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 ]
        Hide
        Kim Haase added a comment -

        Attaching DERBY-5135.diff, DERBY-5135.stat, and two files that show the changes: out/ref/index.html and out/ref/rrefcopyright.html.

        The patch involves adding two modified files to the lib directory to be copied into the DITA-OT1.1.2.1 area.

        A changed index.html file is copied from lib into DITA-OT1.1.2.1/resource. This file differs from the previous version as follows:

        < <html>

        > <html lang="en">
        7,9c7,15
        < <frameset cols="40%,*">
        < <frame name="navwin" src="toc.html" />
        < <frame name="contentwin" src="about:blank" scrolling="auto" />

        > <frameset title="Web Sample" cols="40%,*">
        > <noframes>
        > <body>
        > <p><a href="SAMPLE-single.html">Go to a non-frames version of
        > this content.</a></p>
        > </body>
        > </noframes>
        > <frame title="Table of Contents" name="navwin" src="toc.html" />
        > <frame title="Pages" name="contentwin" src="about:blank" scrolling="auto" />

        A changed dita2htmlImpl.xsl is copied from lib into DITA-OT1.1.2.1/xsl/xslhtml. This file differs from the previous version as follows:

        2798c2798
        < <h4 class="sectiontitle"><xsl:value-of select="@spectitle"/></h4>

        > <h2 class="sectiontitle"><xsl:value-of select="@spectitle"/></h2>
        2802c2802
        < <h4 class="sectiontitle"><xsl:value-of select="$defaulttitle"/></h4>

        > <h2 class="sectiontitle"><xsl:value-of select="$defaulttitle"/></h2>
        2809c2809
        < <h4 class="sectiontitle">

        > <h2 class="sectiontitle">
        2812c2812
        < </h4>

        > </h2>

        (Note: @spectitle is an attribute of the section element that is not used in documents but can be used by "architects of specialized types.")

        The patch also makes three small changes to build.xml: two to copy these files to the appropriate locations, and one to edit index.html to provide the correct name for the one-page HTML book.

        Show
        Kim Haase added a comment - Attaching DERBY-5135 .diff, DERBY-5135 .stat, and two files that show the changes: out/ref/index.html and out/ref/rrefcopyright.html. The patch involves adding two modified files to the lib directory to be copied into the DITA-OT1.1.2.1 area. A changed index.html file is copied from lib into DITA-OT1.1.2.1/resource. This file differs from the previous version as follows: < <html> — > <html lang="en"> 7,9c7,15 < <frameset cols="40%,*"> < <frame name="navwin" src="toc.html" /> < <frame name="contentwin" src="about:blank" scrolling="auto" /> — > <frameset title="Web Sample" cols="40%,*"> > <noframes> > <body> > <p><a href="SAMPLE-single.html">Go to a non-frames version of > this content.</a></p> > </body> > </noframes> > <frame title="Table of Contents" name="navwin" src="toc.html" /> > <frame title="Pages" name="contentwin" src="about:blank" scrolling="auto" /> A changed dita2htmlImpl.xsl is copied from lib into DITA-OT1.1.2.1/xsl/xslhtml. This file differs from the previous version as follows: 2798c2798 < <h4 class="sectiontitle"><xsl:value-of select="@spectitle"/></h4> — > <h2 class="sectiontitle"><xsl:value-of select="@spectitle"/></h2> 2802c2802 < <h4 class="sectiontitle"><xsl:value-of select="$defaulttitle"/></h4> — > <h2 class="sectiontitle"><xsl:value-of select="$defaulttitle"/></h2> 2809c2809 < <h4 class="sectiontitle"> — > <h2 class="sectiontitle"> 2812c2812 < </h4> — > </h2> (Note: @spectitle is an attribute of the section element that is not used in documents but can be used by "architects of specialized types.") The patch also makes three small changes to build.xml: two to copy these files to the appropriate locations, and one to edit index.html to provide the correct name for the one-page HTML book.
        Kim Haase created issue -

          People

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

            Dates

            • Created:
              Updated:
              Resolved:

              Development