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.
Comment | File | Size | Author |
---|---|---|---|
#25 | interdiff_20-25.txt | 510 bytes | spitzialist |
#25 | settings_tray_description_2999597_25.patch | 523 bytes | spitzialist |
#20 | settings_tray_description_2999597_20.patch | 522 bytes | spitzialist |
#20 | interdiff_15-20.txt | 19 bytes | spitzialist |
#15 | interdiff_10_15.txt | 490 bytes | eworwa |
Comments
Comment #2
aburrows CreditAttribution: aburrows at DigiDrop commentedI don't think this is a simple task in terms of it needs to be agreed mutually what we should state in the description.
Comment #3
eworwa CreditAttribution: eworwa commentedUpdated the module description as suggested.
This is my first patch, so be nice.
Comment #4
eworwa CreditAttribution: eworwa commentedComment #5
bserem CreditAttribution: bserem at zehnplus commentedMentoring this with @eworwa in DrupalEurope.
Up for review!
Comment #6
spitzialist CreditAttribution: spitzialist at Unic commentedWorking on that #drupaleurope
Comment #7
spitzialist CreditAttribution: spitzialist at Unic commentedThe wording in the info file was changed and now reflects the proposed resolution.
Comment #8
spitzialist CreditAttribution: spitzialist at Unic commentedComment #9
longwaveWe 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."
Comment #10
eworwa CreditAttribution: eworwa commentedHere a new patch with an improved module description, removed the references to Drupal permissions.
Comment #11
rumburak CreditAttribution: rumburak commentedWorking on this on #drupaleurope
Comment #12
longwave#10 looks great.
Comment #13
ifrikThanks 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.
Comment #14
rumburak CreditAttribution: rumburak commentedDescription is now consistent with the one of other modules and is appropriate.
Comment #15
eworwa CreditAttribution: eworwa commentedThanks for the explanation @ifrik, I updated the module description as suggested.
Comment #16
rumburak CreditAttribution: rumburak commentedDescription adapted to the latest suggestion .
Comment #17
ifrikThanks!
You are making patches faster then I can formulate my reviews!
Comment #18
tedbowThought 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.
Comment #19
spitzialist CreditAttribution: spitzialist at Unic commentedComment #20
spitzialist CreditAttribution: spitzialist as a volunteer and at Unic commentedCreated the patch with wording suggested by the maintainer tedbow in comment #18. Please review.
Comment #21
spitzialist CreditAttribution: spitzialist as a volunteer and at Unic commentedComment #22
ifrikThanks,
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"?
Comment #23
longwaveI 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.
Comment #24
tedbowRE
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.
Comment #25
spitzialist CreditAttribution: spitzialist as a volunteer and at Unic commentedAs suggested by @ifrik in comment #22 I created patch to replace "quickly" with "directly". Please choose which one better fits into the wording style.
Comment #26
longwaveEither #20 or #25 is good!
Comment #27
tedbowI am +1 for RTBC #25. I would also be good with "quickly" instead of "directly" but either is fine.
Comment #28
ifrikThanks, #25 looks good.
Comment #30
AjitS#29 looked like a random failure. Queued the patch in #25 again for testing.
Comment #31
longwaveComment #33
longwaveComment #35
AjitSComment #36
spitzialist CreditAttribution: spitzialist as a volunteer and at Unic commentedDo we need additional work here as the automated tests seem to fail again. Any hint would be appreciated to resolve this issue. thanks!
Comment #37
tedbow@spitzialist no it looks it is just a DrupalCi error and nothing to do with the patch
Comment #39
Gábor HojtsyThanks 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!