Derby
  1. Derby
  2. DERBY-5362

HTML frameset files lack closing newline character

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 10.8.1.2
    • Fix Version/s: 10.8.2.2, 10.9.1.0
    • Component/s: Documentation
    • Labels:
      None

      Description

      The HTML frameset files are generated without a newline at the end of the file. This can be remedied with a one-line change to the dita2htmlImpl.xsl and map2htmtoc.xsl files.

      The HTML Book file also lacks a final newline, but tangling with that is beyond my powers. (In fact, that file is so lacking in newlines that it is virtually unreadable, and the vi editor cannot handle it.)

      1. DERBY-5362.diff
        0.8 kB
        Kim Haase
      2. DERBY-5362.stat
        0.1 kB
        Kim Haase
      3. rgscopyright.html
        3 kB
        Kim Haase

        Activity

        Hide
        Kim Haase added a comment -

        Well, I guess it's just one of those mysteries. I'm on Solaris 10. I see the correct file endings when I process the files myself. But if I right-click and do Save Frame As... from the alpha docs on the web site, the endings are wrong. The file/frame info says they were all processed on Aug. 9.

        Show
        Kim Haase added a comment - Well, I guess it's just one of those mysteries. I'm on Solaris 10. I see the correct file endings when I process the files myself. But if I right-click and do Save Frame As... from the alpha docs on the web site, the endings are wrong. The file/frame info says they were all processed on Aug. 9.
        Hide
        Kristian Waagan added a comment -

        I'm on a Unix system, more specifically Solaris 11.
        Using the technique with tail the file prints fine (i.e. "<html>" on a separate line, followed by the prompt).

        I also get this on the ASF host:
        $ tail toc.html
        <li><a href="rrefidlengthlimits.html">Limitations on identifier length</a></li>
        <li><a href="rrefnumericlimits.html">Numeric limitations</a></li>
        <li><a href="rrefstringlimits.html">String limitations</a></li>
        <li><a href="rreflimitsxml.html">XML limitations</a></li>
        </ul>
        </li>
        <li><a href="rreftrademderby.html">Trademarks</a></li>
        </ul>
        </body>
        </html>
        $

        On 10.7, I do see the issue:
        $ tail toc.html
        <LI><a href="rrefidlengthlimits.html">Limitations on identifier length</a></LI>
        <LI><a href="rrefnumericlimits.html">Numeric limitations</a></LI>
        <LI><a href="rrefstringlimits.html">String limitations</a></LI>
        <LI><a href="rreflimitsxml.html">XML limitations</a></LI>
        </UL>
        </LI>
        <LI><a href="rreftrademderby.html">Trademarks</a></LI>
        </UL>
        </body>
        </html>$

        Show
        Kristian Waagan added a comment - I'm on a Unix system, more specifically Solaris 11. Using the technique with tail the file prints fine (i.e. "<html>" on a separate line, followed by the prompt). I also get this on the ASF host: $ tail toc.html <li><a href="rrefidlengthlimits.html">Limitations on identifier length</a></li> <li><a href="rrefnumericlimits.html">Numeric limitations</a></li> <li><a href="rrefstringlimits.html">String limitations</a></li> <li><a href="rreflimitsxml.html">XML limitations</a></li> </ul> </li> <li><a href="rreftrademderby.html">Trademarks</a></li> </ul> </body> </html> $ On 10.7, I do see the issue: $ tail toc.html <LI><a href="rrefidlengthlimits.html">Limitations on identifier length</a></LI> <LI><a href="rrefnumericlimits.html">Numeric limitations</a></LI> <LI><a href="rrefstringlimits.html">String limitations</a></LI> <LI><a href="rreflimitsxml.html">XML limitations</a></LI> </UL> </LI> <LI><a href="rreftrademderby.html">Trademarks</a></LI> </UL> </body> </html>$
        Hide
        Kim Haase added a comment -

        Yes, I looked at both of them, but they are still not right. Are you on a Unix system? The files look OK on Windows, but not on Unix.

        Show
        Kim Haase added a comment - Yes, I looked at both of them, but they are still not right. Are you on a Unix system? The files look OK on Windows, but not on Unix.
        Hide
        Kristian Waagan added a comment -

        Thanks, Kim.

        From what I can see, toc.html is fine. So is the rrefcopyright.html file. I downloaded both from the dev ref manual.

        Show
        Kristian Waagan added a comment - Thanks, Kim. From what I can see, toc.html is fine. So is the rrefcopyright.html file. I downloaded both from the dev ref manual.
        Hide
        Kim Haase added a comment -

        Hi, Kristian,

        The map2htmtoc.xsl file should be 16234 bytes in size, and line 89
        should look like this

        </html><xsl:value-of select="$newline"/>

        instead of like this:

        </html>

        If you download a page of a manual (the frame file toc.html or any
        individual topic) and run it through "tail" it should be clear that
        there is no newline at the end, since the prompt is on the same line as
        the closing html tag. For example:

        jdench 58 =>tail toc.html
        </li>
        <li><a
        href="http://db.apache.org/derby/docs/dev/getstart/cgslib19524.html">Derby
        libraries and scripts: complete reference</a>
        <ul>
        <li><a
        href="http://db.apache.org/derby/docs/dev/getstart/rgslib46043.html">Libraries
        provided by Derby</a></li>
        <li><a
        href="http://db.apache.org/derby/docs/dev/getstart/rgslib27507.html">Scripts
        included with Derby</a></li>
        </ul>
        </li>
        <li><a
        href="http://db.apache.org/derby/docs/dev/getstart/rgstrademderby.html">Trademarks</a></li>
        </ul>
        </body></html> jdench 59 =>

        I couldn't see anything at the link you sent – I got an "Error: no
        workspace" page. I don't think I can log in to that place.

        Kim

        Show
        Kim Haase added a comment - Hi, Kristian, The map2htmtoc.xsl file should be 16234 bytes in size, and line 89 should look like this </html><xsl:value-of select="$newline"/> instead of like this: </html> If you download a page of a manual (the frame file toc.html or any individual topic) and run it through "tail" it should be clear that there is no newline at the end, since the prompt is on the same line as the closing html tag. For example: jdench 58 =>tail toc.html </li> <li><a href="http://db.apache.org/derby/docs/dev/getstart/cgslib19524.html">Derby libraries and scripts: complete reference</a> <ul> <li><a href="http://db.apache.org/derby/docs/dev/getstart/rgslib46043.html">Libraries provided by Derby</a></li> <li><a href="http://db.apache.org/derby/docs/dev/getstart/rgslib27507.html">Scripts included with Derby</a></li> </ul> </li> <li><a href="http://db.apache.org/derby/docs/dev/getstart/rgstrademderby.html">Trademarks</a></li> </ul> </body></html> jdench 59 => I couldn't see anything at the link you sent – I got an "Error: no workspace" page. I don't think I can log in to that place. Kim
        Hide
        Kristian Waagan added a comment -

        I don't have a clue. I wiped the workspace and rebuilt the docs yesterday (9th). Doesn't the xsl file(s) look ok? [1]

        It isn't quite clear to me how to verify if the fix made a difference or not in the published docs. I can't even see the difference between the copyright file attached and the one from for instance the 10.7 docs, so maybe you could check the redeployed files again?

        [1] https://builds.apache.org/view/A-F/view/Derby/job/Derby-docs/ws/trunk/lib/map2htmtoc.xsl/*view*/

        Show
        Kristian Waagan added a comment - I don't have a clue. I wiped the workspace and rebuilt the docs yesterday (9th). Doesn't the xsl file(s) look ok? [1] It isn't quite clear to me how to verify if the fix made a difference or not in the published docs. I can't even see the difference between the copyright file attached and the one from for instance the 10.7 docs, so maybe you could check the redeployed files again? [1] https://builds.apache.org/view/A-F/view/Derby/job/Derby-docs/ws/trunk/lib/map2htmtoc.xsl/*view*/
        Hide
        Kim Haase added a comment -

        The changes made in this JIRA don't seem to be reflected in the latest doc builds on the Derby site – that is, the HTML files still lack newlines. Is there some reason why these files in the lib directory were not updated on the site?

        Show
        Kim Haase added a comment - The changes made in this JIRA don't seem to be reflected in the latest doc builds on the Derby site – that is, the HTML files still lack newlines. Is there some reason why these files in the lib directory were not updated on the site?
        Hide
        Kim Haase added a comment -

        Thanks, Dag!

        Committed patch DERBY-5362.diff to documentation trunk at revision 1152860.
        Merged to 10.8 doc branch at revision 1152862.

        Show
        Kim Haase added a comment - Thanks, Dag! Committed patch DERBY-5362 .diff to documentation trunk at revision 1152860. Merged to 10.8 doc branch at revision 1152862.
        Hide
        Dag H. Wanvik added a comment -

        Looks like a clean and simple fix, although I have no idea how it works..

        Show
        Dag H. Wanvik added a comment - Looks like a clean and simple fix, although I have no idea how it works..
        Hide
        Kim Haase added a comment -

        Attaching DERBY-5362.diff, DERBY-5362.stat, and a sample output file showing the newline. The changes are to

        M lib/dita2htmlImpl.xsl
        M lib/map2htmtoc.xsl

        Show
        Kim Haase added a comment - Attaching DERBY-5362 .diff, DERBY-5362 .stat, and a sample output file showing the newline. The changes are to M lib/dita2htmlImpl.xsl M lib/map2htmtoc.xsl

          People

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

            Dates

            • Created:
              Updated:
              Resolved:

              Development