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

Use modern HTML in the JVMTI spec

XMLWordPrintable

    • b25

      The JVMTI spec generated by the XSL scripts and post-processed into the specs/ directory by Docs.gmk is "basic".

      The most notable "feature" at the top of the page is the TOC, with all the links in bold font, achieved in the HTML by wrapping the HTML links with explicit `<b>` tags. These days, a better practice would be to remove the `<b>` tags and use CSS to achieve whatever is the desired style (and, preferably _not_ bold!)

      In general, I recommend at least the following:

      1. remove the `<b>` tags around the links in the TOC
      2. put `class="doc"` or some equivalent on the top level `<ul>` element
      3. surround the entire `<ul>`...`</ul>` with `<nav>` and `</nav>` to indicate the list is just a series of links
      4. surround the rest of the document with `<main>` and `</main>`

      I realize the basic spec is generated by XSL scripts, but even so, these suggestions should be reasonably easy to incorporate into `jvmti.xsl`.

            amenkov Alex Menkov
            jjg Jonathan Gibbons
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated:
              Resolved: