| @@ -1,9 +1,9 @@ | ||
| 1 | 1 | FeedWordPress |
| 2 | 2 | ============= |
| 3 | 3 | |
| 4 | 4 | * Author: [Charles Johnson](http://www.radgeek.com/contact) |
| 5 | -* Version: 0.95 | |
| 5 | +* Version: 0.91 | |
| 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 |
| @@ -67,71 +67,33 @@ | ||
| 67 | 67 | |
| 68 | 68 | For detailed installation instructions, point your web browser to |
| 69 | 69 | <http://projects.radgeek.com/feedwordpress/install>. |
| 70 | 70 | |
| 71 | -Basic Concepts | |
| 72 | -FeedWordPress is written as a plugin for [WordPress 1.5][]. It is designed to | |
| 73 | -store all the data it needs within the WordPress database and to make that data | |
| 74 | -easy to manage from within the WordPress Dashboard. | |
| 71 | +Feed Settings | |
| 72 | +------------- | |
| 75 | 73 | |
| 76 | -### Contributors / Newsfeeds ### | |
| 74 | +Once you have your links configured and regular feed updates scheduled, you can | |
| 75 | +mostly leave FeedWordPress to run on its own. If you need to add, remove, or | |
| 76 | +change information for any contributors, you can do so from the WordPress | |
| 77 | +Dashboard under Links --> Syndicated. If you want to distribute the labor of | |
| 78 | +adding, updating, and managing feeds, you can use the WordPress login and access | |
| 79 | +privileges system. Users with an access level of 5 or greater can add or modify | |
| 80 | +syndicated links, and change syndication options. | |
| 77 | 81 | |
| 78 | -FeedWordPress uses the WordPress Links database to keep a list of the feeds from | |
| 79 | -which it will syndicate content. WordPress allows you to place links in | |
| 80 | -categories; FeedWordPress will treat all and only the links in one category | |
| 81 | -(by default, this is a category named "Contributors"; you can change the | |
| 82 | -category that FeedWordPress will use using Options --> Syndication). | |
| 82 | +All the information for a syndicated feed is managed through the WordPress Links | |
| 83 | +database. Feeds in the category to be syndicated (by default, "Contributors") | |
| 84 | +use several fields of the standard WordPress Link record: | |
| 83 | 85 | |
| 84 | -From WordPress's perspective, the list of Contributors are normal links, and | |
| 85 | -they can be manipulated like other links through the WordPress Dashboard. If | |
| 86 | -you need to add, remove, or change information for any contributors, you can | |
| 87 | -do so easily under Links --> Syndicated. If you want to distribute the labor of | |
| 88 | -adding, updating, and managing feeds, you can use the WordPress login and | |
| 89 | -access privileges system. Users with an access level of 5 or greater can add, | |
| 90 | -delete, and modify Contributors; users with an access level of 6 or greater can | |
| 91 | -change syndication options. | |
| 86 | +- The Link URI is used to store a URI to the front page (*not* the feed!) | |
| 87 | + of the syndicated website. | |
| 92 | 88 | |
| 93 | -When FeedWordPress looks for new posts, it does so by retrieving one or all of | |
| 94 | -the links from the Contributors category (depending on whether it has been told | |
| 95 | -to scan for new posts on one or all of the feeds). | |
| 96 | - | |
| 97 | -__Feed settings:__ All of the information for a syndicated feed is stored in | |
| 98 | -the WordPress Links database. Feeds in the category to be syndicated (by | |
| 99 | -default, "Contributors") use several fields of the standard WordPress Link | |
| 100 | -record: | |
| 101 | - | |
| 102 | -- The RSS URI is used to store the URI for the feed to be syndicated. | |
| 103 | - (Note that this is *not* the same as the Link URI. The Link URI points | |
| 104 | - to the human-readable *front page* of the website that the feed | |
| 105 | - syndicates.) | |
| 106 | - | |
| 107 | -- The Link URI is used to store a URI to the human-readable front page | |
| 108 | - (*not* the feed!) of the syndicated website. FeedWordPress automatically | |
| 109 | - updates this URI using the URI that is reported by the newsfeed whenever | |
| 110 | - it checks the feed for new posts, so if the page moves this will be | |
| 111 | - reflected automatically on your Contributors links list. | |
| 112 | - | |
| 113 | 89 | - The Link Name is used to store the title of the syndicated website. |
| 114 | - By default, FeedWordPress automatically updates the name of the link | |
| 115 | - whenever it checks for new posts, using the title that the | |
| 116 | - newsfeed reports (so that if a Contributor changes the title of her | |
| 117 | - website, this is reflected automatically on your Contributors links | |
| 118 | - list). This behavior can be turned off for all feeds through the | |
| 119 | - settings in Options --> Syndication. The default behavior can be | |
| 120 | - overridden for specific feeds using the feed setting | |
| 121 | - `hardcode name`. | |
| 122 | 90 | |
| 123 | 91 | - The Short Description is used to store the tagline of the syndicated |
| 124 | - website. By default, FeedWordPress automatically updates the description | |
| 125 | - whenever it checks for new posts, using the tagline or description that | |
| 126 | - the newsfeed reports (so that if a Contributor changes the tagline of | |
| 127 | - her website, this is reflected automatically on your Contributors links | |
| 128 | - list). his behavior can be turned off for all feeds through the | |
| 129 | - settings in Options --> Syndication. The default behavior can be | |
| 130 | - overridden for specific feeds using the feed setting | |
| 131 | - `hardcode description`. | |
| 92 | + website. | |
| 132 | 93 | |
| 94 | +- The RSS URI is used to store the URI for the feed to be syndicated. | |
| 95 | + | |
| 133 | 96 | - The Link Notes are used to store a collection of manually-encoded and |
| 134 | 97 | automatically-generated settings that apply to this feed. The format of |
| 135 | 98 | settings in Link Notes is: |
| 136 | 99 | |
| @@ -136,8 +98,9 @@ | ||
| 136 | 98 | settings in Link Notes is: |
| 137 | 99 | |
| 138 | 100 | key1: value1 |
| 139 | 101 | key2: value2 |
| 102 | + key3: value3 | |
| 140 | 103 | feed/key1: value1 |
| 141 | 104 | feed/key2: value2 |
| 142 | 105 | |
| 143 | 106 | And so on. Values that are prefixed by 'feed/' are automatically |
| @@ -144,30 +107,16 @@ | ||
| 144 | 107 | generated from feed data every time the feed syndicated by this link is |
| 145 | 108 | checked for updates. Values without the prefix are set manually by the |
| 146 | 109 | user. |
| 147 | 110 | |
| 148 | -The Link Notes section can be used to add, remove, and change custom feed | |
| 149 | -settings. For example, if you want to *add* the feed setting for | |
| 150 | -`unfamiliar author` with the value `filter`, you can do so by going to Links --> | |
| 151 | -Syndicated, clicking the "Edit" link for the feed that you wish to add this | |
| 152 | -setting for, and then adding the following, on a line by itself, to the Link | |
| 153 | -Notes section: | |
| 111 | +Most settings in the Link Notes have no effect on FeedWordPress, but can be | |
| 112 | +accessed from templates using the ``get_feed_meta()`` template function in a | |
| 113 | +post context. For example, many aggregator sites use a "face" image for each | |
| 114 | +feed to visually distinguish posts from different feeds. To implement a face | |
| 115 | +feature, you could add a line like this to each feed's Link Notes section: | |
| 154 | 116 | |
| 155 | - unfamiliar author: filter | |
| 117 | + face: http://www.zyx.com/mugs/ugly | |
| 156 | 118 | |
| 157 | -To remove the setting, follow the same procedure, but find the line for the | |
| 158 | -feed setting that you want to remove and remove it. To change the value, simply | |
| 159 | -change the text that follows after the colon. | |
| 160 | - | |
| 161 | -Most settings in the Link Notes have no effect on FeedWordPress, but you can use | |
| 162 | -them to store information for templates to retrieve using the `get_feed_meta()` | |
| 163 | -template function in a post context (see Template API below). For example, many | |
| 164 | -aggregator sites use a "face" image for each feed to visually distinguish posts | |
| 165 | -from different feeds. To implement a face feature, you could add something | |
| 166 | -like this to each feed's Link Notes, on a line by itself: | |
| 167 | - | |
| 168 | - face: http://www.zyx.com/mugs/ugly | |
| 169 | - | |
| 170 | 119 | The URI should be changed out for each feed to point to the appropriate image, |
| 171 | 120 | of course. Then, to use the setting from within a template: |
| 172 | 121 | |
| 173 | 122 | // In a post context |
| @@ -180,179 +129,10 @@ | ||
| 180 | 129 | particular feed, ``get_feed_meta()`` will return an empty string and no image |
| 181 | 130 | will be displayed. |
| 182 | 131 | |
| 183 | 132 | Not all feed settings are only for templates. Some affect how FeedWordPress |
| 184 | -processes posts from that feed. Currently, the settings with special effects | |
| 185 | -on FeedWordPress are `cats`, `hardcode name`, `hardcode description`, | |
| 186 | -`hardcode categories`, `post status`, `comment status`, `ping status`, | |
| 187 | -`unfamiliar author`, and `unfamiliar categories`. For descriptions of their | |
| 188 | -effects, see Special Feed Settings below. | |
| 133 | +processes posts from that feed. Currently, the special settings are: | |
| 189 | 134 | |
| 190 | -### Syndicated Posts ### | |
| 191 | - | |
| 192 | -Whenever FeedWordPress updates, it scans one or more of the feeds in its | |
| 193 | -Contributors list and adds any new posts that it finds to the WordPress | |
| 194 | -database. Syndicated posts are displayed on your WordPress pages like any other | |
| 195 | -posts: they can be listed in archives by category, author, or date; they can be | |
| 196 | -found with the search box; and they are included in the newsfeed of your blog. | |
| 197 | - | |
| 198 | -In your WordPress templates (Presentation --> Theme Editor) you can access | |
| 199 | -special information about syndicated posts using functions provided by | |
| 200 | -FeedWordPress, such as `is_syndicated()`, `the_syndication_source()`, | |
| 201 | -`the_syndication_source_link()`, and `get_feed_meta()`. For example, here is | |
| 202 | -the template code that I use (in a post context) to display both the author's | |
| 203 | -name and the original source of the post in the templates for [Feminist Blogs][]: | |
| 204 | - | |
| 205 | - <cite class="feed">from <?php the_author_posts_link()?><?php | |
| 206 | - if (is_syndicated() and (get_the_author() !== get_syndication_source())): | |
| 207 | - echo ' @ <a href="'; the_syndication_source_link(); echo '">'; | |
| 208 | - the_syndication_source(); | |
| 209 | - echo '</a>'; | |
| 210 | - endif; ?></cite> | |
| 211 | - | |
| 212 | -For more information on template functions, see Template API below. | |
| 213 | - | |
| 214 | -### Categories ### | |
| 215 | - | |
| 216 | -WordPress allows for posts to be placed in *categories*. Each syndicated post | |
| 217 | -that FeedWordPress adds to the WordPress database is placed into a set of | |
| 218 | -categories. FeedWordPress gets the list of category names to use from two | |
| 219 | -sources: | |
| 220 | - | |
| 221 | -1. Categories (or "tags") that the original author placed the post in on | |
| 222 | - her blog | |
| 223 | - | |
| 224 | -2. Categories that you set explicitly for each feed using the `cats` | |
| 225 | - feed setting. For example, if you wanted all the posts from Alas, A Blog | |
| 226 | - to be placed in the "Pacific Northwest" category and the "Cartoonists" | |
| 227 | - category (in addition to any categories that they were placed in on | |
| 228 | - Alas, A Blog), you could do this by going to Links --> Syndicated, | |
| 229 | - clicking the "Edit" link for Alas, A Blog, and adding the following line | |
| 230 | - to the Link Notes section: | |
| 231 | - | |
| 232 | - cats: Pacific Northwest:Cartoonists | |
| 233 | - | |
| 234 | - (The colon separates one category name from the next.) | |
| 235 | - | |
| 236 | -Given the list of category names, FeedWordPress looks for categories in the | |
| 237 | -WordPress database with the same name as either (1) the category name, or | |
| 238 | -(2) one of the "aliases" listed in the category description. | |
| 239 | - | |
| 240 | -__Aliases:__ Different often authors use slightly different names for | |
| 241 | -categories that mean the same thing (contributors to Feminist Blogs, for | |
| 242 | -example, used categories including "Feminism", "feministy stuff", | |
| 243 | -"Women's Issues", "Gender Issues", "Gender Equality", and so on). If you want | |
| 244 | -FeedWordPress to treat one category name as a synonym for another, you can | |
| 245 | -do so by creating an "alias" for the category. For example, to make | |
| 246 | -FeedWordPress treat posts that are placed in the category "feministy stuff" as | |
| 247 | -if they had been placed in the category "Feminism", go to Manage --> Categories, | |
| 248 | -find the category "Feminism" and click the "Edit" link for it, and then add | |
| 249 | -the following to the Description field, on a line by itself: | |
| 250 | - | |
| 251 | - a.k.a.: feministy stuff | |
| 252 | - | |
| 253 | -You can add as many aliases as you like. You can also add any other text that | |
| 254 | -you like to the Description without interfering with FeedWordPress's ability to | |
| 255 | -use the aliases. Each alias must be on a line by itself. | |
| 256 | - | |
| 257 | -__Unfamiliar categories:__ By default, if one of the category names that a | |
| 258 | -newsfeed provides is unfamiliar -- that is, if there is not yet any category | |
| 259 | -with that name (or with that name as an alias) in your WordPress database -- | |
| 260 | -then by default FeedWordPress will *automatically create* a new category with | |
| 261 | -that name and place the current post in it. The default behavior can be changed, | |
| 262 | -using either the global settings in Options --> Syndication or the | |
| 263 | -`unfamiliar categories` feed setting (see Feed Settings above), so that unfamiliar | |
| 264 | -categories will not be added to the database. If you choose to disable the | |
| 265 | -creation of new categories, you can also choose whether or not FeedWordPress | |
| 266 | -should syndicate posts that do not match *any* of the categories that are | |
| 267 | -currently in the database. | |
| 268 | - | |
| 269 | -One of the uses of this feature is filtering posts by category: if you want to | |
| 270 | -your blog to syndicate only the posts in one particular category from a feed | |
| 271 | -that has several categories, you could do so by creating a category by that | |
| 272 | -name, adding the new feed(s), and then adding the following line to the Link | |
| 273 | -Notes section of the feed(s) that you want to filter: | |
| 274 | - | |
| 275 | - unfamiliar categories: filter | |
| 276 | - | |
| 277 | -Since only posts in categories that are in your database will be included, and | |
| 278 | -only the category or categories that you wanted posts from has been added to | |
| 279 | -your database, this will filter out all the posts that aren't in the category | |
| 280 | -or categories that you defined ahead of time. (Similarly, you could set up | |
| 281 | -FeedWordPress so that *all* the feeds are filtered by author by creating the set | |
| 282 | -of users named after the authors you want to syndicate, and then setting the | |
| 283 | -default behavior for *all* feeds at Options --> Syndication). | |
| 284 | - | |
| 285 | -If you need a category filter with more complex logic, you can always create a | |
| 286 | -`syndicated_item` filter in PHP (see Plugin API below) that manipulates the | |
| 287 | -`['categories']` array of a syndicated item. | |
| 288 | - | |
| 289 | -### Authors ### | |
| 290 | - | |
| 291 | -Most newsfeeds include information about the author of the items on them. | |
| 292 | -(If a feed doesn't, then FeedWordPress will create an author's name based on | |
| 293 | -the title of the feed from which the item was taken.) This information is used | |
| 294 | -to determine the WordPress user that the post will be attributed to. Given the | |
| 295 | -name of the author, FeedWordPress looks for authors in the WordPress database | |
| 296 | -with the same name as either (1) their login, (2) their first name, (3) their | |
| 297 | -nickname, (4) their full name, or (5) one of the "aliases" listed in the | |
| 298 | -user's profile. | |
| 299 | - | |
| 300 | -__Aliases:__ If there is an author who posts under more than one name (for | |
| 301 | -example, one of our contributors at [Feminist Blogs][] posts on several | |
| 302 | -different blogs, sometimes using her full name and sometimes using only her | |
| 303 | -first name), then you can ensure that FeedWordPress will attribute those posts | |
| 304 | -to the same author by creating "aliases" for the author. For example, to make | |
| 305 | -FeedWordPress treat posts by "Joseph Cardinal Ratzinger" and posts by "Pope | |
| 306 | -Benedict XVI" as having the same author, go to Users --> Authors & Users, click | |
| 307 | -on the "Edit" link for Pope Benedict XVI, and add a line like this to the | |
| 308 | -Profile text: | |
| 309 | - | |
| 310 | - a.k.a.: Joseph Cardinal Ratzinger | |
| 311 | - | |
| 312 | -You can add as many aliases as you like. You can also add any other text that | |
| 313 | -you like to the Profile without interfering with FeedWordPress's ability to use | |
| 314 | -the aliases. Each alias must be on a line by itself. | |
| 315 | - | |
| 316 | -__Unfamiliar authors:__ By default, if the author named by the newsfeed is | |
| 317 | -unfamiliar -- that is, if there is no-one with that name registered in the | |
| 318 | -WordPress author's database -- then by default FeedWordPress will automatically | |
| 319 | -create a new user account with the given name and attribute the post to the new | |
| 320 | -user. The default behavior can be changed, using either the global settings in | |
| 321 | -Options --> Syndication or the `unfamiliar author` feed setting (see Feed | |
| 322 | -Settings above), so that posts by unfamiliar authors will either be attributed | |
| 323 | -to a default author (instead of creating a new user account to attribute them | |
| 324 | -to), or filtered out and not syndicated at all. | |
| 325 | - | |
| 326 | -One of the uses of this feature is filtering posts by author: if you want to | |
| 327 | -your blog to syndicate only the posts by one particular author from a feed that | |
| 328 | -has several authors, you could do so by creating a user account with that | |
| 329 | -author's name, adding the new feed(s), and then adding the following line to the | |
| 330 | -Link Notes section of the feed(s) that you want to filter: | |
| 331 | - | |
| 332 | - unfamiliar author: filter | |
| 333 | - | |
| 334 | -Since only posts by authors that are in your database will be included, and only | |
| 335 | -the author that you wanted posts from has been added to your database, this will | |
| 336 | -filter out posts by anyone else on the feeds with that setting. (Similarly, you | |
| 337 | -could set up FeedWordPress so that *all* the feeds are filtered by author by | |
| 338 | -creating the set of users named after the authors you want to syndicate, and | |
| 339 | -then setting the default behavior for *all* feeds at Options --> Syndication). | |
| 340 | - | |
| 341 | -If you need an author filter with more complex logic than this allows, you can | |
| 342 | -always create a `syndicated_item` filter in PHP (see Plugin API below) that | |
| 343 | -manipulates the `['author_name']` or `['dc']['creator']` elements of a | |
| 344 | -syndicated item. | |
| 345 | - | |
| 346 | -Special Feed Settings | |
| 347 | -Most feed settings (see Feed Settings above) have no effect on FeedWordPress | |
| 348 | -itself, but can be useful because they can be accessed from templates using the | |
| 349 | -`get_feed_meta()` template function in a post context (see Feed Settings above | |
| 350 | -for an example). However, you can use some feed settings to affect how | |
| 351 | -FeedWordPress will process posts from that particular feed. Currently, these | |
| 352 | -special settings are: | |
| 353 | - | |
| 354 | 135 | - `cats:` a colon-separated list of default categories for any post coming |
| 355 | 136 | from this feed. So, for example, a this line in its Notes section: |
| 356 | 137 | |
| 357 | 138 | cats: computers:web |
| @@ -357,79 +137,64 @@ | ||
| 357 | 137 | |
| 358 | 138 | cats: computers:web |
| 359 | 139 | |
| 360 | 140 | ... will make FeedWordPress place any posts syndicated from that feed in |
| 361 | - the "computers" and "web" categories. Note that by default, | |
| 362 | - FeedWordPress will place them in those categories *in addition to* any | |
| 363 | - categories that the author of the post put them in on her own website. | |
| 364 | - If you want to place posts from a feed *only* in the categories you | |
| 365 | - explicitly set, then you should use the `cats` setting together with | |
| 366 | - the `unfamiliar categories` setting. (See Categories above and | |
| 367 | - `unfamiliar categories` below for the nitty-gritty.) | |
| 141 | + the "computers" and "web" categories (*in addition to*, not *instead of* | |
| 142 | + any categories that are applied to the post in the feed) | |
| 368 | 143 | |
| 369 | 144 | - `hardcode name: (yes|no)` |
| 370 | 145 | |
| 371 | - By default, FeedWordPress updates the value of the Link Name field | |
| 372 | - automatically to reflect the title that is reported by a syndicated | |
| 373 | - feed--so that if one of your contributors changes the title of her | |
| 374 | - website, the change will be reflected on your Contributors list after | |
| 375 | - the next update. If you want to stop this behavior (so that you can | |
| 376 | - set the title of a Contributor link manually -- e.g. so that you can use | |
| 377 | - an abbreviated form for reasons of space), you can change the default | |
| 378 | - behavior for *all* feeds using the settings in Options --> Syndication. | |
| 379 | - If you want to override the default behavior for only *one* feed, you | |
| 380 | - can use the `hardcode name` feed setting. If FeedWordPress updates the | |
| 381 | - title of all feeds by default, but you wish to use a manually-set title | |
| 382 | - for one particular feed, you can add a line like this to the Link Notes | |
| 383 | - section of the feed that you want to manually set the title for: | |
| 146 | + A yes/no setting. By default, FeedWordPress updates the value of the | |
| 147 | + Link Name field automatically to reflect the title that is reported by a | |
| 148 | + syndicated feed. (So, for example, if one of your contributors changes | |
| 149 | + 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: | |
| 384 | 155 | |
| 385 | 156 | hardcode name: yes |
| 386 | 157 | |
| 387 | - Similarly, if FeedWordPress uses your manually-entered titles for all | |
| 388 | - feeds by default, but you wish to use an automatically updated title for | |
| 389 | - one particular feed, you can add a line like this to the Link Notes | |
| 390 | - section of the feed that you want to manually set the title for: | |
| 391 | - | |
| 392 | - hardcode name: no | |
| 393 | - | |
| 394 | - If `hardcode name` is absent, or set to a value other than `yes` or | |
| 395 | - `no`, FeedWordPress will follow the default behavior set under | |
| 396 | - Options --> Syndication. | |
| 158 | + If `hardcode name` is absent, or set to a value other than `yes`, | |
| 159 | + FeedWordPress will take that as a 'no' and follow the default behavior. | |
| 397 | 160 | |
| 398 | 161 | - `hardcode description: (yes|no)` |
| 399 | 162 | |
| 400 | - By default, FeedWordPress updates the value of the Link Description | |
| 401 | - field automatically to reflect the tagline or description that is | |
| 402 | - reported by a syndicated feed--so that if one of your contributors | |
| 403 | - changes the tagline for her website, the change will be reflected on | |
| 404 | - your Contributors list after the next update. If you want to stop this | |
| 405 | - behavior (so that you can set the taglien of a Contributor link manually | |
| 406 | - -- e.g. so that you can use it to provide information of another sort or | |
| 407 | - use an abbreviated form for reasons of space), you can change the | |
| 408 | - default behavior for *all* feeds using the settings in Options --> | |
| 409 | - Syndication. If you want to override the default behavior for only *one* | |
| 410 | - feed, you can use the `hardcode description` feed setting. If | |
| 411 | - FeedWordPress updates the description of all feeds by default, but you | |
| 412 | - wish to use a manually-set description for one particular feed, you can | |
| 413 | - add a line like this to the Link Notes section of that particular feed: | |
| 414 | - | |
| 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 | + | |
| 415 | 172 | hardcode description: yes |
| 416 | 173 | |
| 417 | - Similarly, if FeedWordPress uses your manually-entered descriptions for | |
| 418 | - all feeds by default, but you wish to use an automatically updated | |
| 419 | - description for one particular feed, you can add a line like this to the | |
| 420 | - Link Notes section of that particular feed: | |
| 421 | - | |
| 422 | - hardcode description: no | |
| 423 | - | |
| 424 | - If `hardcode description` is absent, or set to a value other than `yes` | |
| 425 | - or `no`, FeedWordPress will follow the default behavior set under | |
| 426 | - Options --> Syndication. | |
| 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. | |
| 427 | 176 | |
| 428 | 177 | - `hardcode categories: (yes|no)` |
| 429 | 178 | |
| 430 | - **This setting has been deprecated.** If set to `yes` it is now treated | |
| 431 | - as equivalent to `unfamiliar categories: default`. (See below.) | |
| 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. | |
| 432 | 197 | |
| 433 | 198 | - `post status:` sets the default post status for posts from this feed |
| 434 | 199 | This can be 'publish', 'draft', or 'private'. By default, it is set to |
| 435 | 200 | 'publish' (syndicated posts go online immediately). |
| @@ -443,81 +208,8 @@ | ||
| 443 | 208 | PingBack pings on posts syndicated from this feed. By default, |
| 444 | 209 | syndicated posts are closed to pings, but you can set this to 'open' or |
| 445 | 210 | 'closed' for particular feeds. |
| 446 | 211 | |
| 447 | -- `unfamiliar authors: (create|default|filter)` | |
| 448 | - | |
| 449 | - By default, FeedWordPress creates new author accounts whenever it finds | |
| 450 | - a new post that is by an author whose name is not already in the | |
| 451 | - WordPress database, and uses that account for this post and any future | |
| 452 | - posts by an author of that name. FeedWordPress also allows you to | |
| 453 | - attribute posts by unfamiliar authors to a *default* user account | |
| 454 | - (currently, this means the System Administrator account), *instead of* | |
| 455 | - creating a new author, or simply not to syndicate posts by unfamiliar | |
| 456 | - authors (thus only syndicating posts by authors who are already in the | |
| 457 | - database). | |
| 458 | - | |
| 459 | - Which of these FeedWordPress does by default can be set using the | |
| 460 | - settings in Options --> Syndicated. You can also override the default | |
| 461 | - behavior for specific feeds by adding the `unfamiliar author` feed | |
| 462 | - setting to the Link Notes section of a feed. For example, to ensure that | |
| 463 | - FeedWordPress filters out posts by unfamiliar authors for one particular | |
| 464 | - feed, add the setting: | |
| 465 | - | |
| 466 | - unfamiliar author: filter | |
| 467 | - | |
| 468 | - To ensure that FeedWordPress assigns posts by unfamiliar authors to the | |
| 469 | - default user account instead of creating a new user account, add the | |
| 470 | - setting: | |
| 471 | - | |
| 472 | - unfamiliar author: default | |
| 473 | - | |
| 474 | - If you changed the default behavior under Options --> Syndicated but | |
| 475 | - want to ensure that FeedWordPress creates new author accounts for | |
| 476 | - unfamiliar authors on one specific feed, add the setting: | |
| 477 | - | |
| 478 | - unfamiliar author: create | |
| 479 | - | |
| 480 | - If the setting is anything other than `create`, `default`, or `filter`, | |
| 481 | - FeedWordPress will ignore the setting and follow the default behavior | |
| 482 | - that you specified under Options --> Syndication. | |
| 483 | - | |
| 484 | -- `unfamiliar categories: (create|default|filter)` | |
| 485 | - | |
| 486 | - By default, FeedWordPress creates categories whenever it finds a new | |
| 487 | - post that is placed in categories whose names are not already in the | |
| 488 | - WordPress database. FeedWordPress allows you to change this behavior, | |
| 489 | - so that it will *not* create new category names. It also allows you to | |
| 490 | - choose whether or not posts must match *at least one* familiar category | |
| 491 | - to be syndicated at all. | |
| 492 | - | |
| 493 | - Which of these FeedWordPress does by default can be set using the | |
| 494 | - settings in Options --> Syndicated. You can also override the default | |
| 495 | - behavior for specific feeds by adding the `unfamiliar categories` feed | |
| 496 | - setting to the Link Notes section of a feed. For example, to ensure | |
| 497 | - that, when adding new posts from *one particular feed*, FeedWordPress | |
| 498 | - does *not* create new categories, and filters out any posts that don't | |
| 499 | - match *at least one* of the categories that you have already defined, | |
| 500 | - add the setting: | |
| 501 | - | |
| 502 | - unfamiliar categories: filter | |
| 503 | - | |
| 504 | - To ensure that FeedWordPress does *not* create new categories, but | |
| 505 | - *will* still syndicate categories even if they don't match any of the | |
| 506 | - pre-defined categories, add the following to the feed settings: | |
| 507 | - | |
| 508 | - unfamiliar categories: default | |
| 509 | - | |
| 510 | - If you changed the default behavior under Options --> Syndicated but | |
| 511 | - want to ensure that FeedWordPress creates new categories for posts | |
| 512 | - from one particular feed, add the setting: | |
| 513 | - | |
| 514 | - unfamiliar categories: create | |
| 515 | - | |
| 516 | - If the setting is anything other than `create`, `default`, or `filter`, | |
| 517 | - FeedWordPress will ignore the setting and follow the default behavior | |
| 518 | - that you specified under Options --> Syndication. | |
| 519 | - | |
| 520 | 212 | Template API |
| 521 | 213 | ------------ |
| 522 | 214 | When activated, FeedWordPress makes the following functions available for use by |
| 523 | 215 | themes/templates: |
| @@ -573,9 +265,9 @@ | ||
| 573 | 265 | ``feedwordpress_check_feed``, the action ``feedwordpress_update_complete``, the |
| 574 | 266 | filter ``syndicated_item``, the filter ``syndicated_post``, the action |
| 575 | 267 | ``post_syndicated_item``, and the action ``update_syndicated_item``. |
| 576 | 268 | |
| 577 | -For more information, see <http://projects.radgeek.com/feedwordpress/api>. | |
| 269 | +For more information, see <http://projects.radgeek.com/feedwordpress/use>. | |
| 578 | 270 | |
| 579 | 271 | License |
| 580 | 272 | ------- |
| 581 | 273 | The FeedWordPress plugin is copyright (c) 2005 by Charles Johnson. It uses code |
