Problem/Motivation

The current description strings in this fieldset are:

Label: Initial menu level
[select box]
Description: The menu will only be visible if the menu item for the current page is at or below the selected starting level. Select level 1 to always keep this menu visible.

Label: Maximum number of menu levels to display
[select box]
Description: The maximum number of menu levels to show, starting from the initial menu level. For example: with an initial level 2 and a maximum number of 3, menu levels 2, 3 and 4 can be displayed.

These are quite long and not particularly clear.

Proposed resolution

Shorten and simplify the descriptions.

Remaining tasks

Write new descriptions

User interface changes

Shorter descriptions.

API changes

None

Data model changes

None

Before

screenshot before

After

screenshot after

Comments

tkoleary created an issue. See original summary.

tkoleary’s picture

Issue summary: View changes

My suggestion:

Label: Initial level
[select box]
Description: The first level to show. Should be no greater than the current page level.

Label: Max levels
[select box]
Description: How many levels to shown, including the initial level.

tkoleary’s picture

How this would look in the confined space of the outside-in edit tray:

Before

After

tkoleary’s picture

Issue tags: +contextual help
tkoleary’s picture

joachim’s picture

> Description: The first level to show. Should be no greater than the current page level.

I'm afraid that's no clearer, to me at least. What is the current page level?

lodey’s picture

Issue tags: +Dublin2016

I'm working on this issue for DrupalCon Dublin

lodey’s picture

The original menu descriptions are not too bad, but they could be slightly shorter and remove the potentially confusing example. This has the advantage of clearing some space on the new slide out toolbar.

I proposed some simple alterations to make this more concise and readable.

Initial Menu Level
The starting level where this menu should become viewable. Level 1 will always show the menu.

Maximum levels displayed
The maximum number of menu levels to show underneath the initial menu level selected.

AndreaD’s picture

I will look at this issue.

AndreaD’s picture

Assigned: Unassigned » AndreaD
yoroy’s picture

I agree with @Joachim that "Should be no greater than the current page level" is not clear.

Maybe we can try and make the labels more meaningful. Some ideas:

## Label 1

Show the menu starting from level
Initial menu visibility level
Initial visibility level
Start showing the menu from level
Show the menu from level

## Description 1

Use level 1 to always show this menu.

## Label 2

Number of levels to display
Number of levels to show
How many levels to show?

## Description 2

The maximum number of menu levels to show.

(And we're not consistent in display vs. show…)

Sutharsan’s picture

@lodey, It is helpfull for others to understand the issue, to place the 'before' screenshot in the issue summary. Can you do this too?

ifrik’s picture

Status: Needs review » Needs work

Thanks,
looks like this is one of the issues where UI text standards would be useful :-)

So for consistency, I would opt for "display" rather then show because that what we use for concepts such as display modes.
Also, we should try to avoid duplication between the label and the additional help in the description. However, the question what this visibility is about shouldn't be removed.

So from the different proposals so far, I would go for:

Menu levels

Initial visibility level The menu is only visible if the menu item for the current page is at this level or below it. Use level 1 to always display this menu.
Number of levels to display This maximum number includes the initial level.

AndreaD’s picture

