| @@ -1,9 +1,9 @@ | ||
| 1 | 1 | FeedWordPress |
| 2 | 2 | ============= |
| 3 | 3 | |
| 4 | 4 | * Author: [Charles Johnson](http://www.radgeek.com/contact) |
| 5 | -* Version: 0.91 | |
| 5 | +* Version: 0.8 | |
| 6 | 6 | * Project URI: <http://projects.radgeek.com/feedwordpress> |
| 7 | 7 | * License: GPL. See License below for copyright jots and tittles. |
| 8 | 8 | |
| 9 | 9 | Introduction |
| @@ -8,26 +8,28 @@ | ||
| 8 | 8 | |
| 9 | 9 | Introduction |
| 10 | 10 | ------------ |
| 11 | 11 | FeedWordPress is an Atom/RSS aggregator for WordPress. It syndicates content |
| 12 | -from newsfeeds that you select into your WordPress blog; if you syndicate | |
| 13 | -several newsfeeds then you can WordPress's posts database and templating engine | |
| 14 | -as the back-end of an aggregation ("planet") website. I originally developed it | |
| 15 | -because I needed a more flexible replacement for [Planet][] to use at | |
| 16 | -[Feminist Blogs][]. | |
| 12 | +from newsfeeds that you select; if you syndicate several newsfeeds then you can | |
| 13 | +WordPress's posts database and templating engine as the back-end of an | |
| 14 | +aggregation ("planet") website. | |
| 17 | 15 | |
| 18 | - [Planet]: http://www.planetplanet.org/ "Planet Planet" | |
| 19 | - [Feminist Blogs]: http://www.feministblogs.org/ | |
| 16 | +FeedWordPress is similar in conception to software such as [Planet][]--in fact, | |
| 17 | +I started developing it because I needed a more flexible replacement for | |
| 18 | +Planet at to run [Feminist Blogs](http://www.feministblogs.org/). Since it | |
| 19 | +works on top of WordPress's database and templating system, however, it boasts | |
| 20 | +far more flexibility than many other aggregators. It is also designed with ease | |
| 21 | +of configuration and use in mind. | |
| 20 | 22 | |
| 21 | -FeedWordPress is designed with flexibility, ease of use, and ease of | |
| 22 | -configuration in mind. You'll need a working installation of [WordPress 1.5][] | |
| 23 | -and FTP or SFTP access to your web host. The ability to create cron jobs on your | |
| 24 | -web host would be very helpful but it's not absolutely necessary. You *don't* | |
| 25 | -need to tweak any plain-text configuration files and you *don't* need shell | |
| 26 | -access to your web host to make it work. (Although, I should point out, web | |
| 27 | -hosts that *don't* offer shell access are *bad web hosts*.) | |
| 23 | +You'll need a working installation of [WordPress 1.5][] and FTP or SFTP access | |
| 24 | +to your web host. The ability to create cron jobs on your web host would be very | |
| 25 | +helpful but it's not absolutely necessary. You *don't* need to tweak any | |
| 26 | +plain-text configuration files and you *don't* need shell access to your web | |
| 27 | +host to make it work. (Although, I should point out, web hosts that *don't* | |
| 28 | +offer shell access are *bad web hosts*.) | |
| 28 | 29 | |
| 29 | 30 | [WordPress 1.5]: http://wordpress.org/development/2005/02/strayhorn/ |
| 31 | + [Planet]: http://www.planetplanet.org/ "Planet Planet" | |
| 30 | 32 | |
| 31 | 33 | Installation & Requirements |
| 32 | 34 | --------------------------- |
| 33 | 35 | You'll need a website with WordPress 1.5 installed and configured and FTP or |
| @@ -69,8 +71,9 @@ | ||
| 69 | 71 | <http://projects.radgeek.com/feedwordpress/install>. |
| 70 | 72 | |
| 71 | 73 | Feed Settings |
| 72 | 74 | ------------- |
| 75 | +### Feed Settings ### | |
| 73 | 76 | |
| 74 | 77 | Once you have your links configured and regular feed updates scheduled, you can |
| 75 | 78 | mostly leave FeedWordPress to run on its own. If you need to add, remove, or |
| 76 | 79 | change information for any contributors, you can do so from the WordPress |
| @@ -119,9 +122,9 @@ | ||
| 119 | 122 | The URI should be changed out for each feed to point to the appropriate image, |
| 120 | 123 | of course. Then, to use the setting from within a template: |
| 121 | 124 | |
| 122 | 125 | // In a post context |
| 123 | - <?php $img = get_feed_meta('face'); if (strlen($img) > 0): ?> | |
| 126 | + <?php $img = get_feed_meta('face'); if strlen($img) > 0): ?> | |
| 124 | 127 | <img src="<?=$img?>" alt="" /> |
| 125 | 128 | <?php endif; ?> |
| 126 | 129 | |
| 127 | 130 | ... which will display the image, if any, whose URI is set in the "face" setting |
| @@ -146,13 +149,12 @@ | ||
| 146 | 149 | A yes/no setting. By default, FeedWordPress updates the value of the |
| 147 | 150 | Link Name field automatically to reflect the title that is reported by a |
| 148 | 151 | syndicated feed. (So, for example, if one of your contributors changes |
| 149 | 152 | the title of her weblog, the change will be reflected on your |
| 150 | - Contributors list after the next update.) To manually set the Link Name | |
| 151 | - and prevent your new name from being overridden by FeedWordPress (so as | |
| 152 | - to, for example, use an abbreviated form of the site's title for reasons | |
| 153 | - of space), change the Link Name to a title of your choosing and then add | |
| 154 | - a line like this to the Link Notes section: | |
| 153 | + Contributors list after the next update.) To override that behavior for | |
| 154 | + a particular feed (e.g. to force WordPress to use an abbreviated form of | |
| 155 | + the site's title for reasons of space), add a line like this to the Link | |
| 156 | + Notes section: | |
| 155 | 157 | |
| 156 | 158 | hardcode name: yes |
| 157 | 159 | |
| 158 | 160 | If `hardcode name` is absent, or set to a value other than `yes`, |
| @@ -157,45 +159,8 @@ | ||
| 157 | 159 | |
| 158 | 160 | If `hardcode name` is absent, or set to a value other than `yes`, |
| 159 | 161 | FeedWordPress will take that as a 'no' and follow the default behavior. |
| 160 | 162 | |
| 161 | -- `hardcode description: (yes|no)` | |
| 162 | - | |
| 163 | - A yes/no setting. By default, FeedWordPress updates the value of the | |
| 164 | - Link Description field automatically to reflect the tagline or | |
| 165 | - description that is reported by a syndicated feed. To manually set the | |
| 166 | - Link Description and prevent your new description from being overridden | |
| 167 | - by FeedWordPress (so as to, for example, use an abbreviated form of the | |
| 168 | - site's tagline for reasons of space), change the Link Description to a | |
| 169 | - title of your choosing and then add a line like this to the Link Notes | |
| 170 | - section: | |
| 171 | - | |
| 172 | - hardcode description: yes | |
| 173 | - | |
| 174 | - If `hardcode description` is absent, or set to a value other than `yes`, | |
| 175 | - FeedWordPress will take that as a 'no' and follow the default behavior. | |
| 176 | - | |
| 177 | -- `hardcode categories: (yes|no)` | |
| 178 | - | |
| 179 | - A yes/no setting. FeedWordPress places each syndicated post in a set of | |
| 180 | - categories within WordPress. It gets that list from two sources: | |
| 181 | - | |
| 182 | - 1. Categories that you set explicitly for each feed (see the `cats` setting above) | |
| 183 | - | |
| 184 | - 2. Categories that the original author placed the post in on her blog | |
| 185 | - | |
| 186 | - If any of the categories on the list do not exist, they are created automatically. | |
| 187 | - | |
| 188 | - If you want the posts from a particular feed to be placed *only* in the | |
| 189 | - categories that you set manually (see the `cats` setting above), and not | |
| 190 | - in the categories that they are in on the Contributor's blog, then add | |
| 191 | - a line like this to the Link Notes section: | |
| 192 | - | |
| 193 | - hardcode categories: yes | |
| 194 | - | |
| 195 | - If `hardcode categories` is absent, or set to a value other than `yes`, | |
| 196 | - FeedWordPress will take that as a 'no' and follow the default behavior. | |
| 197 | - | |
| 198 | 163 | - `post status:` sets the default post status for posts from this feed |
| 199 | 164 | This can be 'publish', 'draft', or 'private'. By default, it is set to |
| 200 | 165 | 'publish' (syndicated posts go online immediately). |
| 201 | 166 | |
| @@ -254,20 +219,8 @@ | ||
| 254 | 219 | that by default the permalinks listed on your website and in your newsfeed will |
| 255 | 220 | link to the location of the posts on the source website, *not* to their location |
| 256 | 221 | on your website. You can switch this behavior on or off at Options --> |
| 257 | 222 | Syndication in the WordPress Dashboard. |
| 258 | - | |
| 259 | -### Plugin API ### | |
| 260 | - | |
| 261 | -FeedWordPress creates five hooks through the WordPress plugin architecture that | |
| 262 | -you can plug in to using PHP WordPress plugins, to supplement ordinary | |
| 263 | -FeedWordPress behavior, or to filter posts according to criteria that you set. | |
| 264 | -The hooks are the action ``feedwordpress_update``, the action | |
| 265 | -``feedwordpress_check_feed``, the action ``feedwordpress_update_complete``, the | |
| 266 | -filter ``syndicated_item``, the filter ``syndicated_post``, the action | |
| 267 | -``post_syndicated_item``, and the action ``update_syndicated_item``. | |
| 268 | - | |
| 269 | -For more information, see <http://projects.radgeek.com/feedwordpress/use>. | |
| 270 | 223 | |
| 271 | 224 | License |
| 272 | 225 | ------- |
| 273 | 226 | The FeedWordPress plugin is copyright (c) 2005 by Charles Johnson. It uses code |
