JDK-8248320: Provide a unique accessible name for <nav role="navigation">

[jonathan-gibbons]

This change is primarily about removing the lower (bottom) instance of the navigation bar, but as a side effect, it is also a cleanup for the way that the <header> and <footer> elements are generated for each page.

The header and footer elements are now generated by two new methods on HtmlDocletWriter: getHeader and getFooter.

The footer is the same for all pages, and now just consists of the "bottom" text (if any) provided with the -bottom option. (In JDK API docs, this is all the legal text at the bottom of each page.) The footer is omitted if there is no bottom text.

The header is structurally the same for each page, consisting of the "top" text (if any) provided with the -top option, and the main navigation bar. The contents of the navigation bar does depend on the kind of page, and so it is generated by a new method getNavBar, which is overridden as needed for some pages, to properly customize the properties.

Since there is no longer a lower navbar, the -footer option, which could be used to inject user-provided text into the bar bar, is now redundant. For now, it is accepted but generates a warning if used.

---

Progress

• Change must not contain extraneous whitespace
• Commit message must refer to an issue
• Change must be properly reviewed

Testing

	Linux x64	Linux x86	Windows x64	macOS x64
Build	⏳ (3/5 running)	⏳ (2/2 running)	⏳ (2/2 running)	⏳ (2/2 running)

Issue

• JDK-8248320: Provide a unique accessible name for

Reviewers

• Hannes Wallnöfer (@hns - Reviewer) ⚠️ Review applies to 1939efc

Download

$ git fetch https://git.openjdk.java.net/jdk pull/710/head:pull/710
$ git checkout pull/710

[bridgekeeper]

👋 Welcome back jjg! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

[openjdk]

@jonathan-gibbons The following label will be automatically applied to this pull request:

• javadoc

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

[mlbridge]

Webrevs

• 02: Full (98b9942)
• 01: Full (1939efc)
• 00: Full (19f1d14)

[jonathan-gibbons]

/csr

[openjdk]

@jonathan-gibbons this pull request will not be integrated until the CSR request JDK-8254949 for issue JDK-8248320 has been approved.

[openjdk]

@jonathan-gibbons this pull request can not be integrated into master due to one or more merge conflicts. To resolve these merge conflicts and update this pull request you can run the following commands in the local repository for your personal fork:

git checkout 8248320-navigation
git fetch https://git.openjdk.java.net/jdk master
git merge FETCH_HEAD
# resolve conflicts and follow the instructions given by git merge
git commit -m "Merge master"
git push

[hns]

Looks good, Jon!

In order to clean up, the following could and should probably be removed:

• HtmlStyle.bottomNav
• Instances of bottom-nav in stylesheet.css
• *_BOTTOM_NAVBAR constants in MarkerComments

[openjdk]

@jonathan-gibbons This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8248320: Provide a unique accessible name for <nav role="navigation">

Reviewed-by: hannesw

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been no new commits pushed to the master branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

[jonathan-gibbons]

Thanks; I'll take care of that cleanup.

…

-- Jon

On 11/3/20 2:25 AM, Hannes Wallnoefer wrote: ***@***.**** approved this pull request. Looks good, Jon! In order to clean up, the following could and should probably be removed: * |HtmlStyle.bottomNav| * Instances of |bottom-nav| in stylesheet.css * |*_BOTTOM_NAVBAR| constants in MarkerComments — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <https://urldefense.com/v3/__https://github.com/openjdk/jdk/pull/710*pullrequestreview-522358876__;Iw!!GqivPVa7Brio!OZ9iGgSl8q-Drk_U444pXFzZHIhWqvKUkfERyZg-zXFchd9lsdYUk8LZnQ4eBPohDTKmQA$>, or unsubscribe <https://urldefense.com/v3/__https://github.com/notifications/unsubscribe-auth/AOUXBRXQQRGLYLFS2OADNUDSN7LALANCNFSM4STZDN6Q__;!!GqivPVa7Brio!OZ9iGgSl8q-Drk_U444pXFzZHIhWqvKUkfERyZg-zXFchd9lsdYUk8LZnQ4eBPqhVzAmtw$>.

[jonathan-gibbons]

/integrate

[openjdk]

@jonathan-gibbons Pushed as commit d47336b.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.