Ok, I have tried to review it, the first thing that comes to my mind, is why we are not using the descriptions, already existing in the /admin/structure/block/manage/* pages?

##Title
Initial menu level
##Label
The starting level where this menu should become viewable. Level 1 will always show the menu.

##Title
Maximum levels displayed
##Label
The maximum number of menu levels to show underneath the initial menu level selected.

BR, Andrea

AndreaD’s picture

Assigned: AndreaD » Unassigned
lodey’s picture

Hi AndreaD, The code for the labelling is the definitely used for both the slide out tray or the main configuration page, so any change we make will be reflected in both locations.

lodey’s picture

Thanks ifrik - completely agree some UI standards would be handy! I find it useful to reference the Google materials design guide for some ideas on this. https://material.google.com/style/writing.html#writing-language

Also agree regarding the consistency and like your changes. It would be great to further condense the first description purely to be more readable in the slideout tray, but I think we would struggle to do so and stay informative enough.

lodey’s picture

This patch will enable the changes suggested by ifrik. Its worth comparing the before and after screenshots for context.

yoroy’s picture

Agreed it's really hard to shorten that first description. What if we started with the easy, more reassuring bit though?

"Use level 1 to always display this menu. The menu will display when the menu item for the current page is at or below this level."

lodey’s picture

I like that. This is now much clearer than the original.

New

Old

yoroy’s picture

Status: Needs work » Needs review
lodey’s picture

Hi Everyone,

Thanks for helping to work on this issue at Drupalcon last week.

It would be great to try and push this to review, and also to understand how to stop issues like this one from stalling out - any tips on the best way to get traction around that without annoying the heck out of everyone?

lodey’s picture

Hi Everyone,

Thanks for helping to work on this issue at Drupalcon last week.

It would be great to try and push this to review, and also to understand how to stop issues like this one from stalling out - any tips on the best way to get traction around that without annoying the heck out of everyone?

lodey’s picture

Hi Everyone,

Thanks for helping to work on this issue at Drupalcon last week.

It would be great to try and push this to review, and also to understand how to stop issues like this one from stalling out - any tips on the best way to get traction around that without annoying the heck out of everyone?

yoroy’s picture

Status: Needs review » Reviewed & tested by the community

I tested the patch on simplytest.me and can confirm the patch looks good.

yoroy’s picture

Issue summary: View changes
xjm’s picture

Assigned: Unassigned » yoroy
Status: Reviewed & tested by the community » Needs review
Issue tags: +String change in 8.3.0

Overall this looks great. I have one concern about @yoroy's proposal in #19 though:

Use level 1 to always display this menu. The menu will display when the menu item for the current page is at or below this level.

This can be read as "The menu will display when the menu item for the current page is at or below level 1." I had to read it a second time to understand it the other way.

Assigning to @yoroy for feedback on whether that's a concern. If the usability team still thinks that is the best way around for the two sentences, though, I'm also fine with them re-RTBCing it.

Aside to @lodey: Three days over a weekend without a patch review is not the issue "stalling out". :) A couple good ways to get reviews are to share the link in IRC, to reach out to someone previously active on the issue, to trade reviews with another contributor, or to join a team of people like the usability team who are collaborating on the same kinds of changes. (Posting comments asking for reviews isn't going to be successful at not annoying people though.) ;)

lodey’s picture

Thanks for taking a look and the feedback @xjm :)

lomasr’s picture

Tested patch #20 . It looks great . I think adding example will help the beginner's in future. Adding patch which includes "For Example".

tkoleary’s picture

@lomasr Let's not add back the example please. It's not adding any value and every additional word we add increases overall cognitive load.

@joachim

...that's no clearer, to me at least. What is the current page level?

With the settings tray open the user should know "the current page" mean the page they are on but perhaps we can be even more clear with "the page the menu is on".

@lodey

...any change we make will be reflected in both locations.

This is true, however if we solve for the less experienced user here (in the tray) that description should also cover the more experienced one.

@ifrik

looks like this is one of the issues where UI text standards would be useful :-) So for consistency, I would opt for "display"...

Consistency is good but we're sliding back to the "tech jargony" wording users were reacting against in the Minnesota study. Our current standards need to evolve away from that.

We need simple everyday language:

"Show" not "Display"
"Shown" not "Visible"
"Largest" not "Maximum"
"Chosen" not "Selected"
"First" not "Initial"
"Link" not "menu item"

We're also defining 'description' too broadly. It's not a full explanation or a tutorial, it's simply a clarification of what the field is for if the field itself, it's label, or it's context are not sufficiently self-explanatory. So:

  • The user is editing a menu. We don't need to repeat "menu"
  • The user is editing a menu with more than one level (or why would I open this). We don't need to repeat "level"
  • both of the available fields use a numeric select so what the user is choosing is clearly a number. We don't always need to tell the user they are choosing a number

Maximum number of levels

If the user has a menu with 3 levels and wants to show all three that's what they will choose, If they only want to show 2 they will choose 2.

By using "maximum" we are forcing the user to grok the dimensions of time, space, and multiple users and mentally formulate "I only have two menu levels now but I want to set it at four because later on another user may add more levels and if it goes to five the indents will strain the horizontal width of the sidebar I'm putting it in."

"Levels to show" follows to the common case and is simple and clear. The complex case is not rendered any less achievable.

Given all of the above the text would then be:

[fieldset label]
Levels

[field label]
First level to show

[description]
Choose "1" to always show this menu (menus only show if the link to the page they are on is at or below the chosen level).

[field label]
Number of levels to show

[description]
Includes the first level (chosen above).

tkoleary’s picture

Issue tags: -Dublin2016 +sprint
yoroy’s picture

Assigned: yoroy » Unassigned

Ahem. So looking at this again, I think that last change reordering the sentences was not so good.
So the patch in #18 would be the one we want to commit.

tkoleary’s picture

+1

tkoleary’s picture

Status: Needs review » Reviewed & tested by the community

The patch at #18 as @Yoroy suggested.

  • xjm committed e211a2e on 8.3.x
    Issue #2803203 by lodey, lomasr, tkoleary, AndreaD, yoroy, joachim, xjm...
xjm’s picture

Status: Reviewed & tested by the community » Fixed

Alright, #18 looks good to me too. In the future, please be sure to upload the correct patch as the last patch on the issue, so that it can be properly tested by the testbot and so committers don't review or commit the wrong thing.

Committed #18 to 8.3.x. Thanks!

Status: Fixed » Closed (fixed)

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