Problem/Motivation

The help text in "Promotion Options" is not user friendly.

It currently says

Promote
A boolean indicating whether the node should be displayed on the front page.
Sticky
A boolean indicating whether the node should be displayed at the top of lists in which it appears.

Proposed resolution

Change the help text to say

Promote
Show this content in featured regions or lists.
Sticky
Show this content at the top of lists.

OR

revert to D7 wording which simply had labels with no description.

Remaining tasks

  1. Write a patch Done. #5 or D7 approach at #11
  2. Review the patch
  3. Commit the patch

#11 and #5 compared

User interface changes

Yes.

API changes

Possibly?

Beta phase evaluation

Reference: https://www.drupal.org/core/beta-changes
Issue category Bug because introduces confusing terminology. D7 had a very simple checkbox. This adds technical programming or search terminology to a simple flag.
Prioritized changes The main goal of this issue is usability.

Original report by @Jody Lynn

On the node form, within Promotion Options the description for the Promote checkbox is "A boolean indicating whether the node should be displayed on the front page." and similar for the Sticky checkbox.

Boolean in particular is not a word we should expect content creators to know. I'd also argue that as a content creator followed a link to 'Add Content' that we should use the word content rather than node throughout the interface text on node forms.

Comments

kattekrab’s picture

Issue tags: +D8UX usability
StatusFileSize
new15.42 KB

I agree the help text in the "Promotion Options" Tab when adding content could be more user friendly.

Currently, it says


PROMOTION OPTIONS
Promote
A boolean indicating whether the node should be displayed on the front page.
Sticky
A boolean indicating whether the node should be displayed at the top of lists in which it appears.

Whilst that's probably the most accurate description... perhaps we could try

Promote
Show this content on the front page.

Sticky
Show this content at the top of any lists in which it appears.

dawehner’s picture

kattekrab’s picture

Issue summary: View changes

Ahaa! Given the related issue suggests removing "front page" terminology, then I'm changing my suggestion to

Promote
Show this content in featured regions or lists.

Sticky
Show this content at the top of lists.

kattekrab’s picture

Issue summary: View changes
kattekrab’s picture

StatusFileSize
new3.14 KB

And... a patch!

And... an "after the patch is applied" screenshot.

Only local images are allowed.

kattekrab’s picture

Status: Active » Needs review
kattekrab’s picture

Issue summary: View changes
kattekrab’s picture

Issue summary: View changes

Updated IS with screenshot, link to patch, and more details about the issue.

jibran’s picture

Status: Needs review » Reviewed & tested by the community

Well code changes looks good. I like the updated text. Let's see what @webchick thinks about it.

jibran’s picture

And thank you @kattekrab for so much detailed issue summary, screenshots and patch.

David_Rothstein’s picture

Status: Reviewed & tested by the community » Needs review
StatusFileSize
new3.19 KB

I don't think the "front page" wording should be removed (at least not just in this one single place - I seem to recall that #987242: The "Promoted to front page" checkbox doesn't do anything if the /node front page listing isn't used discusses removing it everywhere but that's a separate issue).

Why not just use the same wording that Drupal 8 already uses at admin/structure/types/manage/article (and that Drupal 7 uses in both places)? That is, no description at all, but with more information in the checkbox label itself.

The attached patch implements that.

kattekrab’s picture

That could work.

Was there a reason these had been changed from what they were in D7 to a single word with a description?

David_Rothstein’s picture

Good question. I used git bisect (http://webchick.net/node/99) to find out when that text was removed from Drupal 8. Looks like it happened in #2226493: Apply formatters and widgets to Node base fields... As far as I can tell that issue was not intending to change the UI text, so I think it was just a mistake.

rootwork’s picture

I'd support either #11 or #5 over what we have now. I could see arguments for either.

kattekrab’s picture

Either is fine. What we have now isn't good. I reckon we just need someone to make a call and do it. :)

kattekrab’s picture

StatusFileSize
new63.44 KB

I'd probably err on the side that less is more. Here's the two approaches side by side.

kattekrab’s picture

Issue summary: View changes
StatusFileSize
new47.9 KB
kattekrab’s picture

Issue summary: View changes
kattekrab’s picture

kattekrab’s picture

Issue summary: View changes
StatusFileSize
new48.35 KB

oops - got the numbers in the comparison screenshot round the wrong way. fixed!

gábor hojtsy’s picture

Status: Needs review » Reviewed & tested by the community

#11 looks much better, thanks!

berdir’s picture

Yes, this is one of the issues that I mentioned in #2363099: Using translated field definition descriptions in entity schema results in different schema definitions, resulting in update.php changes, which remove those descriptions from the schema.

In HEAD, we would also lose the description in the schema, but with that patch, we never add them like that anymore, so it doesn't matter.

alexpott’s picture

Status: Reviewed & tested by the community » Fixed

Committed a801764 and pushed to 8.0.x. Thanks!

Thank you for adding the beta evaluation to the issue summary.

  • alexpott committed a801764 on 8.0.x
    Issue #2350013 by kattekrab, David_Rothstein: Descriptions for Promotion...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.