The attached patch adds an entry for CCK on the admin/help screen, and provides a first draft effort at help text for CCK in general. I'm certainly open to doing this however the maintainers think best, but I wrote it in the style of the recent help text revisions for Drupal 6. I have no idea how many people actually take advantage of the embedded help, but while we have the tool available to us, I think we should use it. If it provides any help at all to new folks looking to take advantage of CCK features, then that is A Good Thing (tm).

Note that I made a change to content.module's info file to rename the "name" from "Content" to "Content (CCK)" so that it would display correctly on the admin/help page. Without this change, I'm not sure it would be obvious which of the modules there was related to the CCK package one just installed; there are already many notes in the forum with people confused between "CCK" and "Content". On a Drupal 6 installation with all core modules enabled, this is more apparent because of "Content translation" module. As far as I know, changing the name has no other side effects, but I may well be mistaken.

Please feel free to edit away or provide suggestions for other text that you feel should be included. This is really just a starting point. Also, I had considered moving the field module help to the respective field modules, and just linking to them from content module's help, but ended up going with this approach. I'm certainly open to re-visiting that if that approach is preferred.

Thanks!

CommentFileSizeAuthor
#3 content_help4.patch5.59 KBkeith.smith
#2 content_help3.patch5.57 KBkeith.smith
#1 content_help2.patch5.57 KBkeith.smith
content_help.patch5.56 KBkeith.smith

Comments

keith.smith’s picture

keith.smith commented
StatusFileSize
new content_help2.patch5.57 KB

I rerolled so that the patch will still cleanly apply, and fixed a plural issue on the fieldgroup module description.

keith.smith’s picture

keith.smith commented
StatusFileSize
new content_help3.patch5.57 KB

Rerolling to remove a bit of offset.

keith.smith’s picture

keith.smith commented
StatusFileSize
new content_help4.patch5.59 KB

Rerolling to remove LOTS of offset.

Also, this may be an ok proposal for CCK right now, but I somehow feel that every module in core will need its own help text. I think the help in the ul is valuable, as it provides an overview. But, I'll look into creating a set of help texts for the field modules as well; the field module help can link to content module's help and vice versa, as available and necessary.

yched’s picture

yched commented

Committed the help text to HEAD and D5. Thanks !

I'm not 100% happy about renaming 'Content' to 'Content (CCK)' in content.info, since it will also appear in admin/build/modules, where it's already listed under the 'CCK' fieldset, which is awkward...

keith.smith’s picture

keith.smith commented
Status: Needs review » Fixed

yched: Thanks!

I'm not completely happy with the renaming solution either. Perhaps a better way to approach this would be to append the package name as specified in the .info file to the help tag as it displays on the admin/help screen, which would work out to the same thing in this case.

I'm not sure if you meant to mark this fixed or if you wanted #4 to stand as an open item, so please set the status back if this is not 'fixed'.

Anonymous’s picture

Anonymous (not verified) commented
Status: Fixed » Closed (fixed)

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