Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed

Conversation

jonathan-gibbons
Copy link
Contributor

@jonathan-gibbons jonathan-gibbons commented Oct 16, 2020

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

Reviewers

Download

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

@bridgekeeper
Copy link

bridgekeeper bot commented Oct 16, 2020

👋 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 openjdk bot added the rfr Pull request is ready for review label Oct 16, 2020
@openjdk
Copy link

openjdk bot commented Oct 16, 2020

@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.

@openjdk openjdk bot added the javadoc javadoc-dev@openjdk.org label Oct 16, 2020
@jonathan-gibbons jonathan-gibbons changed the title 8248320 navigation JDK-8248320: Provide a unique accessible name for <nav role="navigation"> Oct 16, 2020
@mlbridge
Copy link

mlbridge bot commented Oct 16, 2020

Webrevs

@jonathan-gibbons
Copy link
Contributor Author

jonathan-gibbons commented Oct 17, 2020

/csr

@openjdk openjdk bot added the csr Pull request needs approved CSR before integration label Oct 17, 2020
@openjdk
Copy link

openjdk bot commented Oct 17, 2020

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

@openjdk
Copy link

openjdk bot commented Oct 20, 2020

@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

@openjdk openjdk bot added merge-conflict Pull request has merge conflict with target branch and removed csr Pull request needs approved CSR before integration labels Oct 20, 2020
@openjdk openjdk bot removed the merge-conflict Pull request has merge conflict with target branch label Oct 23, 2020
hns
hns approved these changes Nov 3, 2020
Copy link
Member

@hns hns left a comment

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
Copy link

openjdk bot commented Nov 3, 2020

@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.

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Nov 3, 2020
@jonathan-gibbons
Copy link
Contributor Author

jonathan-gibbons commented Nov 3, 2020

@jonathan-gibbons
Copy link
Contributor Author

jonathan-gibbons commented Nov 3, 2020

/integrate

@openjdk openjdk bot closed this Nov 3, 2020
@openjdk openjdk bot added integrated Pull request has been integrated and removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Nov 3, 2020
@jonathan-gibbons jonathan-gibbons deleted the 8248320-navigation branch Nov 3, 2020
@openjdk
Copy link

openjdk bot commented Nov 3, 2020

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
integrated Pull request has been integrated javadoc javadoc-dev@openjdk.org
2 participants