| @@ -1,43 +1,46 @@ | ||
| 1 | 1 | FeedWordPress |
| 2 | 2 | ============= |
| 3 | 3 | |
| 4 | 4 | * Author: [Charles Johnson](http://radgeek.com/contact) |
| 5 | -* Version: 0.97 | |
| 5 | +* Version: 0.981 | |
| 6 | 6 | * Project URI: <http://projects.radgeek.com/feedwordpress> |
| 7 | 7 | * License: GPL 2. See License below for copyright jots and tittles. |
| 8 | 8 | |
| 9 | 9 | Introduction |
| 10 | 10 | ------------ |
| 11 | -FeedWordPress is an Atom/RSS aggregator for WordPress 1.5. It syndicates content | |
| 12 | -from newsfeeds that you choose into your WordPress blog; if you syndicate | |
| 13 | -several newsfeeds then you can use WordPress's posts database and templating | |
| 14 | -engine as the back-end of an aggregation ("planet") website. I originally | |
| 15 | -developed it because I needed a more flexible replacement for [Planet][] to | |
| 16 | -use at [Feminist Blogs][]. | |
| 11 | +FeedWordPress is an Atom/RSS aggregator for the WordPress weblog software. It | |
| 12 | +syndicates content from newsfeeds that you choose into your WordPress webblog; | |
| 13 | +if you syndicate several newsfeeds then you can use WordPress's posts database | |
| 14 | +and templating engine as the back-end of an aggregation ("planet") website. I | |
| 15 | +originally developed it because I needed a more flexible replacement for | |
| 16 | +[Planet][] to use at [Feminist Blogs][]. | |
| 17 | 17 | |
| 18 | 18 | [Planet]: http://www.planetplanet.org/ "Planet Planet" |
| 19 | 19 | [Feminist Blogs]: http://www.feministblogs.org/ |
| 20 | 20 | |
| 21 | 21 | FeedWordPress is designed with flexibility, ease of use, and ease of |
| 22 | -configuration in mind. You'll need a working installation of [WordPress | |
| 23 | -1.5][] and FTP or SFTP access to your web host. The ability to create cron | |
| 24 | -jobs on your web host would be very helpful but it's not absolutely | |
| 25 | -necessary. You *don't* need to tweak any plain-text configuration files and | |
| 26 | -you *don't* need shell access to your web host to make it work. (Although, I | |
| 27 | -should point out, web hosts that *don't* offer shell access are *bad web | |
| 28 | -hosts*.) | |
| 22 | +configuration in mind. You'll need a working installation of WordPress (version | |
| 23 | +[2.1][], [2.0][] or [1.5][]), and also FTP or SFTP access to your web host. The | |
| 24 | +ability to create cron jobs on your web host would be very helpful but it's not | |
| 25 | +absolutely necessary. You *don't* need to tweak any plain-text configuration | |
| 26 | +files and you *don't* need shell access to your web host to make it work. | |
| 27 | +(Although, I should point out, web hosts that *don't* offer shell access are | |
| 28 | +*bad web hosts*.) | |
| 29 | 29 | |
| 30 | - [WordPress 1.5]: http://wordpress.org/development/2005/02/strayhorn/ | |
| 30 | + [2.1]: http://wordpress.org/development/2007/01/ella-21/ | |
| 31 | + [2.0]: http://wordpress.org/development/2005/12/wp2/ | |
| 32 | + [1.5]: http://wordpress.org/development/2005/02/strayhorn/ | |
| 31 | 33 | |
| 32 | 34 | Installation |
| 33 | 35 | ------------ |
| 34 | 36 | ### Requirements ### |
| 35 | 37 | |
| 36 | -To use version 0.97 of FeedWordPress, you will need: | |
| 38 | +To use version 0.981 of FeedWordPress, you will need: | |
| 37 | 39 | |
| 38 | -1. an installed configured copy of WordPress 1.5.x. (It *won't work* with | |
| 39 | - WP 1.2 or WP 1.6 development builds.) | |
| 40 | +1. an installed and configured copy of WordPress 2.1, 2.0.x, or 1.5.x. | |
| 41 | + (FeedWordPress currently *will not work* with older versions of | |
| 42 | + WordPress, or with WordPress MU.) | |
| 40 | 43 | |
| 41 | 44 | 2. FTP or SFTP access to your web host |
| 42 | 45 | |
| 43 | 46 | And you'll probably also want to have either: |
| @@ -49,23 +52,24 @@ | ||
| 49 | 52 | ### Installation ### |
| 50 | 53 | |
| 51 | 54 | #### Upgrades #### |
| 52 | 55 | |
| 53 | -To *upgrade* an existing installation of FeedWordPress to version 0.97: | |
| 56 | +To *upgrade* an existing installation of FeedWordPress to version 0.981: | |
| 54 | 57 | |
| 55 | 58 | 1. Download the FeedWordPress archive in zip or gzipped tar format and |
| 56 | 59 | extract the files on your computer. Replace your existing FeedWordPress |
| 57 | - files with the new files. Be sure to upgrade `rss-functions.php` if you | |
| 58 | - use the optional MagpieRSS upgrade, or don't use it yet but do want to | |
| 59 | - syndicate Atom 1.0 feeds. | |
| 60 | + files with the new files. Be sure to upgrade `rss.php` and | |
| 61 | + `rss-functions.php` if you use the optional MagpieRSS upgrade, or don't | |
| 62 | + use it yet but do want to syndicate Atom 1.0 feeds. | |
| 60 | 63 | |
| 61 | -2. **Immediately** log in to the WordPress Dashboard, and go to Options --> | |
| 62 | - Syndicated. Follow the directions to launch the database upgrade | |
| 63 | - procedure. The new version of FeedWordPress incorporates some | |
| 64 | - long-needed improvements, but old meta-data needs to be updated to | |
| 65 | - prevent duplicate posts and other possible maladies. If you're upgrading | |
| 66 | - an existing installation, updates and FeedWordPress template functions | |
| 67 | - *will not work* until you've done the upgrade. | |
| 64 | +2. If you are upgrading from version 0.96 or earlier, **immediately** log | |
| 65 | + in to the WordPress Dashboard, and go to Options --> Syndicated. Follow | |
| 66 | + the directions to launch the database upgrade procedure. The new | |
| 67 | + versions of FeedWordPress incorporate some long-needed improvements, but | |
| 68 | + old meta-data needs to be updated to prevent duplicate posts and other | |
| 69 | + possible maladies. If you're upgrading an existing installation, updates | |
| 70 | + and FeedWordPress template functions *will not work* until you've done | |
| 71 | + the upgrade. | |
| 68 | 72 | |
| 69 | 73 | 3. Take a coffee break while the upgrade runs. It should, hopefully, finish |
| 70 | 74 | within a few minutes even on relatively large databases. |
| 71 | 75 | |
| @@ -85,9 +89,9 @@ | ||
| 85 | 89 | 1. Install `feedwordpress.php` in your WordPress `plugins` directory |
| 86 | 90 | and `update-feeds.php` in your WordPress `wp-content` directory. |
| 87 | 91 | |
| 88 | 92 | 2. (Optional) Upgrade the copy of MagpieRSS packaged with WordPress by |
| 89 | - installing the new `rss-functions.php` (archived in | |
| 93 | + installing the new `rss.php` and `rss-functions.php` (archived in | |
| 90 | 94 | `OPTIONAL/wp-includes`) into your WordPress `wp-includes` directory. |
| 91 | 95 | Upgrading MagpieRSS is necessary if you want to take advantage of |
| 92 | 96 | support for Atom 1.0, multiple post categories, RSS enclosures, and |
| 93 | 97 | multiple character encodings. (Note, however, that support for |
| @@ -106,13 +110,13 @@ | ||
| 106 | 110 | and (2) a "secret word" for your RPC-XML updating interface. This |
| 107 | 111 | provides some light security by keeping passing ruffians from saying |
| 108 | 112 | "Update all the feeds" at will to your FeedWordPress installation. |
| 109 | 113 | |
| 110 | -5. Go to Links --> Syndicated to set up the list of sites that you want | |
| 111 | - FeedWordPress to syndicate onto your blog. (If you have the feeds you | |
| 112 | - want to aggregate in a service such as Bloglines, you may prefer to | |
| 113 | - export them to an OPML file and use WordPress's Links --> Import to | |
| 114 | - import them into the contributors category.) | |
| 114 | +5. Go to Blogroll --> Syndicated or Links --> Syndicated to set up the list | |
| 115 | + of sites that you want FeedWordPress to syndicate onto your blog. (If | |
| 116 | + you have the feeds you want to aggregate in a service such as Bloglines, | |
| 117 | + you may prefer to export them to an OPML file and use WordPress's Links | |
| 118 | + --> Import to import them into the contributors category.) | |
| 115 | 119 | |
| 116 | 120 | #### Setting Up Feed Updates #### |
| 117 | 121 | |
| 118 | 122 | FeedWordPress is now ready to accept posts from its syndication sources. |
| @@ -200,11 +204,11 @@ | ||
| 200 | 204 | [Cygwin]: http://www.cygwin.com/ |
| 201 | 205 | |
| 202 | 206 | Basic Concepts |
| 203 | 207 | -------------- |
| 204 | -FeedWordPress is written as a plugin for [WordPress 1.5][]. It is designed to | |
| 205 | -store all the data it needs within the WordPress database and to make that data | |
| 206 | -easy to manage from within the WordPress Dashboard. | |
| 208 | +FeedWordPress is written as a plugin for the WordPress weblog software. It is | |
| 209 | +designed to store all the data it needs within the WordPress database and to | |
| 210 | +make that data easy to manage from within the WordPress Dashboard. | |
| 207 | 211 | |
| 208 | 212 | ### Contributors / Newsfeeds ### |
| 209 | 213 | |
| 210 | 214 | FeedWordPress uses the WordPress Links database to keep a list of the feeds from |
| @@ -370,10 +374,10 @@ | ||
| 370 | 374 | (If a feed doesn't, then FeedWordPress will create an author's name based on |
| 371 | 375 | the title of the feed from which the item was taken.) This information is used |
| 372 | 376 | to determine the WordPress user that the post will be attributed to. Given the |
| 373 | 377 | name of the author, FeedWordPress looks for authors in the WordPress database |
| 374 | -with the same name as either (1) their login, (2) their first name, (3) their | |
| 375 | -nickname, (4) their full name, or (5) one of the "aliases" listed in the | |
| 378 | +with the same name as either (1) their login, (2) their display name, (3) their | |
| 379 | +e-mail address (if given), or (4) one of the "aliases" listed in the | |
| 376 | 380 | user's profile. |
| 377 | 381 | |
| 378 | 382 | __Aliases:__ If there is an author who posts under more than one name (for |
| 379 | 383 | example, one of our contributors at [Feminist Blogs][] posts on several |
