Problem/Motivation

The module description on the Extend page is somewhat different then longer description on the Help page. Also depending on the theme and/or screensize, the region is not displayed as a sidebar.

Proposed resolution

Change the wording to something like "Allows users to edit block configuration without leaving the page."
The title of the settings tray actually says "Configure [foo]." but using "edit" here aligns it with the different wording in the contextual links".

Remaining tasks

Change the wording in the info file of the Settings Tray module.

User interface changes

This is a UI text change.

API changes

None.

Data model changes

None.

CommentFileSizeAuthor
#25 interdiff_20-25.txt510 bytesspitzialist
#25 settings_tray_description_2999597_25.patch523 bytesspitzialist
#20 settings_tray_description_2999597_20.patch522 bytesspitzialist
#20 interdiff_15-20.txt19 bytesspitzialist
#15 interdiff_10_15.txt490 byteseworwa
#15 settings_tray_description_2999597_15.patch513 byteseworwa
#10 interdiff_3_10.txt541 byteseworwa
#10 settings_tray_description_2999597_10.patch500 byteseworwa
#3 settings_tray_description_2999597_3.patch564 byteseworwa
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

ifrik created an issue. See original summary.

aburrows’s picture

aburrows CreditAttribution: aburrows at DigiDrop commented

I don't think this is a simple task in terms of it needs to be agreed mutually what we should state in the description.

eworwa’s picture

eworwa CreditAttribution: eworwa commented
FileSize
settings_tray_description_2999597_3.patch564 bytes

Updated the module description as suggested.

This is my first patch, so be nice.

eworwa’s picture

eworwa CreditAttribution: eworwa commented
Status: Active » Needs review
bserem’s picture

bserem CreditAttribution: bserem at zehnplus commented

Mentoring this with @eworwa in DrupalEurope.
Up for review!

spitzialist’s picture

spitzialist CreditAttribution: spitzialist at Unic commented
Assigned: Unassigned » spitzialist

Working on that #drupaleurope

spitzialist’s picture

spitzialist CreditAttribution: spitzialist at Unic commented

The wording in the info file was changed and now reflects the proposed resolution.

spitzialist’s picture

spitzialist CreditAttribution: spitzialist at Unic commented
Assigned: spitzialist » Unassigned
Status: Needs review » Reviewed & tested by the community
longwave’s picture

longwave
he/him
Primary language English
Location UK
CreditAttribution: longwave as a volunteer commented

We don't usually mention the required permissions in the description. We could shorten this to something like "Allows administrators to edit blocks without visiting a separate page."

eworwa’s picture

eworwa CreditAttribution: eworwa commented
FileSize
settings_tray_description_2999597_10.patch500 bytes
interdiff_3_10.txt541 bytes

Here a new patch with an improved module description, removed the references to Drupal permissions.

rumburak’s picture

rumburak CreditAttribution: rumburak commented

Working on this on #drupaleurope

longwave’s picture

longwave
he/him
Primary language English
Location UK
CreditAttribution: longwave as a volunteer commented

#10 looks great.

ifrik’s picture

ifrik
she/her
CreditAttribution: ifrik commented
Status: Reviewed & tested by the community » Needs work

Thanks for working on this.

And yes, as longwave mentioned, the permissions are usually not mentioned in these short descriptions. Such information is usually given on the Help page.
We also usually refer to "users" rather then assuming a role. The main point is that we show people that this is about something they will be able to do, rather then about something fixed that the module provides.
Thanks for already changing this.

Just one last change, because of Drupal's use of "edit" for content and configuration: This is about editing some of the block configuration, not about editing the block content.

@eworwa: Could you change this reflect this? ... edit block configuration instead of ... edit blocks

@alexburrows: Sure we need to agree on the wording, but the current wording is not correct, and I assume that the hook_help text also was agreed, so we are not venturing far from already agreed text.

rumburak’s picture

rumburak CreditAttribution: rumburak commented
Status: Needs work » Reviewed & tested by the community

Description is now consistent with the one of other modules and is appropriate.

eworwa’s picture

eworwa CreditAttribution: eworwa commented
Status: Reviewed & tested by the community » Needs review
FileSize
settings_tray_description_2999597_15.patch513 bytes
interdiff_10_15.txt490 bytes

Thanks for the explanation @ifrik, I updated the module description as suggested.

rumburak’s picture

rumburak CreditAttribution: rumburak commented
Status: Needs review » Reviewed & tested by the community

Description adapted to the latest suggestion .

ifrik’s picture

ifrik
she/her
CreditAttribution: ifrik commented

Thanks!
You are making patches faster then I can formulate my reviews!

tedbow’s picture

tedbow
he/him
Primary language English
Location Ithaca, NY, USA
CreditAttribution: tedbow at Acquia commented

Thought I would weigh since I the maintainer of the module.

Thanks everyone for the work so far.

I think "without visiting a separate page" is bit wordy.

What about:
"Allows users to quickly edit the configuration of blocks on the current page."

