Help File Fixup: aggregator

A couple of minor comments:

- I think the Uses sections on "Viewing feeds" and "block" could be combined, since the block is a way to view a feed isn't it?
- Let's get rid of the word "powerful" and stick to explaining what the module does.
- The first paragraph could probably have one sentence eliminated, since it repeats the information that the formats are RSS, Atom, etc.
- I think maybe the first paragraph should say "gathers and displays" rather than just "gathers".
- OPML - might want to explain what OPML is (it gives a list of the feeds being aggregated, kind of like a bookmark list, as opposed to listing the items from the feeds).
- In the first sentence, I would say "The aggregator module is"... (missing the word module here) - to conform to the style of the other help texts.
- The patch itself: In a couple of spots there is an extra space, which makes things not line up exactly. Not a huge deal, but if you are redoing the patch anyway...

Patch applies beautifully :)

+++ modules/aggregator/aggregator.module	22 Nov 2009 23:53:25 -0000
@@ -17,8 +17,17 @@ define('AGGREGATOR_CLEAR_NEVER', 0);
+      $output .= '<dd>' . t('Feeds contain feed items, or individual posts published by the site providing the feed. Feeds may be grouped in categories, generally by topic. Users view feed items in the <a href="@aggregator">main aggregator display</a> or by <a href="@aggregator-sources">their source</a>. The most recent items in either a feed or category can be displayed as a block through the <a href="@admin-block">blocks administration page</a>.', array('@aggregator' => url('aggregator'), '@aggregator-sources' => url('aggregator/sources'), '@admin-block' => url('admin/structure/block'))) . '</a></dd>';

Per UI text guidelines, 'content' is preferred over 'post' (http://drupal.org/node/604342)

How about replacing "Feeds contain feed items, or individual posts published by the site providing the feed" with

"Feeds contain individual pieces of content published by the site providing the feed"

but I like "Feeds contain published content" even better (since pieces of content sounds totally clunky here - it sounds as if the RSS feed is breaking up a node) but "Feeds contain published content items" works too since the word 'item' appears further down.

And instead of "Users view feed items" perhaps "Users view feed content"? And "The most recent items" could be "The most recent content"

I can do this one quickly :)

OK, I removed references to 'post', and added link to handbook.

What else does it need? Thx!

- caps on the first A of Aggregator module, to be consistent with the link to handbook page (been trying to get these all consistent)
- the first two lines after case 'admin/help#aggregator': should be:

+      $output = '';
+      $output .= '<h3>' . t('About') . '</h3>';

- the dl's should have their own output lines
- line 23 has an unnecessary space at the start of the string " A machine-readable"

looks pretty darn good otherwise!

Thanks for the help, ariane!!

Rerolled w/ your comments

Oops forgot the capital A... ignore previous patch

Re-rolling this with fixed indenting, some fixed formatting, and a few tiny grammar changes. I think it's good to go - can I get an RTBC?

Yep, looks good!

Committed to CVS HEAD. Thanks.

The standard for capitalization is not being followed. See http://drupal.org/node/632280 -- should start with "The foo module" not "The Foo module" according to standard.

This needs a quick repatch to conform.

Per consensus in #537828: Help text for core modules - update to conform to new standard this commit can stand.