From 8b820b13ecec46c867a4caa84df329c1938f134f Mon Sep 17 00:00:00 2001 From: Dries Buytaert Date: Wed, 4 Aug 2004 17:45:46 +0000 Subject: - Patch #9757 by Al: improved the aggregator help. Help texts should be to the point. --- modules/aggregator/aggregator.module | 54 ++++++++++++++++++------------------ 1 file changed, 27 insertions(+), 27 deletions(-) (limited to 'modules/aggregator') diff --git a/modules/aggregator/aggregator.module b/modules/aggregator/aggregator.module index ec0e1a648..694568ad2 100644 --- a/modules/aggregator/aggregator.module +++ b/modules/aggregator/aggregator.module @@ -8,48 +8,48 @@ function aggregator_help($section) { switch ($section) { case 'admin/help#aggregator': return t(' -

Thousands of web sites, especially news sites and weblogs, syndicate their most recent site content for others to display. The syndicated content always includes titles, also known as headlines, for the newest published stories. Each headline acts as a direct link to the stories on the remote site. Along with the headline, most sites typically provide either the first few paragraphs of the story or a short summary. Many individuals use client-based news aggregators on their personal computer to aggregate content, such as Amphetadesk.

-

Drupal also has a news aggregator built in as a standard feature. With it, you can subscribe to feeds from other sites and display their content for your site users. Simply enable the aggregator module in site administration and enter the feeds that you choose.

-

What do I need to subscribe to a feed?

-

The standard method of syndication is using the XML-based Rich Site Summary (RSS). To syndicate a site\'s content, obtain the full URL of the RSS page providing syndication. Common file tags for RSS pages are .rss, .xml and .rdf. Example: Slashdot RSS.

-

Most weblog sites that offer syndication will have an obvious link on the main page. Often you need only look for a XML syndication button, such as the one Drupal uses for site syndication.

-

But some sites do not make their RSS feeds as easy to find. Or maybe you want to find a number of feeds on a given topic, without extensively searching the web. In that case, try an RSS syndication directory such as Syndic8.

-

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

+

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.

-

Adding news feeds

+

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 submit your new feed, check to see if it is working properly. Select 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.

+

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 which show the latest items in either a source, category, or of all items contain the following information for each item: +

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 add a right hand column to select the categories which each news item is in.

+

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.

@@ -57,11 +57,11 @@ function aggregator_help($section) { case 'admin/modules#description': return t('Used to aggregate syndicated content (RSS and RDF).'); case 'admin/aggregator': - return t('Several web sites, especially news related sites, syndicate parts of their site\'s content for other web sites to display. Usually, the syndicated content includes the latest headlines with a direct link to that story on the remote site. Some syndicated content also includes a description of the headline. The standard method of syndication is using the XML based Rich Site Summary (RSS) or Resource Description Framework (RDF). To get a feed to work you must have cron working. To display the feed or category in a block you must decide how many items to show by editing the feed or block and turn on the feed\'s block.', array('%block' => url('admin/block'), '%cron' => url('admin/help', NULL, 'cron'))); + 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). To display the feed or category in a block you must decide how many items to show by editing the feed or block and turning on the feed\'s block.
NOTE: This module requires cron.', array('%block' => url('admin/block'), '%cron' => url('admin/help', NULL, 'cron'))); case 'admin/aggregator/add/feed': - return t('Add a site that has an RSS/RDF feed. The URL is the full path to the RSS feed file. For the feed to update automatically you must run "cron.php". If you already have a feed with the URL you are planning to use, the system will not accept another feed with the same URL.'); + return t('Add a site that has an RSS/RDF feed. The URL is the full path to the RSS feed file. For the feed to update automatically you must run "cron.php" on a regular basis. If you already have a feed with the URL you are planning to use, the system will not accept another feed with the same URL.'); case 'admin/aggregator/add/category': - return t('Categories provide a generalized way of creating composite news pages or blocks. They allow you, for example, to combine various sport-related items into one category called Sports. News items can be added to a category automatically by setting a feed to automatically place items in a category or by using the categorize items link in any listing of news items.'); + return t('Categories provide a way to group items from different news feeds together. Each news category has its own feed page and block. For example, you could tag various sport-related feeds as belonging to a category called Sports. News items can be added to a category automatically by setting a feed to automatically place its item into that category, or by using the categorize items link in any listing of news items.'); case 'admin/aggregator/configure': return t('These settings control the display of aggregated content.'); } -- cgit v1.2.3