| @@ -1,11 +1,11 @@ | ||
| 1 | 1 | === FeedWordPress === |
| 2 | 2 | Contributors: Charles Johnson |
| 3 | -Donate link: http://projects.radgeek.com/feedwordpress/ | |
| 3 | +Donate link: http://feedwordpress.radgeek.com/ | |
| 4 | 4 | Tags: syndication, aggregation, feed, atom, rss |
| 5 | -Requires at least: 1.5 | |
| 6 | -Tested up to: 2.8 | |
| 7 | -Stable tag: 2009.0613 | |
| 5 | +Requires at least: 2.8 | |
| 6 | +Tested up to: 3.0 | |
| 7 | +Stable tag: 2010.0528 | |
| 8 | 8 | |
| 9 | 9 | FeedWordPress syndicates content from feeds you choose into your WordPress weblog. |
| 10 | 10 | |
| 11 | 11 | == Description == |
| @@ -17,43 +17,39 @@ | ||
| 17 | 17 | FeedWordPress is an Atom/RSS aggregator for WordPress. It syndicates content |
| 18 | 18 | from feeds that you choose into your WordPress weblog; if you syndicate several |
| 19 | 19 | feeds then you can use WordPress's posts database and templating engine as the |
| 20 | 20 | back-end of an aggregation ("planet") website. It was developed, originally, |
| 21 | -because I needed a more flexible replacement for [Planet](http://www.planetplanet.org/) | |
| 22 | -to use at [Feminist Blogs](http://feministblogs.org/). | |
| 21 | +because I needed a more flexible replacement for [Planet][] | |
| 22 | +to use at [Feminist Blogs][]. | |
| 23 | 23 | |
| 24 | +[Planet]: http://www.planetplanet.org/ | |
| 25 | +[Feminist Blogs]: http://feministblogs.org/ | |
| 26 | + | |
| 24 | 27 | FeedWordPress is designed with flexibility, ease of use, and ease of |
| 25 | 28 | configuration in mind. You'll need a working installation of WordPress or |
| 26 | -WordPress MU (versions [2.7][], [2.6][], [2.5][], [2.3][], [2.2][], [2.1][], [2.0][] or | |
| 27 | -[1.5][]), and also FTP or SFTP access to your web host. The ability to create | |
| 28 | -cron jobs on your web host is helpful but not absolutely necessary. You *don't* | |
| 29 | -need to tweak any plain-text configuration files and you *don't* need shell | |
| 30 | -access to your web host to make it work. (Although, I should point out, web | |
| 31 | -hosts that *don't* offer shell access are *bad web hosts*.) | |
| 29 | +WordPress MU (version [2.8] or later), and also FTP or SFTP access to your web | |
| 30 | +host. The ability to create cron jobs on your web host is helpful but not | |
| 31 | +required. You *don't* need to tweak any plain-text configuration files and you | |
| 32 | +*don't* need shell access to your web host to make it work. (Although, I should | |
| 33 | +point out, web hosts that *don't* offer shell access are *bad web hosts*.) | |
| 32 | 34 | |
| 33 | - [2.7]: http://codex.wordpress.org/Version_2.7 | |
| 34 | - [2.6]: http://codex.wordpress.org/Version_2.6 | |
| 35 | - [2.5]: http://codex.wordpress.org/Version_2.5 | |
| 36 | - [2.3]: http://codex.wordpress.org/Version_2.3 | |
| 37 | - [2.2]: http://codex.wordpress.org/Version_2.2 | |
| 38 | - [2.1]: http://codex.wordpress.org/Version_2.1 | |
| 39 | - [2.0]: http://codex.wordpress.org/Version_2.0 | |
| 40 | - [1.5]: http://codex.wordpress.org/Version_1.5 | |
| 35 | + [WordPress]: http://wordpress.org/ | |
| 36 | + [WordPress MU]: http://mu.wordpress.org/ | |
| 37 | + [2.8]: http://codex.wordpress.org/Version_2.8 | |
| 41 | 38 | |
| 42 | 39 | == Installation == |
| 43 | 40 | |
| 44 | 41 | To use FeedWordPress, you will need: |
| 45 | 42 | |
| 46 | -* an installed and configured copy of WordPress version 2.6.x, 2.5.x, | |
| 47 | - 2.3.x, 2.2.x, 2.1.x, 2.0.x, or 1.5.x. (FeedWordPress will also work with | |
| 48 | - the equivalent versions of WordPress MU.) | |
| 43 | +* an installed and configured copy of [WordPress][] or [WordPress MU][] | |
| 44 | + (version 2.8 or later). | |
| 49 | 45 | |
| 50 | -* FTP or SFTP access to your web host | |
| 46 | +* FTP, SFTP or shell access to your web host | |
| 51 | 47 | |
| 52 | 48 | = New Installations = |
| 53 | 49 | |
| 54 | -1. Download the FeedWordPress archive in zip or gzipped tar format and | |
| 55 | - extract the files on your computer. | |
| 50 | +1. Download the FeedWordPress installation package and extract the files on | |
| 51 | + your computer. | |
| 56 | 52 | |
| 57 | 53 | 2. Create a new directory named `feedwordpress` in the `wp-content/plugins` |
| 58 | 54 | directory of your WordPress installation. Use an FTP or SFTP client to |
| 59 | 55 | upload the contents of your FeedWordPress archive to the new directory |
| @@ -58,69 +54,35 @@ | ||
| 58 | 54 | directory of your WordPress installation. Use an FTP or SFTP client to |
| 59 | 55 | upload the contents of your FeedWordPress archive to the new directory |
| 60 | 56 | that you just created on your web host. |
| 61 | 57 | |
| 62 | -3. Upgrade the copy of MagpieRSS packaged with WordPress by installing the | |
| 63 | - new copies of `rss.php` and `rss-functions.php` into the `wp-includes` | |
| 64 | - directory of your FeedWordPress installation. These files are stored in | |
| 65 | - the `MagpieRSS-upgrade` directory of your FeedWordPress archive. Strictly | |
| 66 | - speaking, upgrading MagpieRSS is optional; FeedWordPress will run | |
| 67 | - correctly without the upgrade. But if you hope to take advantage of | |
| 68 | - numerous bug fixes, or support for Atom 1.0, multiple post categories, | |
| 69 | - RSS enclosures, or multiple character encodings, then you need to | |
| 70 | - install the upgrade. | |
| 58 | +3. Log in to the WordPress Dashboard and activate the FeedWordPress plugin. | |
| 71 | 59 | |
| 72 | -4. Log in to the WordPress Dashboard and activate the FeedWordPress plugin. | |
| 60 | +4. Once the plugin is activated, a new **Syndication** section should | |
| 61 | + appear in your WordPress admin menu. Click here to add new syndicated | |
| 62 | + feeds, set up configuration options, and determine how FeedWordPress | |
| 63 | + will check for updates. For help, see the [FeedWordPress Quick Start][] | |
| 64 | + page. | |
| 65 | + | |
| 66 | +[FeedWordPress Quick Start]: http://feedwordpress.radgeek.com/wiki/quick-start | |
| 73 | 67 | |
| 74 | -5. Once the plugin is activated, you can go to **Syndication --> Options** | |
| 75 | - and set (1) the link category that FeedWordPress will syndicate links | |
| 76 | - from (by default, "Contributors"), and (2) whether FeedWordPress will | |
| 77 | - use automatic updates or only manual updates. | |
| 78 | - | |
| 79 | -5. Go to the main **Syndication** page to set up the list of sites that | |
| 80 | - you want FeedWordPress to syndicate onto your blog. | |
| 81 | - | |
| 82 | 68 | = Upgrades = |
| 83 | 69 | |
| 84 | -To *upgrade* an existing installation of FeedWordPress to version 2008.1030: | |
| 70 | +To *upgrade* an existing installation of FeedWordPress to the most recent | |
| 71 | +release: | |
| 85 | 72 | |
| 86 | -1. Download the FeedWordPress archive in zip or gzipped tar format and | |
| 87 | - extract the files on your computer. | |
| 73 | +1. Download the FeedWordPress installation package and extract the files on | |
| 74 | + your computer. | |
| 88 | 75 | |
| 89 | -2. If you are upgrading from version 0.98 or earlier, then you need to | |
| 90 | - create a new directory named `feedwordpress` in the `wp-content/plugins` | |
| 91 | - directory of your WordPress installation, and you also need to *delete* | |
| 92 | - your existing `wp-content/update-feeds.php` and | |
| 93 | - `wp-content/plugins/feedwordpress.php` files. The file structure for | |
| 94 | - FeedWordPress has changed and the files from your old version will not | |
| 95 | - be overwritten, which could cause conflicts if you leave them in place. | |
| 76 | +2. Upload the new PHP files to `wp-content/plugins/feedwordpress`, | |
| 77 | + overwriting any existing FeedWordPress files that are there. | |
| 78 | + | |
| 79 | +3. Log in to your WordPress administrative interface immediately in order | |
| 80 | + to see whether there are any further tasks that you need to perform | |
| 81 | + to complete the upgrade. | |
| 96 | 82 | |
| 97 | -3. Upload the new PHP files to `wp-content/plugins/feedwordpress`, | |
| 98 | - overwriting any existing FeedWordPress files that are there. Also be | |
| 99 | - sure to upgrade the MagpieRSS module by uploading `rss.php` and | |
| 100 | - `rss-functions.php` from the `MagpieRSS-upgrade` directory in your | |
| 101 | - archive to the `wp-includes` directory of your WordPress installation. | |
| 83 | +4. Enjoy your newer and hotter installation of FeedWordPress | |
| 102 | 84 | |
| 103 | -3. If you are upgrading from version 0.96 or earlier, **immediately** log | |
| 104 | - in to the WordPress Dashboard, and go to **Options --> Syndicated**. | |
| 105 | - Follow the directions to launch the database upgrade procedure. The new | |
| 106 | - versions of FeedWordPress incorporate some long-needed improvements, but | |
| 107 | - old meta-data needs to be updated to prevent duplicate posts and other | |
| 108 | - possible maladies. If you're upgrading an existing installation, updates | |
| 109 | - and FeedWordPress template functions *will not work* until you've done | |
| 110 | - the upgrade. Then take a coffee break while the upgrade runs. It should, | |
| 111 | - hopefully, finish within a few minutes even on relatively large | |
| 112 | - databases. | |
| 113 | - | |
| 114 | -4. If you are upgrading from version 0.98 or earlier, note that the old | |
| 115 | - `update-feeds.php` has been eliminated in favor of a (hopefully) more | |
| 116 | - humane method for automatic updating. If you used a cron job for | |
| 117 | - scheduled updates, it will not work anymore, but there is another, | |
| 118 | - simpler method which will. See [Setting Up Feed Updates](http://projects.radgeek.com/feedwordpress/install/#setting-up-feed-updates) | |
| 119 | - to get scheduled updates back on track. | |
| 120 | - | |
| 121 | -5. Enjoy your new installation of FeedWordPress. | |
| 122 | - | |
| 123 | 85 | == Using and Customizing FeedWordPress == |
| 124 | 86 | |
| 125 | 87 | FeedWordPress has many options which can be accessed through the WordPress |
| 126 | 88 | Dashboard, and a lot of functionality accessible programmatically through |
| @@ -126,13 +88,13 @@ | ||
| 126 | 88 | Dashboard, and a lot of functionality accessible programmatically through |
| 127 | 89 | WordPress templates or plugins. For further documentation of the ins and |
| 128 | 90 | outs, see the documentation at the [FeedWordPress project homepage][]. |
| 129 | 91 | |
| 130 | - [FeedWordPress project homepage]: http://projects.radgeek.com/feedwordpress/ | |
| 92 | + [FeedWordPress project homepage]: http://feedwordpress.radgeek.com/ | |
| 131 | 93 | |
| 132 | 94 | == License == |
| 133 | 95 | |
| 134 | -The FeedWordPress plugin is copyright © 2005-2007 by Charles Johnson. It uses | |
| 96 | +The FeedWordPress plugin is copyright © 2005-2010 by Charles Johnson. It uses | |
| 135 | 97 | code derived or translated from: |
| 136 | 98 | |
| 137 | 99 | - [wp-rss-aggregate.php][] by [Kellan Elliot-McCrea](kellan@protest.net) |
| 138 | 100 | - [MagpieRSS][] by [Kellan Elliot-McCrea](kellan@protest.net) |
| @@ -153,7 +115,6 @@ | ||
| 153 | 115 | [wp-rss-aggregate.php]: http://laughingmeme.org/archives/002203.html |
| 154 | 116 | [MagpieRSS]: http://magpierss.sourceforge.net/ |
| 155 | 117 | [HTTP Navigator 2]: http://www.keyvan.net/2004/11/16/http-navigator/ |
| 156 | 118 | [Ultra-Liberal Feed Finder]: http://diveintomark.org/projects/feed_finder/ |
| 157 | - | |
| 158 | 119 | [GNU General Public License]: http://www.gnu.org/copyleft/gpl.html |
| 159 | 120 | |
