RFR: JDK-8305958: Use links instead of buttons for auto-generated header links

Fri May 5 17:59:13 UTC 2023

On Fri, 5 May 2023 13:42:22 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:

> Please review a change to use plain HTML links instead of buttons to provide the URL to page section/heading anchors. Special care was taken to retain the accessibility features added in JDK-8299718, so section links can be reached and activated by keyboard and have an `aria-label` attribute. The generated documentation was tested on a range of desktop and mobile browsers (Firefox, Chrome on Mac OS and Linux, Safari on Mac OS and iOS, Chrome on Android) and can be viewed here:
> 
> https://cr.openjdk.org/~hannesw/8305958/api.00/index.html

Playing with the posted demo docs, I have the following comments, not necessarily criticism

* I'm mildly surprised the links show up on some of the "standard" "internal" headings, like "Constructor Details". I guess there may be cases where this is wanted, and maybe if you didn't do it, we would get a RFE to do it.

* the change accentuates the difference between "real" headings and "heading-like labels" (like **See Also:**) which is just a bold label.   But given my surprise about the use of links in my previous bullet, I'm not necessarily suggesting we should change this.

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

PR Comment: https://git.openjdk.org/jdk/pull/13831#issuecomment-1536590174