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

improve use of <section> in generated docs

    Details

    • Type: Enhancement
    • Status: Resolved
    • Priority: P3
    • Resolution: Duplicate
    • Affects Version/s: 13
    • Fix Version/s: None
    • Component/s: tools

      Description

      We can/should improve the use of <section> tags within generated documentation.

      Two closely-related aspects are noted here:

      1. Currently, all existing uses of <section> do not identify a "class" attribute. They are all of the simple form '<section role="region">'
      Specifying a class would allow the ability to use styling for the section.

      2. Certain uses of <div> would be better replaced by <section>.
      On the page for a class declaration, this specifically includes the <div> tags with the class of "description", "summary", "details".

      3. On a class declaration page, it might be reasonable to include the inheritance section in a new section. Currently, the top level structure of a class declaration is

      :div[contentContainer]
          ul[inheritance]
          div[description]
          div[summary]
          div[details]


      See https://www.w3.org/TR/2011/WD-html5-20110525/sections.html#the-section-element

      Note that changing <div> to <section> may require corresponding changes to the standard stylesheet.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                pmuthuswamy Priya Lakshmi Muthuswamy (Inactive)
                Reporter:
                jjg Jonathan Gibbons
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: