This patch provides an update for the node module's main help page.

  • It simplifies the English, fixes some errors in English composition, and makes things clearer.
  • It documents what a "content type" is and how Drupal can use it.
  • It documents the "revisions" feature.
  • It makes the various administration pages for the node module easy to find in context.

It includes two comments that need attention. (These appear in bold when the patch is applied.)

In the unordered list at the beginning of the help page, the patch includes four links that need arrays to define their destinations. Since I don't know PHP, I don't know how to place arrays within an unordered list. So those arrays still need to be supplied. For this I'd need someone's help.

Since this is the first patch I've ever done, I'd be grateful to know whether, technically speaking, it has been "done right" or whether there's anything I should do differently. (I used UnxUtils. The ID for the original file of the module reads "node.module,v 1.746 2006/12/10 21:07:15 dries".)

I have text ready for several other modules. So if I've done this one right I'll submit the others.

Thank you.
O Govinda

CommentFileSizeAuthor
#10 103041-10.patch3.67 KBkeith.smith
#9 node.module.patch2.34 KBgaele
#7 node.module.patch2.25 KBgaele
Revised help page for Nodes module.patch5.48 KBAnonymous (not verified)
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

webchick’s picture

Title: Revised help page for Nodes module » String freeze: Revised help page for Nodes module
Status: Needs review » Needs work

Hi, O Govinda! Thanks for the patch! Here's some feedback.

I's great to split patches up into logical distinct pieces and you've done that well. You also figured out "diff" which can be intimidating for new people. So well done! :)

However:

1. What you should do is just change the text to however you'd like it, and then make the patch from that modified file; a patch file is basically, "I think Drupal should do this instead of that"; comments/suggestions/questions should be posted to the issue queue instead.

2. It's best if you can do:

cvs diff -up > patchfile.patch

from the "root" your Drupal CVS checkout. This will make it so one of the developers can do a simple command (patch -p0 < patchfile.patch) to import your changes and see what they look like. The patch as it stands now will prompt the tester to go and find the file to patch, because Drupal doesn't have a "node.module.new"

3. The links in the t() are broken. This is not immediately apparent, but what you need to do in addition to putting @placeholder in is throw in an array('@placeholder' => 'thingy') at the end. For example:

      $output .= '<p>'. t('For more information please read the configuration and customization handbook <a href="@system">System page</a>.', array('@system' => 'http://drupal.org/handbook/modules/system/')) .'</p>';

4. Regarding your comments themselves: No, we probably shouldn't have the link to search there since it's dependent on search module, so go ahead and remove it. And for the second, while I would like to explain this in rich detail, it would be overkill for a simple help page, so better to put that as a sub-page in the handbook or something under that section.

Marking code needs work just until those things are addressed.

Paul Natsuo Kishimoto’s picture

Version: 5.0-beta2 » 5.x-dev

@o: Seconding webchick on figuring out diff. I'm still working on it o_O.

Given the string freeze, I'm going to update all your UI text issues to 5.x-dev so they get looked at once the 5.0 release cycle is done, and don't get lost when people forget about the betas. Clear English makes a huge difference to many users, and also to people doing localization, who won't have to translate unusual grammar and colloquialisms.

webchick’s picture

Version: 5.x-dev » 6.x-dev

RC1 is out, so this now gets pushed to 6.x-dev. Sorry. :\

Paul Natsuo Kishimoto’s picture

@webchick: Whoops - sorry! It makes sense that the strings have to stay the same for the whole 5.x branch (so that translations don't have to be continually revised, I suppose). I should have thought of that earlier.

I'll go update all the issues I just made 5.x-dev to 6.x-dev, and not make this mistake again in the future!

webchick’s picture

Hey, no problem. :) Thanks for doing some house-cleaning!

keith.smith’s picture

Component: node system » documentation

Moving to documentation component.

gaele’s picture

Status: Needs work » Needs review
FileSize
2.25 KB

Patch as webchick suggested (see #1 item 4).

I left out the link to "search posts", and also the other links, as they are repeated below under "Node administration pages". Perhaps in D7 we could have a general overhaul of the help pages, and integrate these links with the help text.

keith.smith’s picture

Status: Needs review » Needs work

Thanks for moving forward with this! I very very much appreciate it...

A few notes, of course:

  • we have recently been breaking the items in lists into separate t()'d strings, which is apparently less troublesome when translating. Any of the recent commits of help pages that have lists should provide an example, like the patch that was committed in http://drupal.org/node/175127. In one of those last comments on that issue, there is also a discussion about a convention for referencing text on other pages, as well, that may be helpful.
  • Is the node module what lets you "search all the content on your site"?
  • To be consistent with some of the other help pages, you may want to make some of the references like "content types" clickable, so that they lead to the page they reference.
  • On "set norms for how posts are entered and displayed", that still makes me wonder what it does. But, so did the original "The configure settings tab has basic settings for content on your site."
  • Technically, I guess it is the node module, rather than "the nodes module".

Please do not interpret any of these minor things as criticism; really, you're my new best friend for jumping in here.

gaele’s picture

Status: Needs work » Needs review
FileSize
2.34 KB

- separated list items
- removed "search all content"
- fixed "node module"

The "content types" link is already mentioned in the link list below the text. I wouldn't mention it twice (but see my remark in #7).

keith.smith’s picture

FileSize
3.67 KB

@gaele: I took your patch in #9 and added some more info about publishing settings, revision moderation, etc. I certainly understand your comment in #9 about content types and permissions already being below in the link list, but we also mention them in-line in most of the other help texts so far. Maybe in D7 we can redo this somehow, as you say.

I guess this is about the only place where we can legitimately use the word "node" in help text, in fact, I think we need to mention it in here, since try as we might, it is an intrinsic Drupal concept.

Gábor Hojtsy’s picture

Status: Needs review » Fixed

Great, I committed this one. It gives much more action links to users and cleans up help on some UI which we don't have anymore. I also easier on the translators. Thanks!

Anonymous’s picture

Status: Fixed » Closed (fixed)

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