| 1 |
// $Id: README.txt,v 1.17 2007/10/04 22:03:37 m3avrck Exp $
|
| 2 |
|
| 3 |
### ABOUT #############################################################################
|
| 4 |
|
| 5 |
SimpleFeed, Version 1.0
|
| 6 |
|
| 7 |
Authors:
|
| 8 |
|
| 9 |
Ted Serbinski, aka, m3avrck (original author)
|
| 10 |
hello@tedserbinski.com
|
| 11 |
http://tedserbinski.com
|
| 12 |
|
| 13 |
Bill O'Connor, aka, csevb10
|
| 14 |
billiamo@gmail.com
|
| 15 |
http://achieveinternet.com
|
| 16 |
|
| 17 |
Requirements: Drupal 5.0
|
| 18 |
|
| 19 |
|
| 20 |
|
| 21 |
### FEATURES #############################################################################
|
| 22 |
|
| 23 |
- uses SimplePie <http://simplepie.org/> as the default feed parsing engine
|
| 24 |
- very simple and fast: everything is a node, use hook_nodeapi() to manipulate anything you want
|
| 25 |
- feed & feed items obey default node workflow + options (e.g., set if feed items should be published by default)
|
| 26 |
- auto-taxonomy, automatically add categories in feeds to Drupal's taxonomy system
|
| 27 |
- revisions support for both feeds & feed items
|
| 28 |
- automatically delete feed items after a certain amount of time
|
| 29 |
- automatically generate feed item titles if they don't exist in the feed
|
| 30 |
- optionally save specific feed items by editing their expiration time to "never"
|
| 31 |
- edit any feed or feed item that comes in
|
| 32 |
- manually insert feed items into feeds
|
| 33 |
- customizable default input format for imported feeds (e.g., which tags to strip from feeds, if any)
|
| 34 |
- postgres support
|
| 35 |
- duplicate checking of both feeds & feed items
|
| 36 |
- granular feed permissions
|
| 37 |
- optional views support
|
| 38 |
- optional token support
|
| 39 |
|
| 40 |
|
| 41 |
|
| 42 |
### INSTALLATION #############################################################################
|
| 43 |
|
| 44 |
1. Download and unzip the SimpleFeed module into your modules directory.
|
| 45 |
|
| 46 |
2. Download SimplePie library (http://simplepie.org/), either the 1.0 or 1.1 development version (recommended).
|
| 47 |
Place simplepie.inc in your SimpleFeed module directory.
|
| 48 |
|
| 49 |
3. Goto Administer > Site Building > Modules and enable both SimpleFeed and SimpleFeed Item.
|
| 50 |
|
| 51 |
4. Goto Administer > Site Configuration > Simplefeed and configure the options.
|
| 52 |
|
| 53 |
5. If you wish to use auto-taxonomy support:
|
| 54 |
a. Enable taxonomy module
|
| 55 |
b. Create a new vocabulary and assign it to both the "feed" and "feed item" node types.
|
| 56 |
c. Check the "free tagging" box, since this feature only works with free tagging enabled taxonomies.
|
| 57 |
d. Revisit the settings page to have this vocabulary shown.
|
| 58 |
|
| 59 |
6. Goto User Management > Access control and set the permissions for both feeds and feed items.
|
| 60 |
|
| 61 |
7. Ensure that your "files" directory is public and writeable. Visit admin/logs/status to check this status.
|
| 62 |
(this is needed to cache feeds on the filesystem for significantly improved performance
|
| 63 |
if this is not possible, SimpleFeed will still work but you will see warnings in your logs)
|
| 64 |
|
| 65 |
8. Goto Create content > Feed to create a new feed.
|
| 66 |
|
| 67 |
9. Setup cron to run and download need items for the newly added feed.
|
| 68 |
|
| 69 |
10. Optionally install Views module that provides various views for seeing all feeds & feed items on your site.
|
| 70 |
|
| 71 |
11. Optionally enable the default block provided (requires Views).
|
| 72 |
|
| 73 |
|
| 74 |
|
| 75 |
### NOTES #############################################################################
|
| 76 |
|
| 77 |
- Even though aggressive says this caching won't work, it will -- it's only needed for non-cached pages and hence no affect.
|
| 78 |
|
| 79 |
- If some feeds aren't parsed, likely this is an issue with SimplePie <http://simplepie.org/> and not the module, which only
|
| 80 |
implements this library (e.g., it doesn't actually parse anything). Please submit those bugs to: http://simplepie.org/support/
|
| 81 |
|
| 82 |
- If you want your feeds to use a different default input format than "filtered html", make sure you give
|
| 83 |
anonymous users the right to use that input filter under Admin > Site Configuration > Input Formats
|
| 84 |
|
| 85 |
- If cron.php does not return because of a script timeout (e.g., trying to parse too many feeds at once),
|
| 86 |
wget calls by default the site up to 20 times total until it gets a valid response. Change your wget to -t 1 (try once)
|
| 87 |
0 * * * * wget -O - -q -t 1 http://www.example.com/cron.php
|
| 88 |
|
| 89 |
- Any registered Drupal user that creates a feed node will also own all subsequent feed item children. If you want
|
| 90 |
different behavior or don't want this at all, consider overriding this in a node template for this node type.
|
| 91 |
|
| 92 |
- If you want to change or remove the links at the bottom of each feed node or feed item node, simply use
|
| 93 |
Drupal's hook_form_alter <http://api.drupal.org/api/function/hook_link_alter/5> to alter them.
|
| 94 |
|
| 95 |
|
| 96 |
|
| 97 |
### CHANGELOG #############################################################################
|
| 98 |
|
| 99 |
SimpleFeed 1.0, 2007-xx-xx
|
| 100 |
----------------------
|
| 101 |
- Initial release
|
Parent Directory
| 
Revision Log
| 
Revision Graph