"on the current page" keeps the meaning that it is only the blocks that are currently viewable.

spitzialist’s picture

spitzialist CreditAttribution: spitzialist at Unic commented
Assigned: Unassigned » spitzialist
Status: Reviewed & tested by the community » Needs work
spitzialist’s picture

spitzialist CreditAttribution: spitzialist as a volunteer and at Unic commented
FileSize
interdiff_15-20.txt19 bytes
settings_tray_description_2999597_20.patch522 bytes

Created the patch with wording suggested by the maintainer tedbow in comment #18. Please review.

spitzialist’s picture

spitzialist CreditAttribution: spitzialist as a volunteer and at Unic commented
Assigned: spitzialist » Unassigned
Status: Needs work » Needs review
ifrik’s picture

ifrik
she/her
CreditAttribution: ifrik commented
Status: Needs review » Needs work

Thanks,
I like the logic that "on the current page" also carries the notion that it's only those blocks.

I'm not sure where the "quickly" comes from and it's not quite the style we usually use because we can't make assumptions about the way people work. Could you either just delete it, or replace it with "directly"?

longwave’s picture

longwave
he/him
Primary language English
Location UK
CreditAttribution: longwave as a volunteer commented

I think we need "directly" or some other qualifier, as you can already "edit blocks on the current page", just you have to go elsewhere to do it.

tedbow’s picture

tedbow
he/him
Primary language English
Location Ithaca, NY, USA
CreditAttribution: tedbow at Acquia commented

RE

I'm not sure where the "quickly" comes from and it's not quite the style we usually use because we can't make assumptions about the way people work.

Well we have whole module name that makes that assumption, "Quick Edit" 😉

but also kind of the whole purpose of the module is making easier to find this configuration and make less clicks away. So it would be "quicker". I don't think that is assumption about the way people work.

spitzialist’s picture

spitzialist CreditAttribution: spitzialist as a volunteer and at Unic commented
Status: Needs work » Needs review
FileSize
settings_tray_description_2999597_25.patch523 bytes
interdiff_20-25.txt510 bytes

As suggested by @ifrik in comment #22 I created patch to replace "quickly" with "directly". Please choose which one better fits into the wording style.

longwave’s picture

longwave
he/him
Primary language English
Location UK
CreditAttribution: longwave as a volunteer commented
Status: Needs review » Reviewed & tested by the community

Either #20 or #25 is good!

tedbow’s picture

tedbow
he/him
Primary language English
Location Ithaca, NY, USA
CreditAttribution: tedbow at Acquia commented

I am +1 for RTBC #25. I would also be good with "quickly" instead of "directly" but either is fine.

ifrik’s picture

ifrik
she/her
CreditAttribution: ifrik commented

Thanks, #25 looks good.

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 25: settings_tray_description_2999597_25.patch, failed testing. View results

AjitS’s picture

AjitS
he/him
Primary language Marathi
Location Pune
CreditAttribution: AjitS as a volunteer commented

#29 looked like a random failure. Queued the patch in #25 again for testing.

longwave’s picture

longwave
he/him
Primary language English
Location UK
CreditAttribution: longwave as a volunteer commented
Status: Needs work » Reviewed & tested by the community

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 25: settings_tray_description_2999597_25.patch, failed testing. View results

longwave’s picture

longwave
he/him
Primary language English
Location UK
CreditAttribution: longwave as a volunteer commented
Status: Needs work » Reviewed & tested by the community

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 25: settings_tray_description_2999597_25.patch, failed testing. View results

AjitS’s picture

AjitS
he/him
Primary language Marathi
Location Pune
CreditAttribution: AjitS as a volunteer commented
Status: Needs work » Reviewed & tested by the community
spitzialist’s picture

spitzialist CreditAttribution: spitzialist as a volunteer and at Unic commented

Do we need additional work here as the automated tests seem to fail again. Any hint would be appreciated to resolve this issue. thanks!

tedbow’s picture

tedbow
he/him
Primary language English
Location Ithaca, NY, USA
CreditAttribution: tedbow at Acquia commented

@spitzialist no it looks it is just a DrupalCi error and nothing to do with the patch

  • Gábor Hojtsy committed 4f89e9a on 8.7.x 
    Issue #2999597 by eworwa, spitzialist, longwave, ifrik, tedbow, bserem:...
Gábor Hojtsy’s picture

Gábor Hojtsy
he/him
Primary language Hungarian
Location Hungary
CreditAttribution: Gábor Hojtsy at Acquia commented
Status: Reviewed & tested by the community » Fixed

Thanks all! I understand the reservations with "quickly", although I don't think "directly" 100% explains what is happening, you are not in-place editing the block after all (editing still happens decoupled so to speak from the block itself, not within the block). But given I don't have better words other than "quickly" and "directly" and I also agree that even appearing to be judging the speed of how a user works ("just simply click here" type of stuff) is to be avoided. So committed this! Thanks!

Status: Fixed » Closed (fixed)

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