Though we made a number of edits to the user.module help page, it did not get a real substantial rewrite in the 6 cycle. This page is due for editing. One thing to note is this sentence:

By default there are two roles <em>anonymous</em> - a user who has not logged in, and <em>authenticated</em> a user who has signed up and who has been authorized.

which was added in 2005, and unfortunately did not get edited in 6.

Comments

keith.smith’s picture

Status: Active » Needs review
StatusFileSize
new2.89 KB

Finally, I had a chance to edit the first paragraph of /admin/help/user. I think the other two paragraphs must have been done back in 6.0 days. The major thrust of the edits were to clear up some of the text, as well as fix some improper references to authenticated rather than authenticated user, etc.

Patch attached.

keith.smith’s picture

FYI, #27073: More improvements to help text on access control pages is a patch to deal with some of the other help text issues in user module (on pages other than /admin/help/user). Though the two issues are related, I'd rather just handle them as two separate issues as they are now, since the text they address does not overlap. I'll wait on the other one, though, to prevent needless rerolls.

willhall-dupe’s picture

hi keith, so after working on the block.module ui I moved on to this. I wasn't clear about "approved" or "authenticated." Here are my revisions:


+      $output = '<p>' . t('The user module handles user account registration and authentication, which allow content to be associated with the user who contributed it. The user module is also critical to site security through configurable roles; roles define detailed permissions available to groups of users. There are two default roles and associated permissions: <em>anonymous user</em>, all visitors who have not logged in; and<em>authenticated user</em>, all users who have logged in to approved accounts. Administrators may define additional roles and permissions, and permissions are applied cumulatively to any users with multiple roles.') . '</p>';

 +     $output .= '<p>' . t("Users choose a name or handle, and can change account settings through their <em>My account</em> page. Depending on site configuration, users must log-in by supplying their previously-registered and authenticated username and password; through OpenID, a secure method for logging into multiple websites; with a username and password from another Drupal site; or by some other site-specific mechanism.") . '</p>';

+       $output .= '<p>' . t('Users should have browser cookies enabled when visiting your site. The cookie stores a unique ID, or session ID, for each user. It contains no personal information, but acts as an information retrieval key for each visit.') . '</p>';
keith.smith’s picture

StatusFileSize
new3.64 KB

I like willhall's suggested changes in #3, I've made them into a patch, attached. Unfortunately, I can't RTBC this, since its my patch.

Please credit willhall upon commit.

willhall-dupe’s picture

Sounds good keith.smith.

I'm something of a perfectionist when it comes to copy editing, so feel free to ignore this, but in the third paragraph I tweaked a repeating word ('each'). Such small edits can make a big difference, especially in text read repeatedly. (If you listen to the versions out loud, an improvement is immediately noticeable; visual reading sometimes isolates words from their greater context.)

Previously my revision was:

+ $output .= '<p>' . t('Users should have browser cookies enabled when visiting your site. The cookie stores a unique ID, or session ID, for each user. It contains no personal information, but acts as an information retrieval key for each visit.') . '</p>';

Now with the small tweak:

$output .= '<p>' . t('Users should have browser cookies enabled when visiting your site. The cookie stores a unique ID, or session ID, for each user. It contains no personal information, but acts as an information retrieval key for the visit.') . '</p>';

Also, where you say:

Unfortunately, I can't RTBC this, since its my patch.

Can I help?

- will

keith.smith’s picture

StatusFileSize
new3.66 KB

Erm. Ok. New patch attached.

The patch needs to be reviewed by someone else before it gets in front of a committer, and it should be someone other than the author(s). That leaves both of us out, unfortunately. Don't worry though -- someone will review it eventually.

stevenpatz’s picture

The user module handles user account registration and authentication, which allow content

Shouldn't that read:
The user module handles user account registration and authentication, which allows content

willhall-dupe’s picture

The user module handles user account registration and authentication, which allow content to be associated with the user who contributed it.

Shouldn't that read:
The user module handles user account registration and authentication, which allows content

Not in my mind, because grammatically it is two things, registration and authentication, plural, that are doing the allowing. The clauses should stand independently. So let's break it into two sentences:

The user module handles user account registration and authentication.
User account registration and authentication allow content to be associated with the user who contributed it.

or

The user module handles user account registration and authentication.
User account registration and authentication allows content to be associated with the user who contributed it.

So if in the context of Drupal usage, "registration and authentication" are the same thing, then you're right, it should be "allows." Otherwise, no.

Grammar and usage, however, must be flexible to the greater purpose of intelligible reading. if "allow" is a stumblingblock and just 'sounds wrong,' then, yes, we should recognize that this is a special case, and change it in the interests if smoother language.

Keith what do you think? And I tell you what, if this is just editing the .txt file, saving as .patch, and uploading it via the upload feature on this page, then I can do that if needed.

Thanks for input, and also do point me in the direction of more ui copy editing needs. Should I just grab text from the ui myself and open an issue?

-- Will

keith.smith’s picture

If it were me, I'd reword the sentence to avoid the problem altogether.

Maybe something like "The user module handles user account registration and authentication, allowing content to be associated with the user who contributed it."

@willhall: in this case, yes, you could just edit the patch and reupload it. In general, though, if the patch is more complex than this one, then you'd want to make the change to a copy of HEAD and refresh the patch (to properly account for anything else that may have changed in HEAD in the interim). It's also easy to corrupt a patch if you edit it manually to the point where it doesn't apply.

In regard to other changes, if you see trouble spots in the UI, and a current issue doesn't exist (it would likely be in the user interface text queue if it does), then you could open a new issue. If an issue exists, then just comment there.

willhall-dupe’s picture

StatusFileSize
new3.66 KB

Maybe something like "The user module handles user account registration and authentication, allowing content to be associated with the user who contributed it."

Nice.

OK I edited the patch and to say "allowing," and here it is.

Status: Needs review » Needs work

The last submitted patch failed testing.

willhall-dupe’s picture

StatusFileSize
new3.66 KB
keith.smith’s picture

Status: Needs work » Needs review

Patch in #12 needs review.

Status: Needs review » Needs work

The last submitted patch failed testing.

mlncn’s picture

Because installation profiles can (and the default install profile does) add a role, "default" is not the best word choice. There can be other roles provided by default, and these two core roles cannot be overridden.

With a the proposal in "make roles admin look like content types" to refer to these roles as built-in (a follow-up to that issue that could perhaps be rolled in over here with only maiming a kitten). Built-in wasn't popular there, and i don't love it either, but "default" is simply misleading.

ctmattice1’s picture

StatusFileSize
new2.53 KB

how does resident sound in place of default

ctmattice1’s picture

Status: Needs work » Needs review

forgot to change status

Status: Needs review » Needs work

The last submitted patch, 222855-4.diff, failed testing.

ctmattice1’s picture

Status: Needs work » Needs review
StatusFileSize
new2.34 KB

My Bad. win line endings

yoroy’s picture

Status: Needs review » Fixed

User module help page got updated during the big core help update. Feel free to re-open if you find specific issues with the current text.

Status: Fixed » Closed (fixed)

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