summaryrefslogtreecommitdiff
path: root/modules/aggregator.module
diff options
context:
space:
mode:
authorDries Buytaert <dries@buytaert.net>2001-06-23 10:33:38 +0000
committerDries Buytaert <dries@buytaert.net>2001-06-23 10:33:38 +0000
commit3e075294febed760b7e59a8b8a59dc2ebe8ccf7b (patch)
tree54cf6511398f05bc056b6cdee9db755ec3ee4b29 /modules/aggregator.module
parentd565b6f34ad1923cd32a6b80ba31c0791782445f (diff)
downloadbrdo-3e075294febed760b7e59a8b8a59dc2ebe8ccf7b.tar.gz
brdo-3e075294febed760b7e59a8b8a59dc2ebe8ccf7b.tar.bz2
- Added locale documentation: written by Gerhard, revised by Dries.
- Added import documentation: written by Gerhard, revised by Dries. TODO: - A quick introduction on content syndication needs to be written for import.module. - If some one who is native English could go over the these text, please do.
Diffstat (limited to 'modules/aggregator.module')
-rw-r--r--modules/aggregator.module7
1 files changed, 6 insertions, 1 deletions
diff --git a/modules/aggregator.module b/modules/aggregator.module
index 8befa5beb..447090738 100644
--- a/modules/aggregator.module
+++ b/modules/aggregator.module
@@ -2,7 +2,12 @@
function import_help() {
?>
- <P>TODO - anyone?</P>
+ <P><I>TODO: introduction on syndication and a few pointers to more information.</I></P>
+ <P>In Drupal you have <I>feeds</I> and <I>bundles</I>. Feeds define news sources and bundles categoriz syndicated content by source, topic or any other heuristic. Bundles provide a generalized way of creating composite feeds. They allow you, for example, to combine various sport-related feeds into one bundle called "Sport".</P>
+ <P>You can have several providers of news feeds. You can add a feed by clicking the "add feed" link on the import administration pages. Give the feed a name, supply the URI and a comma-separated list of attributes that you want to associate the feed with. The update interval defines how often Drupal should go out to try and grab fresh content. The expiration time defines how long syndicated content is kept in the database. So set the update and expiration time and save your settings. You have just defined your first feed. If you have more feeds repeat as necessary.</P>
+ <P>To verify whether your feed works, press "update items" at the overview page. The number of items that have been sucessfully fetched, should then become visible in the third column of the feed overview.</P>
+ <P>Now you have to define some bundles. Bundles look for feeds that contain one of the keywords associated with the bundle and display those feeds together. To define a bundle you have to give it a name and a comma-separated list of keywords just like this is the case for feeds.</P>
+ <P>Your newly created bundle will now show up in the list of blocks that you can see at the block related administration pages. There you can customize where and when your bundles will be displayed.</P>
<?php
}