String freeze: Change some confusing help texts in "RSS Publishing"
marco.robotangel - December 18, 2007 - 16:33
| Project: | Drupal |
| Version: | 6.x-dev |
| Component: | documentation |
| Category: | task |
| Priority: | normal |
| Assigned: | Unassigned |
| Status: | closed |
Description
Some of the help texts in "RSS Feeds" are, especially for newbies, confusing. It is not obvious from the help text that drupal sites typically have several RSS feeds. The suggestion made at [1] is:
'Number of items per feed' => ''Number of items in each feed'
'The default number of items to include in a feed' => 'The default number of items to include in each feed'
#1
Additionally, it was suggested to change those, too:
'Display of XML feed items' => 'Feed Content'
'Global setting for the length of XML feed items that are output by default' => 'Global setting for the default display of content items in each feed'
It should be clear why those can be confusing for users who have never seen an xml and/or don't know what RSS is exactly.
#2
To the docs queue.
#3
Meh.
Display of XML feed items is confusing to me, and I think the proposed Feed content is much better.
Global setting for the default display of content items in each feed isn't a tremendous improvement over Global setting for the length of XML feed items that are output by default though. Shouldn't that be just Length of items included in feeds.? I would say Format of items... there except that, I guess, they are in XML format or whatever.
That, though, makes me want to change the description on the field above it to Number of items included in feeds. which, really, does not add much value over the field title Number of items in each feed. Really, I'm not sure a description is really necessary on that one, though the attached patch does have one.
#4
(make this easier to find under string freeze doom.)
#5
The "by default" notes refer to some contrib modules purposefully using different settings. Also, what type of content: (title only, teaser or body) is included in the feed is not the *length* of the feed item is it?
#6
This patch uses the suggestions made in the initial issue and in comment #1. The "Feed content" change is certainly a worthwhile mod. :)
@Gábor: I thought about "type" of content, but that gets confusing with content types. "Format" of types is confusing with XML format, and the rest. Anyway, the folks in http://groups.drupal.org/node/7043 have probably thought about this much more than I have.
#7
#6 looks good to me. "default display of content items" describes that option as well as anything I can think of - important not to introduce words that have loaded meanings elsewhere.
#8
Thanks, committed.
#9
Automatically closed -- issue fixed for two weeks with no activity.
#10
Well done Marco (subscribing)