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

Consider using definition lists instead of tables for summaries.

    Details

    • Type: Enhancement
    • Status: Open
    • Priority: P4
    • Resolution: Unresolved
    • Affects Version/s: 15
    • Fix Version/s: tbd
    • Component/s: tools
    • Labels:
      None

      Description

      Tables don't work well for small devices.

      Pretty much all of our tables are composed of rows of the form
          <item> <description>
      even if the item is sometimes itself a pair forming a signature, such as <type> <name>.

      All these tables could reasonably be replaced by HTML <dl> lists, with the <dt>for the item and the <dd> for the description. And, we can use CSS and inline blocks to layout these as tables on big screens and go to a different more flow-oriented verical layout on small devices.

      There is one notable exception I can think of for tables, and that is the package table for a module declaration when the command line options are set to show all details, including details of qualified exports and qualified opens. (We do not do this for JDK docs). For this table, there may be additional columns for the target of the qualified export or opens. For these directives, one possibility would be to reorg the presentation to use a "notes" section to list the targets ... i.e.
        Exported To: <list> and/or
        Opened To: <list>
      similar to the Returns and Parameters for a method declaration.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                Unassigned
                Reporter:
                jjg Jonathan Gibbons
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated: