From a8b218827a400cf5ced7db133be0a0f9e2180875 Mon Sep 17 00:00:00 2001 From: Dries Buytaert Date: Tue, 1 Nov 2005 10:17:34 +0000 Subject: - Patch #26139 by webchick / Kieran / documentation team: improved admin help of core modules! / --- modules/aggregator.module | 60 ++++++++++++----------------------------------- 1 file changed, 15 insertions(+), 45 deletions(-) (limited to 'modules/aggregator.module') diff --git a/modules/aggregator.module b/modules/aggregator.module index 58a5ef224..9cc9dbfdb 100644 --- a/modules/aggregator.module +++ b/modules/aggregator.module @@ -12,51 +12,21 @@ function aggregator_help($section) { switch ($section) { case 'admin/help#aggregator': - return t(' -

Thousands of sites (particularly news sites and weblogs) publish their latest headlines and/or stories in a machine-readable format so that other sites can easily link to them. This content is usually in the form of an RSS feed (which is an XML-based syndication standard).

-

You can read aggregated content from many sites using RSS feed readers, such as Amphetadesk.

-

Drupal provides the means to aggregate feeds from many sites and display these aggregated feeds to your site\'s visitors. To do this, enable the aggregator module in site administration and then go to the aggregator configuration page, where you can subscribe to feeds and set up other options.

-

How do I find RSS feeds to aggregate?

-

Many web sites (especially weblogs) display small XML icons or other obvious links on their home page. You can follow these to obtain the web address for the RSS feed. Common extensions for RSS feeds are .rss, .xml and .rdf. For example: Slashdot RSS.

-

If you can\'t find a feed for a site, or you want to find several feeds on a given topic, try an RSS syndication directory such as Syndic8.

-

To learn more about RSS, read Mark Pilgrim\'s What is RSS and WebReference.com\'s The Evolution of RSS articles.

-

NOTE: Enable your site\'s XML syndication button by turning on the Syndicate block in block management.

-

How do I add a news feed?

-

To subscribe to an RSS feed on another site, use the aggregation page.

-

Once there, click the new feed tab. Drupal will then ask for the following:

- -

Once you have submitted the new feed, check to make sure it is working properly by selecting update items on the aggregation page. If you do not see any items listed for that feed, edit the feed and make sure that the URL was entered correctly.

-

Adding categories

-

News items can be filed into categories. To create a category, start at the aggregation page.

-

Once there, select new category from the menu. Drupal will then ask for the following:

- -

Using the news aggregator

-

The news aggregator has a number of ways that it displays your subscribed content:

- -

Pages that display items (for sources, categories, etc.) display the following for each item: -

-

Additionally, users with the administer news feeds permission will see a link to categorize the news items. Clicking this will allow them to select which category(s) each news item is in.

-

Technical details

-

Drupal automatically generates an OPML feed file that is available by selecting the XML icon on the News Sources page.

-

When fetching feeds Drupal supports conditional GETs, this reduces the bandwidth usage for feeds that have not been updated since the last check.

-

If a feed is permanently moved to a new location Drupal will automatically update the feed URL to the new address.

', array('%block' => url('admin/block'), '%admin-news' => url('admin/aggregator'), '%new-feed' => url('admin/aggregator/add/feed'), '%new-category' => url('admin/aggregator/add/category'), '%update-items' => url('admin/aggregator'), '%news-aggregator' => url('aggregator'), '%sources' => url('aggregator/sources'), '%categories' => url('aggregator/categories'))); + $output = '

'. t('The news aggregator is a powerful on-site RSS syndicator/news reader that can gather fresh content from news sites and weblogs around the web.') .'

'; + $output .= '

'. t('Users can view the latest news chronologically in the main news aggregator display or by source. Administrators can add, edit and delete feeds and choose how often to check for newly updated news for each individual feed. Administrators can also tag individual feeds with categories, offering selective grouping of some feeds into separate displays. Listings of the latest news for individual sources or categorized sources can be enabled as blocks for display in the sidebar through the block administration page. The news aggregator requires cron to check for the latest news from the sites to which you have subscribed. Drupal also provides a machine-readable OPML file of all of your subscribed feeds.', array('%aggregator' => url('aggregator'), '%aggregator-sources' => url('aggregator/sources'), '%admin-block' => url('admin/block'), '%aggregator-opml' => url('aggregator/opml'))) .'

'; + $output .= t('

You can

+ +', array('%admin-aggregator' => url('admin/aggregator'), '%admin-aggregator-add-feed' => url('admin/aggregator/add/feed'), '%admin-aggregator-add-category' => url('admin/aggregator/add/category'), '%admin-settings-aggregator' => url('admin/settings/aggregator'), '%admin-access' => url('admin/access'), '%aggregator' => url('aggregator'))); + $output .= '

'. t('For more information please read the configuration and customization handbook Aggregator page.', array('%aggregator' => 'http://www.drupal.org/handbook/modules/aggregator/')) .'

'; + return $output; case 'admin/modules#description': return t('Aggregates syndicated content (RSS and RDF feeds).'); case 'admin/aggregator': -- cgit v1.2.3