RFR: JDK-8289334: Use CSS variables to define fonts and colors

Hannes Wallnöfer hannesw at openjdk.org
Thu Aug 11 15:36:20 UTC 2022


Please review a change to use CSS custom properties (aka variables) to define the fonts and colors in generated documentation. It is now possible to change the fonts and colors of generated API documentation by changing the values of these properties directly or by using extra stylesheet.

[Documentation rendered with the updated stylesheet][docs] is mostly identical pixel-by-pixel to the previous documentation with very few exceptions:

[docs]: http://cr.openjdk.java.net/~hannesw/8289334/api.00/

 - Some colors have been unified to reduce the number of variable definitions:
      - Single pixel borders used in class documentation pages use a single shade of gray (most visible in headers of member details which now have light gray instead of a darker gray border)
      - Header cells of user defined tables now use the same color as structural tables
 - Some sub-pixel sizing and spacing changes in random places

Contrary to previously stated intention I did not change the stylesheet to become more flexible (e.g. to allow combinations of background and foreground colors that are not currently supported). The reason is that this would have at least doubled the number of color properties and required new CSS rules, increasing the complexity of the style sheet and risking to add new bugs. Reducing the number of variables makes it easier to customize the layout and also preserves part of the original design by reducing the number of colors to a smaller color palette

The only code change is due to the removal of `jquery-ui-overrides.css` which had to be integrated into the main stylesheet in order to make use of CSS custom properties.

-------------

Commit messages:
 - JDK-8289334: Use CSS variables to define fonts and colors

Changes: https://git.openjdk.org/jdk/pull/9839/files
 Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=9839&range=00
  Issue: https://bugs.openjdk.org/browse/JDK-8289334
  Stats: 245 lines in 11 files changed: 51 ins; 48 del; 146 mod
  Patch: https://git.openjdk.org/jdk/pull/9839.diff
  Fetch: git fetch https://git.openjdk.org/jdk pull/9839/head:pull/9839

PR: https://git.openjdk.org/jdk/pull/9839


More information about the javadoc-dev mailing list