modules/feed_node/README.txt

// $Id: README.txt,v 1.2 2006/12/13 17:43:37 dayre Exp $

README
==========================================
The purpose of this module is to provide a simple method 
for displaying aggregator feed items within a node framework.  
One can "feed enable" a particular node type which allows the 
user to attach a single feed to a node by specifying a feed title and URL.  

An alternative module which performs a similar function and integrates
with CCK is the feedfield module: http://drupal.org/project/feedfield

This module provides two display styles (title, and title + teaser) and 
allows the user to configure the maximum number of feed items to
display.  As well, the module ensures that all aspects of an aggregator feed
and it's corresponding feed items are available in the node data
structure so that custom themeing can be achieved if the default
themes are not adequate.

The updating of an individual aggregator feed's items is performed
by the aggregator.  Once a new feed is added, it's items will not be
displayed until the user has manually updated the feed, or the aggregator
has updated the feed via the cron hook.  A future enhancement would be
to perform this automatically or provide the node author a link to
update the associated feed items.

If the title and URL of the feed correspond to an existing feed already
in the aggregator table, then that feed will be used (no duplicates will 
be created).  If the title OR URL are changed, then the title OR URL of
the corresponding feed will be changed in aggregator.  

AUGMENTED NODE STRUCTURE
==========================================
$node->feed_node
$node->feed_node['fid']
$node->feed_node['nid']
$node->feed_node['numItems']
$node->feed_node['displayStyle']
$node->feed_node['aggregator_feed']  - an array containing aggregator_feed database row values
$node->feed_node['aggregator_items'] - an array of arrays containing aggregator_item database row values

Author
==========================================
David Ayre <david at bryght dot com>
Sponsored by Bryght <http://www.bryght.com>
1	// $Id: README.txt,v 1.2 2006/12/13 17:43:37 dayre Exp $
2
3	README
4	==========================================
5	The purpose of this module is to provide a simple method
6	for displaying aggregator feed items within a node framework.
7	One can "feed enable" a particular node type which allows the
8	user to attach a single feed to a node by specifying a feed title and URL.
9
10	An alternative module which performs a similar function and integrates
11	with CCK is the feedfield module: http://drupal.org/project/feedfield
12
13	This module provides two display styles (title, and title + teaser) and
14	allows the user to configure the maximum number of feed items to
15	display. As well, the module ensures that all aspects of an aggregator feed
16	and it's corresponding feed items are available in the node data
17	structure so that custom themeing can be achieved if the default
18	themes are not adequate.
19
20	The updating of an individual aggregator feed's items is performed
21	by the aggregator. Once a new feed is added, it's items will not be
22	displayed until the user has manually updated the feed, or the aggregator
23	has updated the feed via the cron hook. A future enhancement would be
24	to perform this automatically or provide the node author a link to
25	update the associated feed items.
26
27	If the title and URL of the feed correspond to an existing feed already
28	in the aggregator table, then that feed will be used (no duplicates will
29	be created). If the title OR URL are changed, then the title OR URL of
30	the corresponding feed will be changed in aggregator.
31
32	AUGMENTED NODE STRUCTURE
33	==========================================
34	$node->feed_node
35	$node->feed_node['fid']
36	$node->feed_node['nid']
37	$node->feed_node['numItems']
38	$node->feed_node['displayStyle']
39	$node->feed_node['aggregator_feed'] - an array containing aggregator_feed database row values
40	$node->feed_node['aggregator_items'] - an array of arrays containing aggregator_item database row values
41
42	Author
43	==========================================
44	David Ayre <david at bryght dot com>
45	Sponsored by Bryght <http://www.bryght.com>