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-8266779: Use <wbr> instead of ZERO_WIDTH_SPACE #3946

Closed
wants to merge 3 commits into from

Conversation

hns
Copy link
Member

@hns hns commented May 10, 2021

This replaces usages of the zero-width space character (ZWSP, entity &#8203;) with the HTML5 <wbr> element. <wbr> acts as a word break opportunity without adding characters to the text content like ZWSP does. It is supported in all modern browsers, the only browser I know of which doesn't support is are old versions of Internet Explorer.

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/wbr
https://caniuse.com/wbr-element

I have tested the output (both layout and copy-paste behaviour) on Firefox, Safari, and Chrome on Mac OS X.


Progress

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

Issue

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/jdk pull/3946/head:pull/3946
$ git checkout pull/3946

Update a local copy of the PR:
$ git checkout pull/3946
$ git pull https://git.openjdk.java.net/jdk pull/3946/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 3946

View PR using the GUI difftool:
$ git pr show -t 3946

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/jdk/pull/3946.diff

@bridgekeeper
Copy link

bridgekeeper bot commented May 10, 2021

👋 Welcome back hannesw! 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 May 10, 2021
@openjdk
Copy link

openjdk bot commented May 10, 2021

@hns 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 May 10, 2021
@mlbridge
Copy link

mlbridge bot commented May 10, 2021

Webrevs

Copy link
Member

@pavelrappo pavelrappo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's unfortunate that the text blocks in tests are formatted for a fixed width; diffs are filled with unrelated changes. Update copyright years and you're good to go. Thanks for fixing this, Hannes.

@@ -210,7 +211,7 @@ protected void addParameters(ExecutableElement member, Content htmltree) {
Content paramTree = getParameters(member, false);
if (paramTree.charCount() > 2) {
// only add zero-width-space for non-empty parameters
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update this comment.

@openjdk
Copy link

openjdk bot commented May 10, 2021

@hns 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:

8266779: Use <wbr> instead of ZERO_WIDTH_SPACE

Reviewed-by: prappo

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 8 new commits pushed to the master branch:

  • 0cc7833: 8265208: [JEP-356] : SplittableRandom and SplittableGenerators - splits() methods does not throw NullPointerException when source is null
  • f78440a: 8266440: Shenandoah: TestReferenceShortcutCycle.java test failed on AArch64
  • de78431: 8241502: C2: Migrate x86_64.ad to MacroAssembler
  • c8b7447: 8266603: jpackage: Add missing copyright file in Java runtime .deb installers
  • c494efc: 8266774: System property values for stdout/err on Windows UTF-8
  • 25d99e5: 8266330: itableMethodEntry::initialize() asserts with archived old classes
  • 5d761fc: 8266796: Clean up the unnecessary code in the method UnsharedNameTable#fromUtf
  • e41fd73: 8266252: Streamline AbstractInterpreter::method_kind

Please see this link for an up-to-date comparison between the source branch of this pull request and the master branch.
As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this 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 May 10, 2021
@pavelrappo
Copy link
Member

pavelrappo commented May 10, 2021

Come to think of it, consider obtaining an instance of a <wbr> tag indirectly through a static factory method HtmlTree.WBR() rather than through a direct allocation new HtmlTree(TagName.WBR).

@hns
Copy link
Member Author

hns commented May 10, 2021 via email

@pavelrappo
Copy link
Member

I’d rather not. I don’t think it’s a huge improvement, there’s only 4 usages of this tag, and … it’s late and I’d like to close the issue :) I think there are some elements that are much more often used that don’t have a factory method. Maybe another cleanup task? Hannes

Up to you. I have reviewed it already.

@hns
Copy link
Member Author

hns commented May 10, 2021

/integrate

@openjdk openjdk bot closed this May 10, 2021
@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 May 10, 2021
@openjdk
Copy link

openjdk bot commented May 10, 2021

@hns Since your change was applied there have been 8 commits pushed to the master branch:

  • 0cc7833: 8265208: [JEP-356] : SplittableRandom and SplittableGenerators - splits() methods does not throw NullPointerException when source is null
  • f78440a: 8266440: Shenandoah: TestReferenceShortcutCycle.java test failed on AArch64
  • de78431: 8241502: C2: Migrate x86_64.ad to MacroAssembler
  • c8b7447: 8266603: jpackage: Add missing copyright file in Java runtime .deb installers
  • c494efc: 8266774: System property values for stdout/err on Windows UTF-8
  • 25d99e5: 8266330: itableMethodEntry::initialize() asserts with archived old classes
  • 5d761fc: 8266796: Clean up the unnecessary code in the method UnsharedNameTable#fromUtf
  • e41fd73: 8266252: Streamline AbstractInterpreter::method_kind

Your commit was automatically rebased without conflicts.

Pushed as commit 8851cb6.

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

Copy link
Contributor

@jonathan-gibbons jonathan-gibbons left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice

@mlbridge
Copy link

mlbridge bot commented May 14, 2021

Mailing list message from Hannes Wallnoefer on javadoc-dev:

Thanks for the review, Pavel.

Am 10.05.2021 um 16:21 schrieb Pavel Rappo <prappo at openjdk.java.net>:

It's unfortunate that the text blocks in tests are formatted for a fixed width; diffs are filled with unrelated changes. Update copyright years and you're good to go. Thanks for fixing this, Hannes.

It?s not great to look at a ?brick? of text, but it?s much easier for spotting changes than in a huge line several hundred of characters long. Not to mention traditional string literals with their escaped quotes. So even though it?s still bulky, it?s much better than what we had before.

Hannes

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
3 participants