backdrop-issues icon indicating copy to clipboard operation
backdrop-issues copied to clipboard

[UX] Date fields: Better help text

Open klonos opened this issue 5 years ago • 17 comments

It would certainly use some punctuation, and/or be split into two sentences or shortened:

Date objects can be created and cached as date fields are loaded rather than when they are displayed to improve performance.

...something like this perhaps:

Create and cache date objects when date fields are being loaded, rather than when they are being displayed. This improves performance.


PR by @klonos: https://github.com/backdrop/backdrop/pull/3027

klonos avatar Dec 27 '19 20:12 klonos

...BTW, if this setting improves performance, why isn't it on by default?

klonos avatar Dec 27 '19 20:12 klonos

Here's another one, for the "Position of date part labels" setting:

The location of date part labels, like "Year", "Month", or "Day" . "Above" displays the label as titles above each date part. "Hidden" doesn't visually label any of the date parts.

For better UX and readability, the last 2 sentences could be moved under each individual option they are referring to.

klonos avatar Dec 27 '19 20:12 klonos

...there are also tiny typos in the help text for the "Exclude wrapping fieldset" setting:

If using simple inputs such a a single textfield or the date popup, omitting the fieldset may provide simpler styling.

  • such a a -> such as a
  • textfield -> text field

How about this:

Simplify styling when using simple inputs, such as a single text field or the date popup.

klonos avatar Dec 27 '19 21:12 klonos

...filed a PR for all this: https://github.com/backdrop/backdrop/pull/3027

Before:

Screen Shot 2019-12-28 at 9 06 21 am

After:

Screen Shot 2019-12-28 at 9 00 00 am

klonos avatar Dec 27 '19 22:12 klonos

These changes look good to me!

stpaultim avatar Dec 28 '19 06:12 stpaultim

We submitted a new pull request based on the feedback of @BWPanda. Please provide your valuable feedback.

(See PR #4028) - This took the work of @klonos and simply added the comments by @BWPanda

Would provide screenshot, but Sandboxes are not working.

sudipto68 avatar Mar 30 '22 06:03 sudipto68

Ha, this other duplicate issue was also wanting to update some of this text: https://github.com/backdrop/backdrop-issues/issues/4482 I've closed that one, so we'll work on everything here.

ghost avatar Mar 31 '22 02:03 ghost

I've made a suggestion in the PR for how to simplify a chunk of code.

ghost avatar Mar 31 '22 02:03 ghost

Updated PR available for review.

stpaultim avatar Apr 06 '22 09:04 stpaultim

Still needs work.

ghost avatar Apr 08 '22 08:04 ghost

@sudipto68 Are you still interested in moving forward with this?

ghost avatar Jul 01 '22 08:07 ghost

New PR based upon the work of @sudipto68. Needs testing and code review.

Atten: @klonos

stpaultim avatar Dec 27 '23 05:12 stpaultim

I left a comment about the tense I would rather use.

avpaderno avatar Dec 27 '23 10:12 avpaderno

@kiamlaluno - Your suggestion made sense to me. I've updated the PR, it's ready for additional review.

stpaultim avatar Jan 13 '24 07:01 stpaultim

I tried to look at the preview site to see the changes, but the site is not even shown. I will try in the morning. (It is 10 PM, here.)

avpaderno avatar Jan 13 '24 21:01 avpaderno

@kiamlaluno Fixed Sandbox!

stpaultim avatar Mar 25 '24 00:03 stpaultim

I created a date field and selected each widget type to see what changed in their settings and the descriptions used for those settings. For what I can see, all has been changed as per issue.

avpaderno avatar Mar 25 '24 07:03 avpaderno

Thank everyone! I merged https://github.com/backdrop/backdrop/pull/4620 into 1.x and 1.27.x. This is a great improvement to configuring date fields!

https://github.com/backdrop/backdrop/commit/41113e4a7f46c19aca426561e15131cf86e24af0 by @stpaultim, @sudipto68, @BWPanda, @klonos, @kiamlaluno, and @herbdool.

quicksketch avatar Apr 28 '24 18:04 quicksketch