Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.From the main config page at admin/config if you click on "Shortcuts" you get to the settings for adding a "set" of shortcuts. (Personally I would have added shortcut "sets" in a V2 of shortcuts module). The user is expecting to be able to edit the shortcuts themselves. And there is no link there to edit shortcuts. Indeed on the Toolbar there is a link to edit shortcuts. But we can't assume everyone will have the toolbar on. And in any case, when you go to a shortcuts config screen, you need links to the relevant config pages.
The attached patch adds system.module:
case 'admin/config/system/shortcut':
$shortcut_set = shortcut_current_displayed_set();
return t('<p>On this page you can <ul><li>choose a set of shortcuts for current use</li><li>create a new set of shortcuts</li></ul></p><p>Elsewhere you can <a href="@editshortcuts">edit the current set of shortcuts</a> and <a href="@shortcutshelp">learn more about shortcuts</a>.</p>', array('@editshortcuts' => url('admin/config/system/shortcut/' . $shortcut_set->set_name), '@shortcutshelp' => url('admin/help/shortcut'))) . '</p>';
Shai
| Comment | File | Size | Author |
|---|---|---|---|
| #16 | shortcut-help-681814-16.patch | 1.48 KB | Shai |
| #14 | shortcut-help-681814-14.patch | 1.48 KB | Shai |
| #3 | shortcut-help-681814-3.patch | 1.45 KB | Shai |
| shortcut-helptext-patch.patch | 1.43 KB | Shai | |
Comments
Comment #1
Shai CreditAttribution: Shai commentedMight as well test the patch... though I'm not assuming at all its in its final form, definitely want feedback.
Comment #2
matt2000 CreditAttribution: matt2000 commented1. This should go in shortcuts_help() in shortcuts.module, not system.module.
2. The accuracy of this info is dependent on the user having administration permissions for shortcut module. But I doubt any of core's help text is permissions-aware, so this may not matter.
Comment #3
Shai CreditAttribution: Shai commented@matt2000,
Re: your concern #1, I've moved the code to shortcuts_help() as you suggested.
New patch attached.
Not sure I understand what you wrote in #2...
I'm thinking that the "Edit current set" page should be the main link off admin/config. Do people agree and if so, is it hard to do?
Also, anybody know how the links get listed on help pages like at: admin/help/shortcut
In that case, the Edit shortcuts page is not showing up at the bottom where the other two admin links are.
Thanks,
Shai
Comment #4
jhodgdonThere is a similar issue elsewhere... #647084: Missing shortcut edit and delete operations on shortcuts admin. I think this one is a duplicate of that other one.
Comment #5
matt2000 CreditAttribution: matt2000 commentedNope, that's about navigational links. This is about help text. Entirely independent.
Comment #6
jhodgdonSorry. Well, Bojhan is also trying to totally overhaul the shortcuts page, don't have issue link handy, but you might try a search... and it might also affect this issue.
Comment #7
jhodgdon#680500: Shortcuts violate Drupal UI standards is the other issue.
Comment #8
Shai CreditAttribution: Shai commentedI was thinking of marking this issue as "postponed", but now I'm thinking we should commit it ASAP.
Here is my thinking.
If there is going to be a real fix to the shortcut module in advance of D7 alpha 1... then certainly we should hold off on this issue and make the help text fit what the module becomes.
However, if it is unrealistic that the shortcut module is really going to be overhauled in advance of D7 alpha 1, then I think this patch should be committed right away. The UI might be confusing and not fit in with Drupal standards... but at least this help text (with the links provided) will get people to be actually able to use it and experiment with it instead of thinking that it is totally broken... which it isn't.
It'll be no big deal to re-do this help text after Shortcut module gets its more significant fix.
I'm really now leaning to this latter approach. Let's commit this patch to prevent some frustration for testers and early adopters.
Shai
Comment #9
jhodgdonI put a suggested fix to the shortcut help at http://drupal.org/files/issues/shortcuthelp.txt in comment http://drupal.org/node/647084#comment-2473832 on issue #647084: Missing shortcut edit and delete operations on shortcuts admin.
Comment #11
Shai CreditAttribution: Shai commentedIf "#647084: Missing shortcut edit and delete operations on shortcuts admin" is stuck, maybe we should fire this puppy up to try to get it in Alpha-1.
Part of what Alpha-1 will do is get a lot more people using D7; it would be nice to get more feedback from the Shortcut module beyond, "this is unusable."
This patch, since it is just help text, is so easy to undo later and doesn't get in the way of further solving the problems.
My 2 cents. But I'd rather have this in Alpha-1 than no fix at all.
Shai
Comment #12
jhodgdonToo late for the first alpha. :)
So I took a good look at the patch in #3. It has some style issues:
- I would capitalize the first letter of each bullet point, in general.
- I don't like that the first part is a UL and the second part is not, although both are similar two-item lists.
- It is not correct HTML to put a UL inside of a P. Need to close the P before the UL.
- I would (nearly) always put a : before the start of a UL, because whatever comes before the UL acts as a header for the list.
A slightly bigger issue:
We are trying not to state the obvious in context-sensitive, on-page help. So I would actually just leave out the description of what you can do on this page, because it should hopefully be obvious from looking at the page you are on. Instead, I think I would just say something like "You can also edit your current shortcut set, and learn more about shortcuts" (with links as in that patch).
Comment #13
jhodgdonForgot status change
Comment #14
Shai CreditAttribution: Shai commentedHere is another patch. I made all the html changes suggested by @jhodgdon in #12.
As for the "slightly bigger issue." I'm going to leave the "what you can do on this page" in the patch for now.
This is a brand new module. If this patch is committed it is likely an interim solution. Leaving aside the question of what core help-text verbosity level should be, I think we need to think of the Shortcut module as a special case in which we want to encourage earlier adopters to use it, so we can get their feedback. I think that "what you can do on this page" will help a little bit in getting people to grok what's going enough to give it a try.
Shai
Comment #15
jhodgdonPlease get Bojhan to comment on whether what's here is "stating the obvious" or necessary help text. I still think this falls in the obvious category. We need a 3rd opinion, and someone besides the two of us needs to review it anyway.
The patch has too much indentation on the added lines (probably is using tabs instead of spaces), so that needs to be fixed for sure.
Comment #16
Shai CreditAttribution: Shai commentedPatch attached with tabs converted to spaces.
Comment #17
jhodgdon:) Patch format and HTML look good to me. Again, let's get someone else to review the text.
Comment #18
amc CreditAttribution: amc commented#16: shortcut-help-681814-16.patch queued for re-testing.
Comment #20
amc CreditAttribution: amc commentedNot sure about "Choose a set of shortcuts for current use." What about simply "Choose a set of shortcuts" or even "Choose a shortcut set." Likewise all "set of shortcuts" could be changed to "shortcut sets."
Comment #21
Bojhan CreditAttribution: Bojhan commentedI am definitely tempted to mark this won't fix. It's mostly stating the obvious, and providing (too) many links to other places.