-
-
Notifications
You must be signed in to change notification settings - Fork 3.5k
Text Wrapping Behavior in p5.js doesn't match the documentation #7163
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
Comments
Thanks for your question! I should have included examples/screenshots to clarify. The issue is with the default behavior of p5.js being inconsistent with the
However the text doesn't wrap on characters but only on words by default. An extra In Processing, the text wraps on characters by default if setting the text box's width, without the need to call Since p5.js doesn't have the goal to match the behavior of Processing exactly, it could also be a case of updating the documentation to clarify that behavior. |
Understood. I'm wondering if this is a duplicate of #4652, which was marked as completed (but may not be). Is this only an issue when a single 'word' is wider than the bounding box, or are there other cases? |
I only noticed a discrepancy on those "long words". Also related is #5321 in which @limzykenneth said:
If that's the case then the documentation could make clearer that the default wrapping behavior is word-wise as opposed to character-wise, especially since this differs from the default behavior in Processing. |
Hi @SableRaf I tested this issue using the following p5.js code and confirmed that the default text wrapping only breaks at spaces. It does not wrap long words unless Thank You |
Hi @SableRaf ,Is this issue is still open. I’d like to contribute by updating the documentation to clarify this behavior. I would like to adding a note under the |
@Mamatha1718 Before updating the As discussed in #4652, some users find it confusing that long words don’t automatically wrap within the specified dimensions of A fix was merged in #4712, introducing character-wise wrapping with hyphens, but this change led to confusion for some people (#5081) and was later reverted in #5093. My preference is for character-wrapping (without hyphens) to be the default, matching the documentation and the behaviour in Processing. That said, I'm open to other perspectives. We should hear from others before making a decision. @ksen0, @dhowe, @limzykenneth, what do you think? |
My 2-centz is to opt for backwards-compatibility... Whatever the ideal solution (I don't remember why we did this the first time around), there are lots of 1.x sketches out there that would break if we were to change this now |
I would suggest maintaining backwards compatibility as well. @SableRaf I'm not entirely sure what you mean by "character-wrapping (without hyphens) to be the default, matching the documentation" as what I see in the documentation for p5.js is word based wrapping by default instead of character based wrapping? For me the main case for character based wrapping is for languages that don't use spaces to delineate between words as these will not wrap in word based wrapping. For English and probably other Latin based language it usually isn't very readable so will likely only be used for text not meant to be read, eg. text as texture. |
@SableRaf , Thank you for your Response. |
Hi @SableRaf @dhowe @limzykenneth thank you for your input , sounds like the best way forward in this issue is to update the documentation to explain the expected behavior; and keep the current behavior as is for compatibility. Possible changes in behavior can be discussed in #4652 @Mamatha1718 thanks for your interest, do you want to work on the documentation updates? Let me know and I'll assign you if so! You can make 2 PR on 1.x (PR merging to The documentation eventually ends up on the site looking the same, but it is created in 2 different places:
If you do want to work on this, do you have enough to get started? |
Hi @ksen0 Please assign me the issue, and I’ll get started right away! |
Hi @SableRaf , @dhowe , @ksen0 , @limzykenneth , I have raised a PR #7780 for this — updated the documentation for |
The text wrapping behavior in p5.js does not match the documentation for
text()
(or the documentation is ambiguous). The documentation states that specifyingmaxWidth
andmaxHeight
in thetext()
function should automatically wrap text within those dimensions:While word wrapping occurs when boundaries are set, character-wise wrapping requires the additional
textWrap(CHAR)
call, which is not mentioned in the documentation.This is also different from the way the
text()
function works in Processing, where text character-wise wrapping is enabled by default when setting the fourth and fifth parameters of thetext()
function (see: processing/processing-website#544)Steps to Resolve
I can think of two ways to resolve this:
A) Set
text()
to automatically wrap characters when setting the fourth and fifth parameters. This would have the advantage of matching the behavior of the function by the same name in Processing.or
B) Update the documentation to clarify that "Text will wrap to fit within the text box" on words only and that an additional
textWrap(CHAR)
will be required to wrap on characters.The text was updated successfully, but these errors were encountered: