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

Html files in doc-files directories should be wrapped with standard header and footer

    Details

    • Type: Enhancement
    • Status: Resolved
    • Priority: P3
    • Resolution: Fixed
    • Affects Version/s: 9
    • Fix Version/s: 10
    • Component/s: tools

      Description

      Currently, all files in doc-files sub-directories are simply copied to the output directory, including HTML files.
      It would be better to wrap such pages with a standard header and footer, this also implies that these
      files will get the copyright files wrapping if any, and these are specified with -top, -bottom options.
      The header/footer described above really translates to -top/-bottom of the javadoc options.

      There are several advantages, such as copyright wrapping html validation via doclint, etc.

      All other files besides .html/.htm files will be copied to the output as-is.

        Issue Links

          Activity

          Hide
          ksrini Kumar Srinivasan added a comment - - edited
          There are 4 things involved top/bottom, header/footer, I am assuming that top/bottom are
          the wrappers for the doc-files, please see screenshot.
          Show
          ksrini Kumar Srinivasan added a comment - - edited There are 4 things involved top/bottom, header/footer, I am assuming that top/bottom are the wrappers for the doc-files, please see screenshot.
          Hide
          jjg Jonathan Gibbons added a comment -
          I was using "standard header and footer" in the general sense of the stuff that appears at the top and bottom of each page, not in the more limited sense of the javadoc options.
          Show
          jjg Jonathan Gibbons added a comment - I was using "standard header and footer" in the general sense of the stuff that appears at the top and bottom of each page, not in the more limited sense of the javadoc options.
          Hide
          ksrini Kumar Srinivasan added a comment -
          This effort involves the following things:
          1. Make doc-file copying a first class javadoc citizen, have a builder, writer etc.
          2. Wrapping must be done on all .html, .html and .txt files pass through other files types.
          3. Apply javascript checks for the generated html files.
          4. If possible, address css inclusion in the .html files, if any.
          Show
          ksrini Kumar Srinivasan added a comment - This effort involves the following things: 1. Make doc-file copying a first class javadoc citizen, have a builder, writer etc. 2. Wrapping must be done on all .html, .html and .txt files pass through other files types. 3. Apply javascript checks for the generated html files. 4. If possible, address css inclusion in the .html files, if any.
          Show
          ksrini Kumar Srinivasan added a comment - http://mail.openjdk.java.net/pipermail/javadoc-dev/2017-November/000355.html
          Hide
          hgupdate HG Updates added a comment -
          URL: http://hg.openjdk.java.net/jdk/jdk/rev/e9dab2492924
          User: ksrini
          Date: 2017-11-30 18:08:46 +0000
          Show
          hgupdate HG Updates added a comment - URL: http://hg.openjdk.java.net/jdk/jdk/rev/e9dab2492924 User: ksrini Date: 2017-11-30 18:08:46 +0000

            People

            • Assignee:
              ksrini Kumar Srinivasan
              Reporter:
              jjg Jonathan Gibbons
            • Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: