Rewrite User help
Xano - November 2, 2009 - 11:27
| Project: | Drupal |
| Version: | 7.x-dev |
| Component: | user.module |
| Category: | task |
| Priority: | normal |
| Assigned: | Xano |
| Status: | needs review |
| Issue tags: | Cleanup, Help text, Needs text review, ui-text, Usability |
Description
User.module's help texts contain a lot or unnecessary cruft: field api explanations, tech stuff about cookies, OpenID, logins through 3rd party software, etc. This patch removes all this and rewrite some other texts to make them simpler and shorter and yet say exactly the same. After this patch there is no more help text at admin/help/user, apart from a link to the online handbook. I'm not very happy with this, but the text that was there was not useful and the docs in the handbooks are not ready to be put into the module's help section.
| Attachment | Size | Status | Test result | Operations |
|---|---|---|---|---|
| rewrite_user_help_00.patch | 6 KB | Idle | Passed: 14693 passes, 0 fails, 0 exceptions | View details | Re-test |
#1
Tagging.
#2
adding ui-text tag.
#3
This is really a necessary UI Text change.
The changes proposed are severe, but necessary. (I'm reminded of amputation to cure gangrene?)
However, a brief sentence can soften the blow for a new user. This would be generous and helpful.
I've made screenshots of the original, Xano's changes, and my proposed change. Took cue from text on
http://drupal.org/handbook/modules/user/ - to tell the reader, at a high level, what this module does.
Original:
Xano's proposal:
The middle-way:
#4
I suppose you want a patch with that?
#5
Had a discussion with Xano in IRC.
His points
1) Neither of our patches address the problem
2) The problem is: this page is completely unnecessary and so is the corresponding help page. Axe them all!
3) But we can't get rid of this landing page for User module, nor can we rename it.
My points:
1) The person who lands on this page is a 'help page user'. The person who clicks on the general help link, and then see help topics and wanders onto the User page.
2) This page is not accessed through any other means on admin pages.
3) Be gentle, give a brief explanation. Likely they will use the back button, or click the config pages below the explanation (and likely not the handbook page).
Someone seeking advice on Best practices for permissions, suggested roles, registration, welcome emails, etc- are they going to click on a page called 'User'?
Elsewhere in the interface, they see 'People and permissions'.
A corresponding help-page in the handbook would be ideal, but it should link from the People and permissions help page (doesn't exist).
See also #423724: Help landing page: what should be on it, how would it look.
#6
Xano 2) This page isn't unnecessary, but the current contents are as they don't address specific things.
Xano 3/Heather 1) I think we can get rid of the entire page, but my current patch keeps it for sake of the link to the online handbooks.
Heather 2) This page can be accessed by the "More help" links (or whatever they're called these days) below the inline help.
#7
The user help screen has been totally reworked... see #633616: Help file fixup : user.module ... sorry to say we didn't know about this issue. Can someone who's been looking at this give the current help screen for User in D7 a look and see if it is acceptable?