I am reading through all of the new help screens for Drupal 7 today, checking links and taking one more look at spelling, grammar, wording, etc. There are a few minor issues in several of the screens, and I thought maybe it would make sense to collect them here. I'm undecided on the merits of reopening individual module issues for minor fixes, or fixing them all here in one patch... probably one patch is OK as long as the changes are minor.

Here are some things I noticed.
- Aggregator: Should link to Handbook page on cron http://drupal.org/cron, not the status report page (as we did for other modules, such as Search).
- Block: Refers to "The default theme Seven"... It is not the default theme, it is only the default administration theme if you use the non-expert install profile. Should probably say "The administration theme Seven". Also it refers to area and region -- should pick one term (except when first defining) and stick to it. And it should use region as the term it sticks to.
- Blog: OK
- Book: "similarly tiered structure" should have hyphen: similarly-tiered structure. Also, the permission for printer-friendly has apparently been renamed to "View printer-friendly books".
- Color: Apparently the "configure" link for themes has been changed to "settings".
- Comment: OK

I'm going to save this now, and go through some more in a while (adding as later comments). If someone else wants to review a few screens, maybe you could start alphabetically at the end and work backwards?

CommentFileSizeAuthor
#8 pollhelp.png16.64 KBjhodgdon
#8 658140.patch35.76 KBjhodgdon

Comments

jhodgdon’s picture

More modules reviewed:
- Contact: The permission name has changed to "Use the site-wide contact form" apparently.
- Content translation: OK
- Contextual links: OK
- Dashboard: Doesn't link to Handbook page on this module, and I think our standard is that all modules should now.
- Database logging: OK
- Field, Number, List, Field SQL Storage, Options - skip, latest patch has recently been reviewed at #645776: Help File Fixup: field
- Field UI - OK
- File - skip, latest patch has recently been reviewed at #645802: Help File Fixup: File module
- Filter: "adds, removes or transforms" - needs comma before "or" as per our doc standards. Also "URLS" should be "URLs". Hmmm. I used the "expert" install profile, and I didn't have all 3 default formats, but only "plain text". So we should probably note that the 3 default formats come with the default install profile, or just take out the mention of the specific defaults, or say something like "Depending on your install profile, you will have one or more default text formats defined.".

jhodgdon’s picture

I went back and reviewed the ones I had skipped (the patches have been committed). I found that the Number module help wasn't committed with the Field patch, and reopened that issue. Reviewed Field, Field SQL Storage, and File, and they are OK.

More modules reviewed (back to alphabetical):
- Forum: Comment setting "Disabled" is apparently now called "Hidden" (the comment module help has this right).
- Help: OK
- Image: OK
- List: OK
- Locale: OK
- Menu: Admin permission is now called "Administer menus and menu items"
- Node: Is it really accurate to say the node module manages "all site content"? There can actually be a lot of content on a site that is not nodes, such as comments, Aggregator items, custom blocks, etc. The on-line handbook page also repeats this idea that all content on your site is nodes. It just isn't true... Also, the link in Node help to the Permissions page should be url('admin/config/people/permissions') (current link is broken).
- OpenID - OK
- Options - OK

jhodgdon’s picture

I think the best course of action (once I've finished reviewing the screens) is to file a catch-all patch here for the non-controversial, minor stuff (typos, broken links, permission name changes, UI text changes, etc.), and reopen the original issues for the possibly controversial suggested fixes.

So I am reopening:
#632898: Help File Fixup: Block module
#645784: Help File Fixup: Filter
#632820: Documentation standard update : node.module
and have put in the above reviews of those modules for further discussion.

jhodgdon’s picture

More reviews:
- PHP filter - OK
- Path: end of About section "path module" is not capitalized. The word "also" should also probably be removed from the beginning of the "Managing aliases" section, since sections sort of need to stand on their own. I also think the "create" link is problematic in the section below -- the link text is not very good (at a minimum it would need a link title to reflect where the link is going), and it doesn't really add that much value, I think, to link to the Create new content page anyway. So I think I would just make "create" not be a link.
- Poll: Probably needs a couple of commas to be removed (looks like something I probably wrote! I tend to be comma-happy).
- Profile: The page referenced on d.o is actually called "People who live in Canada", not "Users from Canada".
- RDF - OK

jhodgdon’s picture

Oh yeah, I skipped Overlay (had turned it off).

jhodgdon’s picture

More reviews:

- Overlay: With that module turned on, I can see the Overlay help link on both the Modules page and the Help page, but clicking it doesn't show the overlay help screen. Need to investigate this further to see if this is due to a typo in the overlay help screen patch, a bug in the Overlay module, or something else.
- Search: Permission names have changed to "Use search", "View user profiles", and "View published content". Also, in the indexing section, "maintains an index of words found the content" needs the word "in" ("found in the content"). And you always need a comma before which, when used like this: "and Content ranking which lets you adjust..."
- Shortcut: Permission name changed to "Select own shortcut set".
- Statistics: Link to http://drupal.org/cron for cron. Also in that same paragraph, I don't think it's necessary to have two links to the settings page (especially as the link text for the second link is not the same). Permissions page link should go to admin/config/people/permissions#module-statistics, and it would be useful if that paragraph explained what the necessary permisison is (View content hits). And the info about the popular content block should mention that it is only available if you have enabled page counting (see sentence about this in the next paragraph where it talks about the page counter).
- Syslog: OK
- System: OK

jhodgdon’s picture

More reviews:

- Taxonomy - OK
- Testing: OK
- Text: OK
- Toolbar: I think maybe the link to Shortcut module maybe should have the word "module" included in the link text [as it is now, it's (link)Shortcut(endlink) module].
- Tracker: OK
- Trigger: OK
- Update manager: OK
- User: Reopening issue #633616: Help file fixup : user.module with comments.

Phew, that's it (once I reopen User issue). Patch to come shortly.

jhodgdon’s picture

Status: Active » Needs review
StatusFileSize
new35.76 KB
new16.64 KB

Here's a patch that fixes the above-mentioned minor issues in:
aggregator, book, color, contact, dashboard, forum, menu, path, poll, profile, search, shortcut, statistics, shortcut.

Other modules I reopened their issues:
#632898: Help File Fixup: Block module
#645784: Help File Fixup: Filter
#632820: Documentation standard update : node.module
#633616: Help file fixup : user.module

And I still need to investigate Overlay. When I figure that out, I'll either reopen the overlay help issue, or file a new issue, depending on what I think is going on.

And we need an on-line handbook page at http://drupal.org/handbook/modules/dashboard to be created.

I decided that attaching lots of screenshots for minor fixes wasn't time efficient. I hope that's OK. I did attach one for the poll module, as I did a little bit of editing. The others were all fairly minor and I think non-controversial changes.

dries’s picture

Status: Needs review » Fixed

This looks great! Reviewed the patch, and didn't saw anything wrong. Committed to CVS HEAD. Thanks.

arianek’s picture

last night i reviewed all the patches you posted and RTBCed/commented/posted revised patches as needed. got the dashboard page created and aliased as well. (and a new issue posted to make content for it)

jhodgdon’s picture

Thanks arianek, you are a star!

Status: Fixed » Closed (fixed)
Issue tags: -d7help

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